Klickhouse (Fork by Katana Capital)

NOTICE: This repository is a fork of Protryon/klickhouse. Since the upstream repository has not been updated for some time, we at Katana Capital decided to maintain our own fork in an open-source manner. We extend our deepest gratitude to the original author for creating this wonderful crate, and hope they are not inconvenienced by our decision to continue development under our organization.

About the Project

Klickhouse is a pure Rust SDK for working with ClickHouse via its native protocol in asynchronous environments. The aim is to reduce boilerplate code while maximizing performance.

Example Usage

See example usage.

Unsupported Features

• Clickhouse Enum8 and Enum16 types -- use LowCardinality instead.

Running the tests

A Clickhouse server is required to run the integration tests. One can be started easily in a Docker container:

$ docker run  --rm --name clickhouse -p 19000:9000 --ulimit nofile=262144:262144 clickhouse
$ export KLICKHOUSE_TEST_ADDR=127.0.0.1:19000
$ # export KLICKHOUSE_TEST_USER=default
$ # export KLICKHOUSE_TEST_PASSWORD=default
$ # export KLICKHOUSE_TEST_DATABASE=default
$ cargo nextest run

(running the tests simultaneously with cargo test is currently not suported, due to loggers initializations.)

Feature flags

• derive: Enable [klickhouse_derive], providing a derive macro for the [Row] trait. Default.
• compression: lz4 compression for client/server communication. Default.
• serde: Derivation of [serde::Serialize] and [serde::Deserialize] on various objects, and JSON support. Default.
• tls: TLS support via tokio-rustls.
• refinery: Migrations via refinery.
• geo-types: Conversion of geo types to/from the geo-types crate.
• bb8: Enables a ConnectionManager managed by bb8

Credit

klickhouse_derive was made by copy/paste/simplify of serde_derive to get maximal functionality and performance at lowest time-cost. In a prototype, serde was directly used, but this was abandoned due to lock-in of serde's data model.