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

plausible / ch / f13c19e6da55ec10e91e58b2abd9e9858acd1b91

20 Apr 2026 07:38PM UTC coverage: 91.51%. Remained the same
f13c19e6da55ec10e91e58b2abd9e9858acd1b91

push

github

web-flow
use DateTime.to_unix + DateTime.to_naive for naive datetime decoding in RowBinary (#313)

* use DateTime.to_unix + DateTime.to_naive for naive datetime decoding in RowBinary

* changelog

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

2 existing lines in 1 file now uncovered.

927 of 1013 relevant lines covered (91.51%)

79491.21 hits per line

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

88.51
/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_date ~D[1970-01-01]
10
  @epoch_utc_datetime DateTime.new!(@epoch_date, ~T[00:00:00])
11
  @epoch_gregorian_seconds 62_167_219_200
12

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

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

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

28
  defp encode_types([] = done), do: done
8✔
29

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

33
  Examples:
34

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

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

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

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

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

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

55
  Examples:
56

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

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

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

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

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

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

79
  defp _encode_rows([], [], rows, types), do: _encode_rows(rows, types)
2,000,216✔
80

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

86
  def encoding_types([] = done), do: done
153✔
87

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

174
  defp encoding_type(:ring), do: {:array, :point}
2✔
175
  defp encoding_type(:polygon), do: {:array, {:array, :point}}
2✔
176
  defp encoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
2✔
177
  defp encoding_type({:json, opts}), do: {:json, opts}
2✔
178

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

337
  def encode(:datetime, %DateTime{time_zone: "Etc/UTC"} = datetime) do
338
    <<DateTime.to_unix(datetime, :second)::32-little>>
10✔
339
  end
340

341
  def encode(:datetime, %DateTime{} = datetime) do
342
    encode(:datetime, DateTime.shift_zone!(datetime, "Etc/UTC"))
8✔
343
  end
344

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

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

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

353
  def encode({:datetime64, time_unit}, %DateTime{time_zone: "Etc/UTC"} = datetime) do
354
    <<DateTime.diff(datetime, @epoch_utc_datetime, time_unit)::64-little-signed>>
4✔
355
  end
356

357
  def encode({:datetime64, _time_unit}, %DateTime{} = datetime) do
358
    raise ArgumentError, "non-UTC timezones are not supported for encoding: #{datetime}"
×
359
  end
360

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

363
  def encode(:date, %Date{} = date) do
364
    <<Date.diff(date, @epoch_date)::16-little>>
13✔
365
  end
366

367
  def encode(:date, nil), do: <<0::16>>
1✔
368

369
  def encode(:date32, %Date{} = date) do
370
    <<Date.diff(date, @epoch_date)::32-little-signed>>
8✔
371
  end
372

373
  def encode(:date32, nil), do: <<0::32>>
1✔
374

375
  def encode(:time, %Time{} = time) do
376
    {s, _micros} = Time.to_seconds_after_midnight(time)
10✔
377
    <<s::32-little-signed>>
10✔
378
  end
379

380
  def encode(:time, nil), do: <<0::32>>
×
381

382
  def encode({:time64, time_unit}, %Time{} = time) do
383
    {s, micros} = Time.to_seconds_after_midnight(time)
34✔
384

385
    micros_as_ticks =
34✔
386
      cond do
387
        time_unit < 1_000_000 -> div(micros, time_unit)
12✔
388
        time_unit == 1_000_000 -> micros
22✔
389
        true -> micros * div(time_unit, 1_000_000)
10✔
390
      end
391

392
    ticks = s * time_unit + micros_as_ticks
34✔
393
    <<ticks::64-little-signed>>
34✔
394
  end
395

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

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

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

411
    encode(:uuid, raw)
1✔
412
  end
413

414
  def encode(:uuid, nil), do: <<0::128>>
1✔
415

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

419
  def encode(:ipv6, {b1, b2, b3, b4, b5, b6, b7, b8}) do
420
    <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>
4✔
421
  end
422

423
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
×
424
  def encode(:ipv6, nil), do: <<0::128>>
×
425

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

432
  # TODO
433
  def encode(:dynamic, value) do
434
    case value do
20✔
435
      _ when is_binary(value) -> [0x15 | encode(:string, value)]
3✔
436
      _ when is_integer(value) and value >= 0 -> [0x04 | encode(:u64, value)]
5✔
437
      _ when is_integer(value) -> [0x0A | encode(:i64, value)]
2✔
438
      _ when is_float(value) -> [0x0E | encode(:f64, value)]
3✔
439
      %Date{} -> [0x0F | encode(:date, value)]
3✔
440
      %DateTime{} -> [0x11 | encode(:datetime, value)]
×
441
      %NaiveDateTime{} -> [0x11 | encode(:datetime, value)]
2✔
442
      %{} -> [0x30, 0x00, 0x80, 0x08, 0x20, 0x00, 0x00, 0x00 | encode(:json, value)]
2✔
443
      [] -> [0x1E, 0x00]
×
444
    end
445
  end
446

447
  # TODO enum8 and enum16 nil
448
  for size <- [8, 16] do
449
    enum_t = :"enum#{size}"
450
    int_t = :"i#{size}"
451

452
    def encode({unquote(enum_t), mapping}, e) do
453
      i =
12✔
454
        case e do
455
          _ when is_integer(e) ->
456
            e
4✔
457

458
          _ when is_binary(e) ->
459
            case Map.fetch(mapping, e) do
8✔
460
              {:ok, res} ->
461
                res
8✔
462

463
              :error ->
464
                raise ArgumentError,
×
465
                      "enum value #{inspect(e)} not found in mapping: #{inspect(mapping)}"
466
            end
467
        end
468

469
      encode(unquote(int_t), i)
12✔
470
    end
471
  end
472

473
  def encode({:nullable, _type}, nil), do: 1
12✔
474

475
  def encode({:nullable, type}, value) do
476
    case encode(type, value) do
11✔
477
      e when is_list(e) or is_binary(e) -> [0 | e]
11✔
478
      e -> [0, e]
×
479
    end
480
  end
481

482
  defp encode_varint_cont(i) when i < 128, do: <<i>>
8✔
483

484
  defp encode_varint_cont(i) do
12✔
485
    [(i &&& 0b0111_1111) ||| 0b1000_0000 | encode_varint_cont(i >>> 7)]
486
  end
487

488
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
129✔
489
  defp encode_many([] = done, _type), do: done
57✔
490

491
  defp encode_many_kv([{key, value} | rest], key_type, value_type) do
19✔
492
    [
493
      encode(key_type, key),
494
      encode(value_type, value)
495
      | encode_many_kv(rest, key_type, value_type)
496
    ]
497
  end
498

499
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
14✔
500

501
  # TODO find a better way than try/rescue
502
  defp try_encode_variant([type | types], idx, value) do
503
    try do
18✔
504
      encode(type, value)
18✔
505
    else
506
      encoded -> [idx | encoded]
10✔
507
    rescue
508
      _e -> try_encode_variant(types, idx + 1, value)
8✔
509
    end
510
  end
511

512
  defp try_encode_variant([], _idx, value) do
513
    raise ArgumentError, "no matching type found for encoding #{inspect(value)} as Variant"
×
514
  end
515

516
  @compile {:inline, d: 1}
517

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

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

569
  @doc false
570
  @spec decode_header(binary()) ::
571
          {:ok, names :: [String.t()], types :: [term], rest :: binary} | :more
572
  def decode_header(row_binary_with_names_and_types)
573

574
  for {pattern, value} <- varints do
575
    def decode_header(<<unquote(pattern), rest::bytes>>) do
576
      decode_header_names(rest, unquote(value), unquote(value), _acc = [])
42✔
577
    end
578
  end
579

580
  def decode_header(<<_bin::bytes>>) do
1✔
581
    :more
582
  end
583

584
  defp decode_header_names(<<rest::bytes>>, 0, count, names) do
585
    decode_header_types(rest, count, _acc = [], :lists.reverse(names))
27✔
586
  end
587

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

599
  defp decode_header_names(<<_bin::bytes>>, _left, _count, _acc) do
15✔
600
    :more
601
  end
602

603
  defp decode_header_types(<<rest::bytes>>, 0, types, names) do
604
    {:ok, names, decoding_types_reverse(types), rest}
7✔
605
  end
606

607
  for {pattern, value} <- varints do
608
    defp decode_header_types(
609
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
610
           count,
611
           acc,
612
           names
613
         ) do
614
      decode_header_types(rest, count - 1, [type | acc], names)
30✔
615
    end
616
  end
617

618
  defp decode_header_types(<<_bin::bytes>>, _count, _acc, _names) do
20✔
619
    :more
620
  end
621

622
  @doc """
623
  Decodes [RowBinaryWithNamesAndTypes](https://clickhouse.com/docs/en/interfaces/formats/RowBinaryWithNamesAndTypes) into rows.
624

625
  Example:
626

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

630
  """
631
  def decode_rows(row_binary_with_names_and_types)
632
  def decode_rows(<<>>), do: []
1✔
633

634
  for {pattern, value} <- varints do
635
    def decode_rows(<<unquote(pattern), rest::bytes>>) do
636
      skip_names(rest, unquote(value), unquote(value))
7✔
637
    end
638
  end
639

640
  @doc """
641
  Same as `decode_rows/1` but the first element is a list of column names.
642

643
  Example:
644

645
      iex> decode_names_and_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
646
      [["1+1"], [2]]
647

648
  """
649
  def decode_names_and_rows(row_binary_with_names_and_types)
650

651
  for {pattern, value} <- varints do
652
    def decode_names_and_rows(<<unquote(pattern), rest::bytes>>) do
653
      decode_names(rest, unquote(value), unquote(value), _acc = [])
1,453✔
654
    end
655
  end
656

657
  @doc """
658
  Decodes [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) into rows.
659

660
  Example:
661

662
      iex> decode_rows(<<1>>, ["UInt8"])
663
      [[1]]
664

665
  """
666
  def decode_rows(row_binary, types)
667
  def decode_rows(<<>>, _types), do: []
1✔
668

669
  def decode_rows(<<data::bytes>>, types) do
670
    decode_rows!(data, decoding_types(types))
13✔
671
  end
672

673
  defp decode_rows!(data, types) do
674
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
1,324✔
675

676
    case state do
1,290✔
677
      nil ->
678
        rows
1,288✔
679

680
      {:cont, types_rest, row} ->
681
        raise ArgumentError, """
2✔
682
        incomplete RowBinary data: ran out of bytes while decoding
683

684
        Expected to decode: #{inspect(types_rest)}
685
        Remaining bytes: #{byte_size(remaining_data)} bytes
2✔
686
        Partial row: #{inspect(row)}
687
        Completed rows: #{length(rows)}
2✔
688
        """
689
    end
690
  end
691

692
  @doc false
693
  def decode_rows_continue(<<data::bytes>>, types, state) do
694
    case state do
201,166✔
695
      {:cont, types_rest, row} -> decode_rows(types_rest, data, row, [], types)
201,074✔
696
      nil -> decode_rows(types, data, [], [], types)
92✔
697
    end
698
  end
699

700
  @doc false
701
  def decoding_types([type | types]) do
129✔
702
    [decoding_type(type) | decoding_types(types)]
703
  end
704

705
  def decoding_types([] = done), do: done
85✔
706

707
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
1,318✔
708

709
  defp decoding_types_reverse([type | types], acc) do
710
    decoding_types_reverse(types, [decoding_type(type) | acc])
4,176✔
711
  end
712

713
  defp decoding_types_reverse([], acc), do: acc
1,318✔
714

715
  defp decoding_type(t) when is_binary(t) do
716
    decoding_type(Ch.Types.decode(t))
4,291✔
717
  end
718

719
  defp decoding_type(t)
720
       when t in [
721
              :string,
722
              :binary,
723
              :json,
724
              :dynamic,
725
              :boolean,
726
              :uuid,
727
              :date,
728
              :date32,
729
              :time,
730
              :time64,
731
              :ipv4,
732
              :ipv6,
733
              :point,
734
              :nothing
735
            ],
736
       do: t
1,246✔
737

738
  defp decoding_type({:datetime, _tz} = t), do: t
32✔
739
  defp decoding_type({:fixed_string, _len} = t), do: t
22✔
740

741
  for size <- [8, 16, 32, 64, 128, 256] do
742
    defp decoding_type(unquote(:"u#{size}") = u), do: u
2,671✔
743
    defp decoding_type(unquote(:"i#{size}") = i), do: i
98✔
744
  end
745

746
  for size <- [32, 64] do
747
    defp decoding_type(unquote(:"f#{size}") = f), do: f
44✔
748
  end
749

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

752
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
124✔
753

754
  defp decoding_type({:tuple = t, ts}) do
18✔
755
    {t, Enum.map(ts, &decoding_type/1)}
756
  end
757

758
  defp decoding_type({:variant = v, ts}) do
28✔
759
    {v, Enum.map(ts, &decoding_type/1)}
760
  end
761

762
  defp decoding_type({:map = m, kt, vt}) do
763
    {m, decoding_type(kt), decoding_type(vt)}
25✔
764
  end
765

766
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
58✔
767
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
147✔
768

769
  defp decoding_type({:decimal = t, p, s}), do: {t, decimal_size(p), s}
62✔
770
  defp decoding_type({:decimal32, s}), do: {:decimal, 32, s}
1✔
771
  defp decoding_type({:decimal64, s}), do: {:decimal, 64, s}
1✔
772
  defp decoding_type({:decimal128, s}), do: {:decimal, 128, s}
1✔
773
  defp decoding_type({:decimal256, s}), do: {:decimal, 256, s}
1✔
774

775
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
33✔
776
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
20✔
777

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

780
  defp decoding_type({e, mappings}) when e in [:enum8, :enum16] do
17✔
781
    {e, Map.new(mappings, fn {k, v} -> {v, k} end)}
34✔
782
  end
783

784
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
785

786
  defp decoding_type(:ring), do: {:array, :point}
6✔
787
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
6✔
788
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
6✔
789
  defp decoding_type({:json, _opts}), do: :json
6✔
790

791
  defp decoding_type(type) do
792
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
×
793
  end
794

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

797
  for {pattern, value} <- varints do
798
    defp skip_names(<<unquote(pattern), _::size(unquote(value))-bytes, rest::bytes>>, left, count) do
799
      skip_names(rest, left - 1, count)
77✔
800
    end
801
  end
802

803
  defp decode_names(<<rest::bytes>>, 0, count, names) do
1,453✔
804
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
805
  end
806

807
  for {pattern, value} <- varints do
808
    defp decode_names(
809
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
810
           left,
811
           count,
812
           acc
813
         ) do
814
      decode_names(rest, left - 1, count, [name | acc])
4,242✔
815
    end
816
  end
817

818
  defp decode_types(<<>>, 0, _types), do: []
149✔
819

820
  defp decode_types(<<rest::bytes>>, 0, types) do
821
    decode_rows!(rest, decoding_types_reverse(types))
1,311✔
822
  end
823

824
  for {pattern, value} <- varints do
825
    defp decode_types(
826
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
827
           count,
828
           acc
829
         ) do
830
      decode_types(rest, count - 1, [type | acc])
4,319✔
831
    end
832
  end
833

834
  @compile inline: [decode_string_decode_rows: 5]
835

836
  for {pattern, size} <- varints do
837
    defp decode_string_decode_rows(
838
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
839
           types_rest,
840
           row,
841
           rows,
842
           types
843
         ) do
844
      decode_rows(types_rest, bin, [to_utf8(s) | row], rows, types)
1,130✔
845
    end
846
  end
847

848
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
849
    to_be_continued(rows, bin, [:string | types_rest], row)
100,165✔
850
  end
851

852
  @doc false
853
  def to_utf8(str) do
854
    utf8 = to_utf8(str, 0, 0, str, [])
1,130✔
855
    IO.iodata_to_binary(utf8)
1,130✔
856
  end
857

858
  @dialyzer {:no_improper_lists, to_utf8: 5, to_utf8_escape: 5}
859

860
  defp to_utf8(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
861
    to_utf8(rest, from, len + utf8_size(valid), original, acc)
30,139,407✔
862
  end
863

864
  defp to_utf8(<<_invalid, rest::bytes>>, from, len, original, acc) do
865
    acc = [acc | binary_part(original, from, len)]
6✔
866
    to_utf8_escape(rest, from + len, 1, original, acc)
6✔
867
  end
868

869
  defp to_utf8(<<>>, from, len, original, acc) do
1,129✔
870
    [acc | binary_part(original, from, len)]
871
  end
872

873
  defp to_utf8_escape(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
874
    acc = [acc | "�"]
5✔
875
    to_utf8(rest, from + len, utf8_size(valid), original, acc)
5✔
876
  end
877

878
  defp to_utf8_escape(<<_invalid, rest::bytes>>, from, len, original, acc) do
879
    to_utf8_escape(rest, from, len + 1, original, acc)
7✔
880
  end
881

882
  defp to_utf8_escape(<<>>, _from, _len, _original, acc) do
1✔
883
    [acc | "�"]
884
  end
885

886
  # UTF-8 encodes code points in one to four bytes
887
  @compile inline: [utf8_size: 1]
888
  defp utf8_size(codepoint) when codepoint <= 0x7F, do: 1
30,139,376✔
889
  defp utf8_size(codepoint) when codepoint <= 0x7FF, do: 2
13✔
890
  defp utf8_size(codepoint) when codepoint <= 0xFFFF, do: 3
23✔
891
  defp utf8_size(codepoint) when codepoint <= 0x10FFFF, do: 4
×
892

893
  @compile inline: [decode_string_json_decode_rows: 5]
894

895
  for {pattern, size} <- varints do
896
    defp decode_string_json_decode_rows(
897
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
898
           types_rest,
899
           row,
900
           rows,
901
           types
902
         ) do
903
      decode_rows(types_rest, bin, [Jason.decode!(s) | row], rows, types)
98✔
904
    end
905
  end
906

907
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
908
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
909
  end
910

911
  @compile inline: [decode_binary_decode_rows: 5]
912

913
  for {pattern, size} <- varints do
914
    defp decode_binary_decode_rows(
915
           <<unquote(pattern), s::size(unquote(size))-bytes, bin::bytes>>,
916
           types_rest,
917
           row,
918
           rows,
919
           types
920
         ) do
921
      decode_rows(types_rest, bin, [s | row], rows, types)
4✔
922
    end
923
  end
924

925
  defp decode_binary_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
926
    to_be_continued(rows, bin, [:binary | types_rest], row)
100,007✔
927
  end
928

929
  @compile inline: [decode_array_decode_rows: 6]
930
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
931
    decode_rows(types_rest, bin, [[] | row], rows, types)
85✔
932
  end
933

934
  for {pattern, size} <- varints do
935
    defp decode_array_decode_rows(
936
           <<unquote(pattern), bin::bytes>>,
937
           type,
938
           types_rest,
939
           row,
940
           rows,
941
           types
942
         ) do
943
      array_types = List.duplicate(type, unquote(size))
285✔
944
      types_rest = array_types ++ [{:array_over, row} | types_rest]
285✔
945
      decode_rows(types_rest, bin, [], rows, types)
285✔
946
    end
947
  end
948

949
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
950
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
951
  end
952

953
  @compile inline: [decode_map_decode_rows: 7]
954
  defp decode_map_decode_rows(
955
         <<0, bin::bytes>>,
956
         _key_type,
957
         _value_type,
958
         types_rest,
959
         row,
960
         rows,
961
         types
962
       ) do
963
    decode_rows(types_rest, bin, [%{} | row], rows, types)
10✔
964
  end
965

966
  for {pattern, size} <- varints do
967
    defp decode_map_decode_rows(
968
           <<unquote(pattern), bin::bytes>>,
969
           key_type,
970
           value_type,
971
           types_rest,
972
           row,
973
           rows,
974
           types
975
         ) do
976
      types_rest =
32✔
977
        map_types(unquote(size), key_type, value_type) ++ [{:map_over, row} | types_rest]
978

979
      decode_rows(types_rest, bin, [], rows, types)
32✔
980
    end
981
  end
982

983
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
984
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
985
  end
986

987
  defp map_types(count, key_type, value_type) when count > 0 do
57✔
988
    [key_type, value_type | map_types(count - 1, key_type, value_type)]
989
  end
990

991
  defp map_types(0, _key_type, _value_types), do: []
32✔
992

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

1019
  # TODO compile inline?
1020

1021
  for {type, code} <- dynamic_types do
1022
    defp decode_dynamic(
1023
           <<unquote(code), rest::bytes>>,
1024
           dynamic,
1025
           types_rest,
1026
           row,
1027
           rows,
1028
           types
1029
         ) do
1030
      decode_dynamic_continue(rest, [unquote(type) | dynamic], types_rest, row, rows, types)
254✔
1031
    end
1032
  end
1033

1034
  # DateTime 0x11
1035
  defp decode_dynamic(<<0x11, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1036
    decode_dynamic_continue(rest, [{:datetime, nil} | dynamic], types_rest, row, rows, types)
4✔
1037
  end
1038

1039
  # DateTime(time_zone) 0x12 <var_uint_time_zone_name_size><time_zone_name_data>
1040
  for {pattern, size} <- varints do
1041
    defp decode_dynamic(
1042
           <<0x12, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1043
           dynamic,
1044
           types_rest,
1045
           row,
1046
           rows,
1047
           types
1048
         ) do
1049
      decode_dynamic_continue(rest, [{:datetime, tz} | dynamic], types_rest, row, rows, types)
2✔
1050
    end
1051
  end
1052

1053
  # DateTime64(P) 0x13 <uint8_precision>
1054
  defp decode_dynamic(
1055
         <<0x13, precision, rest::bytes>>,
1056
         dynamic,
1057
         types_rest,
1058
         row,
1059
         rows,
1060
         types
1061
       ) do
1062
    decode_dynamic_continue(
2✔
1063
      rest,
1064
      [decoding_type({:datetime64, precision}) | dynamic],
1065
      types_rest,
1066
      row,
1067
      rows,
1068
      types
1069
    )
1070
  end
1071

1072
  # DateTime64(P, time_zone) 0x14 <uint8_precision><var_uint_time_zone_name_size><time_zone_name_data>
1073
  for {pattern, size} <- varints do
1074
    defp decode_dynamic(
1075
           <<0x14, precision, unquote(pattern), tz::size(unquote(size))-bytes, rest::bytes>>,
1076
           dynamic,
1077
           types_rest,
1078
           row,
1079
           rows,
1080
           types
1081
         ) do
1082
      decode_dynamic_continue(
2✔
1083
        rest,
1084
        [decoding_type({:datetime64, precision, tz}) | dynamic],
1085
        types_rest,
1086
        row,
1087
        rows,
1088
        types
1089
      )
1090
    end
1091
  end
1092

1093
  # FixedString(N) 0x16 <var_uint_size>
1094
  for {pattern, size} <- varints do
1095
    defp decode_dynamic(
1096
           <<0x16, unquote(pattern), rest::bytes>>,
1097
           dynamic,
1098
           types_rest,
1099
           row,
1100
           rows,
1101
           types
1102
         ) do
1103
      decode_dynamic_continue(
4✔
1104
        rest,
1105
        [{:fixed_string, unquote(size)} | dynamic],
1106
        types_rest,
1107
        row,
1108
        rows,
1109
        types
1110
      )
1111
    end
1112
  end
1113

1114
  # Decimal32(P, S) 0x19 <uint8_precision><uint8_scale>
1115
  # Decimal64(P, S) 0x1A <uint8_precision><uint8_scale>
1116
  # Decimal128(P, S) 0x1B <uint8_precision><uint8_scale>
1117
  # Decimal256(P, S) 0x1C <uint8_precision><uint8_scale>
1118
  for {code, size} <- [{0x19, 32}, {0x1A, 64}, {0x1B, 128}, {0x1C, 256}] do
1119
    defp decode_dynamic(
1120
           <<unquote(code), _precision, scale, rest::bytes>>,
1121
           dynamic,
1122
           types_rest,
1123
           row,
1124
           rows,
1125
           types
1126
         ) do
1127
      decode_dynamic_continue(
8✔
1128
        rest,
1129
        [{:decimal, unquote(size), scale} | dynamic],
1130
        types_rest,
1131
        row,
1132
        rows,
1133
        types
1134
      )
1135
    end
1136
  end
1137

1138
  # Array(T) 0x1E <nested_type_encoding>
1139
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1140
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
74✔
1141
  end
1142

1143
  # Nullable(T)        0x23 <nested_type_encoding>
1144
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1145
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
12✔
1146
  end
1147

1148
  # LowCardinality(T) 0x26 <nested_type_encoding>
1149
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1150
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
4✔
1151
  end
1152

1153
  # 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>...
1154
  defp decode_dynamic(<<0x30, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1155
    # Assert uint8_serialization_version to be 0
1156
    <<0x00, rest::bytes>> = rest
16✔
1157

1158
    # Skip var_int_max_dynamic_paths
1159
    {_paths, rest} = read_varint(rest)
16✔
1160

1161
    # Skip uint8_max_dynamic_types
1162
    <<_val, rest::bytes>> = rest
16✔
1163

1164
    # Read var_uint_number_of_typed_paths
1165
    {typed_paths, rest} = read_varint(rest)
16✔
1166

1167
    # Skip `typed_paths` typed paths
1168
    rest =
16✔
1169
      Enum.reduce(1..typed_paths//1, rest, fn _, rest ->
1170
        {count, rest} = read_varint(rest)
2✔
1171
        <<_discard::size(count)-bytes, rest::bytes>> = rest
2✔
1172
        skip_type(rest)
2✔
1173
      end)
1174

1175
    # Read var_uint_number_of_skip_paths
1176
    {skip_paths, rest} = read_varint(rest)
14✔
1177

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

1186
    # Read var_uint_number_of_skip_path_regexps
1187
    {skip_path_regexes, rest} = read_varint(rest)
14✔
1188

1189
    # Skip `skip_path_regexes` skipped paths regex
1190
    rest =
14✔
1191
      Enum.reduce(1..skip_path_regexes//1, rest, fn _, rest ->
1192
        {count, rest} = read_varint(rest)
×
1193
        <<_discard::size(count)-bytes, rest::bytes>> = rest
×
1194
        rest
×
1195
      end)
1196

1197
    decode_dynamic_continue(rest, [:json | dynamic], types_rest, row, rows, types)
14✔
1198
  end
1199

1200
  for {pattern, value} <- varints do
1201
    defp read_varint(<<unquote(pattern), rest::bytes>>), do: {unquote(value), rest}
62✔
1202
  end
1203

1204
  other_dynamic_types = [
1205
    datetime: 0x11,
1206
    set: 0x21,
1207
    bfloat16: 0x31,
1208
    time: 0x32
1209
  ]
1210

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

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

1221
  # TODO
1222
  # 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>
1223
  # 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>
1224
  # Tuple(T1, ..., TN)        0x1F <var_uint_number_of_elements><nested_type_encoding_1>...<nested_type_encoding_N>
1225
  # 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>
1226
  # Set        0x21
1227
  # Interval        0x22 <interval_kind> (see interval kind binary encoding)
1228
  # Function        0x24<var_uint_number_of_arguments><argument_type_encoding_1>...<argument_type_encoding_N><return_type_encoding>
1229
  # 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)
1230
  # Map(K, V)        0x27<key_type_encoding><value_type_encoding>
1231
  # Variant(T1, ..., TN)        0x2A<var_uint_number_of_variants><variant_type_encoding_1>...<variant_type_encoding_N>
1232
  # Dynamic(max_types=N)        0x2B<uint8_max_types>
1233
  # Custom type (Ring, Polygon, etc)        0x2C<var_uint_type_name_size><type_name_data>
1234
  # 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)
1235
  # 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>
1236

1237
  unsupported_dynamic_types = %{
1238
    "Enum8" => 0x17,
1239
    "Enum16" => 0x18,
1240
    "Tuple" => 0x1F,
1241
    "TupleWithNames" => 0x20,
1242
    "Set" => 0x21,
1243
    "Interval" => 0x22,
1244
    "Function" => 0x24,
1245
    "AggregateFunction" => 0x25,
1246
    "Map" => 0x27,
1247
    "Variant" => 0x2A,
1248
    "Dynamic" => 0x2B,
1249
    "CustomType" => 0x2C,
1250
    "SimpleAggregateFunction" => 0x2E,
1251
    "Nested" => 0x2F
1252
  }
1253

1254
  for {type, code} <- unsupported_dynamic_types do
1255
    defp decode_dynamic(<<unquote(code), _::bytes>>, _dynamic, _types_rest, _row, _rows, _types) do
1256
      raise ArgumentError, "unsupported dynamic type #{unquote(type)}"
14✔
1257
    end
1258
  end
1259

1260
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1261
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1262
  end
1263

1264
  @compile inline: [decode_dynamic_continue: 6]
1265

1266
  defp decode_dynamic_continue(<<rest::bytes>>, dynamic, types_rest, row, rows, types) do
1267
    continue? =
318✔
1268
      case dynamic do
1269
        [:array | _] -> true
74✔
1270
        [:nullable | _] -> true
12✔
1271
        [:low_cardinality | _] -> true
4✔
1272
        _ -> false
244✔
1273
      end
1274

1275
    if continue? do
318✔
1276
      decode_dynamic(rest, dynamic, types_rest, row, rows, types)
90✔
1277
    else
1278
      type = build_dynamic_type(:lists.reverse(dynamic))
244✔
1279
      decode_rows([type | types_rest], rest, row, rows, types)
244✔
1280
    end
1281
  end
1282

1283
  defp build_dynamic_type([type]), do: type
290✔
1284

1285
  defp build_dynamic_type(type) do
1286
    case type do
88✔
1287
      [:array | rest] -> {:array, build_dynamic_type(rest)}
72✔
1288
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
12✔
1289
      [:low_cardinality | rest] -> build_dynamic_type(rest)
4✔
1290
    end
1291
  end
1292

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

1349
  for {type, clauses} <- simple_types do
1350
    fun = :"decode_#{type}_decode_rows"
1351
    @compile inline: [{fun, 5}]
1352

1353
    for %{pattern: pattern, value: value} <- List.wrap(clauses) do
1354
      defp unquote(fun)(<<unquote(pattern), rest::bytes>>, types_rest, row, rows, types) do
1355
        decode_rows(types_rest, rest, [unquote(value) | row], rows, types)
2,154,379✔
1356
      end
1357
    end
1358

1359
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1360
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
582✔
1361
    end
1362
  end
1363

1364
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1365
    case type do
2,358,487✔
1366
      :u8 ->
1367
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
1,219✔
1368

1369
      :u16 ->
1370
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
1,524✔
1371

1372
      :u32 ->
1373
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
73✔
1374

1375
      :u64 ->
1376
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,150,989✔
1377

1378
      :u128 ->
1379
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
40✔
1380

1381
      :u256 ->
1382
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
72✔
1383

1384
      :i8 ->
1385
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
40✔
1386

1387
      :i16 ->
1388
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
20✔
1389

1390
      :i32 ->
1391
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
42✔
1392

1393
      :i64 ->
1394
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
178✔
1395

1396
      :i128 ->
1397
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
41✔
1398

1399
      :i256 ->
1400
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
73✔
1401

1402
      :f32 ->
1403
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
36✔
1404

1405
      :f64 ->
1406
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
60✔
1407

1408
      :string ->
1409
        decode_string_decode_rows(bin, types_rest, row, rows, types)
101,295✔
1410

1411
      :binary ->
1412
        decode_binary_decode_rows(bin, types_rest, row, rows, types)
100,011✔
1413

1414
      :json ->
1415
        # assuming it arrives as text and not "native" binary JSON
1416
        # i.e. assumes `settings: [output_format_binary_write_json_as_string: 1]`
1417
        # TODO
1418
        decode_string_json_decode_rows(bin, types_rest, row, rows, types)
144✔
1419

1420
      :dynamic ->
1421
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
306✔
1422

1423
      {:dynamic, dynamic} ->
1424
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1425

1426
      # TODO utf8?
1427
      {:fixed_string, size} ->
1428
        case bin do
43✔
1429
          <<s::size(^size)-bytes, rest::bytes>> ->
1430
            decode_rows(types_rest, rest, [s | row], rows, types)
29✔
1431

1432
          _ ->
1433
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1434
        end
1435

1436
      :boolean ->
1437
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
66✔
1438

1439
      :uuid ->
1440
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
86✔
1441

1442
      :date ->
1443
        decode_date_decode_rows(bin, types_rest, row, rows, types)
42✔
1444

1445
      :date32 ->
1446
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
40✔
1447

1448
      :time ->
1449
        decode_time_decode_rows(bin, types_rest, row, rows, types)
46✔
1450

1451
      {:time64, time_unit} ->
1452
        case bin do
180✔
1453
          <<ticks::64-little-signed, bin::bytes>> ->
1454
            time = time_after_midnight(ticks, time_unit)
150✔
1455
            decode_rows(types_rest, bin, [time | row], rows, types)
142✔
1456

1457
          _ ->
1458
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1459
        end
1460

1461
      {:datetime, timezone} ->
1462
        case bin do
88✔
1463
          <<s::32-little, bin::bytes>> ->
1464
            dt = DateTime.from_unix!(s)
66✔
1465

1466
            dt =
66✔
1467
              case timezone do
1468
                nil -> DateTime.to_naive(dt)
26✔
1469
                "UTC" -> dt
22✔
1470
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1471
              end
1472

1473
            decode_rows(types_rest, bin, [dt | row], rows, types)
64✔
1474

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

1479
      {:decimal, size, scale} ->
1480
        case bin do
198✔
1481
          <<val::size(^size)-little-signed, bin::bytes>> ->
1482
            sign = if val < 0, do: -1, else: 1
80✔
1483
            d = Decimal.new(sign, abs(val), -scale)
80✔
1484
            decode_rows(types_rest, bin, [d | row], rows, types)
80✔
1485

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

1490
      {:nullable, inner_type} ->
1491
        case bin do
181✔
1492
          <<b, bin::bytes>> ->
1493
            case b do
178✔
1494
              0 -> decode_rows([inner_type | types_rest], bin, row, rows, types)
85✔
1495
              1 -> decode_rows(types_rest, bin, [nil | row], rows, types)
93✔
1496
            end
1497

1498
          _ ->
1499
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1500
        end
1501

1502
      :nothing ->
1503
        decode_rows(types_rest, bin, [nil | row], rows, types)
62✔
1504

1505
      {:array, inner_type} ->
1506
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
382✔
1507

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

1511
      {:map, key_type, value_type} ->
1512
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
48✔
1513

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

1518
      {:tuple, tuple_types} ->
1519
        decode_rows(tuple_types ++ [{:tuple_over, row} | types_rest], bin, [], rows, types)
26✔
1520

1521
      {:tuple_over, original_row} ->
1522
        tuple = row |> :lists.reverse() |> List.to_tuple()
26✔
1523
        decode_rows(types_rest, bin, [tuple | original_row], rows, types)
26✔
1524

1525
      {:variant, variant_types} ->
1526
        case bin do
59✔
1527
          <<255, bin::bytes>> ->
1528
            # 255 is the variant type index for "nothing"
1529
            decode_rows(types_rest, bin, [nil | row], rows, types)
12✔
1530

1531
          # TODO varint?
1532
          <<variant_type_index::8, bin::bytes>> ->
1533
            variant_type = Enum.at(variant_types, variant_type_index)
44✔
1534
            decode_rows([variant_type | types_rest], bin, row, rows, types)
44✔
1535

1536
          _ ->
1537
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1538
        end
1539

1540
      {:datetime64, time_unit, timezone} ->
1541
        case bin do
122✔
1542
          <<s::64-little-signed, bin::bytes>> ->
1543
            dt = DateTime.from_unix!(s, time_unit)
60✔
1544

1545
            dt =
60✔
1546
              case timezone do
1547
                nil -> DateTime.to_naive(dt)
34✔
1548
                "UTC" -> dt
8✔
1549
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1550
              end
1551

1552
            decode_rows(types_rest, bin, [dt | row], rows, types)
60✔
1553

1554
          _ ->
1555
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1556
        end
1557

1558
      {:enum8, mapping} ->
1559
        case bin do
28✔
1560
          <<v::signed, bin::bytes>> ->
1561
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
28✔
1562

1563
          _ ->
UNCOV
1564
            to_be_continued(rows, bin, [type | types_rest], row)
×
1565
        end
1566

1567
      {:enum16, mapping} ->
1568
        case bin do
8✔
1569
          <<v::16-little-signed, bin::bytes>> ->
1570
            decode_rows(types_rest, bin, [Map.fetch!(mapping, v) | row], rows, types)
4✔
1571

1572
          _ ->
1573
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1574
        end
1575

1576
      :ipv4 ->
1577
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
24✔
1578

1579
      :ipv6 ->
1580
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
74✔
1581

1582
      :point ->
1583
        decode_point_decode_rows(bin, types_rest, row, rows, types)
176✔
1584
    end
1585
  end
1586

1587
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1588
    rows = :lists.reverse([:lists.reverse(row) | rows])
1,380✔
1589
    {rows, empty, _no_state = nil}
1,380✔
1590
  end
1591

1592
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1593
    row = :lists.reverse(row)
2,151,127✔
1594
    decode_rows(types, bin, [], [row | rows], types)
2,151,127✔
1595
  end
1596

1597
  defp decode_rows([_ | _] = types_rest, <<>> = empty, row, rows, _types) do
UNCOV
1598
    to_be_continued(rows, empty, types_rest, row)
×
1599
  end
1600

1601
  @compile inline: [to_be_continued: 4]
1602
  defp to_be_continued(rows, bin, types_rest, row) do
1603
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,719✔
1604
  end
1605

1606
  @compile inline: [decimal_size: 1]
1607
  # https://clickhouse.com/docs/en/sql-reference/data-types/decimal/
1608
  defp decimal_size(precision) when is_integer(precision) do
1609
    cond do
62✔
1610
      precision >= 39 -> 256
4✔
1611
      precision >= 19 -> 128
58✔
1612
      precision >= 10 -> 64
49✔
1613
      true -> 32
33✔
1614
    end
1615
  end
1616

1617
  @compile inline: [time_unit: 1]
1618
  for precision <- 0..9 do
1619
    time_unit = round(:math.pow(10, precision))
1620

1621
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1622
  end
1623

1624
  @compile inline: [time_after_midnight: 2]
1625
  defp time_after_midnight(ticks, time_unit) do
1626
    if ticks >= 0 and ticks < 86400 * time_unit do
182✔
1627
      ticks |> DateTime.from_unix!(time_unit) |> DateTime.to_time()
166✔
1628
    else
1629
      # since ClickHouse supports Time64 values of [-999:59:59.999999999, 999:59:59.999999999]
1630
      # and Elixir's Time supports values of [00:00:00.000000, 23:59:59.999999]
1631
      # we raise an error when ClickHouse's Time64 value is out of Elixir's Time range
1632
      raise ArgumentError,
8✔
1633
            "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✔
1634

1635
      # TODO: we could potentially decode ClickHouse's Time/Time64 values as Elixir's Duration when it's out of Elixir's Time range
1636
    end
1637
  end
1638
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