Skip to content

Commit

Permalink
Remove TLS notes from CHANGELOG and README
Browse files Browse the repository at this point in the history
  • Loading branch information
slvrtrn committed Sep 23, 2024
1 parent 3a3f330 commit 7e3ada2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased] - ReleaseDate
### Changed
- MSRV is now 1.70 due to changes in `hyper-rustls` (see [v0.27.3](https://github.com/rustls/hyper-rustls/releases/tag/v%2F0.27.3)).
- client: `hyper-rustls` now uses pure Rust `ring` backend by default with an option to use `aws-lc-rs` through `rustls-tls-aws` feature. ([#140])
- client: TLS features priority is now `native-tls` > `rustls-tls-aws` > `rustls-tls` ([#141]).

### Fixed
- insert: fix a panic on empty insert ([#139]).

Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,16 +219,15 @@ See [examples](https://github.com/ClickHouse/clickhouse-rs/tree/main/examples).
* `lz4` (enabled by default) — enables `Compression::Lz4` and `Compression::Lz4Hc(_)` variants. If enabled, `Compression::Lz4` is used by default for all queries except for `WATCH`.
* `native-tls` — supports urls with the `HTTPS` schema via `hyper-tls`, which links against OpenSSL.
* `rustls-tls` — supports urls with the `HTTPS` schema via `hyper-rustls`, which does not link against OpenSSL.
* `rustls-tls-aws` - use [`aws-lc-rs`](https://github.com/rustls/hyper-rustls?tab=readme-ov-file#crate-features) instead of the default pure Rust `ring` backend for `hyper-rustls`.
* `inserter` — enables `client.inserter()`.
* `test-util` — adds mocks. See [the example](https://github.com/ClickHouse/clickhouse-rs/tree/main/examples/mock.rs). Use it only in `dev-dependencies`.
* `watch` — enables `client.watch` functionality. See the corresponding section for details.
* `uuid` — adds `serde::uuid` to work with [uuid](https://docs.rs/uuid) crate.
* `time` — adds `serde::time` to work with [time](https://docs.rs/time) crate.

> **NOTE**:
> When connecting to ClickHouse via an `HTTPS` url, you must enable either the `native-tls`, `rustls-tls` or `rustls-tls-aws` features.
> If all are enabled, the priority is `native-tls` > `rustls-tls-aws` > `rustls-tls`.
> When connecting to ClickHouse via an `HTTPS` url, you must enable either the `native-tls` or `rustls-tls` features.
> If both are enabled, the `rustls-tls` feature will take precedence.
## Data Types
* `(U)Int(8|16|32|64|128)` maps to/from corresponding `(u|i)(8|16|32|64|128)` types or newtypes around them.
Expand Down

0 comments on commit 7e3ada2

Please sign in to comment.