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

plausible / ch / 6dfd82929fdb461dfa76f074a9a0617e7f01bd34-PR-320

20 Apr 2026 08:50PM UTC coverage: 91.584% (-0.008%) from 91.592%
6dfd82929fdb461dfa76f074a9a0617e7f01bd34-PR-320

Pull #320

github

ruslandoga
changelog
Pull Request #320: improve naive datetime decoding

11 of 11 new or added lines in 1 file covered. (100.0%)

2 existing lines in 1 file now uncovered.

925 of 1010 relevant lines covered (91.58%)

79724.31 hits per line

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

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

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

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

27
  defp encode_types([] = done), do: done
8✔
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))
127✔
68
  end
69

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

74
  defp _encode_rows([el | els], [t | ts], rows, types) do
2,000,423✔
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,216✔
79

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

85
  def encoding_types([] = done), do: done
153✔
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
151✔
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
  defp encoding_type({:json, opts}), do: {:json, opts}
2✔
177

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

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

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

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

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

203
  def encode({:json, _opts}, json) do
204
    # assuming it can be sent as text and not "native" binary JSON
205
    # i.e. assumes `settings: [input_format_binary_read_json_as_string: 1]`
206
    # TODO
207
    encode(:string, Jason.encode_to_iodata!(json))
2✔
208
  end
209

210
  def encode({:fixed_string, size}, str) when byte_size(str) == size do
211
    str
15✔
212
  end
213

214
  def encode({:fixed_string, size}, str) when byte_size(str) < size do
215
    to_pad = size - byte_size(str)
6✔
216
    [str | <<0::size(to_pad * 8)>>]
217
  end
218

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

221
  # UInt8 — [0 : 255]
222
  def encode(:u8, u) when is_integer(u) and u >= 0 and u <= 255, do: u
111✔
223
  def encode(:u8, nil), do: 0
5✔
224

225
  def encode(:u8, term) do
226
    raise ArgumentError, "invalid UInt8: #{inspect(term)}"
3✔
227
  end
228

229
  # Int8 — [-128 : 127]
230
  def encode(:i8, i) when is_integer(i) and i >= 0 and i <= 127, do: i
15✔
231
  def encode(:i8, i) when is_integer(i) and i < 0 and i >= -128, do: <<i::signed>>
3✔
232
  def encode(:i8, nil), do: 0
1✔
233

234
  def encode(:i8, term) do
235
    raise ArgumentError, "invalid Int8: #{inspect(term)}"
3✔
236
  end
237

238
  for size <- [16, 32, 64, 128, 256] do
239
    def encode(unquote(:"u#{size}"), u) when is_integer(u) do
240
      <<u::unquote(size)-little>>
2,000,066✔
241
    end
242

243
    def encode(unquote(:"i#{size}"), i) when is_integer(i) do
244
      <<i::unquote(size)-little-signed>>
56✔
245
    end
246

247
    def encode(unquote(:"u#{size}"), nil), do: <<0::unquote(size)>>
3✔
248
    def encode(unquote(:"i#{size}"), nil), do: <<0::unquote(size)>>
3✔
249
  end
250

251
  for size <- [32, 64] do
252
    type = :"f#{size}"
253

254
    def encode(unquote(type), f) when is_number(f) do
255
      <<f::unquote(size)-little-signed-float>>
71✔
256
    end
257

258
    def encode(unquote(type), nil), do: <<0::unquote(size)>>
2✔
259
  end
260

261
  def encode({:decimal, precision, scale}, decimal) do
262
    type =
×
263
      case decimal_size(precision) do
264
        32 -> :decimal32
×
265
        64 -> :decimal64
×
266
        128 -> :decimal128
×
267
        256 -> :decimal256
×
268
      end
269

270
    encode({type, scale}, decimal)
×
271
  end
272

273
  for size <- [32, 64, 128, 256] do
274
    type = :"decimal#{size}"
275

276
    def encode({unquote(type), scale} = t, %Decimal{sign: sign, coef: coef, exp: exp} = d) do
277
      cond do
24✔
278
        scale == -exp ->
279
          i = sign * coef
17✔
280
          <<i::unquote(size)-little>>
17✔
281

282
        exp >= 0 ->
7✔
283
          i = sign * coef * round(:math.pow(10, exp + scale))
1✔
284
          <<i::unquote(size)-little>>
1✔
285

286
        true ->
6✔
287
          encode(t, Decimal.round(d, scale))
6✔
288
      end
289
    end
290

291
    def encode({unquote(type), _scale}, nil), do: <<0::unquote(size)>>
4✔
292
  end
293

294
  def encode(:boolean, true), do: 1
4✔
295
  def encode(:boolean, false), do: 0
4✔
296
  def encode(:boolean, nil), do: 0
1✔
297

298
  def encode({:array, type}, [_ | _] = l) do
49✔
299
    [encode(:varint, length(l)) | encode_many(l, type)]
300
  end
301

302
  def encode({:array, _type}, []), do: 0
13✔
303
  def encode({:array, _type}, nil), do: 0
4✔
304

305
  def encode({:map, k, v}, [_ | _] = m) do
14✔
306
    [encode(:varint, length(m)) | encode_many_kv(m, k, v)]
307
  end
308

309
  def encode({:map, _k, _v} = t, m) when is_map(m), do: encode(t, Map.to_list(m))
16✔
310
  def encode({:map, _k, _v}, []), do: 0
8✔
311
  def encode({:map, _k, _v}, nil), do: 0
3✔
312

313
  def encode({:tuple, _types} = t, v) when is_tuple(v) do
314
    encode(t, Tuple.to_list(v))
8✔
315
  end
316

317
  def encode({:tuple, types}, values) when is_list(types) and is_list(values) do
318
    encode_row(values, types)
8✔
319
  end
320

321
  def encode({:tuple, types}, nil) when is_list(types) do
322
    Enum.map(types, fn type -> encode(type, nil) end)
×
323
  end
324

325
  def encode({:variant, _types}, nil), do: 255
4✔
326

327
  def encode({:variant, types}, value) do
328
    try_encode_variant(types, 0, value)
10✔
329
  end
330

331
  def encode(:datetime, %NaiveDateTime{} = datetime) do
332
    {seconds, _micros} = NaiveDateTime.to_gregorian_seconds(datetime)
18✔
333
    <<seconds - @epoch_gregorian_seconds::32-little>>
18✔
334
  end
335

336
  def encode(:datetime, %DateTime{} = datetime) do
337
    <<DateTime.to_unix(datetime, :second)::32-little>>
10✔
338
  end
339

340
  def encode(:datetime, nil), do: <<0::32>>
1✔
341

342
  def encode({:datetime64, time_unit}, %NaiveDateTime{} = datetime) do
343
    {seconds, micros} = NaiveDateTime.to_gregorian_seconds(datetime)
8✔
344

345
    <<(seconds - @epoch_gregorian_seconds) * time_unit + div(micros * time_unit, 1_000_000)::64-little-signed>>
8✔
346
  end
347

348
  def encode({:datetime64, time_unit}, %DateTime{} = datetime) do
349
    <<DateTime.to_unix(datetime, time_unit)::64-little-signed>>
4✔
350
  end
351

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

354
  def encode(:date, %Date{} = date) do
355
    <<Date.to_gregorian_days(date) - @epoch_gregorian_days::16-little>>
13✔
356
  end
357

358
  def encode(:date, nil), do: <<0::16>>
1✔
359

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

364
  def encode(:date32, nil), do: <<0::32>>
1✔
365

366
  def encode(:time, %Time{} = time) do
367
    {s, _micros} = Time.to_seconds_after_midnight(time)
10✔
368
    <<s::32-little-signed>>
10✔
369
  end
370

371
  def encode(:time, nil), do: <<0::32>>
×
372

373
  def encode({:time64, time_unit}, %Time{} = time) do
374
    {s, micros} = Time.to_seconds_after_midnight(time)
34✔
375

376
    micros_as_ticks =
34✔
377
      cond do
378
        time_unit < 1_000_000 -> div(micros, time_unit)
12✔
379
        time_unit == 1_000_000 -> micros
22✔
380
        true -> micros * div(time_unit, 1_000_000)
10✔
381
      end
382

383
    ticks = s * time_unit + micros_as_ticks
34✔
384
    <<ticks::64-little-signed>>
34✔
385
  end
386

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

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

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

402
    encode(:uuid, raw)
1✔
403
  end
404

405
  def encode(:uuid, nil), do: <<0::128>>
1✔
406

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

410
  def encode(:ipv6, {b1, b2, b3, b4, b5, b6, b7, b8}) do
411
    <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>
4✔
412
  end
413

414
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
×
415
  def encode(:ipv6, nil), do: <<0::128>>
×
416

417
  def encode(:point, {x, y}), do: [encode(:f64, x) | encode(:f64, y)]
28✔
418
  def encode(:point, nil), do: <<0::128>>
1✔
419
  def encode(:ring, points), do: encode({:array, :point}, points)
1✔
420
  def encode(:polygon, rings), do: encode({:array, :ring}, rings)
1✔
421
  def encode(:multipolygon, polygons), do: encode({:array, :polygon}, polygons)
1✔
422

423
  # TODO
424
  def encode(:dynamic, value) do
425
    case value do
20✔
426
      _ when is_binary(value) -> [0x15 | encode(:string, value)]
3✔
427
      _ when is_integer(value) and value >= 0 -> [0x04 | encode(:u64, value)]
5✔
428
      _ when is_integer(value) -> [0x0A | encode(:i64, value)]
2✔
429
      _ when is_float(value) -> [0x0E | encode(:f64, value)]
3✔
430
      %Date{} -> [0x0F | encode(:date, value)]
3✔
431
      %DateTime{} -> [0x11 | encode(:datetime, value)]
×
432
      %NaiveDateTime{} -> [0x11 | encode(:datetime, value)]
2✔
433
      %{} -> [0x30, 0x00, 0x80, 0x08, 0x20, 0x00, 0x00, 0x00 | encode(:json, value)]
2✔
434
      [] -> [0x1E, 0x00]
×
435
    end
436
  end
437

438
  # TODO enum8 and enum16 nil
439
  for size <- [8, 16] do
440
    enum_t = :"enum#{size}"
441
    int_t = :"i#{size}"
442

443
    def encode({unquote(enum_t), mapping}, e) do
444
      i =
12✔
445
        case e do
446
          _ when is_integer(e) ->
447
            e
4✔
448

449
          _ when is_binary(e) ->
450
            case Map.fetch(mapping, e) do
8✔
451
              {:ok, res} ->
452
                res
8✔
453

454
              :error ->
455
                raise ArgumentError,
×
456
                      "enum value #{inspect(e)} not found in mapping: #{inspect(mapping)}"
457
            end
458
        end
459

460
      encode(unquote(int_t), i)
12✔
461
    end
462
  end
463

464
  def encode({:nullable, _type}, nil), do: 1
12✔
465

466
  def encode({:nullable, type}, value) do
467
    case encode(type, value) do
11✔
468
      e when is_list(e) or is_binary(e) -> [0 | e]
11✔
469
      e -> [0, e]
×
470
    end
471
  end
472

473
  defp encode_varint_cont(i) when i < 128, do: <<i>>
8✔
474

475
  defp encode_varint_cont(i) do
12✔
476
    [(i &&& 0b0111_1111) ||| 0b1000_0000 | encode_varint_cont(i >>> 7)]
477
  end
478

479
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
129✔
480
  defp encode_many([] = done, _type), do: done
57✔
481

482
  defp encode_many_kv([{key, value} | rest], key_type, value_type) do
19✔
483
    [
484
      encode(key_type, key),
485
      encode(value_type, value)
486
      | encode_many_kv(rest, key_type, value_type)
487
    ]
488
  end
489

490
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
14✔
491

492
  # TODO find a better way than try/rescue
493
  defp try_encode_variant([type | types], idx, value) do
494
    try do
18✔
495
      encode(type, value)
18✔
496
    else
497
      encoded -> [idx | encoded]
10✔
498
    rescue
499
      _e -> try_encode_variant(types, idx + 1, value)
8✔
500
    end
501
  end
502

503
  defp try_encode_variant([], _idx, value) do
504
    raise ArgumentError, "no matching type found for encoding #{inspect(value)} as Variant"
×
505
  end
506

507
  @compile {:inline, d: 1}
508

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

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

560
  @doc false
561
  @spec decode_header(binary()) ::
562
          {:ok, names :: [String.t()], types :: [term], rest :: binary} | :more
563
  def decode_header(row_binary_with_names_and_types)
564

565
  for {pattern, value} <- varints do
566
    def decode_header(<<unquote(pattern), rest::bytes>>) do
567
      decode_header_names(rest, unquote(value), unquote(value), _acc = [])
42✔
568
    end
569
  end
570

571
  def decode_header(<<_bin::bytes>>) do
1✔
572
    :more
573
  end
574

575
  defp decode_header_names(<<rest::bytes>>, 0, count, names) do
576
    decode_header_types(rest, count, _acc = [], :lists.reverse(names))
27✔
577
  end
578

579
  for {pattern, value} <- varints do
580
    defp decode_header_names(
581
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
582
           left,
583
           count,
584
           acc
585
         ) do
586
      decode_header_names(rest, left - 1, count, [name | acc])
84✔
587
    end
588
  end
589

590
  defp decode_header_names(<<_bin::bytes>>, _left, _count, _acc) do
15✔
591
    :more
592
  end
593

594
  defp decode_header_types(<<rest::bytes>>, 0, types, names) do
595
    {:ok, names, decoding_types_reverse(types), rest}
7✔
596
  end
597

598
  for {pattern, value} <- varints do
599
    defp decode_header_types(
600
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
601
           count,
602
           acc,
603
           names
604
         ) do
605
      decode_header_types(rest, count - 1, [type | acc], names)
30✔
606
    end
607
  end
608

609
  defp decode_header_types(<<_bin::bytes>>, _count, _acc, _names) do
20✔
610
    :more
611
  end
612

613
  @doc """
614
  Decodes [RowBinaryWithNamesAndTypes](https://clickhouse.com/docs/en/interfaces/formats/RowBinaryWithNamesAndTypes) into rows.
615

616
  Example:
617

618
      iex> decode_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
619
      [[2]]
620

621
  """
622
  def decode_rows(row_binary_with_names_and_types)
623
  def decode_rows(<<>>), do: []
1✔
624

625
  for {pattern, value} <- varints do
626
    def decode_rows(<<unquote(pattern), rest::bytes>>) do
627
      skip_names(rest, unquote(value), unquote(value))
7✔
628
    end
629
  end
630

631
  @doc """
632
  Same as `decode_rows/1` but the first element is a list of column names.
633

634
  Example:
635

636
      iex> decode_names_and_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
637
      [["1+1"], [2]]
638

639
  """
640
  def decode_names_and_rows(row_binary_with_names_and_types)
641

642
  for {pattern, value} <- varints do
643
    def decode_names_and_rows(<<unquote(pattern), rest::bytes>>) do
644
      decode_names(rest, unquote(value), unquote(value), _acc = [])
1,453✔
645
    end
646
  end
647

648
  @doc """
649
  Decodes [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) into rows.
650

651
  Example:
652

653
      iex> decode_rows(<<1>>, ["UInt8"])
654
      [[1]]
655

656
  """
657
  def decode_rows(row_binary, types)
658
  def decode_rows(<<>>, _types), do: []
1✔
659

660
  def decode_rows(<<data::bytes>>, types) do
661
    decode_rows!(data, decoding_types(types))
13✔
662
  end
663

664
  defp decode_rows!(data, types) do
665
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
1,324✔
666

667
    case state do
1,290✔
668
      nil ->
669
        rows
1,288✔
670

671
      {:cont, types_rest, row} ->
672
        raise ArgumentError, """
2✔
673
        incomplete RowBinary data: ran out of bytes while decoding
674

675
        Expected to decode: #{inspect(types_rest)}
676
        Remaining bytes: #{byte_size(remaining_data)} bytes
2✔
677
        Partial row: #{inspect(row)}
678
        Completed rows: #{length(rows)}
2✔
679
        """
680
    end
681
  end
682

683
  @doc false
684
  def decode_rows_continue(<<data::bytes>>, types, state) do
685
    case state do
201,166✔
686
      {:cont, types_rest, row} -> decode_rows(types_rest, data, row, [], types)
201,074✔
687
      nil -> decode_rows(types, data, [], [], types)
92✔
688
    end
689
  end
690

691
  @doc false
692
  def decoding_types([type | types]) do
129✔
693
    [decoding_type(type) | decoding_types(types)]
694
  end
695

696
  def decoding_types([] = done), do: done
85✔
697

698
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
1,318✔
699

700
  defp decoding_types_reverse([type | types], acc) do
701
    decoding_types_reverse(types, [decoding_type(type) | acc])
4,176✔
702
  end
703

704
  defp decoding_types_reverse([], acc), do: acc
1,318✔
705

706
  defp decoding_type(t) when is_binary(t) do
707
    decoding_type(Ch.Types.decode(t))
4,291✔
708
  end
709

710
  defp decoding_type(t)
711
       when t in [
712
              :string,
713
              :binary,
714
              :json,
715
              :dynamic,
716
              :boolean,
717
              :uuid,
718
              :date,
719
              :date32,
720
              :time,
721
              :time64,
722
              :ipv4,
723
              :ipv6,
724
              :point,
725
              :nothing
726
            ],
727
       do: t
1,246✔
728

729
  defp decoding_type({:datetime, _tz} = t), do: t
32✔
730
  defp decoding_type({:fixed_string, _len} = t), do: t
22✔
731

732
  for size <- [8, 16, 32, 64, 128, 256] do
733
    defp decoding_type(unquote(:"u#{size}") = u), do: u
2,671✔
734
    defp decoding_type(unquote(:"i#{size}") = i), do: i
98✔
735
  end
736

737
  for size <- [32, 64] do
738
    defp decoding_type(unquote(:"f#{size}") = f), do: f
44✔
739
  end
740

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

743
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
124✔
744

745
  defp decoding_type({:tuple = t, ts}) do
18✔
746
    {t, Enum.map(ts, &decoding_type/1)}
747
  end
748

749
  defp decoding_type({:variant = v, ts}) do
28✔
750
    {v, Enum.map(ts, &decoding_type/1)}
751
  end
752

753
  defp decoding_type({:map = m, kt, vt}) do
754
    {m, decoding_type(kt), decoding_type(vt)}
25✔
755
  end
756

757
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
58✔
758
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
147✔
759

760
  defp decoding_type({:decimal = t, p, s}), do: {t, decimal_size(p), s}
62✔
761
  defp decoding_type({:decimal32, s}), do: {:decimal, 32, s}
1✔
762
  defp decoding_type({:decimal64, s}), do: {:decimal, 64, s}
1✔
763
  defp decoding_type({:decimal128, s}), do: {:decimal, 128, s}
1✔
764
  defp decoding_type({:decimal256, s}), do: {:decimal, 256, s}
1✔
765

766
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
33✔
767
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
20✔
768

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

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

775
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
776

777
  defp decoding_type(:ring), do: {:array, :point}
6✔
778
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
6✔
779
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
6✔
780
  defp decoding_type({:json, _opts}), do: :json
6✔
781

782
  defp decoding_type(type) do
783
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
×
784
  end
785

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

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

794
  defp decode_names(<<rest::bytes>>, 0, count, names) do
1,453✔
795
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
796
  end
797

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

809
  defp decode_types(<<>>, 0, _types), do: []
149✔
810

811
  defp decode_types(<<rest::bytes>>, 0, types) do
812
    decode_rows!(rest, decoding_types_reverse(types))
1,311✔
813
  end
814

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

825
  @compile inline: [decode_string_decode_rows: 5]
826

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

839
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
840
    to_be_continued(rows, bin, [:string | types_rest], row)
100,165✔
841
  end
842

843
  @doc false
844
  def to_utf8(str) do
845
    utf8 = to_utf8(str, 0, 0, str, [])
1,130✔
846
    IO.iodata_to_binary(utf8)
1,130✔
847
  end
848

849
  @dialyzer {:no_improper_lists, to_utf8: 5, to_utf8_escape: 5}
850

851
  defp to_utf8(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
852
    to_utf8(rest, from, len + utf8_size(valid), original, acc)
30,139,407✔
853
  end
854

855
  defp to_utf8(<<_invalid, rest::bytes>>, from, len, original, acc) do
856
    acc = [acc | binary_part(original, from, len)]
6✔
857
    to_utf8_escape(rest, from + len, 1, original, acc)
6✔
858
  end
859

860
  defp to_utf8(<<>>, from, len, original, acc) do
1,129✔
861
    [acc | binary_part(original, from, len)]
862
  end
863

864
  defp to_utf8_escape(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
865
    acc = [acc | "�"]
5✔
866
    to_utf8(rest, from + len, utf8_size(valid), original, acc)
5✔
867
  end
868

869
  defp to_utf8_escape(<<_invalid, rest::bytes>>, from, len, original, acc) do
870
    to_utf8_escape(rest, from, len + 1, original, acc)
7✔
871
  end
872

873
  defp to_utf8_escape(<<>>, _from, _len, _original, acc) do
1✔
874
    [acc | "�"]
875
  end
876

877
  # UTF-8 encodes code points in one to four bytes
878
  @compile inline: [utf8_size: 1]
879
  defp utf8_size(codepoint) when codepoint <= 0x7F, do: 1
30,139,376✔
880
  defp utf8_size(codepoint) when codepoint <= 0x7FF, do: 2
13✔
881
  defp utf8_size(codepoint) when codepoint <= 0xFFFF, do: 3
23✔
882
  defp utf8_size(codepoint) when codepoint <= 0x10FFFF, do: 4
×
883

884
  @compile inline: [decode_string_json_decode_rows: 5]
885

886
  for {pattern, size} <- varints do
887
    defp decode_string_json_decode_rows(
888
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
889
           types_rest,
890
           row,
891
           rows,
892
           types
893
         ) do
894
      decode_rows(types_rest, bin, [Jason.decode!(s) | row], rows, types)
98✔
895
    end
896
  end
897

898
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
899
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
900
  end
901

902
  @compile inline: [decode_binary_decode_rows: 5]
903

904
  for {pattern, size} <- varints do
905
    defp decode_binary_decode_rows(
906
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
907
           types_rest,
908
           row,
909
           rows,
910
           types
911
         ) do
912
      decode_rows(types_rest, bin, [s | row], rows, types)
4✔
913
    end
914
  end
915

916
  defp decode_binary_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
917
    to_be_continued(rows, bin, [:binary | types_rest], row)
100,007✔
918
  end
919

920
  @compile inline: [decode_array_decode_rows: 6]
921
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
922
    decode_rows(types_rest, bin, [[] | row], rows, types)
85✔
923
  end
924

925
  for {pattern, size} <- varints do
926
    defp decode_array_decode_rows(
927
           <<unquote(pattern), bin::bytes>>,
928
           type,
929
           types_rest,
930
           row,
931
           rows,
932
           types
933
         ) do
934
      array_types = List.duplicate(type, unquote(size))
285✔
935
      types_rest = array_types ++ [{:array_over, row} | types_rest]
285✔
936
      decode_rows(types_rest, bin, [], rows, types)
285✔
937
    end
938
  end
939

940
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
941
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
942
  end
943

944
  @compile inline: [decode_map_decode_rows: 7]
945
  defp decode_map_decode_rows(
946
         <<0, bin::bytes>>,
947
         _key_type,
948
         _value_type,
949
         types_rest,
950
         row,
951
         rows,
952
         types
953
       ) do
954
    decode_rows(types_rest, bin, [%{} | row], rows, types)
10✔
955
  end
956

957
  for {pattern, size} <- varints do
958
    defp decode_map_decode_rows(
959
           <<unquote(pattern), bin::bytes>>,
960
           key_type,
961
           value_type,
962
           types_rest,
963
           row,
964
           rows,
965
           types
966
         ) do
967
      types_rest =
32✔
968
        map_types(unquote(size), key_type, value_type) ++ [{:map_over, row} | types_rest]
969

970
      decode_rows(types_rest, bin, [], rows, types)
32✔
971
    end
972
  end
973

974
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
975
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
976
  end
977

978
  defp map_types(count, key_type, value_type) when count > 0 do
57✔
979
    [key_type, value_type | map_types(count - 1, key_type, value_type)]
980
  end
981

982
  defp map_types(0, _key_type, _value_types), do: []
32✔
983

984
  # https://clickhouse.com/docs/sql-reference/data-types/data-types-binary-encoding
985
  dynamic_types = [
986
    nothing: 0x00,
987
    u8: 0x01,
988
    u16: 0x02,
989
    u32: 0x03,
990
    u64: 0x04,
991
    u128: 0x05,
992
    u256: 0x06,
993
    i8: 0x07,
994
    i16: 0x08,
995
    i32: 0x09,
996
    i64: 0x0A,
997
    i128: 0x0B,
998
    i256: 0x0C,
999
    f32: 0x0D,
1000
    f64: 0x0E,
1001
    date: 0x0F,
1002
    date32: 0x10,
1003
    string: 0x15,
1004
    uuid: 0x1D,
1005
    ipv4: 0x28,
1006
    ipv6: 0x29,
1007
    boolean: 0x2D
1008
  ]
1009

1010
  # TODO compile inline?
1011

1012
  for {type, code} <- dynamic_types do
1013
    defp decode_dynamic(
1014
           <<unquote(code), rest::bytes>>,
1015
           dynamic,
1016
           types_rest,
1017
           row,
1018
           rows,
1019
           types
1020
         ) do
1021
      decode_dynamic_continue(rest, [unquote(type) | dynamic], types_rest, row, rows, types)
254✔
1022
    end
1023
  end
1024

1025
  # DateTime 0x11
1026
  defp decode_dynamic(<<0x11, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1027
    decode_dynamic_continue(rest, [{:datetime, nil} | dynamic], types_rest, row, rows, types)
4✔
1028
  end
1029

1030
  # DateTime(time_zone) 0x12 <var_uint_time_zone_name_size><time_zone_name_data>
1031
  for {pattern, size} <- varints do
1032
    defp decode_dynamic(
1033
           <<0x12, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1034
           dynamic,
1035
           types_rest,
1036
           row,
1037
           rows,
1038
           types
1039
         ) do
1040
      decode_dynamic_continue(rest, [{:datetime, tz} | dynamic], types_rest, row, rows, types)
2✔
1041
    end
1042
  end
1043

1044
  # DateTime64(P) 0x13 <uint8_precision>
1045
  defp decode_dynamic(
1046
         <<0x13, precision, rest::bytes>>,
1047
         dynamic,
1048
         types_rest,
1049
         row,
1050
         rows,
1051
         types
1052
       ) do
1053
    decode_dynamic_continue(
2✔
1054
      rest,
1055
      [decoding_type({:datetime64, precision}) | dynamic],
1056
      types_rest,
1057
      row,
1058
      rows,
1059
      types
1060
    )
1061
  end
1062

1063
  # DateTime64(P, time_zone) 0x14 <uint8_precision><var_uint_time_zone_name_size><time_zone_name_data>
1064
  for {pattern, size} <- varints do
1065
    defp decode_dynamic(
1066
           <<0x14, precision, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1067
           dynamic,
1068
           types_rest,
1069
           row,
1070
           rows,
1071
           types
1072
         ) do
1073
      decode_dynamic_continue(
2✔
1074
        rest,
1075
        [decoding_type({:datetime64, precision, tz}) | dynamic],
1076
        types_rest,
1077
        row,
1078
        rows,
1079
        types
1080
      )
1081
    end
1082
  end
1083

1084
  # FixedString(N) 0x16 <var_uint_size>
1085
  for {pattern, size} <- varints do
1086
    defp decode_dynamic(
1087
           <<0x16, unquote(pattern), rest::bytes>>,
1088
           dynamic,
1089
           types_rest,
1090
           row,
1091
           rows,
1092
           types
1093
         ) do
1094
      decode_dynamic_continue(
4✔
1095
        rest,
1096
        [{:fixed_string, unquote(size)} | dynamic],
1097
        types_rest,
1098
        row,
1099
        rows,
1100
        types
1101
      )
1102
    end
1103
  end
1104

1105
  # Decimal32(P, S) 0x19 <uint8_precision><uint8_scale>
1106
  # Decimal64(P, S) 0x1A <uint8_precision><uint8_scale>
1107
  # Decimal128(P, S) 0x1B <uint8_precision><uint8_scale>
1108
  # Decimal256(P, S) 0x1C <uint8_precision><uint8_scale>
1109
  for {code, size} <- [{0x19, 32}, {0x1A, 64}, {0x1B, 128}, {0x1C, 256}] do
1110
    defp decode_dynamic(
1111
           <<unquote(code), _precision, scale, rest::bytes>>,
1112
           dynamic,
1113
           types_rest,
1114
           row,
1115
           rows,
1116
           types
1117
         ) do
1118
      decode_dynamic_continue(
8✔
1119
        rest,
1120
        [{:decimal, unquote(size), scale} | dynamic],
1121
        types_rest,
1122
        row,
1123
        rows,
1124
        types
1125
      )
1126
    end
1127
  end
1128

1129
  # Array(T) 0x1E <nested_type_encoding>
1130
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1131
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
74✔
1132
  end
1133

1134
  # Nullable(T)        0x23 <nested_type_encoding>
1135
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1136
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
12✔
1137
  end
1138

1139
  # LowCardinality(T) 0x26 <nested_type_encoding>
1140
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1141
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
4✔
1142
  end
1143

1144
  # 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>...
1145
  defp decode_dynamic(<<0x30, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1146
    # Assert uint8_serialization_version to be 0
1147
    <<0x00, rest::bytes>> = rest
16✔
1148

1149
    # Skip var_int_max_dynamic_paths
1150
    {_paths, rest} = read_varint(rest)
16✔
1151

1152
    # Skip uint8_max_dynamic_types
1153
    <<_val, rest::bytes>> = rest
16✔
1154

1155
    # Read var_uint_number_of_typed_paths
1156
    {typed_paths, rest} = read_varint(rest)
16✔
1157

1158
    # Skip `typed_paths` typed paths
1159
    rest =
16✔
1160
      Enum.reduce(1..typed_paths//1, rest, fn _, rest ->
1161
        {count, rest} = read_varint(rest)
2✔
1162
        <<_discard::size(count)-bytes, rest::bytes>> = rest
2✔
1163
        skip_type(rest)
2✔
1164
      end)
1165

1166
    # Read var_uint_number_of_skip_paths
1167
    {skip_paths, rest} = read_varint(rest)
14✔
1168

1169
    # Skip `skip_paths` skipped paths
1170
    rest =
14✔
1171
      Enum.reduce(1..skip_paths//1, rest, fn _, rest ->
1172
        {count, rest} = read_varint(rest)
×
1173
        <<_discard::size(count)-bytes, rest::bytes>> = rest
×
1174
        rest
×
1175
      end)
1176

1177
    # Read var_uint_number_of_skip_path_regexps
1178
    {skip_path_regexes, rest} = read_varint(rest)
14✔
1179

1180
    # Skip `skip_path_regexes` skipped paths regex
1181
    rest =
14✔
1182
      Enum.reduce(1..skip_path_regexes//1, rest, fn _, rest ->
1183
        {count, rest} = read_varint(rest)
×
1184
        <<_discard::size(count)-bytes, rest::bytes>> = rest
×
1185
        rest
×
1186
      end)
1187

1188
    decode_dynamic_continue(rest, [:json | dynamic], types_rest, row, rows, types)
14✔
1189
  end
1190

1191
  for {pattern, value} <- varints do
1192
    defp read_varint(<<unquote(pattern), rest::bytes>>), do: {unquote(value), rest}
62✔
1193
  end
1194

1195
  other_dynamic_types = [
1196
    datetime: 0x11,
1197
    set: 0x21,
1198
    bfloat16: 0x31,
1199
    time: 0x32
1200
  ]
1201

1202
  # Consume a type header from binary input, returning the rest.
1203
  # TODO: Only supports single-byte type headers for now.
1204
  def skip_type(<<type, rest::bytes>>)
1205
      when type in unquote(Keyword.values(dynamic_types ++ other_dynamic_types)), do: rest
×
1206

1207
  def skip_type(<<type, _::bytes>>) do
1208
    raise ArgumentError,
2✔
1209
          "Unsupported type definition (starting with 0x#{Base.encode16(<<type>>)}) while decoding dynamic JSON. Only single-byte type identifiers are currently supported."
2✔
1210
  end
1211

1212
  # TODO
1213
  # 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>
1214
  # 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>
1215
  # Tuple(T1, ..., TN)        0x1F <var_uint_number_of_elements><nested_type_encoding_1>...<nested_type_encoding_N>
1216
  # 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>
1217
  # Set        0x21
1218
  # Interval        0x22 <interval_kind> (see interval kind binary encoding)
1219
  # Function        0x24<var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N><return_type_encoding>
1220
  # 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)
1221
  # Map(K, V)        0x27<key_type_encoding><value_type_encoding>
1222
  # Variant(T1, ..., TN)        0x2A<var_uint_number_of_variants><variant_type_encoding_1>...<variant_type_encoding_N>
1223
  # Dynamic(max_types=N)        0x2B<uint8_max_types>
1224
  # Custom type (Ring, Polygon, etc)        0x2C<var_uint_type_name_size><type_name_data>
1225
  # 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)
1226
  # 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>
1227

1228
  unsupported_dynamic_types = %{
1229
    "Enum8" => 0x17,
1230
    "Enum16" => 0x18,
1231
    "Tuple" => 0x1F,
1232
    "TupleWithNames" => 0x20,
1233
    "Set" => 0x21,
1234
    "Interval" => 0x22,
1235
    "Function" => 0x24,
1236
    "AggregateFunction" => 0x25,
1237
    "Map" => 0x27,
1238
    "Variant" => 0x2A,
1239
    "Dynamic" => 0x2B,
1240
    "CustomType" => 0x2C,
1241
    "SimpleAggregateFunction" => 0x2E,
1242
    "Nested" => 0x2F
1243
  }
1244

1245
  for {type, code} <- unsupported_dynamic_types do
1246
    defp decode_dynamic(<<unquote(code), _::bytes>>, _dynamic, _types_rest, _row, _rows, _types) do
1247
      raise ArgumentError, "unsupported dynamic type #{unquote(type)}"
14✔
1248
    end
1249
  end
1250

1251
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1252
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1253
  end
1254

1255
  @compile inline: [decode_dynamic_continue: 6]
1256

1257
  defp decode_dynamic_continue(<<rest::bytes>>, dynamic, types_rest, row, rows, types) do
1258
    continue? =
318✔
1259
      case dynamic do
1260
        [:array | _] -> true
74✔
1261
        [:nullable | _] -> true
12✔
1262
        [:low_cardinality | _] -> true
4✔
1263
        _ -> false
244✔
1264
      end
1265

1266
    if continue? do
318✔
1267
      decode_dynamic(rest, dynamic, types_rest, row, rows, types)
90✔
1268
    else
1269
      type = build_dynamic_type(:lists.reverse(dynamic))
244✔
1270
      decode_rows([type | types_rest], rest, row, rows, types)
244✔
1271
    end
1272
  end
1273

1274
  defp build_dynamic_type([type]), do: type
290✔
1275

1276
  defp build_dynamic_type(type) do
1277
    case type do
88✔
1278
      [:array | rest] -> {:array, build_dynamic_type(rest)}
72✔
1279
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
12✔
1280
      [:low_cardinality | rest] -> build_dynamic_type(rest)
4✔
1281
    end
1282
  end
1283

1284
  simple_types = %{
1285
    u8: %{pattern: quote(do: <<u>>), value: quote(do: u)},
1286
    u16: %{pattern: quote(do: <<u::16-little>>), value: quote(do: u)},
1287
    u32: %{pattern: quote(do: <<u::32-little>>), value: quote(do: u)},
1288
    u64: %{pattern: quote(do: <<u::64-little>>), value: quote(do: u)},
1289
    u128: %{pattern: quote(do: <<u::128-little>>), value: quote(do: u)},
1290
    u256: %{pattern: quote(do: <<u::256-little>>), value: quote(do: u)},
1291
    i8: %{pattern: quote(do: <<i::signed>>), value: quote(do: i)},
1292
    i16: %{pattern: quote(do: <<i::16-little-signed>>), value: quote(do: i)},
1293
    i32: %{pattern: quote(do: <<i::32-little-signed>>), value: quote(do: i)},
1294
    i64: %{pattern: quote(do: <<i::64-little-signed>>), value: quote(do: i)},
1295
    i128: %{pattern: quote(do: <<i::128-little-signed>>), value: quote(do: i)},
1296
    i256: %{pattern: quote(do: <<i::256-little-signed>>), value: quote(do: i)},
1297
    f32: [
1298
      %{pattern: quote(do: <<f::32-little-float>>), value: quote(do: f)},
1299
      %{pattern: quote(do: <<_nan_or_inf::32>>), value: quote(do: nil)}
1300
    ],
1301
    f64: [
1302
      %{pattern: quote(do: <<f::64-little-float>>), value: quote(do: f)},
1303
      %{pattern: quote(do: <<_nan_or_inf::64>>), value: quote(do: nil)}
1304
    ],
1305
    uuid: %{
1306
      pattern: quote(do: <<u1::64-little, u2::64-little>>),
1307
      value: quote(do: <<u1::64, u2::64>>)
1308
    },
1309
    date: %{
1310
      pattern: quote(do: <<d::16-little>>),
1311
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1312
    },
1313
    date32: %{
1314
      pattern: quote(do: <<d::32-little-signed>>),
1315
      value: quote(do: Date.from_gregorian_days(d + @epoch_gregorian_days))
1316
    },
1317
    time: %{
1318
      pattern: quote(do: <<s::32-little-signed>>),
1319
      value: quote(do: time_after_midnight(s, 1))
1320
    },
1321
    boolean: [
1322
      %{pattern: quote(do: <<0>>), value: quote(do: false)},
1323
      %{pattern: quote(do: <<1>>), value: quote(do: true)},
1324
      %{pattern: quote(do: <<b>>), value: quote(do: raise("invalid boolean value: #{b}"))}
1325
    ],
1326
    ipv4: %{
1327
      pattern: quote(do: <<b4, b3, b2, b1>>),
1328
      value: quote(do: {b1, b2, b3, b4})
1329
    },
1330
    ipv6: %{
1331
      pattern: quote(do: <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>),
1332
      value: quote(do: {b1, b2, b3, b4, b5, b6, b7, b8})
1333
    },
1334
    point: %{
1335
      pattern: quote(do: <<x::64-little-float, y::64-little-float>>),
1336
      value: quote(do: {x, y})
1337
    }
1338
  }
1339

1340
  for {type, clauses} <- simple_types do
1341
    fun = :"decode_#{type}_decode_rows"
1342
    @compile inline: [{fun, 5}]
1343

1344
    for %{pattern: pattern, value: value} <- List.wrap(clauses) do
1345
      defp unquote(fun)(<<unquote(pattern), rest::bytes>>, types_rest, row, rows, types) do
1346
        decode_rows(types_rest, rest, [unquote(value) | row], rows, types)
2,154,379✔
1347
      end
1348
    end
1349

1350
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1351
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
582✔
1352
    end
1353
  end
1354

1355
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1356
    case type do
2,358,487✔
1357
      :u8 ->
1358
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
1,219✔
1359

1360
      :u16 ->
1361
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
1,524✔
1362

1363
      :u32 ->
1364
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
73✔
1365

1366
      :u64 ->
1367
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,150,989✔
1368

1369
      :u128 ->
1370
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
40✔
1371

1372
      :u256 ->
1373
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
72✔
1374

1375
      :i8 ->
1376
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
40✔
1377

1378
      :i16 ->
1379
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
20✔
1380

1381
      :i32 ->
1382
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
42✔
1383

1384
      :i64 ->
1385
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
178✔
1386

1387
      :i128 ->
1388
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
41✔
1389

1390
      :i256 ->
1391
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
73✔
1392

1393
      :f32 ->
1394
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
36✔
1395

1396
      :f64 ->
1397
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
60✔
1398

1399
      :string ->
1400
        decode_string_decode_rows(bin, types_rest, row, rows, types)
101,295✔
1401

1402
      :binary ->
1403
        decode_binary_decode_rows(bin, types_rest, row, rows, types)
100,011✔
1404

1405
      :json ->
1406
        # assuming it arrives as text and not "native" binary JSON
1407
        # i.e. assumes `settings: [output_format_binary_write_json_as_string: 1]`
1408
        # TODO
1409
        decode_string_json_decode_rows(bin, types_rest, row, rows, types)
144✔
1410

1411
      :dynamic ->
1412
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
306✔
1413

1414
      {:dynamic, dynamic} ->
1415
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1416

1417
      # TODO utf8?
1418
      {:fixed_string, size} ->
1419
        case bin do
43✔
1420
          <<s::size(^size)-bytes, rest::bytes>> ->
1421
            decode_rows(types_rest, rest, [s | row], rows, types)
29✔
1422

1423
          _ ->
1424
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1425
        end
1426

1427
      :boolean ->
1428
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
66✔
1429

1430
      :uuid ->
1431
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
86✔
1432

1433
      :date ->
1434
        decode_date_decode_rows(bin, types_rest, row, rows, types)
42✔
1435

1436
      :date32 ->
1437
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
40✔
1438

1439
      :time ->
1440
        decode_time_decode_rows(bin, types_rest, row, rows, types)
46✔
1441

1442
      {:time64, time_unit} ->
1443
        case bin do
180✔
1444
          <<ticks::64-little-signed, bin::bytes>> ->
1445
            time = time_after_midnight(ticks, time_unit)
150✔
1446
            decode_rows(types_rest, bin, [time | row], rows, types)
142✔
1447

1448
          _ ->
1449
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1450
        end
1451

1452
      {:datetime, timezone} ->
1453
        case bin do
88✔
1454
          <<s::32-little, bin::bytes>> ->
1455
            dt =
66✔
1456
              case timezone do
1457
                nil -> NaiveDateTime.from_gregorian_seconds(s + @epoch_gregorian_seconds)
26✔
1458
                "UTC" -> DateTime.from_unix!(s)
22✔
1459
                _ -> s |> DateTime.from_unix!() |> DateTime.shift_zone!(timezone)
18✔
1460
              end
1461

1462
            decode_rows(types_rest, bin, [dt | row], rows, types)
64✔
1463

1464
          _ ->
1465
            to_be_continued(rows, bin, [type | types_rest], row)
22✔
1466
        end
1467

1468
      {:decimal, size, scale} ->
1469
        case bin do
198✔
1470
          <<val::size(^size)-little-signed, bin::bytes>> ->
1471
            sign = if val < 0, do: -1, else: 1
80✔
1472
            d = Decimal.new(sign, abs(val), -scale)
80✔
1473
            decode_rows(types_rest, bin, [d | row], rows, types)
80✔
1474

1475
          _ ->
1476
            to_be_continued(rows, bin, [type | types_rest], row)
118✔
1477
        end
1478

1479
      {:nullable, inner_type} ->
1480
        case bin do
181✔
1481
          <<b, bin::bytes>> ->
1482
            case b do
178✔
1483
              0 -> decode_rows([inner_type | types_rest], bin, row, rows, types)
85✔
1484
              1 -> decode_rows(types_rest, bin, [nil | row], rows, types)
93✔
1485
            end
1486

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

1491
      :nothing ->
1492
        decode_rows(types_rest, bin, [nil | row], rows, types)
62✔
1493

1494
      {:array, inner_type} ->
1495
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
382✔
1496

1497
      {:array_over, original_row} ->
1498
        decode_rows(types_rest, bin, [:lists.reverse(row) | original_row], rows, types)
285✔
1499

1500
      {:map, key_type, value_type} ->
1501
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
48✔
1502

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

1507
      {:tuple, tuple_types} ->
1508
        decode_rows(tuple_types ++ [{:tuple_over, row} | types_rest], bin, [], rows, types)
26✔
1509

1510
      {:tuple_over, original_row} ->
1511
        tuple = row |> :lists.reverse() |> List.to_tuple()
26✔
1512
        decode_rows(types_rest, bin, [tuple | original_row], rows, types)
26✔
1513

1514
      {:variant, variant_types} ->
1515
        case bin do
59✔
1516
          <<255, bin::bytes>> ->
1517
            # 255 is the variant type index for "nothing"
1518
            decode_rows(types_rest, bin, [nil | row], rows, types)
12✔
1519

1520
          # TODO varint?
1521
          <<variant_type_index::8, bin::bytes>> ->
1522
            variant_type = Enum.at(variant_types, variant_type_index)
44✔
1523
            decode_rows([variant_type | types_rest], bin, row, rows, types)
44✔
1524

1525
          _ ->
1526
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1527
        end
1528

1529
      {:datetime64, time_unit, timezone} ->
1530
        case bin do
122✔
1531
          <<s::64-little-signed, bin::bytes>> ->
1532
            dt = DateTime.from_unix!(s, time_unit)
60✔
1533

1534
            dt =
60✔
1535
              case timezone do
1536
                nil -> DateTime.to_naive(dt)
34✔
1537
                "UTC" -> dt
8✔
1538
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1539
              end
1540

1541
            decode_rows(types_rest, bin, [dt | row], rows, types)
60✔
1542

1543
          _ ->
1544
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1545
        end
1546

1547
      {:enum8, mapping} ->
1548
        case bin do
28✔
1549
          <<v::signed, bin::bytes>> ->
1550
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
28✔
1551

1552
          _ ->
UNCOV
1553
            to_be_continued(rows, bin, [type | types_rest], row)
×
1554
        end
1555

1556
      {:enum16, mapping} ->
1557
        case bin do
8✔
1558
          <<v::16-little-signed, bin::bytes>> ->
1559
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
4✔
1560

1561
          _ ->
1562
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1563
        end
1564

1565
      :ipv4 ->
1566
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
24✔
1567

1568
      :ipv6 ->
1569
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
74✔
1570

1571
      :point ->
1572
        decode_point_decode_rows(bin, types_rest, row, rows, types)
176✔
1573
    end
1574
  end
1575

1576
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1577
    rows = :lists.reverse([:lists.reverse(row) | rows])
1,380✔
1578
    {rows, empty, _no_state = nil}
1,380✔
1579
  end
1580

1581
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1582
    row = :lists.reverse(row)
2,151,127✔
1583
    decode_rows(types, bin, [], [row | rows], types)
2,151,127✔
1584
  end
1585

1586
  defp decode_rows([_ | _] = types_rest, <<>> = empty, row, rows, _types) do
UNCOV
1587
    to_be_continued(rows, empty, types_rest, row)
×
1588
  end
1589

1590
  @compile inline: [to_be_continued: 4]
1591
  defp to_be_continued(rows, bin, types_rest, row) do
1592
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,719✔
1593
  end
1594

1595
  @compile inline: [decimal_size: 1]
1596
  # https://clickhouse.com/docs/en/sql-reference/data-types/decimal/
1597
  defp decimal_size(precision) when is_integer(precision) do
1598
    cond do
62✔
1599
      precision >= 39 -> 256
4✔
1600
      precision >= 19 -> 128
58✔
1601
      precision >= 10 -> 64
49✔
1602
      true -> 32
33✔
1603
    end
1604
  end
1605

1606
  @compile inline: [time_unit: 1]
1607
  for precision <- 0..9 do
1608
    time_unit = Integer.pow(10, precision)
1609
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1610
  end
1611

1612
  @compile inline: [time_after_midnight: 2]
1613
  defp time_after_midnight(ticks, time_unit) do
1614
    if ticks >= 0 and ticks < 86400 * time_unit do
182✔
1615
      ticks |> DateTime.from_unix!(time_unit) |> DateTime.to_time()
166✔
1616
    else
1617
      # since ClickHouse supports Time64 values of [-999:59:59.999999999, 999:59:59.999999999]
1618
      # and Elixir's Time supports values of [00:00:00.000000, 23:59:59.999999]
1619
      # we raise an error when ClickHouse's Time64 value is out of Elixir's Time range
1620
      raise ArgumentError,
8✔
1621
            "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✔
1622

1623
      # TODO: we could potentially decode ClickHouse's Time/Time64 values as Elixir's Duration when it's out of Elixir's Time range
1624
    end
1625
  end
1626
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