clickhouse 0.15.2

Official Rust client for ClickHouse DB
Documentation 
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234

use std::net::{Ipv4Addr, Ipv6Addr};

macro_rules! test_type {
    (
        $(#[$attr:meta])*
        $fn_name:ident($ty:ty $(, $sqlty:literal)?) {
            $($sql:literal == $rust:expr),* $(,)?
        }
    ) => {
        $(#[$attr])*
        #[tokio::test]
        async fn $fn_name() {
            use clickhouse::native::builder::BlockBuilder;

            let db_name = test_database_name!();

            let client = $crate::_priv::prepare_database(&db_name).await;

            client
                .query(&format!(
                    // Temporary tables apparently can't be the source of `CREATE TABLE .. AS ..`,
                    // you get a confusing "unknown table" error
                    "CREATE TABLE {db_name}.sql_values ENGINE = Memory AS {}",
                    // In case any values contain `{}`
                    concat!("SELECT * FROM Values(" $(, "'c1 ", $sqlty, "', ")? $(, $sql, )","* ")")
                ))
                .execute()
                .await
                .expect("error creating value source table");

            client
                .query(&format!(
                    "CREATE TABLE {db_name}.insert_values ENGINE = Memory AS \
                     {db_name}.sql_values",
                ))
                .execute()
                .await
                .expect("error creating insert table");

            let mut insert_block = BlockBuilder::new();

            let mut column = insert_block.upsert_column::<$ty>("c1").expect("error from upsert_column");

            $(
                column.add($rust).expect(concat!("error writing expression `", stringify!($rust), "`"));
            )*

            let insert_block = insert_block.build().expect("error from insert_block.build()");

            let mut insert = client.insert_native("insert_values");

            insert.write(&insert_block).await.expect("error from insert.write()");

            insert.end().await.expect("error from insert.end()");

            let mut cursor = client
                .query(
                    "SELECT \
                     sql_values.c1 AS sql_value, insert_values.c1 AS insert_value, \
                     toBool(sql_value == insert_value) AS values_equal \
                     FROM sql_values PASTE JOIN insert_values",
                )
                .fetch_native()
                .expect("error from fetch_native");

            let block = cursor
                .next()
                .await
                .expect("error from `cursor.next()`")
                .expect("expected block, got none");

            let mut sql_iter = block["sql_value"]
                .iter::<$ty>()
                .expect("error from `block[\"sql_value\"].iter()`");

            $(
                let expected: $ty = $rust;

                let val = sql_iter
                    .next()
                    .expect("expected another value from `sql_iter`")
                    .unwrap_or_else(|e| panic!("error decoding SQL `{}` as Rust value `{expected:?}`: {e:?}", $sql));

                assert_eq!(val, expected, "SQL value does not equal Rust value");
            )*

            if let Some(next) = sql_iter.next() {
                panic!("`unexpected value from `sql_iter.next(): {next:?}`");
            }

            let mut insert_iter = block["insert_value"]
                .iter::<$ty>()
                .expect("error from `block[\"insert_value\"].iter()`");

            $(
                let expected: $ty = $rust;

                let val = insert_iter
                    .next()
                    .expect("expected another value from `insert_iter`")
                    .unwrap_or_else(|e| panic!("error round-tripping Rust value `{expected:?}`: {e:?}"));

                assert_eq!(val, expected, "Rust value did not round-trip correctly");
            )*

            if let Some(next) = insert_iter.next() {
                panic!("unexpected value from `insert_iter.next()`: {next:?}");
            }

            let mut equals_iter = block["values_equal"]
                .iter::<bool>()
                .expect("error from `block[\"values_equal\"].iter()`");

            $(
                let equals = equals_iter
                    .next()
                    .expect("expected another value from `equals_iter`")
                    .expect("error decoding value from `equals_iter`");

                assert!(equals, "values not equal in SQL: {:?} vs `{}`", $sql, stringify!($rust));
            )*

            if let Some(next) = equals_iter.next() {
                panic!("`unexpected value from `equals_iter.next(): {next:?}`");
            }
        }
    };
}

test_type!(test_bool(bool) { "false" == false, "true" == true });

test_type!(test_uint8(u8) { "0" == 0, "1" == 1, "255" == 255 });
test_type!(test_uint16(u16) { "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535 });
test_type!(test_uint32(u32) {
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0xFFFF_FFFF" == 0xFFFF_FFFF,
});
test_type!(test_uint64(u64) {
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0xFFFF_FFFF" == 0xFFFF_FFFF, "0xFFFF_FFFF_FFFF_FFFF" == 0xFFFF_FFFF_FFFF_FFFF
});
test_type!(test_uint128(u128) {
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0xFFFF_FFFF" == 0xFFFF_FFFF, "0xFFFF_FFFF_FFFF_FFFF" == 0xFFFF_FFFF_FFFF_FFFF,
    // Explicit conversion required or else the literal is parsed as `Float64`
    "340282366920938463463374607431768211455::UInt128" == 0xFFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF
});

// Explicit typing is required, otherwise the unsigned values cause an implicit widening
// to the next larger signed type:
//
// `SELECT toTypeName([-1])` => `Array(Int8)`
// `SELECT toTypeName([-1, 1])` => `Array(Int16)`
test_type!(test_int8(i8, "Int8") { "-128" == -128, "-1" == -1, "0" == 0, "1" == 1, "127" == 127 });
test_type!(test_int16(i16, "Int16") {
    "-32768 AS Int16" == -32768, "-128" == -128, "-1" == -1,
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "32767" == 32767
});
test_type!(test_int32(i32, "Int32") {
    "-0x8000_0000" == -0x8000_0000, "-32768" == -32768, "-128" == -128, "-1" == -1,
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0x7FFF_FFFF" == 0x7FFF_FFFF,
});
test_type!(test_int64(i64, "Int64") {
    "-0x8000_0000_0000_0000" == -0x8000_0000_0000_0000, "-0x8000_0000" == -0x8000_0000,
    "-32768" == -32768, "-128" == -128, "-1" == -1,
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0xFFFF_FFFF" == 0xFFFF_FFFF, "0x7FFF_FFFF_FFFF_FFFF" == 0x7FFF_FFFF_FFFF_FFFF
});
test_type!(test_int128(i128, "Int128") {
    // Explicit cast required or else the literal is parsed as `Float64`
    "-170141183460469231731687303715884105728::Int128" == -0x8000_0000_0000_0000_0000_0000_0000_0000,
    "-0x8000_0000_0000_0000" == -0x8000_0000_0000_0000, "-0x8000_0000" == -0x8000_0000,
    "-32768" == -32768, "-128" == -128, "-1" == -1,
    "0" == 0, "1" == 1, "255" == 255, "16384" == 16384, "65535" == 65535,
    "0xFFFF_FFFF" == 0xFFFF_FFFF, "0x7FFF_FFFF_FFFF_FFFF" == 0x7FFF_FFFF_FFFF_FFFF,
    "170141183460469231731687303715884105727::Int128" == 0x7FFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF_FFFF
});

test_type!(
    #[allow(clippy::approx_constant)] // we can't be certain the constant for pi is the same
    test_float32(f32, "Float32") {
        // ClickHouse rejects the bare literal but allows the cast for some reason
        "-inf" == f32::NEG_INFINITY, "toFloat32(-3.40282347e+38)" == f32::MIN,
        "-1.0" == -1.0, "0.0" == 0.0, "toFloat32(1.17549435e-38)" == f32::MIN_POSITIVE,
        "1.0" == 1.0, "toFloat32(3.14)" == 3.14,
        "toFloat32(3.40282347e+38)" == f32::MAX, "inf" == f32::INFINITY,
        // "nan" == f32::NAN, (NaN is never equal to NaN)
    }
);

test_type!(
    #[allow(clippy::approx_constant)] // we can't be certain the constant for pi is the same
    test_float64(f64, "Float64") {
        "-inf" == f64::NEG_INFINITY, "-1.7976931348623157e+308" == f64::MIN,
        "-1.0" == -1.0, "0.0" == 0.0, "2.2250738585072014e-308" == f64::MIN_POSITIVE,
        "1.0" == 1.0, "3.14" == 3.14,
        "1.7976931348623157e+308" == f64::MAX, "inf" == f64::INFINITY,
        // "nan" == f32::NAN, (NaN is never equal to NaN)
    }
);

test_type!(
    test_ipv4(Ipv4Addr, "IPv4") {
        "'0.0.0.0'" == Ipv4Addr::UNSPECIFIED,
        "'1.1.1.1'" == Ipv4Addr::new(1, 1, 1, 1),
        "'127.0.0.1'" == Ipv4Addr::LOCALHOST,
        "'192.168.2.1'" == Ipv4Addr::new(192, 168, 2, 1),
        "'255.255.255.0'" == Ipv4Addr::new(255, 255, 255, 0),
        "'255.255.255.255'" == Ipv4Addr::BROADCAST,
    }
);

test_type!(
    test_ipv6(Ipv6Addr, "IPv6") {
        "'::1'" == Ipv6Addr::LOCALHOST,
        // IPv6 addresses for ClickHouse.com
        "'2606:4700:3108::ac42:2b07'" == "2606:4700:3108::ac42:2b07".parse::<Ipv6Addr>().unwrap(),
        "'2606:4700:3108::ac42:28f9'" == "2606:4700:3108::ac42:28f9".parse::<Ipv6Addr>().unwrap(),
    }
);

#[cfg(feature = "uuid")]
mod uuid {
    use uuid::Uuid;

    test_type!(
        test_uuid(Uuid, "UUID") {
            "'00000000-0000-0000-0000-000000000000'" == Uuid::from_bytes([0u8; 16]),
            "'61f0c404-5cb3-11e7-907b-a6006ad3dba0'" == "61f0c404-5cb3-11e7-907b-a6006ad3dba0".parse::<Uuid>().unwrap(),
            "'67e55044-10b1-426f-9247-bb680e5fe0c8'" == "67e55044-10b1-426f-9247-bb680e5fe0c8".parse::<Uuid>().unwrap(),
        }
    );
}