• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

plausible / ch / 41e53121e9e5928b6f04073c3567f213fdb0b3e4

23 Apr 2026 10:27PM UTC coverage: 92.213% (+0.9%) from 91.309%
41e53121e9e5928b6f04073c3567f213fdb0b3e4

push

github

web-flow
Revert "RowBinary: de- and encode dynamic JSON (#296)" (#328)

This reverts commit d624ecd72.

900 of 976 relevant lines covered (92.21%)

82496.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.88
/lib/ch/row_binary.ex
1
defmodule Ch.RowBinary do
2
  @moduledoc "Helpers for working with ClickHouse [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) format."
3

4
  # @compile {:bin_opt_info, true}
5
  @dialyzer :no_improper_lists
6

7
  import Bitwise
8

9
  @epoch_gregorian_seconds 62_167_219_200
10
  @epoch_gregorian_days 719_528
11

12
  @doc false
13
  def encode_names_and_types(names, types) do
6✔
14
    [encode(:varint, length(names)), encode_many(names, :string), encode_types(types)]
15
  end
16

17
  defp encode_types([type | types]) do
18
    encoded =
18✔
19
      case type do
20
        _ when is_binary(type) -> type
×
21
        _ -> Ch.Types.encode(type)
18✔
22
      end
23

24
    [encode(:string, encoded) | encode_types(types)]
25
  end
26

27
  defp encode_types([] = done), do: done
6✔
28

29
  @doc """
30
  Encodes a single row to [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) as iodata.
31

32
  Examples:
33

34
      iex> encode_row([], [])
35
      []
36

37
      iex> encode_row([1], ["UInt8"])
38
      [1]
39

40
      iex> encode_row([3, "hello"], ["UInt8", "String"])
41
      [3, [5 | "hello"]]
42

43
  """
44
  def encode_row(row, types) do
45
    _encode_row(row, encoding_types(types))
26✔
46
  end
47

48
  defp _encode_row([el | els], [type | types]), do: [encode(type, el) | _encode_row(els, types)]
114✔
49
  defp _encode_row([] = done, []), do: done
26✔
50

51
  @doc """
52
  Encodes multiple rows to [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) as iodata.
53

54
  Examples:
55

56
      iex> encode_rows([], [])
57
      []
58

59
      iex> encode_rows([[1]], ["UInt8"])
60
      [1]
61

62
      iex> encode_rows([[3, "hello"], [4, "hi"]], ["UInt8", "String"])
63
      [3, [5 | "hello"], 4, [2 | "hi"]]
64

65
  """
66
  def encode_rows(rows, types) do
67
    _encode_rows(rows, encoding_types(types))
123✔
68
  end
69

70
  @doc false
71
  def _encode_rows([row | rows], types), do: _encode_rows(row, types, rows, types)
2,000,212✔
72
  def _encode_rows([] = done, _types), do: done
123✔
73

74
  defp _encode_rows([el | els], [t | ts], rows, types) do
2,000,419✔
75
    [encode(t, el) | _encode_rows(els, ts, rows, types)]
76
  end
77

78
  defp _encode_rows([], [], rows, types), do: _encode_rows(rows, types)
2,000,212✔
79

80
  @doc false
81
  def encoding_types([type | types]) do
344✔
82
    [encoding_type(type) | encoding_types(types)]
83
  end
84

85
  def encoding_types([] = done), do: done
149✔
86

87
  defp encoding_type(type) when is_binary(type) do
88
    encoding_type(Ch.Types.decode(type))
213✔
89
  end
90

91
  defp encoding_type(t)
92
       when t in [
93
              :string,
94
              :binary,
95
              :json,
96
              :dynamic,
97
              :boolean,
98
              :uuid,
99
              :date,
100
              :datetime,
101
              :date32,
102
              :time,
103
              :ipv4,
104
              :ipv6,
105
              :point,
106
              :nothing
107
            ],
108
       do: t
149✔
109

110
  defp encoding_type({:datetime = d, "UTC"}), do: d
×
111

112
  defp encoding_type({:datetime, tz}) do
113
    raise ArgumentError, "can't encode DateTime with non-UTC timezone: #{inspect(tz)}"
×
114
  end
115

116
  defp encoding_type({:fixed_string, _len} = t), do: t
13✔
117

118
  for size <- [8, 16, 32, 64, 128, 256] do
119
    defp encoding_type(unquote(:"u#{size}") = u), do: u
127✔
120
    defp encoding_type(unquote(:"i#{size}") = i), do: i
42✔
121
  end
122

123
  for size <- [32, 64] do
124
    defp encoding_type(unquote(:"f#{size}") = f), do: f
6✔
125
  end
126

127
  defp encoding_type({:array = a, t}), do: {a, encoding_type(t)}
25✔
128

129
  defp encoding_type({:tuple = t, ts}) do
4✔
130
    {t, Enum.map(ts, &encoding_type/1)}
131
  end
132

133
  defp encoding_type({:variant = v, ts}) do
4✔
134
    {v, Enum.map(ts, &encoding_type/1)}
135
  end
136

137
  defp encoding_type({:map = m, kt, vt}) do
138
    {m, encoding_type(kt), encoding_type(vt)}
9✔
139
  end
140

141
  defp encoding_type({:nullable = n, t}), do: {n, encoding_type(t)}
16✔
142
  defp encoding_type({:low_cardinality, t}), do: encoding_type(t)
4✔
143

144
  defp encoding_type({:decimal, p, s}) do
145
    case decimal_size(p) do
×
146
      32 -> {:decimal32, s}
×
147
      64 -> {:decimal64, s}
×
148
      128 -> {:decimal128, s}
×
149
      256 -> {:decimal256, s}
×
150
    end
151
  end
152

153
  defp encoding_type({d, _scale} = t)
154
       when d in [:decimal32, :decimal64, :decimal128, :decimal256],
155
       do: t
6✔
156

157
  defp encoding_type({:datetime64 = t, p}), do: {t, time_unit(p)}
2✔
158

159
  defp encoding_type({:datetime64 = t, p, "UTC"}), do: {t, time_unit(p)}
×
160

161
  defp encoding_type({:datetime64, _, tz}) do
162
    raise ArgumentError, "can't encode DateTime64 with non-UTC timezone: #{inspect(tz)}"
×
163
  end
164

165
  defp encoding_type({:time64 = t, p}), do: {t, time_unit(p)}
8✔
166

167
  defp encoding_type({e, mappings}) when e in [:enum8, :enum16] do
4✔
168
    {e, Map.new(mappings)}
169
  end
170

171
  defp encoding_type({:simple_aggregate_function, _f, t}), do: encoding_type(t)
×
172

173
  defp encoding_type(:ring), do: {:array, :point}
2✔
174
  defp encoding_type(:polygon), do: {:array, {:array, :point}}
2✔
175
  defp encoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
2✔
176

177
  defp encoding_type(type) do
178
    raise ArgumentError, "unsupported type for encoding: #{inspect(type)}"
×
179
  end
180

181
  @doc false
182
  def encode(type, value)
183

184
  def encode(:varint, i) when is_integer(i) and i < 128, do: i
383✔
185
  def encode(:varint, i) when is_integer(i), do: encode_varint_cont(i)
8✔
186

187
  def encode(type, str) when type in [:string, :binary] do
188
    case str do
325✔
189
      _ when is_binary(str) -> [encode(:varint, byte_size(str)) | str]
275✔
190
      _ when is_list(str) -> [encode(:varint, IO.iodata_length(str)) | str]
46✔
191
      nil -> 0
1✔
192
    end
193
  end
194

195
  def encode(:json, json) do
196
    # assuming it can be sent as text and not "native" binary JSON
197
    # i.e. assumes `settings: [input_format_binary_read_json_as_string: 1]`
198
    # TODO
199
    encode(:string, Jason.encode_to_iodata!(json))
6✔
200
  end
201

202
  def encode({:fixed_string, size}, str) when byte_size(str) == size do
203
    str
15✔
204
  end
205

206
  def encode({:fixed_string, size}, str) when byte_size(str) < size do
207
    to_pad = size - byte_size(str)
6✔
208
    [str | <<0::size(to_pad * 8)>>]
209
  end
210

211
  def encode({:fixed_string, size}, nil), do: <<0::size(size * 8)>>
1✔
212

213
  # UInt8 — [0 : 255]
214
  def encode(:u8, u) when is_integer(u) and u >= 0 and u <= 255, do: u
111✔
215
  def encode(:u8, nil), do: 0
5✔
216

217
  def encode(:u8, term) do
218
    raise ArgumentError, "invalid UInt8: #{inspect(term)}"
3✔
219
  end
220

221
  # Int8 — [-128 : 127]
222
  def encode(:i8, i) when is_integer(i) and i >= 0 and i <= 127, do: i
15✔
223
  def encode(:i8, i) when is_integer(i) and i < 0 and i >= -128, do: <<i::signed>>
3✔
224
  def encode(:i8, nil), do: 0
1✔
225

226
  def encode(:i8, term) do
227
    raise ArgumentError, "invalid Int8: #{inspect(term)}"
3✔
228
  end
229

230
  for size <- [16, 32, 64, 128, 256] do
231
    def encode(unquote(:"u#{size}"), u) when is_integer(u) do
232
      <<u::unquote(size)-little>>
2,000,066✔
233
    end
234

235
    def encode(unquote(:"i#{size}"), i) when is_integer(i) do
236
      <<i::unquote(size)-little-signed>>
56✔
237
    end
238

239
    def encode(unquote(:"u#{size}"), nil), do: <<0::unquote(size)>>
3✔
240
    def encode(unquote(:"i#{size}"), nil), do: <<0::unquote(size)>>
3✔
241
  end
242

243
  for size <- [32, 64] do
244
    type = :"f#{size}"
245

246
    def encode(unquote(type), f) when is_number(f) do
247
      <<f::unquote(size)-little-signed-float>>
71✔
248
    end
249

250
    def encode(unquote(type), nil), do: <<0::unquote(size)>>
2✔
251
  end
252

253
  def encode({:decimal, precision, scale}, decimal) do
254
    type =
×
255
      case decimal_size(precision) do
256
        32 -> :decimal32
×
257
        64 -> :decimal64
×
258
        128 -> :decimal128
×
259
        256 -> :decimal256
×
260
      end
261

262
    encode({type, scale}, decimal)
×
263
  end
264

265
  for size <- [32, 64, 128, 256] do
266
    type = :"decimal#{size}"
267

268
    def encode({unquote(type), scale} = t, %Decimal{sign: sign, coef: coef, exp: exp} = d) do
269
      cond do
24✔
270
        scale == -exp ->
271
          i = sign * coef
17✔
272
          <<i::unquote(size)-little>>
17✔
273

274
        exp >= 0 ->
7✔
275
          i = sign * coef * round(:math.pow(10, exp + scale))
1✔
276
          <<i::unquote(size)-little>>
1✔
277

278
        true ->
6✔
279
          encode(t, Decimal.round(d, scale))
6✔
280
      end
281
    end
282

283
    def encode({unquote(type), _scale}, nil), do: <<0::unquote(size)>>
4✔
284
  end
285

286
  def encode(:boolean, true), do: 1
4✔
287
  def encode(:boolean, false), do: 0
4✔
288
  def encode(:boolean, nil), do: 0
1✔
289

290
  def encode({:array, type}, [_ | _] = l) do
49✔
291
    [encode(:varint, length(l)) | encode_many(l, type)]
292
  end
293

294
  def encode({:array, _type}, []), do: 0
13✔
295
  def encode({:array, _type}, nil), do: 0
4✔
296

297
  def encode({:map, k, v}, [_ | _] = m) do
14✔
298
    [encode(:varint, length(m)) | encode_many_kv(m, k, v)]
299
  end
300

301
  def encode({:map, _k, _v} = t, m) when is_map(m), do: encode(t, Map.to_list(m))
16✔
302
  def encode({:map, _k, _v}, []), do: 0
8✔
303
  def encode({:map, _k, _v}, nil), do: 0
3✔
304

305
  def encode({:tuple, _types} = t, v) when is_tuple(v) do
306
    encode(t, Tuple.to_list(v))
8✔
307
  end
308

309
  def encode({:tuple, types}, values) when is_list(types) and is_list(values) do
310
    encode_row(values, types)
8✔
311
  end
312

313
  def encode({:tuple, types}, nil) when is_list(types) do
314
    Enum.map(types, fn type -> encode(type, nil) end)
×
315
  end
316

317
  def encode({:variant, _types}, nil), do: 255
4✔
318

319
  def encode({:variant, types}, value) do
320
    try_encode_variant(types, 0, value)
10✔
321
  end
322

323
  def encode(:datetime, %NaiveDateTime{} = datetime) do
324
    {seconds, _micros} = NaiveDateTime.to_gregorian_seconds(datetime)
18✔
325
    <<seconds - @epoch_gregorian_seconds::32-little>>
18✔
326
  end
327

328
  def encode(:datetime, %DateTime{} = datetime) do
329
    <<DateTime.to_unix(datetime, :second)::32-little>>
10✔
330
  end
331

332
  def encode(:datetime, nil), do: <<0::32>>
1✔
333

334
  def encode({:datetime64, time_unit}, %NaiveDateTime{} = datetime) do
335
    {seconds, micros} = NaiveDateTime.to_gregorian_seconds(datetime)
8✔
336

337
    <<(seconds - @epoch_gregorian_seconds) * time_unit + div(micros * time_unit, 1_000_000)::64-little-signed>>
8✔
338
  end
339

340
  def encode({:datetime64, time_unit}, %DateTime{} = datetime) do
341
    <<DateTime.to_unix(datetime, time_unit)::64-little-signed>>
4✔
342
  end
343

344
  def encode({:datetime64, _time_unit}, nil), do: <<0::64>>
1✔
345

346
  def encode(:date, %Date{} = date) do
347
    <<Date.to_gregorian_days(date) - @epoch_gregorian_days::16-little>>
13✔
348
  end
349

350
  def encode(:date, nil), do: <<0::16>>
1✔
351

352
  def encode(:date32, %Date{} = date) do
353
    <<Date.to_gregorian_days(date) - @epoch_gregorian_days::32-little-signed>>
8✔
354
  end
355

356
  def encode(:date32, nil), do: <<0::32>>
1✔
357

358
  def encode(:time, %Time{} = time) do
359
    {s, _micros} = Time.to_seconds_after_midnight(time)
10✔
360
    <<s::32-little-signed>>
10✔
361
  end
362

363
  def encode(:time, nil), do: <<0::32>>
×
364

365
  def encode({:time64, time_unit}, %Time{} = time) do
366
    {s, micros} = Time.to_seconds_after_midnight(time)
34✔
367

368
    micros_as_ticks =
34✔
369
      cond do
370
        time_unit < 1_000_000 -> div(micros, time_unit)
12✔
371
        time_unit == 1_000_000 -> micros
22✔
372
        true -> micros * div(time_unit, 1_000_000)
10✔
373
      end
374

375
    ticks = s * time_unit + micros_as_ticks
34✔
376
    <<ticks::64-little-signed>>
34✔
377
  end
378

379
  def encode({:time64, _time_unit}, nil), do: <<0::64>>
×
380

381
  def encode(:uuid, <<u1::64, u2::64>>), do: <<u1::64-little, u2::64-little>>
9✔
382

383
  def encode(
384
        :uuid,
385
        <<a1, a2, a3, a4, a5, a6, a7, a8, ?-, b1, b2, b3, b4, ?-, c1, c2, c3, c4, ?-, d1, d2, d3,
386
          d4, ?-, e1, e2, e3, e4, e5, e6, e7, e8, e9, e10, e11, e12>>
387
      ) do
388
    raw =
1✔
389
      <<d(a1)::4, d(a2)::4, d(a3)::4, d(a4)::4, d(a5)::4, d(a6)::4, d(a7)::4, d(a8)::4, d(b1)::4,
390
        d(b2)::4, d(b3)::4, d(b4)::4, d(c1)::4, d(c2)::4, d(c3)::4, d(c4)::4, d(d1)::4, d(d2)::4,
391
        d(d3)::4, d(d4)::4, d(e1)::4, d(e2)::4, d(e3)::4, d(e4)::4, d(e5)::4, d(e6)::4, d(e7)::4,
392
        d(e8)::4, d(e9)::4, d(e10)::4, d(e11)::4, d(e12)::4>>
393

394
    encode(:uuid, raw)
1✔
395
  end
396

397
  def encode(:uuid, nil), do: <<0::128>>
1✔
398

399
  def encode(:ipv4, {a, b, c, d}), do: [d, c, b, a]
4✔
400
  def encode(:ipv4, nil), do: <<0::32>>
×
401

402
  def encode(:ipv6, {b1, b2, b3, b4, b5, b6, b7, b8}) do
403
    <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>
4✔
404
  end
405

406
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
×
407
  def encode(:ipv6, nil), do: <<0::128>>
×
408

409
  def encode(:point, {x, y}), do: [encode(:f64, x) | encode(:f64, y)]
28✔
410
  def encode(:point, nil), do: <<0::128>>
1✔
411
  def encode(:ring, points), do: encode({:array, :point}, points)
1✔
412
  def encode(:polygon, rings), do: encode({:array, :ring}, rings)
1✔
413
  def encode(:multipolygon, polygons), do: encode({:array, :polygon}, polygons)
1✔
414

415
  # TODO
416
  def encode(:dynamic, value) do
417
    case value do
18✔
418
      _ when is_binary(value) -> [0x15 | encode(:string, value)]
3✔
419
      _ when is_integer(value) and value >= 0 -> [0x04 | encode(:u64, value)]
5✔
420
      _ when is_integer(value) -> [0x0A | encode(:i64, value)]
2✔
421
      _ when is_float(value) -> [0x0E | encode(:f64, value)]
3✔
422
      %Date{} -> [0x0F | encode(:date, value)]
3✔
423
      %NaiveDateTime{} -> [0x11 | encode(:datetime, value)]
2✔
424
      [] -> [0x1E, 0x00]
×
425
    end
426
  end
427

428
  # TODO enum8 and enum16 nil
429
  for size <- [8, 16] do
430
    enum_t = :"enum#{size}"
431
    int_t = :"i#{size}"
432

433
    def encode({unquote(enum_t), mapping}, e) do
434
      i =
12✔
435
        case e do
436
          _ when is_integer(e) ->
437
            e
4✔
438

439
          _ when is_binary(e) ->
440
            case Map.fetch(mapping, e) do
8✔
441
              {:ok, res} ->
442
                res
8✔
443

444
              :error ->
445
                raise ArgumentError,
×
446
                      "enum value #{inspect(e)} not found in mapping: #{inspect(mapping)}"
447
            end
448
        end
449

450
      encode(unquote(int_t), i)
12✔
451
    end
452
  end
453

454
  def encode({:nullable, _type}, nil), do: 1
12✔
455

456
  def encode({:nullable, type}, value) do
457
    case encode(type, value) do
11✔
458
      e when is_list(e) or is_binary(e) -> [0 | e]
11✔
459
      e -> [0, e]
×
460
    end
461
  end
462

463
  defp encode_varint_cont(i) when i < 128, do: <<i>>
8✔
464

465
  defp encode_varint_cont(i) do
12✔
466
    [(i &&& 0b0111_1111) ||| 0b1000_0000 | encode_varint_cont(i >>> 7)]
467
  end
468

469
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
127✔
470
  defp encode_many([] = done, _type), do: done
55✔
471

472
  defp encode_many_kv([{key, value} | rest], key_type, value_type) do
19✔
473
    [
474
      encode(key_type, key),
475
      encode(value_type, value)
476
      | encode_many_kv(rest, key_type, value_type)
477
    ]
478
  end
479

480
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
14✔
481

482
  # TODO find a better way than try/rescue
483
  defp try_encode_variant([type | types], idx, value) do
484
    try do
18✔
485
      encode(type, value)
18✔
486
    else
487
      encoded -> [idx | encoded]
10✔
488
    rescue
489
      _e -> try_encode_variant(types, idx + 1, value)
8✔
490
    end
491
  end
492

493
  defp try_encode_variant([], _idx, value) do
494
    raise ArgumentError, "no matching type found for encoding #{inspect(value)} as Variant"
×
495
  end
496

497
  @compile {:inline, d: 1}
498

499
  defp d(?0), do: 0
1✔
500
  defp d(?1), do: 1
×
501
  defp d(?2), do: 2
1✔
502
  defp d(?3), do: 3
1✔
503
  defp d(?4), do: 4
×
504
  defp d(?5), do: 5
1✔
505
  defp d(?6), do: 6
1✔
506
  defp d(?7), do: 7
×
507
  defp d(?8), do: 8
1✔
508
  defp d(?9), do: 9
1✔
509
  defp d(?A), do: 10
×
510
  defp d(?B), do: 11
×
511
  defp d(?C), do: 12
×
512
  defp d(?D), do: 13
×
513
  defp d(?E), do: 14
×
514
  defp d(?F), do: 15
×
515
  defp d(?a), do: 10
1✔
516
  defp d(?b), do: 11
1✔
517
  defp d(?c), do: 12
1✔
518
  defp d(?d), do: 13
1✔
519
  defp d(?e), do: 14
1✔
520
  defp d(?f), do: 15
1✔
521

522
  varints = [
523
    {_pattern = quote(do: <<0::1, v1::7>>), _value = quote(do: v1)},
524
    {quote(do: <<1::1, v1::7, 0::1, v2::7>>), quote(do: (v2 <<< 7) + v1)},
525
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 0::1, v3::7>>),
526
     quote(do: (v3 <<< 14) + (v2 <<< 7) + v1)},
527
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 0::1, v4::7>>),
528
     quote(do: (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
529
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 1::1, v4::7, 0::1, v5::7>>),
530
     quote(do: (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
531
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 1::1, v4::7, 1::1, v5::7, 0::1, v6::7>>),
532
     quote(do: (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
533
    {quote do
534
       <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 1::1, v4::7, 1::1, v5::7, 1::1, v6::7, 0::1,
535
         v7::7>>
536
     end,
537
     quote do
538
       (v7 <<< 42) + (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1
539
     end},
540
    {quote do
541
       <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 1::1, v4::7, 1::1, v5::7, 1::1, v6::7, 1::1,
542
         v7::7, 0::1, v8::7>>
543
     end,
544
     quote do
545
       (v8 <<< 49) + (v7 <<< 42) + (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) +
546
         (v2 <<< 7) + v1
547
     end}
548
  ]
549

550
  @doc false
551
  @spec decode_header(binary()) ::
552
          {:ok, names :: [String.t()], types :: [term], rest :: binary} | :more
553
  def decode_header(row_binary_with_names_and_types)
554

555
  for {pattern, value} <- varints do
556
    def decode_header(<<unquote(pattern), rest::bytes>>) do
557
      decode_header_names(rest, unquote(value), unquote(value), _acc = [])
42✔
558
    end
559
  end
560

561
  def decode_header(<<_bin::bytes>>) do
1✔
562
    :more
563
  end
564

565
  defp decode_header_names(<<rest::bytes>>, 0, count, names) do
566
    decode_header_types(rest, count, _acc = [], :lists.reverse(names))
27✔
567
  end
568

569
  for {pattern, value} <- varints do
570
    defp decode_header_names(
571
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
572
           left,
573
           count,
574
           acc
575
         ) do
576
      decode_header_names(rest, left - 1, count, [name | acc])
84✔
577
    end
578
  end
579

580
  defp decode_header_names(<<_bin::bytes>>, _left, _count, _acc) do
15✔
581
    :more
582
  end
583

584
  defp decode_header_types(<<rest::bytes>>, 0, types, names) do
585
    {:ok, names, decoding_types_reverse(types), rest}
7✔
586
  end
587

588
  for {pattern, value} <- varints do
589
    defp decode_header_types(
590
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
591
           count,
592
           acc,
593
           names
594
         ) do
595
      decode_header_types(rest, count - 1, [type | acc], names)
30✔
596
    end
597
  end
598

599
  defp decode_header_types(<<_bin::bytes>>, _count, _acc, _names) do
20✔
600
    :more
601
  end
602

603
  @doc """
604
  Decodes [RowBinaryWithNamesAndTypes](https://clickhouse.com/docs/en/interfaces/formats/RowBinaryWithNamesAndTypes) into rows.
605

606
  Example:
607

608
      iex> decode_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
609
      [[2]]
610

611
  """
612
  def decode_rows(row_binary_with_names_and_types)
613
  def decode_rows(<<>>), do: []
1✔
614

615
  for {pattern, value} <- varints do
616
    def decode_rows(<<unquote(pattern), rest::bytes>>) do
617
      skip_names(rest, unquote(value), unquote(value))
7✔
618
    end
619
  end
620

621
  @doc """
622
  Same as `decode_rows/1` but the first element is a list of column names.
623

624
  Example:
625

626
      iex> decode_names_and_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
627
      [["1+1"], [2]]
628

629
  """
630
  def decode_names_and_rows(row_binary_with_names_and_types)
631

632
  for {pattern, value} <- varints do
633
    def decode_names_and_rows(<<unquote(pattern), rest::bytes>>) do
634
      decode_names(rest, unquote(value), unquote(value), _acc = [])
1,439✔
635
    end
636
  end
637

638
  @doc """
639
  Decodes [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) into rows.
640

641
  Example:
642

643
      iex> decode_rows(<<1>>, ["UInt8"])
644
      [[1]]
645

646
  """
647
  def decode_rows(row_binary, types)
648
  def decode_rows(<<>>, _types), do: []
1✔
649

650
  def decode_rows(<<data::bytes>>, types) do
651
    decode_rows!(data, decoding_types(types))
13✔
652
  end
653

654
  defp decode_rows!(data, types) do
655
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
1,310✔
656

657
    case state do
1,274✔
658
      nil ->
659
        rows
1,272✔
660

661
      {:cont, types_rest, row} ->
662
        raise ArgumentError, """
2✔
663
        incomplete RowBinary data: ran out of bytes while decoding
664

665
        Expected to decode: #{inspect(types_rest)}
666
        Remaining bytes: #{byte_size(remaining_data)} bytes
2✔
667
        Partial row: #{inspect(row)}
668
        Completed rows: #{length(rows)}
2✔
669
        """
670
    end
671
  end
672

673
  @doc false
674
  def decode_rows_continue(<<data::bytes>>, types, state) do
675
    case state do
201,166✔
676
      {:cont, types_rest, row} -> decode_rows(types_rest, data, row, [], types)
201,074✔
677
      nil -> decode_rows(types, data, [], [], types)
92✔
678
    end
679
  end
680

681
  @doc false
682
  def decoding_types([type | types]) do
129✔
683
    [decoding_type(type) | decoding_types(types)]
684
  end
685

686
  def decoding_types([] = done), do: done
85✔
687

688
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
1,304✔
689

690
  defp decoding_types_reverse([type | types], acc) do
691
    decoding_types_reverse(types, [decoding_type(type) | acc])
4,156✔
692
  end
693

694
  defp decoding_types_reverse([], acc), do: acc
1,304✔
695

696
  defp decoding_type(t) when is_binary(t) do
697
    decoding_type(Ch.Types.decode(t))
4,271✔
698
  end
699

700
  defp decoding_type(t)
701
       when t in [
702
              :string,
703
              :binary,
704
              :json,
705
              :dynamic,
706
              :boolean,
707
              :uuid,
708
              :date,
709
              :date32,
710
              :time,
711
              :time64,
712
              :ipv4,
713
              :ipv6,
714
              :point,
715
              :nothing
716
            ],
717
       do: t
1,240✔
718

719
  defp decoding_type({:datetime, _tz} = t), do: t
32✔
720
  defp decoding_type({:fixed_string, _len} = t), do: t
22✔
721

722
  for size <- [8, 16, 32, 64, 128, 256] do
723
    defp decoding_type(unquote(:"u#{size}") = u), do: u
2,663✔
724
    defp decoding_type(unquote(:"i#{size}") = i), do: i
98✔
725
  end
726

727
  for size <- [32, 64] do
728
    defp decoding_type(unquote(:"f#{size}") = f), do: f
44✔
729
  end
730

731
  defp decoding_type(:datetime = t), do: {t, _tz = nil}
21✔
732

733
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
124✔
734

735
  defp decoding_type({:tuple = t, ts}) do
18✔
736
    {t, Enum.map(ts, &decoding_type/1)}
737
  end
738

739
  defp decoding_type({:variant = v, ts}) do
28✔
740
    {v, Enum.map(ts, &decoding_type/1)}
741
  end
742

743
  defp decoding_type({:map = m, kt, vt}) do
744
    {m, decoding_type(kt), decoding_type(vt)}
25✔
745
  end
746

747
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
58✔
748
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
149✔
749

750
  defp decoding_type({:decimal = t, p, s}), do: {t, decimal_size(p), s}
62✔
751
  defp decoding_type({:decimal32, s}), do: {:decimal, 32, s}
1✔
752
  defp decoding_type({:decimal64, s}), do: {:decimal, 64, s}
1✔
753
  defp decoding_type({:decimal128, s}), do: {:decimal, 128, s}
1✔
754
  defp decoding_type({:decimal256, s}), do: {:decimal, 256, s}
1✔
755

756
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
33✔
757
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
20✔
758

759
  defp decoding_type({:time64 = t, p}), do: {t, time_unit(p)}
120✔
760

761
  defp decoding_type({e, mappings}) when e in [:enum8, :enum16] do
17✔
762
    {e, Map.new(mappings, fn {k, v} -> {v, k} end)}
34✔
763
  end
764

765
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
766

767
  defp decoding_type(:ring), do: {:array, :point}
6✔
768
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
6✔
769
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
6✔
770

771
  defp decoding_type(type) do
772
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
×
773
  end
774

775
  defp skip_names(<<rest::bytes>>, 0, count), do: decode_types(rest, count, _acc = [])
7✔
776

777
  for {pattern, value} <- varints do
778
    defp skip_names(<<unquote(pattern), _::size(unquote(value))-bytes, rest::bytes>>, left, count) do
779
      skip_names(rest, left - 1, count)
77✔
780
    end
781
  end
782

783
  defp decode_names(<<rest::bytes>>, 0, count, names) do
1,439✔
784
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
785
  end
786

787
  for {pattern, value} <- varints do
788
    defp decode_names(
789
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
790
           left,
791
           count,
792
           acc
793
         ) do
794
      decode_names(rest, left - 1, count, [name | acc])
4,222✔
795
    end
796
  end
797

798
  defp decode_types(<<>>, 0, _types), do: []
149✔
799

800
  defp decode_types(<<rest::bytes>>, 0, types) do
801
    decode_rows!(rest, decoding_types_reverse(types))
1,297✔
802
  end
803

804
  for {pattern, value} <- varints do
805
    defp decode_types(
806
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
807
           count,
808
           acc
809
         ) do
810
      decode_types(rest, count - 1, [type | acc])
4,299✔
811
    end
812
  end
813

814
  @compile inline: [decode_string_decode_rows: 5]
815

816
  for {pattern, size} <- varints do
817
    defp decode_string_decode_rows(
818
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
819
           types_rest,
820
           row,
821
           rows,
822
           types
823
         ) do
824
      decode_rows(types_rest, bin, [to_utf8(s) | row], rows, types)
1,116✔
825
    end
826
  end
827

828
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
829
    to_be_continued(rows, bin, [:string | types_rest], row)
100,165✔
830
  end
831

832
  @doc false
833
  def to_utf8(str) do
834
    utf8 = to_utf8(str, 0, 0, str, [])
1,116✔
835
    IO.iodata_to_binary(utf8)
1,116✔
836
  end
837

838
  @dialyzer {:no_improper_lists, to_utf8: 5, to_utf8_escape: 5}
839

840
  defp to_utf8(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
841
    to_utf8(rest, from, len + utf8_size(valid), original, acc)
30,139,319✔
842
  end
843

844
  defp to_utf8(<<_invalid, rest::bytes>>, from, len, original, acc) do
845
    acc = [acc | binary_part(original, from, len)]
6✔
846
    to_utf8_escape(rest, from + len, 1, original, acc)
6✔
847
  end
848

849
  defp to_utf8(<<>>, from, len, original, acc) do
1,115✔
850
    [acc | binary_part(original, from, len)]
851
  end
852

853
  defp to_utf8_escape(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
854
    acc = [acc | "�"]
5✔
855
    to_utf8(rest, from + len, utf8_size(valid), original, acc)
5✔
856
  end
857

858
  defp to_utf8_escape(<<_invalid, rest::bytes>>, from, len, original, acc) do
859
    to_utf8_escape(rest, from, len + 1, original, acc)
7✔
860
  end
861

862
  defp to_utf8_escape(<<>>, _from, _len, _original, acc) do
1✔
863
    [acc | "�"]
864
  end
865

866
  # UTF-8 encodes code points in one to four bytes
867
  @compile inline: [utf8_size: 1]
868
  defp utf8_size(codepoint) when codepoint <= 0x7F, do: 1
30,139,288✔
869
  defp utf8_size(codepoint) when codepoint <= 0x7FF, do: 2
13✔
870
  defp utf8_size(codepoint) when codepoint <= 0xFFFF, do: 3
23✔
871
  defp utf8_size(codepoint) when codepoint <= 0x10FFFF, do: 4
×
872

873
  @compile inline: [decode_string_json_decode_rows: 5]
874

875
  for {pattern, size} <- varints do
876
    defp decode_string_json_decode_rows(
877
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
878
           types_rest,
879
           row,
880
           rows,
881
           types
882
         ) do
883
      decode_rows(types_rest, bin, [Jason.decode!(s) | row], rows, types)
76✔
884
    end
885
  end
886

887
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
888
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
889
  end
890

891
  @compile inline: [decode_binary_decode_rows: 5]
892

893
  for {pattern, size} <- varints do
894
    defp decode_binary_decode_rows(
895
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
896
           types_rest,
897
           row,
898
           rows,
899
           types
900
         ) do
901
      decode_rows(types_rest, bin, [s | row], rows, types)
4✔
902
    end
903
  end
904

905
  defp decode_binary_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
906
    to_be_continued(rows, bin, [:binary | types_rest], row)
100,007✔
907
  end
908

909
  @compile inline: [decode_array_decode_rows: 6]
910
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
911
    decode_rows(types_rest, bin, [[] | row], rows, types)
79✔
912
  end
913

914
  for {pattern, size} <- varints do
915
    defp decode_array_decode_rows(
916
           <<unquote(pattern), bin::bytes>>,
917
           type,
918
           types_rest,
919
           row,
920
           rows,
921
           types
922
         ) do
923
      array_types = List.duplicate(type, unquote(size))
255✔
924
      types_rest = array_types ++ [{:array_over, row} | types_rest]
255✔
925
      decode_rows(types_rest, bin, [], rows, types)
255✔
926
    end
927
  end
928

929
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
930
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
931
  end
932

933
  @compile inline: [decode_map_decode_rows: 7]
934
  defp decode_map_decode_rows(
935
         <<0, bin::bytes>>,
936
         _key_type,
937
         _value_type,
938
         types_rest,
939
         row,
940
         rows,
941
         types
942
       ) do
943
    decode_rows(types_rest, bin, [%{} | row], rows, types)
10✔
944
  end
945

946
  for {pattern, size} <- varints do
947
    defp decode_map_decode_rows(
948
           <<unquote(pattern), bin::bytes>>,
949
           key_type,
950
           value_type,
951
           types_rest,
952
           row,
953
           rows,
954
           types
955
         ) do
956
      types_rest =
32✔
957
        map_types(unquote(size), key_type, value_type) ++ [{:map_over, row} | types_rest]
958

959
      decode_rows(types_rest, bin, [], rows, types)
32✔
960
    end
961
  end
962

963
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
964
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
965
  end
966

967
  defp map_types(count, key_type, value_type) when count > 0 do
57✔
968
    [key_type, value_type | map_types(count - 1, key_type, value_type)]
969
  end
970

971
  defp map_types(0, _key_type, _value_types), do: []
32✔
972

973
  # https://clickhouse.com/docs/sql-reference/data-types/data-types-binary-encoding
974
  dynamic_types = [
975
    nothing: 0x00,
976
    u8: 0x01,
977
    u16: 0x02,
978
    u32: 0x03,
979
    u64: 0x04,
980
    u128: 0x05,
981
    u256: 0x06,
982
    i8: 0x07,
983
    i16: 0x08,
984
    i32: 0x09,
985
    i64: 0x0A,
986
    i128: 0x0B,
987
    i256: 0x0C,
988
    f32: 0x0D,
989
    f64: 0x0E,
990
    date: 0x0F,
991
    date32: 0x10,
992
    string: 0x15,
993
    uuid: 0x1D,
994
    ipv4: 0x28,
995
    ipv6: 0x29,
996
    boolean: 0x2D
997
  ]
998

999
  # TODO compile inline?
1000

1001
  for {type, code} <- dynamic_types do
1002
    defp decode_dynamic(
1003
           <<unquote(code), rest::bytes>>,
1004
           dynamic,
1005
           types_rest,
1006
           row,
1007
           rows,
1008
           types
1009
         ) do
1010
      decode_dynamic_continue(rest, [unquote(type) | dynamic], types_rest, row, rows, types)
236✔
1011
    end
1012
  end
1013

1014
  # DateTime 0x11
1015
  defp decode_dynamic(<<0x11, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1016
    decode_dynamic_continue(rest, [{:datetime, nil} | dynamic], types_rest, row, rows, types)
4✔
1017
  end
1018

1019
  # DateTime(time_zone) 0x12 <var_uint_time_zone_name_size><time_zone_name_data>
1020
  for {pattern, size} <- varints do
1021
    defp decode_dynamic(
1022
           <<0x12, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1023
           dynamic,
1024
           types_rest,
1025
           row,
1026
           rows,
1027
           types
1028
         ) do
1029
      decode_dynamic_continue(rest, [{:datetime, tz} | dynamic], types_rest, row, rows, types)
2✔
1030
    end
1031
  end
1032

1033
  # DateTime64(P) 0x13 <uint8_precision>
1034
  defp decode_dynamic(
1035
         <<0x13, precision, rest::bytes>>,
1036
         dynamic,
1037
         types_rest,
1038
         row,
1039
         rows,
1040
         types
1041
       ) do
1042
    decode_dynamic_continue(
2✔
1043
      rest,
1044
      [decoding_type({:datetime64, precision}) | dynamic],
1045
      types_rest,
1046
      row,
1047
      rows,
1048
      types
1049
    )
1050
  end
1051

1052
  # DateTime64(P, time_zone) 0x14 <uint8_precision><var_uint_time_zone_name_size><time_zone_name_data>
1053
  for {pattern, size} <- varints do
1054
    defp decode_dynamic(
1055
           <<0x14, precision, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1056
           dynamic,
1057
           types_rest,
1058
           row,
1059
           rows,
1060
           types
1061
         ) do
1062
      decode_dynamic_continue(
2✔
1063
        rest,
1064
        [decoding_type({:datetime64, precision, tz}) | dynamic],
1065
        types_rest,
1066
        row,
1067
        rows,
1068
        types
1069
      )
1070
    end
1071
  end
1072

1073
  # FixedString(N) 0x16 <var_uint_size>
1074
  for {pattern, size} <- varints do
1075
    defp decode_dynamic(
1076
           <<0x16, unquote(pattern), rest::bytes>>,
1077
           dynamic,
1078
           types_rest,
1079
           row,
1080
           rows,
1081
           types
1082
         ) do
1083
      decode_dynamic_continue(
4✔
1084
        rest,
1085
        [{:fixed_string, unquote(size)} | dynamic],
1086
        types_rest,
1087
        row,
1088
        rows,
1089
        types
1090
      )
1091
    end
1092
  end
1093

1094
  # Decimal32(P, S) 0x19 <uint8_precision><uint8_scale>
1095
  # Decimal64(P, S) 0x1A <uint8_precision><uint8_scale>
1096
  # Decimal128(P, S) 0x1B <uint8_precision><uint8_scale>
1097
  # Decimal256(P, S) 0x1C <uint8_precision><uint8_scale>
1098
  for {code, size} <- [{0x19, 32}, {0x1A, 64}, {0x1B, 128}, {0x1C, 256}] do
1099
    defp decode_dynamic(
1100
           <<unquote(code), _precision, scale, rest::bytes>>,
1101
           dynamic,
1102
           types_rest,
1103
           row,
1104
           rows,
1105
           types
1106
         ) do
1107
      decode_dynamic_continue(
8✔
1108
        rest,
1109
        [{:decimal, unquote(size), scale} | dynamic],
1110
        types_rest,
1111
        row,
1112
        rows,
1113
        types
1114
      )
1115
    end
1116
  end
1117

1118
  # Array(T) 0x1E <nested_type_encoding>
1119
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1120
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
58✔
1121
  end
1122

1123
  # Nullable(T)        0x23 <nested_type_encoding>
1124
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1125
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
10✔
1126
  end
1127

1128
  # LowCardinality(T) 0x26 <nested_type_encoding>
1129
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1130
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
4✔
1131
  end
1132

1133
  # TODO
1134
  # Enum8        0x17 <var_uint_number_of_elements><var_uint_name_size_1><name_data_1><int8_value_1>...<var_uint_name_size_N><name_data_N><int8_value_N>
1135
  # Enum16        0x18 <var_uint_number_of_elements><var_uint_name_size_1><name_data_1><int16_little_endian_value_1>...><var_uint_name_size_N><name_data_N><int16_little_endian_value_N>
1136
  # Tuple(T1, ..., TN)        0x1F <var_uint_number_of_elements><nested_type_encoding_1>...<nested_type_encoding_N>
1137
  # Tuple(name1 T1, ..., nameN TN)        0x20 <var_uint_number_of_elements><var_uint_name_size_1><name_data_1><nested_type_encoding_1>...<var_uint_name_size_N><name_data_N><nested_type_encoding_N>
1138
  # Set        0x21
1139
  # Interval        0x22 <interval_kind> (see interval kind binary encoding)
1140
  # Function        0x24<var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N><return_type_encoding>
1141
  # AggregateFunction(function_name(param_1, ..., param_N), arg_T1, ..., arg_TN)        0x25<var_uint_version><var_uint_function_name_size><function_name_data><var_uint_number_of_parameters><param_1>...<param_N><var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N> (see aggregate function parameter binary encoding)
1142
  # Map(K, V)        0x27<key_type_encoding><value_type_encoding>
1143
  # Variant(T1, ..., TN)        0x2A<var_uint_number_of_variants><variant_type_encoding_1>...<variant_type_encoding_N>
1144
  # Dynamic(max_types=N)        0x2B<uint8_max_types>
1145
  # Custom type (Ring, Polygon, etc)        0x2C<var_uint_type_name_size><type_name_data>
1146
  # SimpleAggregateFunction(function_name(param_1, ..., param_N), arg_T1, ..., arg_TN)        0x2E<var_uint_function_name_size><function_name_data><var_uint_number_of_parameters><param_1>...<param_N><var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N> (see aggregate function parameter binary encoding)
1147
  # Nested(name1 T1, ..., nameN TN)        0x2F<var_uint_number_of_elements><var_uint_name_size_1><name_data_1><nested_type_encoding_1>...<var_uint_name_size_N><name_data_N><nested_type_encoding_N>
1148
  # JSON(max_dynamic_paths=N, max_dynamic_types=M, path Type, SKIP skip_path, SKIP REGEXP skip_path_regexp)        0x30<uint8_serialization_version><var_int_max_dynamic_paths><uint8_max_dynamic_types><var_uint_number_of_typed_paths><var_uint_path_name_size_1><path_name_data_1><encoded_type_1>...<var_uint_number_of_skip_paths><var_uint_skip_path_size_1><skip_path_data_1>...<var_uint_number_of_skip_path_regexps><var_uint_skip_path_regexp_size_1><skip_path_data_regexp_1>...
1149

1150
  unsupported_dynamic_types = %{
1151
    "Enum8" => 0x17,
1152
    "Enum16" => 0x18,
1153
    "Tuple" => 0x1F,
1154
    "TupleWithNames" => 0x20,
1155
    "Set" => 0x21,
1156
    "Interval" => 0x22,
1157
    "Function" => 0x24,
1158
    "AggregateFunction" => 0x25,
1159
    "Map" => 0x27,
1160
    "Variant" => 0x2A,
1161
    "Dynamic" => 0x2B,
1162
    "CustomType" => 0x2C,
1163
    "SimpleAggregateFunction" => 0x2E,
1164
    "Nested" => 0x2F,
1165
    "JSON" => 0x30
1166
  }
1167

1168
  for {type, code} <- unsupported_dynamic_types do
1169
    defp decode_dynamic(<<unquote(code), _::bytes>>, _dynamic, _types_rest, _row, _rows, _types) do
1170
      raise ArgumentError, "unsupported dynamic type #{unquote(type)}"
18✔
1171
    end
1172
  end
1173

1174
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1175
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1176
  end
1177

1178
  @compile inline: [decode_dynamic_continue: 6]
1179

1180
  defp decode_dynamic_continue(<<rest::bytes>>, dynamic, types_rest, row, rows, types) do
1181
    continue? =
212✔
1182
      case dynamic do
1183
        [:array | _] -> true
58✔
1184
        [:nullable | _] -> true
10✔
1185
        [:low_cardinality | _] -> true
4✔
1186
        _ -> false
212✔
1187
      end
1188

1189
    if continue? do
212✔
1190
      decode_dynamic(rest, dynamic, types_rest, row, rows, types)
72✔
1191
    else
1192
      type = build_dynamic_type(:lists.reverse(dynamic))
212✔
1193
      decode_rows([type | types_rest], rest, row, rows, types)
212✔
1194
    end
1195
  end
1196

1197
  defp build_dynamic_type([type]), do: type
258✔
1198

1199
  defp build_dynamic_type(type) do
1200
    case type do
64✔
1201
      [:array | rest] -> {:array, build_dynamic_type(rest)}
50✔
1202
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
10✔
1203
      [:low_cardinality | rest] -> build_dynamic_type(rest)
4✔
1204
    end
1205
  end
1206

1207
  simple_types = %{
1208
    u8: %{pattern: quote(do: <<u>>), value: quote(do: u)},
1209
    u16: %{pattern: quote(do: <<u::16-little>>), value: quote(do: u)},
1210
    u32: %{pattern: quote(do: <<u::32-little>>), value: quote(do: u)},
1211
    u64: %{pattern: quote(do: <<u::64-little>>), value: quote(do: u)},
1212
    u128: %{pattern: quote(do: <<u::128-little>>), value: quote(do: u)},
1213
    u256: %{pattern: quote(do: <<u::256-little>>), value: quote(do: u)},
1214
    i8: %{pattern: quote(do: <<i::signed>>), value: quote(do: i)},
1215
    i16: %{pattern: quote(do: <<i::16-little-signed>>), value: quote(do: i)},
1216
    i32: %{pattern: quote(do: <<i::32-little-signed>>), value: quote(do: i)},
1217
    i64: %{pattern: quote(do: <<i::64-little-signed>>), value: quote(do: i)},
1218
    i128: %{pattern: quote(do: <<i::128-little-signed>>), value: quote(do: i)},
1219
    i256: %{pattern: quote(do: <<i::256-little-signed>>), value: quote(do: i)},
1220
    f32: [
1221
      %{pattern: quote(do: <<f::32-little-float>>), value: quote(do: f)},
1222
      %{pattern: quote(do: <<_nan_or_inf::32>>), value: quote(do: nil)}
1223
    ],
1224
    f64: [
1225
      %{pattern: quote(do: <<f::64-little-float>>), value: quote(do: f)},
1226
      %{pattern: quote(do: <<_nan_or_inf::64>>), value: quote(do: nil)}
1227
    ],
1228
    uuid: %{
1229
      pattern: quote(do: <<u1::64-little, u2::64-little>>),
1230
      value: quote(do: <<u1::64, u2::64>>)
1231
    },
1232
    date: %{
1233
      pattern: quote(do: <<d::16-little>>),
1234
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1235
    },
1236
    date32: %{
1237
      pattern: quote(do: <<d::32-little-signed>>),
1238
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1239
    },
1240
    time: %{
1241
      pattern: quote(do: <<s::32-little-signed>>),
1242
      value: quote(do: time_after_midnight(s, 1))
1243
    },
1244
    boolean: [
1245
      %{pattern: quote(do: <<0>>), value: quote(do: false)},
1246
      %{pattern: quote(do: <<1>>), value: quote(do: true)},
1247
      %{pattern: quote(do: <<b>>), value: quote(do: raise("invalid boolean value: #{b}"))}
1248
    ],
1249
    ipv4: %{
1250
      pattern: quote(do: <<b4, b3, b2, b1>>),
1251
      value: quote(do: {b1, b2, b3, b4})
1252
    },
1253
    ipv6: %{
1254
      pattern: quote(do: <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>),
1255
      value: quote(do: {b1, b2, b3, b4, b5, b6, b7, b8})
1256
    },
1257
    point: %{
1258
      pattern: quote(do: <<x::64-little-float, y::64-little-float>>),
1259
      value: quote(do: {x, y})
1260
    }
1261
  }
1262

1263
  for {type, clauses} <- simple_types do
1264
    fun = :"decode_#{type}_decode_rows"
1265
    @compile inline: [{fun, 5}]
1266

1267
    for %{pattern: pattern, value: value} <- List.wrap(clauses) do
1268
      defp unquote(fun)(<<unquote(pattern), rest::bytes>>, types_rest, row, rows, types) do
1269
        decode_rows(types_rest, rest, [unquote(value) | row], rows, types)
2,154,363✔
1270
      end
1271
    end
1272

1273
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1274
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
582✔
1275
    end
1276
  end
1277

1278
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1279
    case type do
2,358,323✔
1280
      :u8 ->
1281
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
1,211✔
1282

1283
      :u16 ->
1284
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
1,524✔
1285

1286
      :u32 ->
1287
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
73✔
1288

1289
      :u64 ->
1290
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,150,989✔
1291

1292
      :u128 ->
1293
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
40✔
1294

1295
      :u256 ->
1296
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
72✔
1297

1298
      :i8 ->
1299
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
40✔
1300

1301
      :i16 ->
1302
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
20✔
1303

1304
      :i32 ->
1305
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
42✔
1306

1307
      :i64 ->
1308
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
170✔
1309

1310
      :i128 ->
1311
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
41✔
1312

1313
      :i256 ->
1314
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
73✔
1315

1316
      :f32 ->
1317
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
36✔
1318

1319
      :f64 ->
1320
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
60✔
1321

1322
      :string ->
1323
        decode_string_decode_rows(bin, types_rest, row, rows, types)
101,281✔
1324

1325
      :binary ->
1326
        decode_binary_decode_rows(bin, types_rest, row, rows, types)
100,011✔
1327

1328
      :json ->
1329
        # assuming it arrives as text and not "native" binary JSON
1330
        # i.e. assumes `settings: [output_format_binary_write_json_as_string: 1]`
1331
        # TODO
1332
        decode_string_json_decode_rows(bin, types_rest, row, rows, types)
122✔
1333

1334
      :dynamic ->
1335
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
276✔
1336

1337
      {:dynamic, dynamic} ->
1338
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1339

1340
      # TODO utf8?
1341
      {:fixed_string, size} ->
1342
        case bin do
43✔
1343
          <<s::size(^size)-bytes, rest::bytes>> ->
1344
            decode_rows(types_rest, rest, [s | row], rows, types)
29✔
1345

1346
          _ ->
1347
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1348
        end
1349

1350
      :boolean ->
1351
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
66✔
1352

1353
      :uuid ->
1354
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
86✔
1355

1356
      :date ->
1357
        decode_date_decode_rows(bin, types_rest, row, rows, types)
42✔
1358

1359
      :date32 ->
1360
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
40✔
1361

1362
      :time ->
1363
        decode_time_decode_rows(bin, types_rest, row, rows, types)
46✔
1364

1365
      {:time64, time_unit} ->
1366
        case bin do
180✔
1367
          <<ticks::64-little-signed, bin::bytes>> ->
1368
            time = time_after_midnight(ticks, time_unit)
150✔
1369
            decode_rows(types_rest, bin, [time | row], rows, types)
142✔
1370

1371
          _ ->
1372
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1373
        end
1374

1375
      {:datetime, timezone} ->
1376
        case bin do
88✔
1377
          <<s::32-little, bin::bytes>> ->
1378
            dt = DateTime.from_unix!(s)
66✔
1379

1380
            dt =
66✔
1381
              case timezone do
1382
                nil -> DateTime.to_naive(dt)
26✔
1383
                "UTC" -> dt
22✔
1384
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1385
              end
1386

1387
            decode_rows(types_rest, bin, [dt | row], rows, types)
64✔
1388

1389
          _ ->
1390
            to_be_continued(rows, bin, [type | types_rest], row)
22✔
1391
        end
1392

1393
      {:decimal, size, scale} ->
1394
        case bin do
198✔
1395
          <<val::size(^size)-little-signed, bin::bytes>> ->
1396
            sign = if val < 0, do: -1, else: 1
80✔
1397
            d = Decimal.new(sign, abs(val), -scale)
80✔
1398
            decode_rows(types_rest, bin, [d | row], rows, types)
80✔
1399

1400
          _ ->
1401
            to_be_continued(rows, bin, [type | types_rest], row)
118✔
1402
        end
1403

1404
      {:nullable, inner_type} ->
1405
        case bin do
175✔
1406
          <<b, bin::bytes>> ->
1407
            case b do
172✔
1408
              0 -> decode_rows([inner_type | types_rest], bin, row, rows, types)
79✔
1409
              1 -> decode_rows(types_rest, bin, [nil | row], rows, types)
93✔
1410
            end
1411

1412
          _ ->
1413
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1414
        end
1415

1416
      :nothing ->
1417
        decode_rows(types_rest, bin, [nil | row], rows, types)
54✔
1418

1419
      {:array, inner_type} ->
1420
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
346✔
1421

1422
      {:array_over, original_row} ->
1423
        decode_rows(types_rest, bin, [:lists.reverse(row) | original_row], rows, types)
253✔
1424

1425
      {:map, key_type, value_type} ->
1426
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
48✔
1427

1428
      {:map_over, original_row} ->
1429
        map = row |> Enum.chunk_every(2) |> Enum.map(fn [v, k] -> {k, v} end) |> Map.new()
32✔
1430
        decode_rows(types_rest, bin, [map | original_row], rows, types)
32✔
1431

1432
      {:tuple, tuple_types} ->
1433
        decode_rows(tuple_types ++ [{:tuple_over, row} | types_rest], bin, [], rows, types)
26✔
1434

1435
      {:tuple_over, original_row} ->
1436
        tuple = row |> :lists.reverse() |> List.to_tuple()
26✔
1437
        decode_rows(types_rest, bin, [tuple | original_row], rows, types)
26✔
1438

1439
      {:variant, variant_types} ->
1440
        case bin do
59✔
1441
          <<255, bin::bytes>> ->
1442
            # 255 is the variant type index for "nothing"
1443
            decode_rows(types_rest, bin, [nil | row], rows, types)
12✔
1444

1445
          # TODO varint?
1446
          <<variant_type_index::8, bin::bytes>> ->
1447
            variant_type = Enum.at(variant_types, variant_type_index)
44✔
1448
            decode_rows([variant_type | types_rest], bin, row, rows, types)
44✔
1449

1450
          _ ->
1451
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1452
        end
1453

1454
      {:datetime64, time_unit, timezone} ->
1455
        case bin do
122✔
1456
          <<s::64-little-signed, bin::bytes>> ->
1457
            dt = DateTime.from_unix!(s, time_unit)
60✔
1458

1459
            dt =
60✔
1460
              case timezone do
1461
                nil -> DateTime.to_naive(dt)
34✔
1462
                "UTC" -> dt
8✔
1463
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1464
              end
1465

1466
            decode_rows(types_rest, bin, [dt | row], rows, types)
60✔
1467

1468
          _ ->
1469
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1470
        end
1471

1472
      {:enum8, mapping} ->
1473
        case bin do
28✔
1474
          <<v::signed, bin::bytes>> ->
1475
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
28✔
1476

1477
          _ ->
1478
            to_be_continued(rows, bin, [type | types_rest], row)
×
1479
        end
1480

1481
      {:enum16, mapping} ->
1482
        case bin do
8✔
1483
          <<v::16-little-signed, bin::bytes>> ->
1484
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
4✔
1485

1486
          _ ->
1487
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1488
        end
1489

1490
      :ipv4 ->
1491
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
24✔
1492

1493
      :ipv6 ->
1494
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
74✔
1495

1496
      :point ->
1497
        decode_point_decode_rows(bin, types_rest, row, rows, types)
176✔
1498
    end
1499
  end
1500

1501
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1502
    rows = :lists.reverse([:lists.reverse(row) | rows])
1,364✔
1503
    {rows, empty, _no_state = nil}
1,364✔
1504
  end
1505

1506
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1507
    row = :lists.reverse(row)
2,151,119✔
1508
    decode_rows(types, bin, [], [row | rows], types)
2,151,119✔
1509
  end
1510

1511
  defp decode_rows([_ | _] = types_rest, <<>> = empty, row, rows, _types) do
1512
    to_be_continued(rows, empty, types_rest, row)
×
1513
  end
1514

1515
  @compile inline: [to_be_continued: 4]
1516
  defp to_be_continued(rows, bin, types_rest, row) do
1517
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,719✔
1518
  end
1519

1520
  @compile inline: [decimal_size: 1]
1521
  # https://clickhouse.com/docs/en/sql-reference/data-types/decimal/
1522
  defp decimal_size(precision) when is_integer(precision) do
1523
    cond do
62✔
1524
      precision >= 39 -> 256
4✔
1525
      precision >= 19 -> 128
58✔
1526
      precision >= 10 -> 64
49✔
1527
      true -> 32
33✔
1528
    end
1529
  end
1530

1531
  @compile inline: [time_unit: 1]
1532
  for precision <- 0..9 do
1533
    time_unit = Integer.pow(10, precision)
1534
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1535
  end
1536

1537
  @compile inline: [time_after_midnight: 2]
1538
  defp time_after_midnight(ticks, time_unit) do
1539
    if ticks >= 0 and ticks < 86400 * time_unit do
182✔
1540
      ticks |> DateTime.from_unix!(time_unit) |> DateTime.to_time()
166✔
1541
    else
1542
      # since ClickHouse supports Time64 values of [-999:59:59.999999999, 999:59:59.999999999]
1543
      # and Elixir's Time supports values of [00:00:00.000000, 23:59:59.999999]
1544
      # we raise an error when ClickHouse's Time64 value is out of Elixir's Time range
1545
      raise ArgumentError,
8✔
1546
            "ClickHouse Time value #{:erlang.float_to_binary(ticks / time_unit, [:short])} (seconds) is out of Elixir's Time range (00:00:00.000000 - 23:59:59.999999)"
8✔
1547

1548
      # TODO: we could potentially decode ClickHouse's Time/Time64 values as Elixir's Duration when it's out of Elixir's Time range
1549
    end
1550
  end
1551
end
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc