Merge branch 'main' into 0.14.0-changelog

Author: slvrtrn

.github/workflows/ci.yml

@@ -41,6 +41,9 @@ jobs:
       - 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

CHANGELOG.md

@@ -45,12 +45,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `RowBinaryWithNamesAndTypes` struct definition validation, as it contains ClickHouse data types AST, as well as
   functions and utilities to parse the types out of the ClickHouse server response. ([#221]).
 - query: support serializing `serde_bytes::Bytes` as hex string literals in query parameters ([#250]).
+- derive: added `#[clickhouse(crate = "...")]` attribute for `#[derive(Row)]` ([#189]/[#292])
 
 ### Fixed
 
 - client: extract the exception code from `X-ClickHouse-Exception-Code` in case of incorrect 200 OK response 
   that could occur with ClickHouse server up to versions 24.x ([#256]).
 
+[#189]: https://github.com/ClickHouse/clickhouse-rs/pull/189
 [#221]: https://github.com/ClickHouse/clickhouse-rs/pull/221
 [#229]: https://github.com/ClickHouse/clickhouse-rs/pull/229
 [#232]: https://github.com/ClickHouse/clickhouse-rs/pull/232
@@ -61,6 +63,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#250]: https://github.com/ClickHouse/clickhouse-rs/pull/250
 [#256]: https://github.com/ClickHouse/clickhouse-rs/pull/256
 [#258]: https://github.com/ClickHouse/clickhouse-rs/pull/258
+[#292]: https://github.com/ClickHouse/clickhouse-rs/pull/292
 
 ## [0.13.3] - 2025-05-29
 ### Added

Cargo.toml

@@ -137,8 +137,8 @@ hyper-rustls = { version = "0.27.3", default-features = false, features = [
     "tls12",
 ], optional = true }
 url = "2.1.1"
-futures = "0.3.5"
-futures-channel = "0.3.30"
+futures-util = { version = "0.3.5", default-features = false, features = ["sink", "io"] }
+futures-channel = { version = "0.3.30", features = ["sink"] }
 static_assertions = "1.1"
 sealed = "0.6"
 lz4_flex = { version = "0.11.3", default-features = false, features = [

benches/common.rs

@@ -12,7 +12,7 @@ use std::{
 
 use bytes::Bytes;
 use clickhouse::error::Result;
-use futures::stream::StreamExt;
+use futures_util::stream::StreamExt;
 use http_body_util::BodyExt;
 use hyper::{
     body::{Body, Incoming},

benches/mocked_select.rs

@@ -5,7 +5,7 @@ use clickhouse::{
 };
 use clickhouse_types::{Column, DataTypeNode};
 use criterion::{criterion_group, criterion_main, Criterion, Throughput};
-use futures::stream::{self, StreamExt as _};
+use futures_util::stream::{self, StreamExt as _};
 use http_body_util::StreamBody;
 use hyper::{
     body::{Body, Frame, Incoming},

benches/select_nyc_taxi_data.rs

@@ -3,7 +3,7 @@
 use crate::common_select::{
     do_select_bench, print_header, print_results, BenchmarkRow, WithAccessType, WithId,
 };
-use clickhouse::{Compression, Row};
+use clickhouse::{Client, Compression, Row};
 use serde::Deserialize;
 use serde_repr::Deserialize_repr;
 use time::OffsetDateTime;
@@ -74,6 +74,86 @@ struct TripSmallMapAccess {
 impl_benchmark_row!(TripSmallSeqAccess, trip_id, "seq");
 impl_benchmark_row!(TripSmallMapAccess, trip_id, "map");
 
+// See https://clickhouse.com/docs/getting-started/example-datasets/nyc-taxi
+async fn prepare_data() {
+    let client = Client::default().with_url("http://localhost:8123");
+
+    client
+        .query("CREATE DATABASE IF NOT EXISTS nyc_taxi")
+        .execute()
+        .await
+        .unwrap();
+    client
+        .query(
+            r#"
+            CREATE TABLE IF NOT EXISTS nyc_taxi.trips_small (
+                trip_id             UInt32,
+                pickup_datetime     DateTime,
+                dropoff_datetime    DateTime,
+                pickup_longitude    Nullable(Float64),
+                pickup_latitude     Nullable(Float64),
+                dropoff_longitude   Nullable(Float64),
+                dropoff_latitude    Nullable(Float64),
+                passenger_count     UInt8,
+                trip_distance       Float32,
+                fare_amount         Float32,
+                extra               Float32,
+                tip_amount          Float32,
+                tolls_amount        Float32,
+                total_amount        Float32,
+                payment_type        Enum('CSH' = 1, 'CRE' = 2, 'NOC' = 3, 'DIS' = 4, 'UNK' = 5),
+                pickup_ntaname      LowCardinality(String),
+                dropoff_ntaname     LowCardinality(String)
+            )
+            ENGINE = MergeTree
+            PRIMARY KEY (pickup_datetime, dropoff_datetime)
+            "#,
+        )
+        .execute()
+        .await
+        .unwrap();
+
+    let len = client
+        .query("SELECT count() FROM nyc_taxi.trips_small")
+        .fetch_one::<usize>()
+        .await
+        .unwrap();
+
+    if len == 0 {
+        client
+        .query(
+            "
+            INSERT INTO nyc_taxi.trips_small
+            SELECT
+                trip_id,
+                pickup_datetime,
+                dropoff_datetime,
+                pickup_longitude,
+                pickup_latitude,
+                dropoff_longitude,
+                dropoff_latitude,
+                passenger_count,
+                trip_distance,
+                fare_amount,
+                extra,
+                tip_amount,
+                tolls_amount,
+                total_amount,
+                payment_type,
+                pickup_ntaname,
+                dropoff_ntaname
+            FROM gcs(
+                'https://storage.googleapis.com/clickhouse-public-datasets/nyc-taxi/trips_{0..2}.gz',
+                'TabSeparatedWithNames'
+            );
+            ",
+        )
+        .execute()
+        .await
+        .unwrap();
+    }
+}
+
 async fn bench<T: BenchmarkRow>(compression: Compression, validation: bool) {
     let stats = do_select_bench::<T>(
         "SELECT * FROM nyc_taxi.trips_small ORDER BY trip_id DESC",
@@ -87,6 +167,7 @@ async fn bench<T: BenchmarkRow>(compression: Compression, validation: bool) {
 
 #[tokio::main]
 async fn main() {
+    prepare_data().await;
     print_header(Some("  access"));
     bench::<TripSmallSeqAccess>(Compression::None, false).await;
     bench::<TripSmallSeqAccess>(Compression::None, true).await;

derive/src/attributes.rs

@@ -0,0 +1,52 @@
+use syn::meta::ParseNestedMeta;
+
+pub struct Attributes {
+    pub crate_path: syn::Path,
+}
+
+impl Default for Attributes {
+    fn default() -> Self {
+        Attributes {
+            // Note: changing this to `::clickhouse` is likely a breaking change;
+            // it's possible that the user has renamed the `clickhouse` package,
+            // but then aliased it back to `clickhouse` to fix the derive.
+            crate_path: syn::parse_str("clickhouse").expect("BUG: crate_path should parse"),
+        }
+    }
+}
+
+impl TryFrom<&[syn::Attribute]> for Attributes {
+    type Error = syn::Error;
+
+    fn try_from(attrs: &[syn::Attribute]) -> syn::Result<Self> {
+        for attr in attrs {
+            if attr.path().is_ident("clickhouse") {
+                let mut out = Attributes::default();
+
+                attr.parse_nested_meta(|meta| parse_nested_meta(meta, &mut out))?;
+
+                return Ok(out);
+            }
+        }
+
+        Ok(Self::default())
+    }
+}
+
+/// Called for each meta-item inside the `#[clickhouse(...)]` attribute.
+fn parse_nested_meta(meta: ParseNestedMeta<'_>, out: &mut Attributes) -> syn::Result<()> {
+    // #[clickhouse(crate = "<path>")]
+    if meta.path.is_ident("crate") {
+        out.crate_path = meta
+            // Expect and eat the `=` token
+            .value()?
+            // Expect a string literal like Serde: https://serde.rs/container-attrs.html#crate
+            .parse::<syn::LitStr>()?
+            // Parse the literal content as `Path`
+            .parse()?;
+    } else {
+        return Err(meta.error("unexpected `#[clickhouse(...)]` argument"));
+    }
+
+    Ok(())
+}

derive/src/lib.rs

@@ -1,3 +1,4 @@
+use crate::attributes::Attributes;
 use proc_macro2::{Span, TokenStream};
 use quote::quote;
 use serde_derive_internals::{
@@ -6,9 +7,21 @@ use serde_derive_internals::{
 };
 use syn::{parse_macro_input, Data, DataStruct, DeriveInput, Error, Fields, Lifetime, Result};
 
+mod attributes;
+
 #[cfg(test)]
 mod tests;
 
+// TODO: support wrappers `Wrapper(Inner)` and `Wrapper<T>(T)`.
+// TODO: support the `nested` attribute.
+#[proc_macro_derive(Row, attributes(clickhouse))]
+pub fn row(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
+    let input = parse_macro_input!(input as DeriveInput);
+    row_impl(input)
+        .unwrap_or_else(Error::into_compile_error)
+        .into()
+}
+
 fn column_names(data: &DataStruct, cx: &Ctxt, container: &Container) -> Result<TokenStream> {
     Ok(match &data.fields {
         Fields::Named(fields) => {
@@ -36,19 +49,11 @@ fn column_names(data: &DataStruct, cx: &Ctxt, container: &Container) -> Result<T
     })
 }
 
-// TODO: support wrappers `Wrapper(Inner)` and `Wrapper<T>(T)`.
-// TODO: support the `nested` attribute.
-// TODO: support the `crate` attribute.
-#[proc_macro_derive(Row)]
-pub fn row(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
-    let input = parse_macro_input!(input as DeriveInput);
-    row_impl(input)
-        .unwrap_or_else(Error::into_compile_error)
-        .into()
-}
-
 fn row_impl(input: DeriveInput) -> Result<TokenStream> {
     let cx = Ctxt::new();
+
+    let Attributes { crate_path } = input.attrs[..].try_into()?;
+
     let container = Container::from_ast(&cx, &input);
     let name = input.ident;
 
@@ -89,14 +94,13 @@ fn row_impl(input: DeriveInput) -> Result<TokenStream> {
 
     let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();
 
-    // TODO: replace `clickhouse` with `::clickhouse` here.
     Ok(quote! {
         #[automatically_derived]
-        impl #impl_generics clickhouse::Row for #name #ty_generics #where_clause {
+        impl #impl_generics #crate_path::Row for #name #ty_generics #where_clause {
             const NAME: &'static str = stringify!(#name);
             const COLUMN_NAMES: &'static [&'static str] = #column_names;
-            const COLUMN_COUNT: usize = <Self as clickhouse::Row>::COLUMN_NAMES.len();
-            const KIND: clickhouse::_priv::RowKind = clickhouse::_priv::RowKind::Struct;
+            const COLUMN_COUNT: usize = <Self as #crate_path::Row>::COLUMN_NAMES.len();
+            const KIND: #crate_path::_priv::RowKind = #crate_path::_priv::RowKind::Struct;
 
             type Value<'__v> = #value;
         }

derive/src/tests/cases.rs

@@ -14,7 +14,7 @@ fn simple_owned_row() {
             a: i32,
             b: String,
         }
-    };
+    }
 }
 
 #[test]
@@ -25,23 +25,23 @@ fn generic_owned_row() {
             a: i32,
             b: T,
         }
-    };
+    }
 
     render! {
         #[derive(Row)]
         struct Sample<A, B> {
             a: A,
             b: B,
         }
-    };
+    }
 
     render! {
         #[derive(Row)]
         struct Sample<T> where T: Clone {
             a: i32,
             b: T,
         }
-    };
+    }
 }
 
 #[test]
@@ -52,7 +52,7 @@ fn simple_borrowed_row() {
             a: i32,
             b: &'a str,
         }
-    };
+    }
 }
 
 #[test]
@@ -63,23 +63,23 @@ fn generic_borrowed_row() {
             a: i32,
             b: &'a T,
         }
-    };
+    }
 
     render! {
         #[derive(Row)]
         struct Sample<'a, A, B> {
             a: A,
             b: &'a B,
         }
-    };
+    }
 
     render! {
         #[derive(Row)]
         struct Sample<'a, T> where T: Clone {
             a: i32,
             b: &'a T,
         }
-    };
+    }
 }
 
 #[test]
@@ -93,7 +93,7 @@ fn serde_rename() {
             #[serde(rename = "items.b")]
             items_b: Vec<u32>,
         }
-    };
+    }
 }
 
 #[test]
@@ -105,7 +105,7 @@ fn serde_skip_serializing() {
             #[serde(skip_serializing)]
             b: u32,
         }
-    };
+    }
 }
 
 #[test]
@@ -117,5 +117,17 @@ fn serde_skip_deserializing() {
             #[serde(skip_deserializing)]
             b: u32,
         }
-    };
+    }
+}
+
+#[test]
+fn crate_attribute() {
+    render! {
+        #[derive(Row)]
+        #[clickhouse(crate = "foo")]
+        struct Foo {
+            a: u32,
+            b: u32,
+        }
+    }
 }