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

plausible / ch / 0268f859a1824b41ad8de81c8f75b16c10e4e612-PR-397

02 Aug 2026 05:37PM UTC coverage: 97.941% (-0.1%) from 98.054%
0268f859a1824b41ad8de81c8f75b16c10e4e612-PR-397

Pull #397

github

ruslandoga
Use frames for container decoding
Pull Request #397: Use frames for container decoding

16 of 17 new or added lines in 1 file covered. (94.12%)

761 of 777 relevant lines covered (97.94%)

15413.04 hits per line

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

99.75
/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
5✔
14
    [encode(:varint, length(names)), encode_many(names, :string), encode_types(types)]
15
  end
16

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

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

27
  defp encode_types([] = done), do: done
5✔
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))
22✔
46
  end
47

48
  defp _encode_row([el | els], [type | types]), do: [encode(type, el) | _encode_row(els, types)]
106✔
49
  defp _encode_row([] = done, []), do: done
22✔
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))
854✔
68
  end
69

70
  @doc false
71
  def _encode_rows([row | rows], types), do: _encode_rows(row, types, rows, types)
4,888✔
72
  def _encode_rows([] = done, _types), do: done
854✔
73

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

78
  defp _encode_rows([], [], rows, types), do: _encode_rows(rows, types)
4,888✔
79

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

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

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

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

109
  defp encoding_type({:datetime = d, "UTC"}), do: d
2✔
110

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

115
  defp encoding_type({:fixed_string, _len} = t), do: t
311✔
116

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

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

126
  defp encoding_type({:array = a, t}), do: {a, encoding_type(t)}
548✔
127

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

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

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

140
  defp encoding_type({:nullable = n, t}), do: {n, encoding_type(t)}
113✔
141
  defp encoding_type({:low_cardinality, t}), do: encoding_type(t)
202✔
142

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

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

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

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

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

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

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

170
  defp encoding_type({:simple_aggregate_function, _f, t}), do: encoding_type(t)
1✔
171

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

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

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

183
  def encode(:varint, i) when is_integer(i) and i < 128, do: i
7,842✔
184
  def encode(:varint, i) when is_integer(i), do: encode_varint_cont(i)
14✔
185

186
  def encode(:string, str) do
187
    case str do
5,893✔
188
      _ when is_binary(str) -> [encode(:varint, byte_size(str)) | str]
5,859✔
189
      _ when is_list(str) -> [encode(:varint, IO.iodata_length(str)) | str]
25✔
190
      nil -> 0
3✔
191
    end
192
  end
193

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

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

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

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

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

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

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

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

229
  for size <- [16, 32, 64, 128, 256] do
230
    unsigned_max = (1 <<< size) - 1
231
    signed_min = -(1 <<< (size - 1))
232
    signed_max = (1 <<< (size - 1)) - 1
233
    uint = :"u#{size}"
234
    int = :"i#{size}"
235

236
    def encode(unquote(uint), u) when is_integer(u) and u >= 0 and u <= unquote(unsigned_max) do
237
      <<u::unquote(size)-little>>
147✔
238
    end
239

240
    def encode(unquote(int), i)
241
        when is_integer(i) and i >= unquote(signed_min) and i <= unquote(signed_max) do
242
      <<i::unquote(size)-little-signed>>
153✔
243
    end
244

245
    def encode(unquote(uint), nil), do: <<0::unquote(size)>>
3✔
246
    def encode(unquote(int), nil), do: <<0::unquote(size)>>
3✔
247

248
    def encode(unquote(uint), term) do
249
      raise ArgumentError, "invalid UInt#{unquote(size)}: #{inspect(term)}"
15✔
250
    end
251

252
    def encode(unquote(int), term) do
253
      raise ArgumentError, "invalid Int#{unquote(size)}: #{inspect(term)}"
15✔
254
    end
255
  end
256

257
  for size <- [32, 64] do
258
    type = :"f#{size}"
259

260
    def encode(unquote(type), f) when is_number(f) do
261
      <<f::unquote(size)-little-signed-float>>
1,298✔
262
    end
263

264
    def encode(unquote(type), nil), do: <<0::unquote(size)>>
4✔
265
  end
266

267
  def encode({:decimal, precision, scale}, decimal) do
268
    type =
4✔
269
      case decimal_size(precision) do
270
        32 -> :decimal32
1✔
271
        64 -> :decimal64
1✔
272
        128 -> :decimal128
1✔
273
        256 -> :decimal256
1✔
274
      end
275

276
    encode({type, scale}, decimal)
4✔
277
  end
278

279
  for size <- [32, 64, 128, 256] do
280
    type = :"decimal#{size}"
281

282
    def encode({unquote(type), scale} = t, %Decimal{sign: sign, coef: coef, exp: exp} = d) do
283
      cond do
29✔
284
        scale == -exp ->
285
          i = sign * coef
20✔
286
          <<i::unquote(size)-little>>
20✔
287

288
        exp >= 0 ->
9✔
289
          i = sign * coef * Integer.pow(10, exp + scale)
1✔
290
          <<i::unquote(size)-little>>
1✔
291

292
        true ->
8✔
293
          encode(t, Decimal.round(d, scale))
8✔
294
      end
295
    end
296

297
    def encode({unquote(type), _scale}, nil), do: <<0::unquote(size)>>
4✔
298
  end
299

300
  def encode(:boolean, true), do: 1
990✔
301
  def encode(:boolean, false), do: 0
1,000✔
302
  def encode(:boolean, nil), do: 0
1✔
303

304
  def encode({:array, type}, [_ | _] = l) do
1,954✔
305
    [encode(:varint, length(l)) | encode_many(l, type)]
306
  end
307

308
  def encode({:array, _type}, []), do: 0
287✔
309
  def encode({:array, _type}, nil), do: 0
4✔
310

311
  def encode({:map, k, v}, [_ | _] = m) do
12✔
312
    [encode(:varint, length(m)) | encode_many_kv(m, k, v)]
313
  end
314

315
  def encode({:map, _k, _v} = t, m) when is_map(m), do: encode(t, Map.to_list(m))
14✔
316
  def encode({:map, _k, _v}, []), do: 0
4✔
317
  def encode({:map, _k, _v}, nil), do: 0
1✔
318

319
  def encode({:tuple, _types} = t, v) when is_tuple(v) do
320
    encode(t, Tuple.to_list(v))
11✔
321
  end
322

323
  def encode({:tuple, types}, values) when is_list(types) and is_list(values) do
324
    encode_row(values, types)
11✔
325
  end
326

327
  def encode({:tuple, types}, nil) when is_list(types) do
328
    Enum.map(types, fn type -> encode(type, nil) end)
1✔
329
  end
330

331
  def encode({:variant, _types}, nil), do: 255
3✔
332

333
  def encode({:variant, types}, value) do
334
    try_encode_variant(types, 0, value)
8✔
335
  end
336

337
  def encode(:datetime, %NaiveDateTime{} = datetime) do
338
    {seconds, _micros} = NaiveDateTime.to_gregorian_seconds(datetime)
17✔
339
    <<seconds - @epoch_gregorian_seconds::32-little>>
17✔
340
  end
341

342
  def encode(:datetime, %DateTime{} = datetime) do
343
    <<DateTime.to_unix(datetime, :second)::32-little>>
5✔
344
  end
345

346
  def encode(:datetime, nil), do: <<0::32>>
1✔
347

348
  def encode({:datetime64, time_unit}, %NaiveDateTime{} = datetime) do
349
    {seconds, micros} = NaiveDateTime.to_gregorian_seconds(datetime)
4✔
350

351
    <<(seconds - @epoch_gregorian_seconds) * time_unit + div(micros * time_unit, 1_000_000)::64-little-signed>>
4✔
352
  end
353

354
  def encode({:datetime64, time_unit}, %DateTime{} = datetime) do
355
    <<DateTime.to_unix(datetime, time_unit)::64-little-signed>>
5✔
356
  end
357

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

360
  def encode(:date, %Date{} = date) do
361
    <<Date.to_gregorian_days(date) - @epoch_gregorian_days::16-little>>
14✔
362
  end
363

364
  def encode(:date, nil), do: <<0::16>>
1✔
365

366
  def encode(:date32, %Date{} = date) do
367
    <<Date.to_gregorian_days(date) - @epoch_gregorian_days::32-little-signed>>
8✔
368
  end
369

370
  def encode(:date32, nil), do: <<0::32>>
1✔
371

372
  def encode(:time, %Time{} = time) do
373
    {s, _micros} = Time.to_seconds_after_midnight(time)
107✔
374
    <<s::32-little-signed>>
107✔
375
  end
376

377
  def encode(:time, nil), do: <<0::32>>
1✔
378

379
  def encode({:time64, time_unit}, %Time{} = time) do
380
    {s, micros} = Time.to_seconds_after_midnight(time)
117✔
381

382
    micros_as_ticks =
117✔
383
      cond do
384
        time_unit < 1_000_000 -> div(micros, div(1_000_000, time_unit))
79✔
385
        time_unit == 1_000_000 -> micros
38✔
386
        true -> micros * div(time_unit, 1_000_000)
22✔
387
      end
388

389
    ticks = s * time_unit + micros_as_ticks
117✔
390
    <<ticks::64-little-signed>>
117✔
391
  end
392

393
  def encode({:time64, _time_unit}, nil), do: <<0::64>>
1✔
394

395
  def encode(:uuid, <<u1::64, u2::64>>), do: <<u1::64-little, u2::64-little>>
12✔
396

397
  def encode(
398
        :uuid,
399
        <<a1, a2, a3, a4, a5, a6, a7, a8, ?-, b1, b2, b3, b4, ?-, c1, c2, c3, c4, ?-, d1, d2, d3,
400
          d4, ?-, e1, e2, e3, e4, e5, e6, e7, e8, e9, e10, e11, e12>>
401
      ) do
402
    raw =
2✔
403
      <<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,
404
        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,
405
        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,
406
        d(e8)::4, d(e9)::4, d(e10)::4, d(e11)::4, d(e12)::4>>
407

408
    encode(:uuid, raw)
2✔
409
  end
410

411
  def encode(:uuid, nil), do: <<0::128>>
1✔
412

413
  def encode(:ipv4, {a, b, c, d}), do: [d, c, b, a]
6✔
414
  def encode(:ipv4, nil), do: <<0::32>>
1✔
415

416
  def encode(:ipv6, {b1, b2, b3, b4, b5, b6, b7, b8}) do
417
    <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>
6✔
418
  end
419

420
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
1✔
421
  def encode(:ipv6, nil), do: <<0::128>>
1✔
422

423
  def encode(:point, {x, y}), do: [encode(:f64, x) | encode(:f64, y)]
22✔
424
  def encode(:point, nil), do: <<0::128>>
1✔
425
  def encode(:ring, points), do: encode({:array, :point}, points)
1✔
426
  def encode(:polygon, rings), do: encode({:array, :ring}, rings)
1✔
427
  def encode(:multipolygon, polygons), do: encode({:array, :polygon}, polygons)
1✔
428

429
  # TODO
430
  def encode(:dynamic, value) do
431
    case value do
12✔
432
      _ when is_binary(value) -> [0x15 | encode(:string, value)]
2✔
433
      _ when is_integer(value) and value >= 0 -> [0x04 | encode(:u64, value)]
3✔
434
      _ when is_integer(value) -> [0x0A | encode(:i64, value)]
1✔
435
      _ when is_float(value) -> [0x0E | encode(:f64, value)]
2✔
436
      %Date{} -> [0x0F | encode(:date, value)]
2✔
437
      %NaiveDateTime{} -> [0x11 | encode(:datetime, value)]
1✔
438
      [] -> [0x1E, 0x00]
1✔
439
    end
440
  end
441

442
  # TODO enum8 and enum16 nil
443
  for size <- [8, 16] do
444
    enum_t = :"enum#{size}"
445
    int_t = :"i#{size}"
446

447
    def encode({unquote(enum_t), mapping}, e) do
448
      i =
12✔
449
        case e do
450
          _ when is_integer(e) ->
451
            e
2✔
452

453
          _ when is_binary(e) ->
454
            case Map.fetch(mapping, e) do
10✔
455
              {:ok, res} ->
456
                res
9✔
457

458
              :error ->
459
                raise ArgumentError,
1✔
460
                      "enum value #{inspect(e)} not found in mapping: #{inspect(mapping)}"
461
            end
462
        end
463

464
      encode(unquote(int_t), i)
11✔
465
    end
466
  end
467

468
  def encode({:nullable, _type}, nil), do: 1
866✔
469

470
  def encode({:nullable, type}, value) do
471
    case encode(type, value) do
832✔
472
      e when is_list(e) or is_binary(e) -> [0 | e]
831✔
473
      e -> [0, e]
1✔
474
    end
475
  end
476

477
  defp encode_varint_cont(i) when i < 128, do: <<i>>
14✔
478

479
  defp encode_varint_cont(i) do
19✔
480
    [(i &&& 0b0111_1111) ||| 0b1000_0000 | encode_varint_cont(i >>> 7)]
481
  end
482

483
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
8,585✔
484
  defp encode_many([] = done, _type), do: done
1,959✔
485

486
  defp encode_many_kv([{key, value} | rest], key_type, value_type) do
16✔
487
    [
488
      encode(key_type, key),
489
      encode(value_type, value)
490
      | encode_many_kv(rest, key_type, value_type)
491
    ]
492
  end
493

494
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
12✔
495

496
  # TODO find a better way than try/rescue
497
  defp try_encode_variant([type | types], idx, value) do
498
    try do
13✔
499
      encode(type, value)
13✔
500
    else
501
      encoded -> [idx | encoded]
7✔
502
    rescue
503
      _e -> try_encode_variant(types, idx + 1, value)
6✔
504
    end
505
  end
506

507
  defp try_encode_variant([], _idx, value) do
508
    raise ArgumentError, "no matching type found for encoding #{inspect(value)} as Variant"
1✔
509
  end
510

511
  @compile {:inline, d: 1}
512

513
  defp d(?0), do: 0
1✔
514
  defp d(?1), do: 1
1✔
515
  defp d(?2), do: 2
3✔
516
  defp d(?3), do: 3
1✔
517
  defp d(?4), do: 4
1✔
518
  defp d(?5), do: 5
3✔
519
  defp d(?6), do: 6
1✔
520
  defp d(?7), do: 7
1✔
521
  defp d(?8), do: 8
1✔
522
  defp d(?9), do: 9
1✔
523
  defp d(?A), do: 10
1✔
524
  defp d(?B), do: 11
1✔
525
  defp d(?C), do: 12
1✔
526
  defp d(?D), do: 13
1✔
527
  defp d(?E), do: 14
1✔
528
  defp d(?F), do: 15
1✔
529
  defp d(?a), do: 10
1✔
530
  defp d(?b), do: 11
1✔
531
  defp d(?c), do: 12
1✔
532
  defp d(?d), do: 13
1✔
533
  defp d(?e), do: 14
1✔
534
  defp d(?f), do: 15
1✔
535

536
  varints = [
537
    {_pattern = quote(do: <<0::1, v1::7>>), _value = quote(do: v1)},
538
    {quote(do: <<1::1, v1::7, 0::1, v2::7>>), quote(do: (v2 <<< 7) + v1)},
539
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 0::1, v3::7>>),
540
     quote(do: (v3 <<< 14) + (v2 <<< 7) + v1)},
541
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 0::1, v4::7>>),
542
     quote(do: (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
543
    {quote(do: <<1::1, v1::7, 1::1, v2::7, 1::1, v3::7, 1::1, v4::7, 0::1, v5::7>>),
544
     quote(do: (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
545
    {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>>),
546
     quote(do: (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1)},
547
    {quote do
548
       <<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,
549
         v7::7>>
550
     end,
551
     quote do
552
       (v7 <<< 42) + (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) + (v2 <<< 7) + v1
553
     end},
554
    {quote do
555
       <<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,
556
         v7::7, 0::1, v8::7>>
557
     end,
558
     quote do
559
       (v8 <<< 49) + (v7 <<< 42) + (v6 <<< 35) + (v5 <<< 28) + (v4 <<< 21) + (v3 <<< 14) +
560
         (v2 <<< 7) + v1
561
     end}
562
  ]
563

564
  @doc false
565
  @spec decode_header(binary()) ::
566
          {:ok, names :: [String.t()], types :: [term], rest :: binary} | :more
567
  def decode_header(row_binary_with_names_and_types)
568

569
  for {pattern, value} <- varints do
570
    def decode_header(<<unquote(pattern), rest::bytes>>) do
571
      decode_header_names(rest, unquote(value), unquote(value), _acc = [])
36✔
572
    end
573
  end
574

575
  def decode_header(<<_bin::bytes>>) do
1✔
576
    :more
577
  end
578

579
  defp decode_header_names(<<rest::bytes>>, 0, count, names) do
580
    decode_header_types(rest, count, _acc = [], :lists.reverse(names))
21✔
581
  end
582

583
  for {pattern, value} <- varints do
584
    defp decode_header_names(
585
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
586
           left,
587
           count,
588
           acc
589
         ) do
590
      decode_header_names(rest, left - 1, count, [name | acc])
78✔
591
    end
592
  end
593

594
  defp decode_header_names(<<_bin::bytes>>, _left, _count, _acc) do
15✔
595
    :more
596
  end
597

598
  defp decode_header_types(<<rest::bytes>>, 0, types, names) do
599
    {:ok, names, decoding_types_reverse(types), rest}
1✔
600
  end
601

602
  for {pattern, value} <- varints do
603
    defp decode_header_types(
604
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
605
           count,
606
           acc,
607
           names
608
         ) do
609
      decode_header_types(rest, count - 1, [type | acc], names)
24✔
610
    end
611
  end
612

613
  defp decode_header_types(<<_bin::bytes>>, _count, _acc, _names) do
20✔
614
    :more
615
  end
616

617
  @doc """
618
  Decodes [RowBinaryWithNamesAndTypes](https://clickhouse.com/docs/en/interfaces/formats/RowBinaryWithNamesAndTypes) into rows.
619

620
  Example:
621

622
      iex> decode_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
623
      [[2]]
624

625
  """
626
  def decode_rows(row_binary_with_names_and_types)
627
  def decode_rows(<<>>), do: []
1✔
628

629
  for {pattern, value} <- varints do
630
    def decode_rows(<<unquote(pattern), rest::bytes>>) do
631
      skip_names(rest, unquote(value), unquote(value))
5✔
632
    end
633
  end
634

635
  @doc """
636
  Same as `decode_rows/1` but the first element is a list of column names.
637

638
  Example:
639

640
      iex> decode_names_and_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
641
      [["1+1"], [2]]
642

643
  """
644
  def decode_names_and_rows(row_binary_with_names_and_types)
645

646
  for {pattern, value} <- varints do
647
    def decode_names_and_rows(<<unquote(pattern), rest::bytes>>) do
648
      decode_names(rest, unquote(value), unquote(value), _acc = [])
3,030✔
649
    end
650
  end
651

652
  @doc """
653
  Decodes [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) into rows.
654

655
  Example:
656

657
      iex> decode_rows(<<1>>, ["UInt8"])
658
      [[1]]
659

660
  """
661
  def decode_rows(row_binary, types)
662
  def decode_rows(<<>>, _types), do: []
1✔
663

664
  def decode_rows(<<data::bytes>>, types) do
665
    decode_rows!(data, decoding_types(types))
435✔
666
  end
667

668
  defp decode_rows!(data, types) do
669
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
3,448✔
670

671
    case state do
3,431✔
672
      nil ->
673
        rows
3,429✔
674

675
      {:cont, types_rest, row} ->
676
        raise ArgumentError, """
2✔
677
        incomplete RowBinary data: ran out of bytes while decoding
678

679
        Expected to decode: #{inspect(types_rest)}
680
        Remaining bytes: #{byte_size(remaining_data)} bytes
2✔
681
        Partial row: #{inspect(row)}
682
        Completed rows: #{length(rows)}
2✔
683
        """
684
    end
685
  end
686

687
  @doc false
688
  def decode_rows_continue(<<data::bytes>>, types, state) do
689
    case state do
201,104✔
690
      {:cont, types_rest, row} -> decode_rows(types_rest, data, row, [], types)
201,046✔
691
      nil -> decode_rows(types, data, [], [], types)
58✔
692
    end
693
  end
694

695
  @doc false
696
  def decoding_types([type | types]) do
551✔
697
    [decoding_type(type) | decoding_types(types)]
698
  end
699

700
  def decoding_types([] = done), do: done
506✔
701

702
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
3,015✔
703

704
  defp decoding_types_reverse([type | types], acc) do
705
    decoding_types_reverse(types, [decoding_type(type) | acc])
16,467✔
706
  end
707

708
  defp decoding_types_reverse([], acc), do: acc
3,015✔
709

710
  defp decoding_type(t) when is_binary(t) do
711
    decoding_type(Ch.Types.decode(t))
16,782✔
712
  end
713

714
  defp decoding_type(t)
715
       when t in [
716
              :string,
717
              :json,
718
              :dynamic,
719
              :boolean,
720
              :uuid,
721
              :date,
722
              :date32,
723
              :time,
724
              :time64,
725
              :ipv4,
726
              :ipv6,
727
              :point,
728
              :nothing
729
            ],
730
       do: t
3,226✔
731

732
  defp decoding_type({:datetime, _tz} = t), do: t
15✔
733
  defp decoding_type({:fixed_string, _len} = t), do: t
423✔
734

735
  for size <- [8, 16, 32, 64, 128, 256] do
736
    defp decoding_type(unquote(:"u#{size}") = u), do: u
12,185✔
737
    defp decoding_type(unquote(:"i#{size}") = i), do: i
416✔
738
  end
739

740
  for size <- [32, 64] do
741
    defp decoding_type(unquote(:"f#{size}") = f), do: f
455✔
742
  end
743

744
  defp decoding_type(:datetime = t), do: {t, _tz = nil}
13✔
745

746
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
1,337✔
747

748
  defp decoding_type({:tuple = t, ts}) do
319✔
749
    {t, Enum.map(ts, &decoding_type/1)}
750
  end
751

752
  defp decoding_type({:variant = v, ts}) do
15✔
753
    {v, Enum.map(ts, &decoding_type/1)}
754
  end
755

756
  defp decoding_type({:map = m, kt, vt}) do
757
    {m, decoding_type(kt), decoding_type(vt)}
327✔
758
  end
759

760
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
545✔
761
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
277✔
762

763
  defp decoding_type({:decimal = t, p, s}), do: {t, decimal_size(p), s}
358✔
764
  defp decoding_type({:decimal32, s}), do: {:decimal, 32, s}
1✔
765
  defp decoding_type({:decimal64, s}), do: {:decimal, 64, s}
1✔
766
  defp decoding_type({:decimal128, s}), do: {:decimal, 128, s}
1✔
767
  defp decoding_type({:decimal256, s}), do: {:decimal, 256, s}
1✔
768

769
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
6✔
770
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
316✔
771

772
  defp decoding_type({:time64 = t, p}), do: {t, time_unit(p)}
262✔
773

774
  defp decoding_type({e, mappings}) when e in [:enum8, :enum16] do
17✔
775
    {e, Map.new(mappings, fn {k, v} -> {v, k} end)}
34✔
776
  end
777

778
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
779

780
  defp decoding_type(:ring), do: {:array, :point}
1✔
781
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
1✔
782
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
1✔
783

784
  defp decoding_type(type) do
785
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
1✔
786
  end
787

788
  defp skip_names(<<rest::bytes>>, 0, count), do: decode_types(rest, count, _acc = [])
5✔
789

790
  for {pattern, value} <- varints do
791
    defp skip_names(<<unquote(pattern), _::size(unquote(value))-bytes, rest::bytes>>, left, count) do
792
      skip_names(rest, left - 1, count)
75✔
793
    end
794
  end
795

796
  defp decode_names(<<rest::bytes>>, 0, count, names) do
3,030✔
797
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
798
  end
799

800
  for {pattern, value} <- varints do
801
    defp decode_names(
802
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
803
           left,
804
           count,
805
           acc
806
         ) do
807
      decode_names(rest, left - 1, count, [name | acc])
16,447✔
808
    end
809
  end
810

811
  defp decode_types(<<>>, 0, _types), do: []
21✔
812

813
  defp decode_types(<<rest::bytes>>, 0, types) do
814
    decode_rows!(rest, decoding_types_reverse(types))
3,014✔
815
  end
816

817
  for {pattern, value} <- varints do
818
    defp decode_types(
819
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
820
           count,
821
           acc
822
         ) do
823
      decode_types(rest, count - 1, [type | acc])
16,522✔
824
    end
825
  end
826

827
  @compile inline: [decode_string_decode_rows: 5]
828

829
  for {pattern, size} <- varints do
830
    defp decode_string_decode_rows(
831
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
832
           types_rest,
833
           row,
834
           rows,
835
           types
836
         ) do
837
      decode_rows(types_rest, bin, [s | row], rows, types)
9,011✔
838
    end
839
  end
840

841
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
842
    to_be_continued(rows, bin, [:string | types_rest], row)
200,144✔
843
  end
844

845
  @compile inline: [decode_string_json_decode_rows: 5]
846

847
  for {pattern, size} <- varints do
848
    defp decode_string_json_decode_rows(
849
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
850
           types_rest,
851
           row,
852
           rows,
853
           types
854
         ) do
855
      decode_rows(types_rest, bin, [JSON.decode!(s) | row], rows, types)
43✔
856
    end
857
  end
858

859
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
860
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
861
  end
862

863
  @compile inline: [decode_array_decode_rows: 6]
864
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
865
    decode_rows(types_rest, bin, [[] | row], rows, types)
432✔
866
  end
867

868
  for {pattern, size} <- varints do
869
    defp decode_array_decode_rows(
870
           <<unquote(pattern), bin::bytes>>,
871
           type,
872
           types_rest,
873
           row,
874
           rows,
875
           types
876
         ) do
877
      decode_rows(
2,665✔
878
        [type, {:array_items, unquote(size) - 1, type, [], row} | types_rest],
879
        bin,
880
        [],
881
        rows,
882
        types
883
      )
884
    end
885
  end
886

887
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
888
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
889
  end
890

891
  @compile inline: [decode_map_decode_rows: 7]
892
  defp decode_map_decode_rows(
893
         <<0, bin::bytes>>,
894
         _key_type,
895
         _value_type,
896
         types_rest,
897
         row,
898
         rows,
899
         types
900
       ) do
901
    decode_rows(types_rest, bin, [%{} | row], rows, types)
47✔
902
  end
903

904
  for {pattern, size} <- varints do
905
    defp decode_map_decode_rows(
906
           <<unquote(pattern), bin::bytes>>,
907
           key_type,
908
           value_type,
909
           types_rest,
910
           row,
911
           rows,
912
           types
913
         ) do
914
      decode_rows(
281✔
915
        [
916
          key_type,
917
          value_type,
918
          {:map_items, unquote(size) - 1, key_type, value_type, %{}, row}
919
          | types_rest
920
        ],
921
        bin,
922
        [],
923
        rows,
924
        types
925
      )
926
    end
927
  end
928

929
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
930
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
931
  end
932

933
  # https://clickhouse.com/docs/sql-reference/data-types/data-types-binary-encoding
934
  dynamic_types = [
935
    nothing: 0x00,
936
    u8: 0x01,
937
    u16: 0x02,
938
    u32: 0x03,
939
    u64: 0x04,
940
    u128: 0x05,
941
    u256: 0x06,
942
    i8: 0x07,
943
    i16: 0x08,
944
    i32: 0x09,
945
    i64: 0x0A,
946
    i128: 0x0B,
947
    i256: 0x0C,
948
    f32: 0x0D,
949
    f64: 0x0E,
950
    date: 0x0F,
951
    date32: 0x10,
952
    string: 0x15,
953
    uuid: 0x1D,
954
    ipv4: 0x28,
955
    ipv6: 0x29,
956
    boolean: 0x2D
957
  ]
958

959
  # TODO compile inline?
960

961
  for {type, code} <- dynamic_types do
962
    defp decode_dynamic(
963
           <<unquote(code), rest::bytes>>,
964
           dynamic,
965
           types_rest,
966
           row,
967
           rows,
968
           types
969
         ) do
970
      decode_dynamic_continue(rest, [unquote(type) | dynamic], types_rest, row, rows, types)
120✔
971
    end
972
  end
973

974
  # DateTime 0x11
975
  defp decode_dynamic(<<0x11, rest::bytes>>, dynamic, types_rest, row, rows, types) do
976
    decode_dynamic_continue(rest, [{:datetime, nil} | dynamic], types_rest, row, rows, types)
2✔
977
  end
978

979
  # DateTime(time_zone) 0x12 <var_uint_time_zone_name_size><time_zone_name_data>
980
  for {pattern, size} <- varints do
981
    defp decode_dynamic(
982
           <<0x12, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
983
           dynamic,
984
           types_rest,
985
           row,
986
           rows,
987
           types
988
         ) do
989
      decode_dynamic_continue(rest, [{:datetime, tz} | dynamic], types_rest, row, rows, types)
1✔
990
    end
991
  end
992

993
  # DateTime64(P) 0x13 <uint8_precision>
994
  defp decode_dynamic(
995
         <<0x13, precision, rest::bytes>>,
996
         dynamic,
997
         types_rest,
998
         row,
999
         rows,
1000
         types
1001
       ) do
1002
    decode_dynamic_continue(
1✔
1003
      rest,
1004
      [decoding_type({:datetime64, precision}) | dynamic],
1005
      types_rest,
1006
      row,
1007
      rows,
1008
      types
1009
    )
1010
  end
1011

1012
  # DateTime64(P, time_zone) 0x14 <uint8_precision><var_uint_time_zone_name_size><time_zone_name_data>
1013
  for {pattern, size} <- varints do
1014
    defp decode_dynamic(
1015
           <<0x14, precision, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1016
           dynamic,
1017
           types_rest,
1018
           row,
1019
           rows,
1020
           types
1021
         ) do
1022
      decode_dynamic_continue(
1✔
1023
        rest,
1024
        [decoding_type({:datetime64, precision, tz}) | dynamic],
1025
        types_rest,
1026
        row,
1027
        rows,
1028
        types
1029
      )
1030
    end
1031
  end
1032

1033
  # FixedString(N) 0x16 <var_uint_size>
1034
  for {pattern, size} <- varints do
1035
    defp decode_dynamic(
1036
           <<0x16, unquote(pattern), rest::bytes>>,
1037
           dynamic,
1038
           types_rest,
1039
           row,
1040
           rows,
1041
           types
1042
         ) do
1043
      decode_dynamic_continue(
2✔
1044
        rest,
1045
        [{:fixed_string, unquote(size)} | dynamic],
1046
        types_rest,
1047
        row,
1048
        rows,
1049
        types
1050
      )
1051
    end
1052
  end
1053

1054
  # Decimal32(P, S) 0x19 <uint8_precision><uint8_scale>
1055
  # Decimal64(P, S) 0x1A <uint8_precision><uint8_scale>
1056
  # Decimal128(P, S) 0x1B <uint8_precision><uint8_scale>
1057
  # Decimal256(P, S) 0x1C <uint8_precision><uint8_scale>
1058
  for {code, size} <- [{0x19, 32}, {0x1A, 64}, {0x1B, 128}, {0x1C, 256}] do
1059
    defp decode_dynamic(
1060
           <<unquote(code), _precision, scale, rest::bytes>>,
1061
           dynamic,
1062
           types_rest,
1063
           row,
1064
           rows,
1065
           types
1066
         ) do
1067
      decode_dynamic_continue(
4✔
1068
        rest,
1069
        [{:decimal, unquote(size), scale} | dynamic],
1070
        types_rest,
1071
        row,
1072
        rows,
1073
        types
1074
      )
1075
    end
1076
  end
1077

1078
  # Array(T) 0x1E <nested_type_encoding>
1079
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1080
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
29✔
1081
  end
1082

1083
  # Nullable(T)        0x23 <nested_type_encoding>
1084
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1085
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
5✔
1086
  end
1087

1088
  # LowCardinality(T) 0x26 <nested_type_encoding>
1089
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1090
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
2✔
1091
  end
1092

1093
  # TODO
1094
  # 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>
1095
  # 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>
1096
  # Tuple(T1, ..., TN)        0x1F <var_uint_number_of_elements><nested_type_encoding_1>...<nested_type_encoding_N>
1097
  # 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>
1098
  # Set        0x21
1099
  # Interval        0x22 <interval_kind> (see interval kind binary encoding)
1100
  # Function        0x24<var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N><return_type_encoding>
1101
  # 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)
1102
  # Map(K, V)        0x27<key_type_encoding><value_type_encoding>
1103
  # Variant(T1, ..., TN)        0x2A<var_uint_number_of_variants><variant_type_encoding_1>...<variant_type_encoding_N>
1104
  # Dynamic(max_types=N)        0x2B<uint8_max_types>
1105
  # Custom type (Ring, Polygon, etc)        0x2C<var_uint_type_name_size><type_name_data>
1106
  # 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)
1107
  # 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>
1108
  # 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>...
1109

1110
  unsupported_dynamic_types = %{
1111
    "Enum8" => 0x17,
1112
    "Enum16" => 0x18,
1113
    "Tuple" => 0x1F,
1114
    "TupleWithNames" => 0x20,
1115
    "Set" => 0x21,
1116
    "Interval" => 0x22,
1117
    "Function" => 0x24,
1118
    "AggregateFunction" => 0x25,
1119
    "Map" => 0x27,
1120
    "Variant" => 0x2A,
1121
    "Dynamic" => 0x2B,
1122
    "CustomType" => 0x2C,
1123
    "SimpleAggregateFunction" => 0x2E,
1124
    "Nested" => 0x2F,
1125
    "JSON" => 0x30
1126
  }
1127

1128
  for {type, code} <- unsupported_dynamic_types do
1129
    defp decode_dynamic(<<unquote(code), _::bytes>>, _dynamic, _types_rest, _row, _rows, _types) do
1130
      raise ArgumentError, "unsupported dynamic type #{unquote(type)}"
9✔
1131
    end
1132
  end
1133

1134
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1135
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1136
  end
1137

1138
  @compile inline: [decode_dynamic_continue: 6]
1139

1140
  defp decode_dynamic_continue(<<rest::bytes>>, dynamic, types_rest, row, rows, types) do
1141
    continue? =
103✔
1142
      case dynamic do
1143
        [:array | _] -> true
29✔
1144
        [:nullable | _] -> true
5✔
1145
        [:low_cardinality | _] -> true
2✔
1146
        _ -> false
103✔
1147
      end
1148

1149
    if continue? do
103✔
1150
      decode_dynamic(rest, dynamic, types_rest, row, rows, types)
36✔
1151
    else
1152
      type = build_dynamic_type(:lists.reverse(dynamic))
103✔
1153
      decode_rows([type | types_rest], rest, row, rows, types)
103✔
1154
    end
1155
  end
1156

1157
  defp build_dynamic_type([type]), do: type
131✔
1158

1159
  defp build_dynamic_type(type) do
1160
    case type do
32✔
1161
      [:array | rest] -> {:array, build_dynamic_type(rest)}
25✔
1162
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
5✔
1163
      [:low_cardinality | rest] -> build_dynamic_type(rest)
2✔
1164
    end
1165
  end
1166

1167
  simple_types = %{
1168
    u8: %{pattern: quote(do: <<u>>), value: quote(do: u)},
1169
    u16: %{pattern: quote(do: <<u::16-little>>), value: quote(do: u)},
1170
    u32: %{pattern: quote(do: <<u::32-little>>), value: quote(do: u)},
1171
    u64: %{pattern: quote(do: <<u::64-little>>), value: quote(do: u)},
1172
    u128: %{pattern: quote(do: <<u::128-little>>), value: quote(do: u)},
1173
    u256: %{pattern: quote(do: <<u::256-little>>), value: quote(do: u)},
1174
    i8: %{pattern: quote(do: <<i::signed>>), value: quote(do: i)},
1175
    i16: %{pattern: quote(do: <<i::16-little-signed>>), value: quote(do: i)},
1176
    i32: %{pattern: quote(do: <<i::32-little-signed>>), value: quote(do: i)},
1177
    i64: %{pattern: quote(do: <<i::64-little-signed>>), value: quote(do: i)},
1178
    i128: %{pattern: quote(do: <<i::128-little-signed>>), value: quote(do: i)},
1179
    i256: %{pattern: quote(do: <<i::256-little-signed>>), value: quote(do: i)},
1180
    f32: [
1181
      %{pattern: quote(do: <<f::32-little-float>>), value: quote(do: f)},
1182
      %{pattern: quote(do: <<_nan_or_inf::32>>), value: quote(do: nil)}
1183
    ],
1184
    f64: [
1185
      %{pattern: quote(do: <<f::64-little-float>>), value: quote(do: f)},
1186
      %{pattern: quote(do: <<_nan_or_inf::64>>), value: quote(do: nil)}
1187
    ],
1188
    uuid: %{
1189
      pattern: quote(do: <<u1::64-little, u2::64-little>>),
1190
      value: quote(do: <<u1::64, u2::64>>)
1191
    },
1192
    date: %{
1193
      pattern: quote(do: <<d::16-little>>),
1194
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1195
    },
1196
    date32: %{
1197
      pattern: quote(do: <<d::32-little-signed>>),
1198
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1199
    },
1200
    time: %{
1201
      pattern: quote(do: <<s::32-little-signed>>),
1202
      value: quote(do: time_after_midnight(s, 1))
1203
    },
1204
    boolean: [
1205
      %{pattern: quote(do: <<0>>), value: quote(do: false)},
1206
      %{pattern: quote(do: <<1>>), value: quote(do: true)},
1207
      %{pattern: quote(do: <<b>>), value: quote(do: raise("invalid boolean value: #{b}"))}
1208
    ],
1209
    ipv4: %{
1210
      pattern: quote(do: <<b4, b3, b2, b1>>),
1211
      value: quote(do: {b1, b2, b3, b4})
1212
    },
1213
    ipv6: %{
1214
      pattern: quote(do: <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>),
1215
      value: quote(do: {b1, b2, b3, b4, b5, b6, b7, b8})
1216
    },
1217
    point: %{
1218
      pattern: quote(do: <<x::64-little-float, y::64-little-float>>),
1219
      value: quote(do: {x, y})
1220
    }
1221
  }
1222

1223
  for {type, clauses} <- simple_types do
1224
    fun = :"decode_#{type}_decode_rows"
1225
    @compile inline: [{fun, 5}]
1226

1227
    for %{pattern: pattern, value: value} <- List.wrap(clauses) do
1228
      defp unquote(fun)(<<unquote(pattern), rest::bytes>>, types_rest, row, rows, types) do
1229
        decode_rows(types_rest, rest, [unquote(value) | row], rows, types)
2,021,813✔
1230
      end
1231
    end
1232

1233
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1234
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
583✔
1235
    end
1236
  end
1237

1238
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1239
    case type do
2,256,953✔
1240
      :u8 ->
1241
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
6,021✔
1242

1243
      :u16 ->
1244
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
10,295✔
1245

1246
      :u32 ->
1247
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
124✔
1248

1249
      :u64 ->
1250
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,000,230✔
1251

1252
      :u128 ->
1253
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
71✔
1254

1255
      :u256 ->
1256
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
104✔
1257

1258
      :i8 ->
1259
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
173✔
1260

1261
      :i16 ->
1262
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
129✔
1263

1264
      :i32 ->
1265
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
71✔
1266

1267
      :i64 ->
1268
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
148✔
1269

1270
      :i128 ->
1271
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
80✔
1272

1273
      :i256 ->
1274
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
121✔
1275

1276
      :f32 ->
1277
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
880✔
1278

1279
      :f64 ->
1280
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
943✔
1281

1282
      :string ->
1283
        decode_string_decode_rows(bin, types_rest, row, rows, types)
209,155✔
1284

1285
      :json ->
1286
        # assuming it arrives as text and not "native" binary JSON
1287
        # i.e. assumes `settings: [output_format_binary_write_json_as_string: 1]`
1288
        # TODO
1289
        decode_string_json_decode_rows(bin, types_rest, row, rows, types)
89✔
1290

1291
      :dynamic ->
1292
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
140✔
1293

1294
      {:dynamic, dynamic} ->
1295
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1296

1297
      {:fixed_string, size} ->
1298
        case bin do
4,279✔
1299
          <<s::size(^size)-bytes, rest::bytes>> ->
1300
            decode_rows(types_rest, rest, [s | row], rows, types)
4,265✔
1301

1302
          _ ->
1303
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1304
        end
1305

1306
      :boolean ->
1307
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
2,128✔
1308

1309
      :uuid ->
1310
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
193✔
1311

1312
      :date ->
1313
        decode_date_decode_rows(bin, types_rest, row, rows, types)
173✔
1314

1315
      :date32 ->
1316
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
53✔
1317

1318
      :time ->
1319
        decode_time_decode_rows(bin, types_rest, row, rows, types)
230✔
1320

1321
      {:time64, time_unit} ->
1322
        case bin do
300✔
1323
          <<ticks::64-little-signed, bin::bytes>> ->
1324
            time = time_after_midnight(ticks, time_unit)
270✔
1325
            decode_rows(types_rest, bin, [time | row], rows, types)
265✔
1326

1327
          _ ->
1328
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1329
        end
1330

1331
      {:datetime, timezone} ->
1332
        case bin do
59✔
1333
          <<s::32-little, bin::bytes>> ->
1334
            dt = DateTime.from_unix!(s)
37✔
1335

1336
            dt =
37✔
1337
              case timezone do
1338
                nil -> DateTime.to_naive(dt)
16✔
1339
                "UTC" -> dt
15✔
1340
                _ -> DateTime.shift_zone!(dt, timezone)
6✔
1341
              end
1342

1343
            decode_rows(types_rest, bin, [dt | row], rows, types)
37✔
1344

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

1349
      {:decimal, size, scale} ->
1350
        case bin do
496✔
1351
          <<val::size(^size)-little-signed, bin::bytes>> ->
1352
            sign = if val < 0, do: -1, else: 1
378✔
1353
            d = Decimal.new(sign, abs(val), -scale)
378✔
1354
            decode_rows(types_rest, bin, [d | row], rows, types)
378✔
1355

1356
          _ ->
1357
            to_be_continued(rows, bin, [type | types_rest], row)
118✔
1358
        end
1359

1360
      {:nullable, inner_type} ->
1361
        case bin do
2,685✔
1362
          <<b, bin::bytes>> ->
1363
            case b do
2,682✔
1364
              0 -> decode_rows([inner_type | types_rest], bin, row, rows, types)
1,323✔
1365
              1 -> decode_rows(types_rest, bin, [nil | row], rows, types)
1,359✔
1366
            end
1367

1368
          _ ->
1369
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1370
        end
1371

1372
      :nothing ->
1373
        decode_rows(types_rest, bin, [nil | row], rows, types)
27✔
1374

1375
      {:array, inner_type} ->
1376
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
3,109✔
1377

1378
      {:array_items, 0, _inner_type, array_acc, original_row} ->
1379
        [value] = row
2,664✔
1380
        array = :lists.reverse([value | array_acc])
2,664✔
1381
        decode_rows(types_rest, bin, [array | original_row], rows, types)
2,664✔
1382

1383
      {:array_items, remaining, inner_type, array_acc, original_row} ->
1384
        [value] = row
8,391✔
1385

1386
        decode_rows(
8,391✔
1387
          [
1388
            inner_type,
1389
            {:array_items, remaining - 1, inner_type, [value | array_acc], original_row}
1390
            | types_rest
1391
          ],
1392
          bin,
1393
          [],
1394
          rows,
1395
          types
1396
        )
1397

1398
      {:map, key_type, value_type} ->
1399
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
334✔
1400

1401
      {:map_items, 0, _key_type, _value_type, map, original_row} ->
1402
        [value, key] = row
281✔
1403
        map = Map.put(map, key, value)
281✔
1404
        decode_rows(types_rest, bin, [map | original_row], rows, types)
281✔
1405

1406
      {:map_items, remaining, key_type, value_type, map, original_row} ->
1407
        [value, key] = row
817✔
1408

1409
        decode_rows(
817✔
1410
          [
1411
            key_type,
1412
            value_type,
1413
            {:map_items, remaining - 1, key_type, value_type, Map.put(map, key, value),
1414
             original_row}
1415
            | types_rest
1416
          ],
1417
          bin,
1418
          [],
1419
          rows,
1420
          types
1421
        )
1422

1423
      {:tuple, []} ->
NEW
1424
        decode_rows(types_rest, bin, [{} | row], rows, types)
×
1425

1426
      {:tuple, [tuple_type | remaining_types]} ->
1427
        decode_rows(
339✔
1428
          [tuple_type, {:tuple_items, remaining_types, [], row} | types_rest],
1429
          bin,
1430
          [],
1431
          rows,
1432
          types
1433
        )
1434

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

1440
      {:tuple_items, [tuple_type | remaining_types], tuple_acc, original_row} ->
1441
        [value] = row
340✔
1442

1443
        decode_rows(
340✔
1444
          [
1445
            tuple_type,
1446
            {:tuple_items, remaining_types, [value | tuple_acc], original_row}
1447
            | types_rest
1448
          ],
1449
          bin,
1450
          [],
1451
          rows,
1452
          types
1453
        )
1454

1455
      {:variant, variant_types} ->
1456
        case bin do
34✔
1457
          <<255, bin::bytes>> ->
1458
            # 255 is the variant type index for "nothing"
1459
            decode_rows(types_rest, bin, [nil | row], rows, types)
7✔
1460

1461
          # TODO varint?
1462
          <<variant_type_index::8, bin::bytes>> ->
1463
            variant_type = Enum.at(variant_types, variant_type_index)
24✔
1464
            decode_rows([variant_type | types_rest], bin, row, rows, types)
24✔
1465

1466
          _ ->
1467
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1468
        end
1469

1470
      {:datetime64, time_unit, timezone} ->
1471
        case bin do
640✔
1472
          <<s::64-little-signed, bin::bytes>> ->
1473
            dt = DateTime.from_unix!(s, time_unit)
578✔
1474

1475
            dt =
578✔
1476
              case timezone do
1477
                nil -> DateTime.to_naive(dt)
7✔
1478
                "UTC" -> dt
565✔
1479
                _ -> DateTime.shift_zone!(dt, timezone)
6✔
1480
              end
1481

1482
            decode_rows(types_rest, bin, [dt | row], rows, types)
578✔
1483

1484
          _ ->
1485
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1486
        end
1487

1488
      {:enum8, mapping} ->
1489
        case bin do
31✔
1490
          <<v::signed, bin::bytes>> ->
1491
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
30✔
1492

1493
          _ ->
1494
            to_be_continued(rows, bin, [type | types_rest], row)
1✔
1495
        end
1496

1497
      {:enum16, mapping} ->
1498
        case bin do
6✔
1499
          <<v::16-little-signed, bin::bytes>> ->
1500
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
2✔
1501

1502
          _ ->
1503
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1504
        end
1505

1506
      :ipv4 ->
1507
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
38✔
1508

1509
      :ipv6 ->
1510
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
83✔
1511

1512
      :point ->
1513
        decode_point_decode_rows(bin, types_rest, row, rows, types)
108✔
1514
    end
1515
  end
1516

1517
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1518
    rows = :lists.reverse([:lists.reverse(row) | rows])
3,485✔
1519
    {rows, empty, _no_state = nil}
3,485✔
1520
  end
1521

1522
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1523
    row = :lists.reverse(row)
2,004,099✔
1524
    decode_rows(types, bin, [], [row | rows], types)
2,004,099✔
1525
  end
1526

1527
  @compile inline: [to_be_continued: 4]
1528
  defp to_be_continued(rows, bin, types_rest, row) do
1529
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,697✔
1530
  end
1531

1532
  @compile inline: [decimal_size: 1]
1533
  # https://clickhouse.com/docs/en/sql-reference/data-types/decimal/
1534
  defp decimal_size(precision) when is_integer(precision) do
1535
    cond do
367✔
1536
      precision >= 39 -> 256
207✔
1537
      precision >= 19 -> 128
159✔
1538
      precision >= 10 -> 64
153✔
1539
      true -> 32
18✔
1540
    end
1541
  end
1542

1543
  @compile inline: [time_unit: 1]
1544
  for precision <- 0..9 do
1545
    time_unit = Integer.pow(10, precision)
1546
    defp time_unit(unquote(precision)), do: unquote(time_unit)
692✔
1547
  end
1548

1549
  @compile inline: [time_after_midnight: 2]
1550
  defp time_after_midnight(ticks, time_unit) do
1551
    if ticks >= 0 and ticks < 86400 * time_unit do
486✔
1552
      ticks |> DateTime.from_unix!(time_unit) |> DateTime.to_time()
478✔
1553
    else
1554
      # since ClickHouse supports Time64 values of [-999:59:59.999999999, 999:59:59.999999999]
1555
      # and Elixir's Time supports values of [00:00:00.000000, 23:59:59.999999]
1556
      # we raise an error when ClickHouse's Time64 value is out of Elixir's Time range
1557
      raise ArgumentError,
8✔
1558
            "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✔
1559

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

© 2026 Coveralls, Inc