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
#include "shim_matrix.h"

#include <cstring>
#include <limits>
#include <optional>
#include <stdexcept>
#include <string>
#include <string_view>
#include <tuple>
#include <type_traits>
#include <vector>

#include "clickhouse/columns/array.h"
#include "clickhouse/columns/bool.h"
#include "clickhouse/columns/date.h"
#include "clickhouse/columns/decimal.h"
#include "clickhouse/columns/enum.h"
#include "clickhouse/columns/factory.h"
#include "clickhouse/columns/geo.h"
#include "clickhouse/columns/ip4.h"
#include "clickhouse/columns/ip6.h"
#include "clickhouse/columns/json.h"
#include "clickhouse/columns/lowcardinality.h"
#include "clickhouse/columns/map.h"
#include "clickhouse/columns/nothing.h"
#include "clickhouse/columns/nullable.h"
#include "clickhouse/columns/numeric.h"
#include "clickhouse/columns/string.h"
#include "clickhouse/columns/time.h"
#include "clickhouse/columns/tuple.h"
#include "clickhouse/columns/uuid.h"

namespace chcxx {
namespace {

using Code = clickhouse::Type::Code;

template <typename T>
T* cast(const clickhouse::ColumnRef& column) {
    auto* typed = dynamic_cast<T*>(column.get());
    if (!typed) {
        throw std::runtime_error("column type does not match requested C++ column class");
    }
    return typed;
}

std::shared_ptr<ColumnHandle> handle(const clickhouse::ColumnRef& column) {
    return std::make_shared<ColumnHandle>(column);
}

template <typename K, typename V>
bool append_map_typed(
    const clickhouse::ColumnRef& target,
    const clickhouse::ColumnRef& keys,
    const clickhouse::ColumnRef& values) {
    auto typed = target->As<clickhouse::ColumnMapT<K, V>>();
    if (!typed) {
        return false;
    }
    auto* key_column = dynamic_cast<K*>(keys.get());
    auto* value_column = dynamic_cast<V*>(values.get());
    if (!key_column || !value_column) {
        throw std::invalid_argument("map key/value column types do not match the map type");
    }
    if (key_column->Size() != value_column->Size()) {
        throw std::invalid_argument("map key and value columns have different row counts");
    }
    using Key = std::decay_t<decltype(std::declval<K>().At(0))>;
    using Value = std::decay_t<decltype(std::declval<V>().At(0))>;
    std::vector<std::tuple<Key, Value>> rows;
    rows.reserve(key_column->Size());
    for (std::size_t i = 0; i < key_column->Size(); ++i) {
        rows.emplace_back(key_column->At(i), value_column->At(i));
    }
    typed->Append(rows);
    return true;
}

template <typename T>
bool append_low_cardinality_string(const clickhouse::ColumnRef& target, std::string_view value) {
    auto typed = target->As<clickhouse::ColumnLowCardinalityT<T>>();
    if (!typed) {
        return false;
    }
    typed->Append(value);
    return true;
}

// The value type of the dictionary column decides the width; casting the wide
// input before that type is known would silently truncate, e.g. 1000 into an
// Int8 dictionary. Only the matching instantiation reaches the range check.
// ColumnLowCardinality exposes no public ItemView append; the typed wrapper's
// Append(std::nullopt) reaches the NULL dictionary item for a Nullable
// dictionary. Wrap() shares the underlying dictionary, so this mutates the
// original column.
template <typename Dictionary>
bool append_low_cardinality_null(const clickhouse::ColumnRef& target) {
    auto typed = target->As<clickhouse::ColumnLowCardinalityT<Dictionary>>();
    if (!typed) {
        return false;
    }
    typed->Append(std::nullopt);
    return true;
}

template <typename T, typename Wide>
bool append_low_cardinality_int(const clickhouse::ColumnRef& target, Wide value) {
    auto typed = target->As<clickhouse::ColumnLowCardinalityT<clickhouse::ColumnVector<T>>>();
    if (!typed) {
        return false;
    }
    if (value < static_cast<Wide>(std::numeric_limits<T>::min()) ||
        value > static_cast<Wide>(std::numeric_limits<T>::max())) {
        throw std::invalid_argument(
            "low cardinality integer value out of range for dictionary column");
    }
    typed->Append(static_cast<T>(value));
    return true;
}

}  // namespace

void ColumnHandle::nullable_append_fixed(rust::Slice<const uint8_t> bytes) {
    prepare_mutation();
    ColumnHandle child(cast<clickhouse::ColumnNullable>(column_)->Nested(), false);
    child.append_fixed(bytes);
}

void ColumnHandle::nullable_append_string(rust::Slice<const uint8_t> value) {
    prepare_mutation();
    ColumnHandle child(cast<clickhouse::ColumnNullable>(column_)->Nested(), false);
    child.append_string(value);
}

void ColumnHandle::nullable_append_column(const ColumnHandle& other) {
    prepare_mutation();
    cast<clickhouse::ColumnNullable>(column_)->Nested()->Append(other.ref());
}

void ColumnHandle::nullable_append_default() {
    prepare_mutation();
    ColumnHandle child(cast<clickhouse::ColumnNullable>(column_)->Nested(), false);
    child.append_default();
}

std::shared_ptr<ColumnHandle> ColumnHandle::nested() const {
    switch (column_->Type()->GetCode()) {
        case Code::Nullable:
            return handle(cast<clickhouse::ColumnNullable>(column_)->Nested());
        case Code::Array:
            return handle(cast<clickhouse::ColumnArray>(column_)->GetData());
        default:
            return std::shared_ptr<ColumnHandle>(nullptr);
    }
}

rust::Slice<const uint8_t> ColumnHandle::nulls() const {
    if (column_->Type()->GetCode() != Code::Nullable) {
        return rust::Slice<const uint8_t>(nullptr, 0);
    }
    auto nulls = cast<clickhouse::ColumnNullable>(column_)->Nulls();
    const auto& data = cast<clickhouse::ColumnUInt8>(nulls)->GetWritableData();
    return rust::Slice<const uint8_t>(
        reinterpret_cast<const uint8_t*>(data.data()), data.size());
}

void ColumnHandle::append_nullable_flag(bool is_null) {
    prepare_mutation();
    cast<clickhouse::ColumnNullable>(column_)->Append(is_null);
}

rust::Slice<const uint64_t> ColumnHandle::array_offsets() const {
    if (column_->Type()->GetCode() != Code::Array) {
        return rust::Slice<const uint64_t>(nullptr, 0);
    }
    const auto& data = cast<clickhouse::ColumnArray>(column_)->GetOffsets()->GetWritableData();
    return rust::Slice<const uint64_t>(
        reinterpret_cast<const uint64_t*>(data.data()), data.size());
}

void ColumnHandle::array_append_row(const ColumnHandle& values) {
    prepare_mutation();
    cast<clickhouse::ColumnArray>(column_)->AppendAsColumn(values.ref());
}

std::size_t ColumnHandle::tuple_len() const {
    if (column_->Type()->GetCode() != Code::Tuple) {
        return 0;
    }
    return cast<clickhouse::ColumnTuple>(column_)->TupleSize();
}

std::shared_ptr<ColumnHandle> ColumnHandle::tuple_at(std::size_t index) const {
    auto* tuple = dynamic_cast<clickhouse::ColumnTuple*>(column_.get());
    if (!tuple || index >= tuple->TupleSize()) return nullptr;
    return handle(tuple->At(index));
}

void ColumnHandle::tuple_append_fixed(
    std::size_t index, rust::Slice<const uint8_t> bytes) {
    prepare_mutation();
    auto* tuple = cast<clickhouse::ColumnTuple>(column_);
    if (index >= tuple->TupleSize()) throw std::out_of_range("tuple element index out of bounds");
    ColumnHandle child(tuple->At(index), false);
    child.append_fixed(bytes);
}

void ColumnHandle::tuple_append_string(
    std::size_t index, rust::Slice<const uint8_t> value) {
    prepare_mutation();
    auto* tuple = cast<clickhouse::ColumnTuple>(column_);
    if (index >= tuple->TupleSize()) throw std::out_of_range("tuple element index out of bounds");
    ColumnHandle child(tuple->At(index), false);
    child.append_string(value);
}

void ColumnHandle::map_append_row(
    const ColumnHandle& keys, const ColumnHandle& values) {
    prepare_mutation();
    if (column_->Type()->GetCode() != Code::Map) {
        throw std::invalid_argument("column is not a Map");
    }
    if (append_map_typed<clickhouse::ColumnString, clickhouse::ColumnUInt64>(
            column_, keys.ref(), values.ref()) ||
        append_map_typed<clickhouse::ColumnString, clickhouse::ColumnString>(
            column_, keys.ref(), values.ref()) ||
        append_map_typed<clickhouse::ColumnUInt64, clickhouse::ColumnUInt64>(
            column_, keys.ref(), values.ref()) ||
        append_map_typed<clickhouse::ColumnInt64, clickhouse::ColumnFloat64>(
            column_, keys.ref(), values.ref())) {
        return;
    }
    throw std::invalid_argument("unsupported Map key/value column combination");
}

std::shared_ptr<ColumnHandle> ColumnHandle::map_row(std::size_t index) const {
    return std::make_shared<ColumnHandle>(
        cast<clickhouse::ColumnMap>(column_)->GetAsColumn(index));
}

void ColumnHandle::low_cardinality_append_string(rust::Slice<const uint8_t> value) {
    prepare_mutation();
    const std::string_view view(reinterpret_cast<const char*>(value.data()), value.size());
    if (append_low_cardinality_string<clickhouse::ColumnString>(column_, view) ||
        append_low_cardinality_string<clickhouse::ColumnFixedString>(column_, view)) {
        return;
    }
    throw std::invalid_argument("LowCardinality dictionary does not accept strings");
}

void ColumnHandle::low_cardinality_append_i64(std::int64_t value) {
    prepare_mutation();
    if (append_low_cardinality_int<std::int8_t>(column_, value) ||
        append_low_cardinality_int<std::int16_t>(column_, value) ||
        append_low_cardinality_int<std::int32_t>(column_, value) ||
        append_low_cardinality_int<std::int64_t>(column_, value)) {
        return;
    }
    throw std::invalid_argument("LowCardinality dictionary does not accept signed integers");
}

void ColumnHandle::low_cardinality_append_u64(std::uint64_t value) {
    prepare_mutation();
    if (append_low_cardinality_int<std::uint8_t>(column_, value) ||
        append_low_cardinality_int<std::uint16_t>(column_, value) ||
        append_low_cardinality_int<std::uint32_t>(column_, value) ||
        append_low_cardinality_int<std::uint64_t>(column_, value)) {
        return;
    }
    throw std::invalid_argument("LowCardinality dictionary does not accept unsigned integers");
}

void ColumnHandle::geo_append_point(double x, double y) {
    prepare_mutation();
    auto typed = column_->As<clickhouse::ColumnPoint>();
    if (!typed) {
        throw std::invalid_argument("column is not a Point");
    }
    typed->Append(std::make_tuple(x, y));
}

void ColumnHandle::append_default() {
    prepare_mutation();
    const auto code = column_->Type()->GetCode();
    if (code == Code::Nullable) {
        auto nested_column = cast<clickhouse::ColumnNullable>(column_)->Nested();
        ColumnHandle nested(nested_column, false);
        nested.append_default();
        cast<clickhouse::ColumnNullable>(column_)->Append(true);
        return;
    }
    if (code == Code::Array) {
        auto* array = cast<clickhouse::ColumnArray>(column_);
        const auto item_name = array->Type()->As<clickhouse::ArrayType>()->GetItemType()->GetName();
        auto empty = clickhouse::CreateColumnByType(item_name);
        if (!empty) {
            throw std::invalid_argument("cannot create an empty Array item column");
        }
        array->AppendAsColumn(empty);
        return;
    }
    if (code == Code::Tuple) {
        auto* tuple = cast<clickhouse::ColumnTuple>(column_);
        for (std::size_t i = 0; i < tuple->TupleSize(); ++i) {
            ColumnHandle child(tuple->At(i), false);
            child.append_default();
        }
        return;
    }
    if (code == Code::Map) {
        auto* map_type = column_->Type()->As<clickhouse::MapType>();
        auto keys = clickhouse::CreateColumnByType(map_type->GetKeyType()->GetName());
        auto values = clickhouse::CreateColumnByType(map_type->GetValueType()->GetName());
        if (!keys || !values) {
            throw std::invalid_argument("cannot create empty Map key/value columns");
        }
        ColumnHandle key_handle(std::move(keys));
        ColumnHandle value_handle(std::move(values));
        map_append_row(key_handle, value_handle);
        return;
    }
    if (code == Code::LowCardinality) {
        auto* low_cardinality = cast<clickhouse::ColumnLowCardinality>(column_);
        switch (low_cardinality->GetNestedType()->GetCode()) {
            case Code::String:
            case Code::FixedString: {
                const std::string_view empty;
                low_cardinality_append_string(rust::Slice<const uint8_t>(
                    reinterpret_cast<const uint8_t*>(empty.data()), empty.size()));
                return;
            }
            case Code::Nullable:
                if (append_low_cardinality_null<
                        clickhouse::ColumnNullableT<clickhouse::ColumnString>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnFixedString>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::int8_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::int16_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::int32_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::int64_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::uint8_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::uint16_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::uint32_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<std::uint64_t>>>(column_) ||
                    append_low_cardinality_null<clickhouse::ColumnNullableT<
                        clickhouse::ColumnVector<float>>>(column_) ||
                    append_low_cardinality_null<
                        clickhouse::ColumnNullableT<clickhouse::ColumnVector<double>>>(
                        column_)) {
                    return;
                }
                throw std::invalid_argument(
                    "unsupported LowCardinality nullable dictionary type");
            default:
                low_cardinality_append_i64(0);
                return;
        }
    }
    if (code == Code::Point) {
        geo_append_point(0.0, 0.0);
        return;
    }
    if (code == Code::Void) {
        cast<clickhouse::ColumnNothing>(column_)->Append(std::unique_ptr<void*>(nullptr));
        return;
    }
    if (code == Code::String) {
        append_string(rust::Slice<const uint8_t>(nullptr, 0));
        return;
    }
    if (code == Code::JSON) {
        const std::string_view empty_object("{}");
        append_string(rust::Slice<const uint8_t>(
            reinterpret_cast<const uint8_t*>(empty_object.data()), empty_object.size()));
        return;
    }
    if (code == Code::Ring || code == Code::Polygon || code == Code::MultiPolygon) {
        throw std::invalid_argument("default append for nested Geo arrays is not supported");
    }
    std::size_t width = 0;
    switch (code) {
        case Code::UInt8:
        case Code::Int8:
        case Code::Bool:
        case Code::Enum8:
            width = 1;
            break;
        case Code::UInt16:
        case Code::Int16:
        case Code::Date:
        case Code::Enum16:
            width = 2;
            break;
        case Code::UInt32:
        case Code::Int32:
        case Code::Float32:
        case Code::Date32:
        case Code::DateTime:
        case Code::IPv4:
        case Code::Time:
            width = 4;
            break;
        case Code::UInt64:
        case Code::Int64:
        case Code::Float64:
        case Code::DateTime64:
        case Code::Time64:
            width = 8;
            break;
        case Code::UInt128:
        case Code::Int128:
        case Code::UUID:
        case Code::IPv6:
            width = 16;
            break;
        case Code::Decimal:
        case Code::Decimal32:
        case Code::Decimal64:
        case Code::Decimal128: {
            const auto precision = cast<clickhouse::ColumnDecimal>(column_)->GetPrecision();
            width = precision <= 9 ? 4 : (precision <= 18 ? 8 : 16);
            break;
        }
        case Code::FixedString:
            width = cast<clickhouse::ColumnFixedString>(column_)->FixedSize();
            break;
        default:
            throw std::invalid_argument("default append is not supported for this column type");
    }
    std::vector<uint8_t> zeros(width, 0);
    append_fixed(rust::Slice<const uint8_t>(zeros.data(), zeros.size()));
}

}  // namespace chcxx