Skip to content

Commit c4f71f5

Browse files
committed
docs(README): small improvements
1 parent a505f9b commit c4f71f5

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,21 @@ A typed client for ClickHouse.
1717
[actions-url]: https://github.com/loyd/clickhouse.rs/actions/workflows/ci.yml
1818

1919
* Uses `serde` for encoding/decoding rows.
20-
* Uses `RowBinary` encoding.
21-
* Supports HTTP and HTTPS.
20+
* Supports `serde` attributes: `skip_serializing`, `skip_deserializing`, `rename`.
21+
* Uses `RowBinary` encoding over HTTP transport.
22+
* There are plans to switch to `Native` over TCP.
23+
* Supports TLS.
24+
* Supports compression and decompression (LZ4 and LZ4HC).
2225
* Provides API for selecting.
2326
* Provides API for inserting.
2427
* Provides API for infinite transactional (see below) inserting.
2528
* Provides API for watching live views.
26-
* Compression and decompression (LZ4).
2729
* Provides mocks for unit testing.
2830

31+
Note: [ch2rs](https://github.com/loyd/ch2rs) is useful to generate a row type from ClickHouse.
32+
2933
## Usage
34+
3035
To use the crate, add this to your `Cargo.toml`:
3136
```toml
3237
[dependencies]
@@ -126,7 +131,6 @@ insert.end().await?;
126131
* If `end()` isn't called, the `INSERT` is aborted.
127132
* Rows are being sent progressively to spread network load.
128133
* ClickHouse inserts batches atomically only if all rows fit in the same partition and their number is less [`max_insert_block_size`](https://clickhouse.tech/docs/en/operations/settings/settings/#settings-max_insert_block_size).
129-
* [ch2rs](https://github.com/loyd/ch2rs) is useful to generate a row type from ClickHouse.
130134

131135
</details>
132136
<details>
@@ -226,7 +230,7 @@ See [examples](https://github.com/loyd/clickhouse.rs/tree/master/examples).
226230
<summary>Example</summary>
227231

228232
```rust,ignore
229-
#[derive(Debug, Serialize, Deserialize)]
233+
#[derive(Row, Debug, Serialize, Deserialize)]
230234
struct MyRow<'a> {
231235
str: &'a str,
232236
string: String,

0 commit comments

Comments
 (0)