ClickHouse Rust 客户端

ClickHouse 的官方 Rust 客户端，最初由 Paul Loyd 开发。客户端源代码可在 GitHub 仓库 中找到。

概述

• 使用 serde 进行行编码/解码。
• 支持 serde 属性：skip_serializing、skip_deserializing、rename。
• 通过 HTTP 传输使用 RowBinary 格式。
  • 计划切换到通过 TCP 使用 Native 格式。
• 支持 TLS（通过 native-tls 和 rustls-tls 特性）。
• 支持压缩和解压缩（LZ4）。
• 提供用于选择或插入数据、执行 DDL 以及客户端批量处理的 API。
• 提供方便的模拟对象，用于单元测试。

安装

要使用此 crate，请将以下内容添加到您的 Cargo.toml 中

[dependencies]
clickhouse = "0.12.2"

[dev-dependencies]
clickhouse = { version = "0.12.2", features = ["test-util"] }

另请参阅：crates.io 页面。

Cargo 特性

• lz4（默认启用）— 启用 Compression::Lz4 和 Compression::Lz4Hc(_) 变体。如果启用，Compression::Lz4 将用于所有查询的默认压缩方式，除了 WATCH 查询。
• native-tls — 支持使用 hyper-tls 的 HTTPS 模式的 URL，该模式链接到 OpenSSL。
• rustls-tls — 支持使用 hyper-rustls 的 HTTPS 模式的 URL，该模式不链接到 OpenSSL。
• inserter — 启用 client.inserter()。
• test-util — 添加模拟对象。请参阅 示例。仅在 dev-dependencies 中使用。
• watch — 启用 client.watch 功能。请参阅相应部分了解详细信息。
• uuid — 添加 serde::uuid 以配合 uuid crate 使用。
• time — 添加 serde::time 以配合 time crate 使用。

参考

通过 HTTPS URL 连接到 ClickHouse 时，应启用 native-tls 或 rustls-tls 特性之一。如果同时启用，则 rustls-tls 特性将优先。

ClickHouse 版本兼容性

该客户端与 ClickHouse 的 LTS 或更新版本以及 ClickHouse Cloud 兼容。

较旧的 ClickHouse 服务器（低于 v22.6）在某些罕见情况下会错误处理 RowBinary。您可以使用 v0.11+ 并启用 wa-37420 特性来解决此问题。注意：此特性不应与较新的 ClickHouse 版本一起使用。

示例

我们旨在通过客户端仓库中的 示例 涵盖客户端使用的各种场景。概述可在 示例 README 中找到。

如果示例或以下文档中有任何不清楚或缺失的地方，请随时 联系我们。

用法

注意

ch2rs crate 对于从 ClickHouse 生成行类型非常有用。

创建客户端实例

提示

重用创建的客户端或克隆它们，以便重用底层的 hyper 连接池。

use clickhouse::Client;

let client = Client::default()
    // should include both protocol and port
    .with_url("https://:8123")
    .with_user("name")
    .with_password("123")
    .with_database("test");

HTTPS 或 ClickHouse Cloud 连接

HTTPS 使用 rustls-tls 或 native-tls cargo 特性之一。

然后，像往常一样创建客户端。在此示例中，环境变量用于存储连接详细信息

参考

URL 应包括协议和端口，例如 https://instance.clickhouse.cloud:8443。

fn read_env_var(key: &str) -> String {
    env::var(key).unwrap_or_else(|_| panic!("{key} env variable should be set"))
}

let client = Client::default()
    .with_url(read_env_var("CLICKHOUSE_URL"))
    .with_user(read_env_var("CLICKHOUSE_USER"))
    .with_password(read_env_var("CLICKHOUSE_PASSWORD"));

参见

• 客户端仓库中的 HTTPS 与 ClickHouse Cloud 示例。这同样适用于本地 HTTPS 连接。

选择行

use serde::Deserialize;
use clickhouse::Row;
use clickhouse::sql::Identifier;

#[derive(Row, Deserialize)]
struct MyRow<'a> {
    no: u32,
    name: &'a str,
}

let table_name = "some";
let mut cursor = client
    .query("SELECT ?fields FROM ? WHERE no BETWEEN ? AND ?")
    .bind(Identifier(table_name))
    .bind(500)
    .bind(504)
    .fetch::<MyRow<'_>>()?;

while let Some(row) = cursor.next().await? { .. }

• 占位符 ?fields 将被 no, name（Row 的字段）替换。
• 占位符 ? 将在后续的 bind() 调用中被值替换。
• 可以使用方便的 fetch_one::<Row>() 和 fetch_all::<Row>() 方法分别获取第一行或所有行。
• sql::Identifier 可用于绑定表名。

注意：由于整个响应都是流式传输的，游标即使在生成一些行之后也可能返回错误。如果您的用例中发生这种情况，您可以尝试 query(...).with_option("wait_end_of_query", "1") 以启用服务器端响应缓冲。 更多详细信息。 buffer_size 选项也可能有用。

注意

谨慎使用 wait_end_of_query 来选择行，因为它会导致服务器端更高的内存消耗并可能降低整体性能。

插入行

use serde::Serialize;
use clickhouse::Row;

#[derive(Row, Serialize)]
struct MyRow {
    no: u32,
    name: String,
}

let mut insert = client.insert("some")?;
insert.write(&MyRow { no: 0, name: "foo".into() }).await?;
insert.write(&MyRow { no: 1, name: "bar".into() }).await?;
insert.end().await?;

• 如果未调用 end()，则 INSERT 将被中止。
• 行作为流以渐进方式发送，以分散网络负载。
• 只有当所有行都适合同一个分区并且其数量小于 max_insert_block_size 时，ClickHouse 才会以原子方式插入批次。

异步插入（服务器端批量处理）

您可以使用 ClickHouse 异步插入 以避免客户端的传入数据批量处理。这可以通过简单地将 async_insert 选项提供给 insert 方法（甚至提供给 Client 实例本身，以便它会影响所有 insert 调用）来完成。

let client = Client::default()
    .with_url("https://:8123")
    .with_option("async_insert", "1")
    .with_option("wait_for_async_insert", "0");

参见

• 客户端仓库中的异步插入示例。

Inserter 特性（客户端批量处理）

需要 inserter cargo 特性。

let mut inserter = client.inserter("some")?
    .with_timeouts(Some(Duration::from_secs(5)), Some(Duration::from_secs(20)))
    .with_max_bytes(50_000_000)
    .with_max_rows(750_000)
    .with_period(Some(Duration::from_secs(15)));

inserter.write(&MyRow { no: 0, name: "foo".into() })?;
inserter.write(&MyRow { no: 1, name: "bar".into() })?;
let stats = inserter.commit().await?;
if stats.rows > 0 {
    println!(
        "{} bytes, {} rows, {} transactions have been inserted",
        stats.bytes, stats.rows, stats.transactions,
    );
}

// don't forget to finalize the inserter during the application shutdown
// and commit the remaining rows. `.end()` will provide stats as well.
inserter.end().await?;

• Inserter 在达到任何阈值（max_bytes、max_rows、period）时在 commit() 中结束活动的插入。
• 可以使用 with_period_bias 来调整间隔结束活动 INSERT 的时间，以避免并行 inserter 造成的负载峰值。
• Inserter::time_left() 可用于检测当前周期何时结束。再次调用 Inserter::commit() 以检查限制，如果您的流很少发出项目。
• 时间阈值通过使用 quanta crate 来加速 inserter。如果启用了 test-util，则不使用（因此，时间可以通过自定义测试中的 tokio::time::advance() 进行管理）。
• commit() 调用之间的所有行都插入到同一个 INSERT 语句中。

注意

如果您想终止/完成插入，请不要忘记刷新

inserter.end().await?;

执行 DDL

对于单节点部署，执行 DDL 就像这样就足够了

client.query("DROP TABLE IF EXISTS some").execute().await?;

但是，在具有负载均衡器或 ClickHouse Cloud 的集群部署中，建议使用 wait_end_of_query 选项等待 DDL 在所有副本上应用。这可以这样完成

client
    .query("DROP TABLE IF EXISTS some")
    .with_option("wait_end_of_query", "1")
    .execute()
    .await?;

ClickHouse 设置

您可以使用 with_option 方法应用各种 ClickHouse 设置。例如

let numbers = client
    .query("SELECT number FROM system.numbers")
    // This setting will be applied to this particular query only;
    // it will override the global client setting.
    .with_option("limit", "3")
    .fetch_all::<u64>()
    .await?;

除了 query 之外，它也适用于 insert 和 inserter 方法；此外，相同的方法也可以在 Client 实例上调用，以设置所有查询的全局设置。

查询 ID

使用 .with_option，您可以设置 query_id 选项以在 ClickHouse 查询日志中标识查询。

let numbers = client
    .query("SELECT number FROM system.numbers LIMIT 1")
    .with_option("query_id", "some-query-id")
    .fetch_all::<u64>()
    .await?;

除了 query 之外，它也适用于 insert 和 inserter 方法。

危险

如果您手动设置 query_id，请确保它是唯一的。UUID 是一个不错的选择。

另请参阅：客户端仓库中的 query_id 示例。

会话 ID

与 query_id 类似，您可以设置 session_id 以在同一个会话中执行语句。session_id 可以在客户端级别全局设置，也可以在每个 query、insert 或 inserter 调用中设置。

let client = Client::default()
    .with_url("https://:8123")
    .with_option("session_id", "my-session");

危险

对于集群部署，由于缺乏“粘性会话”，您需要连接到特定的集群节点才能正确利用此功能，因为例如，轮询负载均衡器不能保证后续请求将由同一个 ClickHouse 节点处理。

另请参阅：客户端仓库中的 session_id 示例。

自定义 HTTP 标头

如果您正在使用代理身份验证或需要传递自定义标头，可以这样做

let client = Client::default()
    .with_url("https://:8123")
    .with_header("X-My-Header", "hello");

另请参阅：客户端仓库中的自定义 HTTP 标头示例。

自定义 HTTP 客户端

这对于调整底层 HTTP 连接池设置可能很有用。

use hyper_util::client::legacy::connect::HttpConnector;
use hyper_util::client::legacy::Client as HyperClient;
use hyper_util::rt::TokioExecutor;

let connector = HttpConnector::new(); // or HttpsConnectorBuilder
let hyper_client = HyperClient::builder(TokioExecutor::new())
    // For how long keep a particular idle socket alive on the client side (in milliseconds).
    // It is supposed to be a fair bit less that the ClickHouse server KeepAlive timeout,
    // which was by default 3 seconds for pre-23.11 versions, and 10 seconds after that.
    .pool_idle_timeout(Duration::from_millis(2_500))
    // Sets the maximum idle Keep-Alive connections allowed in the pool.
    .pool_max_idle_per_host(4)
    .build(connector);

let client = Client::with_http_client(hyper_client).with_url("https://:8123");

注意

此示例依赖于遗留的 Hyper API，未来可能会发生变化。

另请参阅：客户端仓库中的 自定义 HTTP 客户端示例。

数据类型

参考

另请参阅其他示例

• 更简单的 ClickHouse 数据类型
• 类似容器的 ClickHouse 数据类型

• (U)Int(8|16|32|64|128) 映射到/从相应的 (u|i)(8|16|32|64|128) 类型或围绕它们的 newtype 映射。
• (U)Int256 不直接支持，但有 一个解决方法。
• Float(32|64) 映射到/从相应的 f(32|64) 或围绕它们的 newtype 映射。
• Decimal(32|64|128) 映射到/从相应的 i(32|64|128) 或围绕它们的 newtype 映射。使用 fixnum 或另一个有符号定点数的实现更方便。
• Boolean 映射到/从 bool 或围绕它的 newtype 映射。
• String 映射到/从任何字符串或字节类型，例如 &str、&[u8]、String、Vec<u8> 或 SmartString。也支持 newtype。要存储字节，请考虑使用 serde_bytes，因为它更有效。

#[derive(Row, Debug, Serialize, Deserialize)]
struct MyRow<'a> {
    str: &'a str,
    string: String,
    #[serde(with = "serde_bytes")]
    bytes: Vec<u8>,
    #[serde(with = "serde_bytes")]
    byte_slice: &'a [u8],
}

• FixedString(N) 作为字节数组支持，例如 [u8; N]。

#[derive(Row, Debug, Serialize, Deserialize)]
struct MyRow {
    fixed_str: [u8; 16], // FixedString(16)
}

• 使用 serde_repr 支持 Enum(8|16)。

use serde_repr::{Deserialize_repr, Serialize_repr};

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    level: Level,
}

#[derive(Debug, Serialize_repr, Deserialize_repr)]
#[repr(u8)]
enum Level {
    Debug = 1,
    Info = 2,
    Warn = 3,
    Error = 4,
}

• UUID 映射到/从 uuid::Uuid，通过使用 serde::uuid。需要 uuid 特性。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    #[serde(with = "clickhouse::serde::uuid")]
    uuid: uuid::Uuid,
}

• IPv6 映射到/从 std::net::Ipv6Addr。
• IPv4 映射到/从 std::net::Ipv4Addr，通过使用 serde::ipv4。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    #[serde(with = "clickhouse::serde::ipv4")]
    ipv4: std::net::Ipv4Addr,
}

• Date 映射到/从 u16 或围绕它的 newtype，并表示自 1970-01-01 以来经过的天数。此外，使用 serde::time::date 支持 time::Date，需要 time 特性。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    days: u16,
    #[serde(with = "clickhouse::serde::time::date")]
    date: Date,
}

• Date32 映射到/从 i32 或围绕它的 newtype，并表示自 1970-01-01 以来经过的天数。此外，使用 serde::time::date32 支持 time::Date，需要 time 特性。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    days: i32,
    #[serde(with = "clickhouse::serde::time::date32")]
    date: Date,
}

• DateTime 映射到/从 u32 或围绕它的 newtype，并表示自 UNIX epoch 以来经过的秒数。此外，使用 serde::time::datetime 支持 time::OffsetDateTime，需要 time 特性。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    ts: u32,
    #[serde(with = "clickhouse::serde::time::datetime")]
    dt: OffsetDateTime,
}

• DateTime64(_) 映射到/从 i32 或围绕它的 newtype，并表示自 UNIX epoch 以来经过的时间。此外，使用 serde::time::datetime64::* 支持 time::OffsetDateTime，需要 time 特性。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    ts: i64, // elapsed s/us/ms/ns depending on `DateTime64(X)`
    #[serde(with = "clickhouse::serde::time::datetime64::secs")]
    dt64s: OffsetDateTime,  // `DateTime64(0)`
    #[serde(with = "clickhouse::serde::time::datetime64::millis")]
    dt64ms: OffsetDateTime, // `DateTime64(3)`
    #[serde(with = "clickhouse::serde::time::datetime64::micros")]
    dt64us: OffsetDateTime, // `DateTime64(6)`
    #[serde(with = "clickhouse::serde::time::datetime64::nanos")]
    dt64ns: OffsetDateTime, // `DateTime64(9)`
}

• Tuple(A, B, ...) 映射到/从 (A, B, ...) 或围绕它的 newtype。
• Array(_) 映射到/从任何切片，例如 Vec<_>、&[_]。也支持 newtype。
• Map(K, V) 表现得像 Array((K, V))。
• LowCardinality(_) 无缝支持。
• Nullable(_) 映射到/从 Option<_>。对于 clickhouse::serde::* 助手，添加 ::option。

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    #[serde(with = "clickhouse::serde::ipv4::option")]
    ipv4_opt: Option<Ipv4Addr>,
}

• 通过提供多个具有重命名的数组来支持 Nested。

// CREATE TABLE test(items Nested(name String, count UInt32))
#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    #[serde(rename = "items.name")]
    items_name: Vec<String>,
    #[serde(rename = "items.count")]
    items_count: Vec<u32>,
}

• 支持 Geo 类型。Point 表现得像一个元组 (f64, f64)，其余类型只是点的切片。

type Point = (f64, f64);
type Ring = Vec<Point>;
type Polygon = Vec<Ring>;
type MultiPolygon = Vec<Polygon>;
type LineString = Vec<Point>;
type MultiLineString = Vec<LineString>;

#[derive(Row, Serialize, Deserialize)]
struct MyRow {
    point: Point,
    ring: Ring,
    polygon: Polygon,
    multi_polygon: MultiPolygon,
    line_string: LineString,
    multi_line_string: MultiLineString,
}

• Variant、Dynamic、（新的）JSON 数据类型尚未支持。

模拟

该 crate 提供了用于模拟 CH 服务器和测试 DDL、SELECT、INSERT 和 WATCH 查询的工具。可以使用 test-util 特性启用该功能。仅将其用作 dev-dependency。

请参阅 示例。

故障排除

CANNOT_READ_ALL_DATA

CANNOT_READ_ALL_DATA 错误的常见原因是应用程序侧的行定义与 ClickHouse 中的不匹配。

考虑以下表

CREATE OR REPLACE TABLE event_log (id UInt32)
ENGINE = MergeTree
ORDER BY timestamp

然后，如果 EventLog 在应用程序侧定义了不匹配的类型，例如

#[derive(Debug, Serialize, Deserialize, Row)]
struct EventLog {
    id: String, // <- should be u32 instead!
}

插入数据时，可能会发生以下错误

Error: BadResponse("Code: 33. DB::Exception: Cannot read all data. Bytes read: 5. Bytes expected: 23.: (at row 1)\n: While executing BinaryRowInputFormat. (CANNOT_READ_ALL_DATA)")

在此示例中，通过正确定义 EventLog 结构来解决此问题

#[derive(Debug, Serialize, Deserialize, Row)]
struct EventLog {
    id: u32
}

已知限制

• Variant、Dynamic、（新的）JSON 数据类型尚未支持。
• 服务器端参数绑定尚未支持；请参阅 此 issue 以跟踪。

联系我们

如果您有任何问题或需要帮助，请随时通过 Community Slack 或通过 GitHub issues 与我们联系。