refactor: rename derive to macros (#318)

Author: slvrtrn

.github/workflows/ci.yml

@@ -59,7 +59,7 @@ jobs:
       - run: rustup override set nightly
       - run: rustup show active-toolchain -v
       # Serde 1.0.227 fails to build with `--cfg docsrs`, only pass it to our own packages
-      - run: cargo rustdoc -p clickhouse-derive --all-features -- -D warnings --cfg docsrs
+      - run: cargo rustdoc -p clickhouse-macros --all-features -- -D warnings --cfg docsrs
       - run: cargo rustdoc -p clickhouse-types --all-features -- -D warnings --cfg docsrs
       - run: cargo rustdoc -p clickhouse --all-features -- -D warnings --cfg docsrs
 

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - tls: improved error messages in case of missing TLS features when using HTTPS ([#229]).
 - crate: MSRV is now 1.79 due to borrowed rows support redesign in [#247].
 - crate: bumped dependencies, see [#232], [#239] and [#280] for additional details.
+- crate: starting from 0.3.0, `clickhouse-derive` is now published as [`clickhouse-macros` on crates.io](https://crates.io/crates/clickhouse-macros/0.3.0). The former `clickhouse-derive` crate is discontinued. ([#318]).
 
 ### Added
 
@@ -73,6 +74,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#280]: https://github.com/ClickHouse/clickhouse-rs/pull/280
 [#292]: https://github.com/ClickHouse/clickhouse-rs/pull/292
 [#311]: https://github.com/ClickHouse/clickhouse-rs/pull/311
+[#318]: https://github.com/ClickHouse/clickhouse-rs/pull/318
 
 ## [0.13.3] - 2025-05-29
 ### Added

Cargo.toml

@@ -12,7 +12,7 @@ edition.workspace = true
 rust-version.workspace = true
 
 [workspace]
-members = ["derive", "types"]
+members = ["macros", "types"]
 # `rust-version`-aware dependency resolution;
 # applies to all workspace members
 resolver = "3"
@@ -122,7 +122,7 @@ rustls-tls-native-roots = [
 ]
 
 [dependencies]
-clickhouse-derive = { version = "0.3.0", path = "derive" }
+clickhouse-macros = { version = "0.3.0", path = "macros" }
 clickhouse-types = { version = "0.1.0", path = "types" }
 
 thiserror = "2.0"
@@ -155,7 +155,7 @@ quanta = { version = "0.12", optional = true }
 replace_with = { version = "0.1.7" }
 
 [dev-dependencies]
-clickhouse-derive = { version = "0.3.0", path = "derive" }
+clickhouse-macros = { version = "0.3.0", path = "macros" }
 criterion = "0.6"
 serde = { version = "1.0.106", features = ["derive"] }
 tokio = { version = "1.0.1", features = ["full", "test-util"] }

examples/clickhouse_cloud.rs

@@ -1,6 +1,6 @@
 use clickhouse::Client;
+use clickhouse::Row;
 use clickhouse::sql::Identifier;
-use clickhouse_derive::Row;
 use serde::{Deserialize, Serialize};
 use std::env;
 
@@ -42,9 +42,9 @@ async fn main() -> clickhouse::error::Result<()> {
         .execute()
         .await?;
 
-    let mut insert = client.insert::<Data>(table_name).await?;
+    let mut insert = client.insert::<MyRow>(table_name).await?;
     insert
-        .write(&Data {
+        .write(&MyRow {
             id: 42,
             name: "foo".into(),
         })
@@ -57,15 +57,15 @@ async fn main() -> clickhouse::error::Result<()> {
         // This setting is optional; use it when you need strong consistency guarantees on the reads
         // See https://clickhouse.com/docs/en/cloud/reference/shared-merge-tree#consistency
         .with_option("select_sequential_consistency", "1")
-        .fetch_all::<Data>()
+        .fetch_all::<MyRow>()
         .await?;
 
     println!("Stored data: {data:?}");
     Ok(())
 }
 
 #[derive(Debug, Serialize, Deserialize, Row)]
-struct Data {
+struct MyRow {
     id: i32,
     name: String,
 }

examples/data_types_derive_containers.rs

@@ -37,14 +37,14 @@ async fn main() -> Result<()> {
         .execute()
         .await?;
 
-    let mut insert = client.insert::<Row>(table_name).await?;
-    insert.write(&Row::new()).await?;
+    let mut insert = client.insert::<MyRow>(table_name).await?;
+    insert.write(&MyRow::new()).await?;
     insert.end().await?;
 
     let rows = client
         .query("SELECT ?fields FROM ?")
         .bind(Identifier(table_name))
-        .fetch_all::<Row>()
+        .fetch_all::<MyRow>()
         .await?;
 
     println!("{rows:#?}");
@@ -61,7 +61,7 @@ type MultiLineString = Vec<LineString>;
 
 #[derive(Clone, Debug, PartialEq)]
 #[derive(clickhouse::Row, serde::Serialize, serde::Deserialize)]
-pub struct Row {
+pub struct MyRow {
     arr: Vec<String>,
     arr2: Vec<Vec<String>>,
     map: Vec<(String, u32)>,
@@ -81,10 +81,10 @@ pub struct Row {
     multi_line_string: MultiLineString,
 }
 
-impl Row {
+impl MyRow {
     pub fn new() -> Self {
         let mut rng = rand::rng();
-        Row {
+        MyRow {
             arr: vec![random_str()],
             arr2: vec![vec![random_str()]],
             map: vec![(random_str(), 42)],
@@ -104,7 +104,7 @@ impl Row {
     }
 }
 
-impl Default for Row {
+impl Default for MyRow {
     fn default() -> Self {
         Self::new()
     }

examples/data_types_derive_simple.rs

@@ -80,14 +80,14 @@ async fn main() -> Result<()> {
         .execute()
         .await?;
 
-    let mut insert = client.insert::<Row>(table_name).await?;
-    insert.write(&Row::new()).await?;
+    let mut insert = client.insert::<MyRow>(table_name).await?;
+    insert.write(&MyRow::new()).await?;
     insert.end().await?;
 
     let rows = client
         .query("SELECT ?fields FROM ?")
         .bind(Identifier(table_name))
-        .fetch_all::<Row>()
+        .fetch_all::<MyRow>()
         .await?;
 
     println!("{rows:#?}");
@@ -96,7 +96,7 @@ async fn main() -> Result<()> {
 
 #[derive(Clone, Debug, PartialEq)]
 #[derive(clickhouse::Row, serde::Serialize, serde::Deserialize)]
-pub struct Row {
+pub struct MyRow {
     pub int8: i8,
     pub int16: i16,
     pub int32: i32,
@@ -191,10 +191,10 @@ pub enum Enum16 {
     Qux = 255,
 }
 
-impl Row {
+impl MyRow {
     pub fn new() -> Self {
         let mut rng = rand::rng();
-        Row {
+        MyRow {
             int8: rng.random(),
             int16: rng.random(),
             int32: rng.random(),
@@ -259,7 +259,7 @@ impl Row {
     }
 }
 
-impl Default for Row {
+impl Default for MyRow {
     fn default() -> Self {
         Self::new()
     }

examples/data_types_new_json.rs

@@ -1,8 +1,7 @@
-use clickhouse_derive::Row;
 use serde::{Deserialize, Serialize};
 
 use clickhouse::sql::Identifier;
-use clickhouse::{Client, error::Result};
+use clickhouse::{Client, Row, error::Result};
 
 // Requires ClickHouse 24.10+, as the `input_format_binary_read_json_as_string` and `output_format_binary_write_json_as_string` settings were added in that version.
 // Inserting and selecting a row with a JSON column as a string.
@@ -35,7 +34,7 @@ async fn main() -> Result<()> {
         .execute()
         .await?;
 
-    let row = Row {
+    let row = MyRow {
         id: 1,
         data: r#"
         {
@@ -49,14 +48,14 @@ async fn main() -> Result<()> {
         .to_string(),
     };
 
-    let mut insert = client.insert::<Row>(table_name).await?;
+    let mut insert = client.insert::<MyRow>(table_name).await?;
     insert.write(&row).await?;
     insert.end().await?;
 
     let db_row = client
         .query("SELECT ?fields FROM ? LIMIT 1")
         .bind(Identifier(table_name))
-        .fetch_one::<Row>()
+        .fetch_one::<MyRow>()
         .await?;
 
     println!("{db_row:#?}");
@@ -69,7 +68,7 @@ async fn main() -> Result<()> {
 }
 
 #[derive(Debug, Row, Serialize, Deserialize)]
-pub struct Row {
+pub struct MyRow {
     id: u64,
     data: String,
 }

examples/data_types_variant.rs

@@ -1,8 +1,7 @@
-use clickhouse_derive::Row;
 use serde::{Deserialize, Serialize};
 
 use clickhouse::sql::Identifier;
-use clickhouse::{Client, error::Result};
+use clickhouse::{Client, Row, error::Result};
 
 // See also: https://clickhouse.com/docs/en/sql-reference/data-types/variant
 

examples/session_id.rs

@@ -1,9 +1,8 @@
-use clickhouse_derive::Row;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
 use clickhouse::sql::Identifier;
-use clickhouse::{Client, error::Result};
+use clickhouse::{Client, Row, error::Result};
 
 /// Besides [`Client::with_option`], which will be applied for all requests,
 /// `session_id` (and other settings) can be set separately for a particular `query`, `insert`,

derive/Cargo.toml renamed to macros/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "clickhouse-derive"
-description = "A macro for deriving clickhouse::Row"
+name = "clickhouse-macros"
+description = "Renamed from clickhouse-derive. A macro for deriving clickhouse::Row"
 version = "0.3.0"
 
 authors.workspace = true