chore!: update and document MSRV, ClickHouse compatibility (#303)

Author: abonander

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ env:
   RUSTFLAGS: -Dwarnings
   RUSTDOCFLAGS: -Dwarnings
   RUST_BACKTRACE: 1
-  MSRV: 1.79.0
+  # note: MSRV now tracked in `rust-toolchain.toml`
 
 jobs:
   build:
@@ -23,32 +23,6 @@ jobs:
       - run: cargo build --all-targets --no-default-features
       - run: cargo build --all-targets --all-features
 
-  msrv:
-    runs-on: ubuntu-latest
-    env:
-      RUSTFLAGS: "" # remove -Dwarnings
-    steps:
-      - uses: actions/checkout@v4
-      - run: rustup toolchain install ${{ env.MSRV }} --profile minimal
-      - run: rustup override set ${{ env.MSRV }}
-      - run: rustup show active-toolchain -v
-      # URL 2.5.4 -> ICU4X 2.x require rustc 1.82
-      # See https://github.com/servo/rust-url?tab=readme-ov-file#alternative-unicode-back-ends
-      #     https://github.com/hsivonen/idna_adapter?tab=readme-ov-file#icu4x-as-the-default
-      - run: cargo update -p idna_adapter --precise 1.2.0
-      - run: cargo update -p native-tls --precise 0.2.13 # 0.2.14 requires rustc 1.80
-      - run: cargo update -p litemap --precise 0.7.4 # 0.7.5 requires rustc 1.81
-      - run: cargo update -p zerofrom --precise 0.1.5 # 0.1.6 requires rustc 1.81
-      - run: cargo update -p lz4_flex --precise 0.11.3 # 0.11.4 requires rustc 1.81
-      - run: cargo update -p url --precise 2.5.0 # 2.5.4 requires rustc 1.82
-      - run: cargo update -p time --precise 0.3.41 # 0.3.43 requires rustc 1.81
-      - run: cargo update -p time-core --precise 0.1.4 # 0.1.6 requires rustc 1.81
-      - run: cargo update -p deranged --precise 0.4.0 # 0.5.x requires rustc 1.81
-      - run: cargo build
-      - run: cargo build --no-default-features
-      - run: cargo build --features uuid,time,chrono
-      - run: cargo build --all-features
-
   rustfmt:
     runs-on: ubuntu-latest
     steps:

Cargo.toml

@@ -3,26 +3,28 @@ name = "clickhouse"
 version = "0.13.3"
 description = "Official Rust client for ClickHouse DB"
 keywords = ["clickhouse", "database", "driver", "tokio", "hyper"]
-authors = ["ClickHouse Contributors", "Paul Loyd <pavelko95@gmail.com>"]
-repository = "https://github.com/ClickHouse/clickhouse-rs"
-homepage = "https://clickhouse.com"
-license = "MIT OR Apache-2.0"
 readme = "README.md"
-edition = "2021"
-# update `workspace.package.rust-version` below and CI if changed
-# TODO: after bumping to v1.80, remove `--precise` in the "msrv" CI job
-rust-version = "1.79.0"
+authors.workspace = true
+homepage.workspace = true
+repository.workspace = true
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
 
 [workspace]
 members = ["derive", "types"]
+# `rust-version`-aware dependency resolution;
+# applies to all workspace members
+resolver = "3"
 
 [workspace.package]
 authors = ["ClickHouse Contributors", "Paul Loyd <pavelko95@gmail.com>"]
 repository = "https://github.com/ClickHouse/clickhouse-rs"
 homepage = "https://clickhouse.com"
-edition = "2021"
+edition = "2024"
 license = "MIT OR Apache-2.0"
-rust-version = "1.79.0"
+# N.B. be sure to update this in `rust-toolchain.toml` as well
+rust-version = "1.89.0"
 
 [lints.rust]
 rust_2018_idioms = { level = "warn", priority = -1 }

README.md

@@ -526,3 +526,25 @@ The crate provides utils for mocking CH server and testing DDL, `SELECT` and `IN
 The functionality can be enabled with the `test-util` feature. Use it **only** in dev-dependencies.
 
 See [the example](https://github.com/ClickHouse/clickhouse-rs/tree/main/examples/mock.rs).
+
+## Support Policies
+
+### Minimum Supported Rust Version (MSRV)
+
+This project's MSRV is the second-to-last stable release as of the beginning of the current release cycle (`0.x.0`),
+where it will remain until the beginning of the _next_ release cycle (`0.{x+1}.0`).
+
+The MSRV for the `0.14.x` release cycle is `1.89.0`.
+
+This guarantees that `clickhouse-rs` will compile with a Rust version that is at _least_ six weeks old, 
+which should be plenty of time for it to make it through any packaging system that is being actively kept up to date.
+
+Beware when installing Rust through operating system package managers, as it can often be a year or more
+out-of-date. For example, Debian Bookworm (released 10 June 2023) shipped with Rust 1.63.0 (released 11 August 2022).
+
+### ClickHouse Versions
+
+The supported versions of the ClickHouse database server coincide with the versions currently receiving security
+updates.
+
+For the list of currently supported versions, see <https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support>.

benches/common.rs

@@ -15,9 +15,10 @@ use clickhouse::error::Result;
 use futures_util::stream::StreamExt;
 use http_body_util::BodyExt;
 use hyper::{
+    Request, Response,
     body::{Body, Incoming},
     server::conn,
-    service, Request, Response,
+    service,
 };
 use hyper_util::rt::{TokioIo, TokioTimer};
 use tokio::{

benches/common_select.rs

@@ -75,7 +75,9 @@ pub(crate) fn print_results<T: WithAccessType>(
         let access_type = T::ACCESS_TYPE;
         &format!("  {access_type:>6}")
     };
-    println!("{compression:>8}  {validation_mode:>10}  {elapsed:>9.3?}  {throughput_mbytes_sec:>4.0} MiB/s  {received_mbytes:>4.0} MiB{access}");
+    println!(
+        "{compression:>8}  {validation_mode:>10}  {elapsed:>9.3?}  {throughput_mbytes_sec:>4.0} MiB/s  {received_mbytes:>4.0} MiB{access}"
+    );
 }
 
 pub(crate) async fn fetch_cursor<T: Row>(

benches/mocked_insert.rs

@@ -1,11 +1,11 @@
 use bytes::Bytes;
-use clickhouse::{error::Result, Client, Compression, Row};
+use clickhouse::{Client, Compression, Row, error::Result};
 use clickhouse_types::{Column, DataTypeNode};
-use criterion::{criterion_group, criterion_main, Criterion, Throughput};
+use criterion::{Criterion, Throughput, criterion_group, criterion_main};
 use futures_util::stream;
 use http_body_util::StreamBody;
 use hyper::body::{Body, Frame};
-use hyper::{body::Incoming, Request, Response};
+use hyper::{Request, Response, body::Incoming};
 use serde::Serialize;
 use std::convert::Infallible;
 use std::hint::black_box;

benches/mocked_select.rs

@@ -1,15 +1,15 @@
 use bytes::Bytes;
 use clickhouse::{
-    error::{Error, Result},
     Client, Compression, Row,
+    error::{Error, Result},
 };
 use clickhouse_types::{Column, DataTypeNode};
-use criterion::{criterion_group, criterion_main, Criterion, Throughput};
+use criterion::{Criterion, Throughput, criterion_group, criterion_main};
 use futures_util::stream::{self, StreamExt as _};
 use http_body_util::StreamBody;
 use hyper::{
-    body::{Body, Frame, Incoming},
     Request, Response,
+    body::{Body, Frame, Incoming},
 };
 use serde::Deserialize;
 use std::convert::Infallible;
@@ -56,7 +56,7 @@ async fn serve(
 }
 
 fn prepare_chunk() -> Bytes {
-    use rand::{distr::StandardUniform, rngs::SmallRng, Rng, SeedableRng};
+    use rand::{Rng, SeedableRng, distr::StandardUniform, rngs::SmallRng};
 
     // Generate random data to avoid _real_ compression.
     // TODO: It would be more useful to generate real data.

benches/select_market_data.rs

@@ -1,5 +1,5 @@
 use crate::common_select::{
-    do_select_bench, print_header, print_results, BenchmarkRow, WithAccessType, WithId,
+    BenchmarkRow, WithAccessType, WithId, do_select_bench, print_header, print_results,
 };
 use clickhouse::{Client, Compression, Row};
 use serde::{Deserialize, Serialize};

benches/select_numbers.rs

@@ -1,7 +1,7 @@
 use serde::Deserialize;
 
 use crate::common_select::{
-    do_select_bench, print_header, print_results, BenchmarkRow, WithAccessType, WithId,
+    BenchmarkRow, WithAccessType, WithId, do_select_bench, print_header, print_results,
 };
 use clickhouse::{Compression, Row};
 

benches/select_nyc_taxi_data.rs

@@ -1,7 +1,7 @@
 #![cfg(feature = "time")]
 
 use crate::common_select::{
-    do_select_bench, print_header, print_results, BenchmarkRow, WithAccessType, WithId,
+    BenchmarkRow, WithAccessType, WithId, do_select_bench, print_header, print_results,
 };
 use clickhouse::{Client, Compression, Row};
 use serde::Deserialize;