1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
//! Clickhouse Utils
//!
//! This crate provides a set of utilities for working with Clickhouse.
//!
//! # Features
//!
//! - fastnum: Enable support for Fastnum D256.
//!
//! # Usage
//!
//! ## Migration
//!
//! create a migrations folder in your project and add your migrations files.
//! Example:
//! ```text
//! migrations/
//! ├── 0001_create_users_table.sql
//! └── 0002_add_email_column.sql
//! ```
//!
//! Run the migrations:
//! ```rust,no_run
//! #[tokio::main]
//! async fn main() {
//! let client = clickhouse::Client::default()
//! .with_user("default")
//! .with_password("default")
//! .with_url("http://localhost:8123")
//! .with_database("default");
//!
//! clickhouse_utils::migrate(&client).await.expect("failed to run migrations");
//! }
//! ```
//!
//! ## Serde
//!
//! Serialize and Deserialize common types for Clickhouse.
//!
//! - Std Hashmap of <String, String>
//! - Fastnum : decimal D256
//!
//! ## Examples
//!
//! ```rust,no_run
//! use std::collections::HashMap;
//!
//! use serde::{Deserialize, Serialize};
//! use fastnum::decimal::D256;
//!
//! #[derive(Debug, Serialize, Deserialize, clickhouse::Row)]
//! pub struct SomeTable {
//! #[serde(with = "clickhouse_utils::serde::fastnum_d256")]
//! pub decimal: D256,
//! #[serde(with = "clickhouse_utils::serde::map")]
//! pub attributes: HashMap<String, String>,
//! }
//! ```
pub use ClickhouseUtilsError;
pub use migrate;