clickhouse-sys 0.0.1

Static clickhouse-cpp bridge for the clickhouse-cxx workspace
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
#include "shim.h"
#include "rustls_socket.h"

#include "clickhouse-sys/src/lib.rs.h"

#include "clickhouse/block.h"
#include "clickhouse/client.h"
#include "clickhouse/columns/numeric.h"
#include "clickhouse/columns/string.h"
#include "clickhouse/query.h"

#include <chrono>
#include <stdexcept>
#include <string>
#include <vector>

namespace chcxx {
namespace {

constexpr uint32_t KIND_U8 = 1;
constexpr uint32_t KIND_U16 = 2;
constexpr uint32_t KIND_U32 = 3;
constexpr uint32_t KIND_U64 = 4;
constexpr uint32_t KIND_I8 = 5;
constexpr uint32_t KIND_I16 = 6;
constexpr uint32_t KIND_I32 = 7;
constexpr uint32_t KIND_I64 = 8;
constexpr uint32_t KIND_F32 = 9;
constexpr uint32_t KIND_F64 = 10;
constexpr uint32_t KIND_STRING = 11;
constexpr uint32_t KIND_FIXED_STRING = 12;

std::string to_std(rust::Str text) {
    return std::string(text.data(), text.size());
}

template <typename T>
std::shared_ptr<clickhouse::ColumnVector<T>> numeric(
    const clickhouse::ColumnRef& column) {
    return std::dynamic_pointer_cast<clickhouse::ColumnVector<T>>(column);
}

clickhouse::ColumnRef find_column(clickhouse::Block& block,
                                  const std::string& name) {
    for (size_t index = 0; index < block.GetColumnCount(); ++index) {
        if (block.GetColumnName(index) == name) {
            return block.At(index);
        }
    }
    return nullptr;
}


template <typename T>
void append_numeric(clickhouse::Block& block, rust::Str name,
                    rust::Slice<const T> values) {
    const std::string key = to_std(name);
    if (auto existing = find_column(block, key)) {
        auto typed = std::dynamic_pointer_cast<clickhouse::ColumnVector<T>>(existing);
        if (!typed) {
            throw std::runtime_error("column kind mismatch for " + key);
        }
        for (const auto& value : values) {
            typed->Append(value);
        }
        return;
    }
    auto column = std::make_shared<clickhouse::ColumnVector<T>>();
    for (const auto& value : values) {
        column->Append(value);
    }
    block.AppendColumn(key, column);
}

template <typename T>
const std::vector<T>& numeric_data(const clickhouse::ColumnRef& column) {
    auto typed = numeric<T>(column);
    if (!typed) {
        throw std::runtime_error("clickhouse-cpp column kind mismatch");
    }
    return typed->GetWritableData();
}

uint32_t kind_of(const clickhouse::ColumnRef& column) {
    if (numeric<uint8_t>(column)) return KIND_U8;
    if (numeric<uint16_t>(column)) return KIND_U16;
    if (numeric<uint32_t>(column)) return KIND_U32;
    if (numeric<uint64_t>(column)) return KIND_U64;
    if (numeric<int8_t>(column)) return KIND_I8;
    if (numeric<int16_t>(column)) return KIND_I16;
    if (numeric<int32_t>(column)) return KIND_I32;
    if (numeric<int64_t>(column)) return KIND_I64;
    if (numeric<float>(column)) return KIND_F32;
    if (numeric<double>(column)) return KIND_F64;
    if (std::dynamic_pointer_cast<clickhouse::ColumnString>(column)) {
        return KIND_STRING;
    }
    if (std::dynamic_pointer_cast<clickhouse::ColumnFixedString>(column)) {
        return KIND_FIXED_STRING;
    }
    return 0;
}

rust::Slice<const uint8_t> bytes_of(const clickhouse::ColumnRef& column,
                                    uint32_t kind) {
    const uint8_t* data = nullptr;
    size_t size = 0;
    switch (kind) {
        case KIND_U8: {
            const auto& values = numeric_data<uint8_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(uint8_t);
            break;
        }
        case KIND_U16: {
            const auto& values = numeric_data<uint16_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(uint16_t);
            break;
        }
        case KIND_U32: {
            const auto& values = numeric_data<uint32_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(uint32_t);
            break;
        }
        case KIND_U64: {
            const auto& values = numeric_data<uint64_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(uint64_t);
            break;
        }
        case KIND_I8: {
            const auto& values = numeric_data<int8_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(int8_t);
            break;
        }
        case KIND_I16: {
            const auto& values = numeric_data<int16_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(int16_t);
            break;
        }
        case KIND_I32: {
            const auto& values = numeric_data<int32_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(int32_t);
            break;
        }
        case KIND_I64: {
            const auto& values = numeric_data<int64_t>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(int64_t);
            break;
        }
        case KIND_F32: {
            const auto& values = numeric_data<float>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(float);
            break;
        }
        case KIND_F64: {
            const auto& values = numeric_data<double>(column);
            data = reinterpret_cast<const uint8_t*>(values.data());
            size = values.size() * sizeof(double);
            break;
        }
        default:
            throw std::runtime_error("column is not a fixed-width column");
    }
    return rust::Slice<const uint8_t>(data, size);
}

}  // namespace

clickhouse::ClientOptions base_client_options(const std::string& host, uint16_t port,
                                              const std::string& user,
                                              const std::string& password,
                                              const std::string& database) {
    clickhouse::ClientOptions options;
    options.SetHost(host);
    options.SetPort(port);
    options.SetUser(user);
    options.SetPassword(password);
    options.SetDefaultDatabase(database);
    return options;
}

void apply_compression(clickhouse::ClientOptions& options, std::uint8_t method) {
    switch (method) {
        case 0: options.SetCompressionMethod(clickhouse::CompressionMethod::None); break;
        case 1: options.SetCompressionMethod(clickhouse::CompressionMethod::LZ4); break;
        case 2: options.SetCompressionMethod(clickhouse::CompressionMethod::ZSTD); break;
        default: throw std::invalid_argument("unknown block compression method");
    }
}

Client::Client(rust::Str host, uint16_t port, rust::Str user, rust::Str password,
               rust::Str database) {
    clickhouse::ClientOptions options = base_client_options(
        to_std(host), port, to_std(user), to_std(password), to_std(database));
    options.SetRethrowException(true);
    inner_ = std::make_unique<clickhouse::Client>(options,
        std::make_unique<RustlsSocketFactory>(RustlsSocketFactory::Settings{}));
}

Client::Client(rust::Str host, uint16_t port, rust::Str user, rust::Str password,
               rust::Str database, std::uint8_t compression, std::uint64_t timeout_ms) {
    clickhouse::ClientOptions options = base_client_options(
        std::string(host), port, std::string(user), std::string(password),
        std::string(database));
    options.SetRethrowException(true)
        .SetConnectionConnectTimeout(std::chrono::milliseconds(timeout_ms))
        .SetConnectionRecvTimeout(std::chrono::milliseconds(timeout_ms))
        .SetConnectionSendTimeout(std::chrono::milliseconds(timeout_ms));
    apply_compression(options, compression);
    inner_ = std::make_unique<clickhouse::Client>(options,
        std::make_unique<RustlsSocketFactory>(RustlsSocketFactory::Settings{}));
}

clickhouse::Client& Client::inner() { return *inner_; }
const clickhouse::Client& Client::inner() const { return *inner_; }

std::unique_ptr<Client> new_client(rust::Str host, uint16_t port, rust::Str user,
                                   rust::Str password, rust::Str database) {
    return std::make_unique<Client>(host, port, user, password, database);
}

std::unique_ptr<Client> new_client_options(rust::Str host, uint16_t port, rust::Str user,
                                           rust::Str password, rust::Str database,
                                           std::uint8_t compression, std::uint64_t timeout_ms) {
    return std::make_unique<Client>(host, port, user, password, database, compression,
                                    timeout_ms);
}

void ping(Client& client) { client.inner().Ping(); }

void reset(Client& client) { client.inner().ResetConnection(); }

ServerInfo get_server_info(const Client& client) {
    const auto& info = client.inner().GetServerInfo();
    return {rust::String(info.name), rust::String(info.timezone),
        rust::String(info.display_name), info.version_major, info.version_minor,
        info.version_patch, info.revision};
}

Version get_version() {
    const auto version = clickhouse::Client::GetVersion();
    return {version.major, version.minor, version.patch, version.build,
        rust::String(version.extra)};
}

void execute(Client& client, rust::Str sql) {
    clickhouse::Query query(to_std(sql));
    client.inner().Execute(query);
}

void insert_block(Client& client, rust::Str table, const Block& block) {
    client.inner().Insert(to_std(table), block.inner());
}

std::unique_ptr<BlockList> query_blocks(Client& client, rust::Str sql) {
    auto list = std::make_unique<BlockList>();
    client.inner().Select(to_std(sql), [&list](const clickhouse::Block& block) {
        list->blocks.push_back(std::make_unique<Block>(block));
    });
    return list;
}

Block::Block() = default;
Block::Block(const clickhouse::Block& block) : inner_(block) {}

clickhouse::Block& Block::inner() { detach_block_storage(inner_); return inner_; }
const clickhouse::Block& Block::inner() const { return inner_; }

size_t block_list_len(const BlockList& list) { return list.blocks.size(); }

std::unique_ptr<Block> block_list_get(const BlockList& list, size_t index) {
    return std::make_unique<Block>(*list.blocks.at(index));
}

std::unique_ptr<Block> block_new() { return std::make_unique<Block>(); }

void block_append_column_handle(Block& block, rust::Str name,
                                const ColumnHandle& column) {
    block.inner().AppendColumn(std::string(name.data(), name.size()), column.ref());
}

std::shared_ptr<ColumnHandle> block_column_handle(const Block& block, size_t index) {
    return std::make_shared<ColumnHandle>(block.inner().At(index));
}

void block_append_u8(Block& block, rust::Str name,
                     rust::Slice<const uint8_t> values) {
    append_numeric<uint8_t>(block.inner(), name, values);
}

void block_append_u16(Block& block, rust::Str name,
                      rust::Slice<const uint16_t> values) {
    append_numeric<uint16_t>(block.inner(), name, values);
}

void block_append_u32(Block& block, rust::Str name,
                      rust::Slice<const uint32_t> values) {
    append_numeric<uint32_t>(block.inner(), name, values);
}

void block_append_u64(Block& block, rust::Str name,
                      rust::Slice<const uint64_t> values) {
    append_numeric<uint64_t>(block.inner(), name, values);
}

void block_append_i8(Block& block, rust::Str name,
                     rust::Slice<const int8_t> values) {
    append_numeric<int8_t>(block.inner(), name, values);
}

void block_append_i16(Block& block, rust::Str name,
                      rust::Slice<const int16_t> values) {
    append_numeric<int16_t>(block.inner(), name, values);
}

void block_append_i32(Block& block, rust::Str name,
                      rust::Slice<const int32_t> values) {
    append_numeric<int32_t>(block.inner(), name, values);
}

void block_append_i64(Block& block, rust::Str name,
                      rust::Slice<const int64_t> values) {
    append_numeric<int64_t>(block.inner(), name, values);
}

void block_append_f32(Block& block, rust::Str name,
                      rust::Slice<const float> values) {
    append_numeric<float>(block.inner(), name, values);
}

void block_append_f64(Block& block, rust::Str name,
                      rust::Slice<const double> values) {
    append_numeric<double>(block.inner(), name, values);
}

void block_append_string(Block& block, rust::Str name,
                         rust::Slice<const rust::String> values) {
    const std::string key = to_std(name);
    if (auto existing = find_column(block.inner(), key)) {
        auto typed = std::dynamic_pointer_cast<clickhouse::ColumnString>(existing);
        if (!typed) {
            throw std::runtime_error("column kind mismatch for " + key);
        }
        for (const auto& value : values) {
            typed->Append(std::string_view(value.data(), value.size()));
        }
        return;
    }
    auto column = std::make_shared<clickhouse::ColumnString>();
    for (const auto& value : values) {
        column->Append(std::string_view(value.data(), value.size()));
    }
    block.inner().AppendColumn(key, column);
}

void block_append_string_flat(Block& block, rust::Str name,
                              rust::Slice<const uint64_t> offsets,
                              rust::Slice<const uint8_t> bytes) {
    const std::string key = to_std(name);
    if (offsets.empty()) {
        if (!bytes.empty()) {
            throw std::runtime_error("string offsets are empty but bytes are not");
        }
    }
    uint64_t previous = 0;
    for (const auto& offset : offsets) {
        if (offset < previous || offset > bytes.size()) {
            throw std::runtime_error("invalid string offsets");
        }
        previous = offset;
    }
    if (previous != bytes.size()) {
        throw std::runtime_error("string offsets do not cover every byte");
    }
    std::shared_ptr<clickhouse::ColumnString> column;
    bool created = false;
    if (auto existing = find_column(block.inner(), key)) {
        column = std::dynamic_pointer_cast<clickhouse::ColumnString>(existing);
        if (!column) {
            throw std::runtime_error("column kind mismatch for " + key);
        }
    } else {
        column = std::make_shared<clickhouse::ColumnString>();
        created = true;
    }
    previous = 0;
    for (const auto& offset : offsets) {
        const auto* start = reinterpret_cast<const char*>(bytes.data() + previous);
        column->Append(std::string_view(start, offset - previous));
        previous = offset;
    }
    if (created) {
        block.inner().AppendColumn(key, column);
    }
}

rust::Vec<uint64_t> block_column_string_offsets(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return rust::Vec<uint64_t>();
    }
    auto column = std::dynamic_pointer_cast<clickhouse::ColumnString>(block.inner().At(index));
    if (!column) {
        return rust::Vec<uint64_t>();
    }
    rust::Vec<uint64_t> offsets;
    uint64_t total = 0;
    for (size_t row = 0; row < column->Size(); ++row) {
        total += column->At(row).size();
        offsets.push_back(total);
    }
    return offsets;
}

rust::Vec<uint8_t> block_column_string_flat(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return rust::Vec<uint8_t>();
    }
    auto column = std::dynamic_pointer_cast<clickhouse::ColumnString>(block.inner().At(index));
    if (!column) {
        return rust::Vec<uint8_t>();
    }
    rust::Vec<uint8_t> bytes;
    for (size_t row = 0; row < column->Size(); ++row) {
        const auto value = column->At(row);
        for (char byte : value) {
            bytes.push_back(static_cast<uint8_t>(byte));
        }
    }
    return bytes;
}

void block_clear(Block& block) { block.inner().Clear(); }

void block_refresh(Block& block) { block.inner().RefreshRowCount(); }

size_t block_rows(const Block& block) { return block.inner().GetRowCount(); }

size_t block_columns(const Block& block) {
    return block.inner().GetColumnCount();
}

rust::String block_column_type(const Block& block, size_t index) {
    return rust::String(block.inner().At(index)->Type()->GetName());
}

// These accessors return non-Result cxx types, so a thrown exception would
// cross the FFI boundary instead of becoming a Rust error. Out-of-range
// indices therefore answer empty/zero rather than throwing.
rust::String block_column_name(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return rust::String();
    }
    return rust::String(block.inner().GetColumnName(index));
}

uint32_t block_column_kind(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return 0;
    }
    auto column = block.inner().At(index);
    if (!column) {
        return 0;
    }
    return kind_of(column);
}

rust::Slice<const uint8_t> block_column_bytes(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return rust::Slice<const uint8_t>(nullptr, 0);
    }
    auto column = block.inner().At(index);
    if (!column) {
        return rust::Slice<const uint8_t>(nullptr, 0);
    }
    const uint32_t kind = kind_of(column);
    if (kind == 0 || kind == KIND_STRING || kind == KIND_FIXED_STRING) {
        return rust::Slice<const uint8_t>(nullptr, 0);
    }
    return bytes_of(column, kind);
}

rust::Vec<rust::String> block_column_strings(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return rust::Vec<rust::String>();
    }
    auto column =
        std::dynamic_pointer_cast<clickhouse::ColumnString>(block.inner().At(index));
    if (!column) {
        return rust::Vec<rust::String>();
    }
    rust::Vec<rust::String> values;
    for (size_t row = 0; row < column->Size(); ++row) {
        values.push_back(rust::String(std::string(column->At(row))));
    }
    return values;
}

size_t block_column_capacity(const Block& block, size_t index) {
    if (index >= block.inner().GetColumnCount()) {
        return 0;
    }
    auto column = block.inner().At(index);
    switch (kind_of(column)) {
        case KIND_U8:
            return numeric<uint8_t>(column)->Capacity();
        case KIND_U16:
            return numeric<uint16_t>(column)->Capacity();
        case KIND_U32:
            return numeric<uint32_t>(column)->Capacity();
        case KIND_U64:
            return numeric<uint64_t>(column)->Capacity();
        case KIND_I8:
            return numeric<int8_t>(column)->Capacity();
        case KIND_I16:
            return numeric<int16_t>(column)->Capacity();
        case KIND_I32:
            return numeric<int32_t>(column)->Capacity();
        case KIND_I64:
            return numeric<int64_t>(column)->Capacity();
        case KIND_F32:
            return numeric<float>(column)->Capacity();
        case KIND_F64:
            return numeric<double>(column)->Capacity();
        default:
            return 0;
    }
}

}  // namespace chcxx