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

plausible / ch / 1f7ac2a2deb23f65832094142cf90713c817155b-PR-311

20 Apr 2026 06:03PM UTC coverage: 91.609% (+0.1%) from 91.494%
1f7ac2a2deb23f65832094142cf90713c817155b-PR-311

Pull #311

github

ruslandoga
continue
Pull Request #311: improve naive datetime handling in rowbinary

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

39 existing lines in 1 file now uncovered.

928 of 1013 relevant lines covered (91.61%)

79495.41 hits per line

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

88.74
/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
UNCOV
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

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

112
  defp encoding_type({:datetime, tz}) do
UNCOV
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
UNCOV
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

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

161
  defp encoding_type({:datetime64, _, tz}) do
UNCOV
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

UNCOV
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
UNCOV
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
UNCOV
262
    type =
×
263
      case decimal_size(precision) do
UNCOV
264
        32 -> :decimal32
×
265
        64 -> :decimal64
×
266
        128 -> :decimal128
×
267
        256 -> :decimal256
×
268
      end
269

UNCOV
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
UNCOV
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{} = naive) do
332
    {seconds, _micros} = NaiveDateTime.to_gregorian_seconds(naive)
18✔
333
    # TODO raise if negative?
334
    epoch_seconds = seconds - @epoch_gregorian_seconds
18✔
335
    <<epoch_seconds::32-little>>
18✔
336
  end
337

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

342
  def encode(:datetime, nil), do: <<0::32>>
1✔
343

344
  def encode({:datetime64, time_unit}, %NaiveDateTime{} = naive) do
345
    {seconds, micros} = NaiveDateTime.to_gregorian_seconds(naive)
8✔
346

347
    t =
8✔
348
      (seconds - @epoch_gregorian_seconds) * time_unit + div(micros * time_unit, 1_000_000)
349

350
    <<t::64-little-signed>>
8✔
351
  end
352

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

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

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

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

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

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

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

UNCOV
376
  def encode(:time, nil), do: <<0::32>>
×
377

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

381
    micros_as_ticks =
34✔
382
      cond do
383
        time_unit < 1_000_000 -> div(micros, time_unit)
12✔
384
        time_unit == 1_000_000 -> micros
22✔
385
        true -> micros * div(time_unit, 1_000_000)
10✔
386
      end
387

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

UNCOV
392
  def encode({:time64, _time_unit}, nil), do: <<0::64>>
×
393

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

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

407
    encode(:uuid, raw)
1✔
408
  end
409

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

412
  def encode(:ipv4, {a, b, c, d}), do: [d, c, b, a]
4✔
UNCOV
413
  def encode(:ipv4, nil), do: <<0::32>>
×
414

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

UNCOV
419
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
×
UNCOV
420
  def encode(:ipv6, nil), do: <<0::128>>
×
421

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

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

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

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

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

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

465
      encode(unquote(int_t), i)
12✔
466
    end
467
  end
468

469
  def encode({:nullable, _type}, nil), do: 1
12✔
470

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

478
  defp encode_varint_cont(i) when i < 128, do: <<i>>
8✔
479

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

484
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
129✔
485
  defp encode_many([] = done, _type), do: done
57✔
486

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

495
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
14✔
496

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

621
  Example:
622

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

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

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

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

639
  Example:
640

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

644
  """
645
  def decode_names_and_rows(row_binary_with_names_and_types)
646

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

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

656
  Example:
657

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

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

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

669
  defp decode_rows!(data, types) do
670
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
1,324✔
671

672
    case state do
1,290✔
673
      nil ->
674
        rows
1,288✔
675

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

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

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

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

701
  def decoding_types([] = done), do: done
85✔
702

703
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
1,318✔
704

705
  defp decoding_types_reverse([type | types], acc) do
706
    decoding_types_reverse(types, [decoding_type(type) | acc])
4,176✔
707
  end
708

709
  defp decoding_types_reverse([], acc), do: acc
1,318✔
710

711
  defp decoding_type(t) when is_binary(t) do
712
    decoding_type(Ch.Types.decode(t))
4,291✔
713
  end
714

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

734
  defp decoding_type({:datetime, _tz} = t), do: t
32✔
735
  defp decoding_type({:fixed_string, _len} = t), do: t
22✔
736

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

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

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

748
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
124✔
749

750
  defp decoding_type({:tuple = t, ts}) do
18✔
751
    {t, Enum.map(ts, &decoding_type/1)}
752
  end
753

754
  defp decoding_type({:variant = v, ts}) do
28✔
755
    {v, Enum.map(ts, &decoding_type/1)}
756
  end
757

758
  defp decoding_type({:map = m, kt, vt}) do
759
    {m, decoding_type(kt), decoding_type(vt)}
25✔
760
  end
761

762
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
58✔
763
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
147✔
764

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

771
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
33✔
772
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
20✔
773

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

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

780
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
781

782
  defp decoding_type(:ring), do: {:array, :point}
6✔
783
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
6✔
784
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
6✔
785
  defp decoding_type({:json, _opts}), do: :json
6✔
786

787
  defp decoding_type(type) do
UNCOV
788
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
×
789
  end
790

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

793
  for {pattern, value} <- varints do
794
    defp skip_names(<<unquote(pattern), _::size(unquote(value))-bytes, rest::bytes>>, left, count) do
795
      skip_names(rest, left - 1, count)
77✔
796
    end
797
  end
798

799
  defp decode_names(<<rest::bytes>>, 0, count, names) do
1,453✔
800
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
801
  end
802

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

814
  defp decode_types(<<>>, 0, _types), do: []
149✔
815

816
  defp decode_types(<<rest::bytes>>, 0, types) do
817
    decode_rows!(rest, decoding_types_reverse(types))
1,311✔
818
  end
819

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

830
  @compile inline: [decode_string_decode_rows: 5]
831

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

844
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
845
    to_be_continued(rows, bin, [:string | types_rest], row)
100,165✔
846
  end
847

848
  @doc false
849
  def to_utf8(str) do
850
    utf8 = to_utf8(str, 0, 0, str, [])
1,130✔
851
    IO.iodata_to_binary(utf8)
1,130✔
852
  end
853

854
  @dialyzer {:no_improper_lists, to_utf8: 5, to_utf8_escape: 5}
855

856
  defp to_utf8(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
857
    to_utf8(rest, from, len + utf8_size(valid), original, acc)
30,139,407✔
858
  end
859

860
  defp to_utf8(<<_invalid, rest::bytes>>, from, len, original, acc) do
861
    acc = [acc | binary_part(original, from, len)]
6✔
862
    to_utf8_escape(rest, from + len, 1, original, acc)
6✔
863
  end
864

865
  defp to_utf8(<<>>, from, len, original, acc) do
1,129✔
866
    [acc | binary_part(original, from, len)]
867
  end
868

869
  defp to_utf8_escape(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
870
    acc = [acc | "�"]
5✔
871
    to_utf8(rest, from + len, utf8_size(valid), original, acc)
5✔
872
  end
873

874
  defp to_utf8_escape(<<_invalid, rest::bytes>>, from, len, original, acc) do
875
    to_utf8_escape(rest, from, len + 1, original, acc)
7✔
876
  end
877

878
  defp to_utf8_escape(<<>>, _from, _len, _original, acc) do
1✔
879
    [acc | "�"]
880
  end
881

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

889
  @compile inline: [decode_string_json_decode_rows: 5]
890

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

903
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
904
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
905
  end
906

907
  @compile inline: [decode_binary_decode_rows: 5]
908

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

921
  defp decode_binary_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
922
    to_be_continued(rows, bin, [:binary | types_rest], row)
100,007✔
923
  end
924

925
  @compile inline: [decode_array_decode_rows: 6]
926
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
927
    decode_rows(types_rest, bin, [[] | row], rows, types)
85✔
928
  end
929

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

945
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
946
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
947
  end
948

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

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

975
      decode_rows(types_rest, bin, [], rows, types)
32✔
976
    end
977
  end
978

979
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
980
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
981
  end
982

983
  defp map_types(count, key_type, value_type) when count > 0 do
57✔
984
    [key_type, value_type | map_types(count - 1, key_type, value_type)]
985
  end
986

987
  defp map_types(0, _key_type, _value_types), do: []
32✔
988

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

1015
  # TODO compile inline?
1016

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

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

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

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

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

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

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

1134
  # Array(T) 0x1E <nested_type_encoding>
1135
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1136
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
74✔
1137
  end
1138

1139
  # Nullable(T)        0x23 <nested_type_encoding>
1140
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1141
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
12✔
1142
  end
1143

1144
  # LowCardinality(T) 0x26 <nested_type_encoding>
1145
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1146
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
4✔
1147
  end
1148

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

1154
    # Skip var_int_max_dynamic_paths
1155
    {_paths, rest} = read_varint(rest)
16✔
1156

1157
    # Skip uint8_max_dynamic_types
1158
    <<_val, rest::bytes>> = rest
16✔
1159

1160
    # Read var_uint_number_of_typed_paths
1161
    {typed_paths, rest} = read_varint(rest)
16✔
1162

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

1171
    # Read var_uint_number_of_skip_paths
1172
    {skip_paths, rest} = read_varint(rest)
14✔
1173

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

1182
    # Read var_uint_number_of_skip_path_regexps
1183
    {skip_path_regexes, rest} = read_varint(rest)
14✔
1184

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

1193
    decode_dynamic_continue(rest, [:json | dynamic], types_rest, row, rows, types)
14✔
1194
  end
1195

1196
  for {pattern, value} <- varints do
1197
    defp read_varint(<<unquote(pattern), rest::bytes>>), do: {unquote(value), rest}
62✔
1198
  end
1199

1200
  other_dynamic_types = [
1201
    datetime: 0x11,
1202
    set: 0x21,
1203
    bfloat16: 0x31,
1204
    time: 0x32
1205
  ]
1206

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

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

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

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

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

1256
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1257
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1258
  end
1259

1260
  @compile inline: [decode_dynamic_continue: 6]
1261

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

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

1279
  defp build_dynamic_type([type]), do: type
290✔
1280

1281
  defp build_dynamic_type(type) do
1282
    case type do
88✔
1283
      [:array | rest] -> {:array, build_dynamic_type(rest)}
72✔
1284
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
12✔
1285
      [:low_cardinality | rest] -> build_dynamic_type(rest)
4✔
1286
    end
1287
  end
1288

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

1345
  for {type, clauses} <- simple_types do
1346
    fun = :"decode_#{type}_decode_rows"
1347
    @compile inline: [{fun, 5}]
1348

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

1355
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1356
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
582✔
1357
    end
1358
  end
1359

1360
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1361
    case type do
2,358,487✔
1362
      :u8 ->
1363
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
1,219✔
1364

1365
      :u16 ->
1366
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
1,524✔
1367

1368
      :u32 ->
1369
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
73✔
1370

1371
      :u64 ->
1372
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,150,989✔
1373

1374
      :u128 ->
1375
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
40✔
1376

1377
      :u256 ->
1378
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
72✔
1379

1380
      :i8 ->
1381
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
40✔
1382

1383
      :i16 ->
1384
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
20✔
1385

1386
      :i32 ->
1387
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
42✔
1388

1389
      :i64 ->
1390
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
178✔
1391

1392
      :i128 ->
1393
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
41✔
1394

1395
      :i256 ->
1396
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
73✔
1397

1398
      :f32 ->
1399
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
36✔
1400

1401
      :f64 ->
1402
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
60✔
1403

1404
      :string ->
1405
        decode_string_decode_rows(bin, types_rest, row, rows, types)
101,295✔
1406

1407
      :binary ->
1408
        decode_binary_decode_rows(bin, types_rest, row, rows, types)
100,011✔
1409

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

1416
      :dynamic ->
1417
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
306✔
1418

1419
      {:dynamic, dynamic} ->
1420
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1421

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

1428
          _ ->
1429
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1430
        end
1431

1432
      :boolean ->
1433
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
66✔
1434

1435
      :uuid ->
1436
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
86✔
1437

1438
      :date ->
1439
        decode_date_decode_rows(bin, types_rest, row, rows, types)
42✔
1440

1441
      :date32 ->
1442
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
40✔
1443

1444
      :time ->
1445
        decode_time_decode_rows(bin, types_rest, row, rows, types)
46✔
1446

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

1453
          _ ->
1454
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1455
        end
1456

1457
      {:datetime, timezone} ->
1458
        case bin do
88✔
1459
          <<s::32-little, bin::bytes>> ->
1460
            dt = DateTime.from_unix!(s)
66✔
1461

1462
            dt =
66✔
1463
              case timezone do
1464
                nil -> DateTime.to_naive(dt)
26✔
1465
                "UTC" -> dt
22✔
1466
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1467
              end
1468

1469
            decode_rows(types_rest, bin, [dt | row], rows, types)
64✔
1470

1471
          _ ->
1472
            to_be_continued(rows, bin, [type | types_rest], row)
22✔
1473
        end
1474

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

1482
          _ ->
1483
            to_be_continued(rows, bin, [type | types_rest], row)
118✔
1484
        end
1485

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

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

1498
      :nothing ->
1499
        decode_rows(types_rest, bin, [nil | row], rows, types)
62✔
1500

1501
      {:array, inner_type} ->
1502
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
382✔
1503

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

1507
      {:map, key_type, value_type} ->
1508
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
48✔
1509

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

1514
      {:tuple, tuple_types} ->
1515
        decode_rows(tuple_types ++ [{:tuple_over, row} | types_rest], bin, [], rows, types)
26✔
1516

1517
      {:tuple_over, original_row} ->
1518
        tuple = row |> :lists.reverse() |> List.to_tuple()
26✔
1519
        decode_rows(types_rest, bin, [tuple | original_row], rows, types)
26✔
1520

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

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

1532
          _ ->
1533
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1534
        end
1535

1536
      {:datetime64, time_unit, timezone} ->
1537
        case bin do
122✔
1538
          <<s::64-little-signed, bin::bytes>> ->
1539
            dt = DateTime.from_unix!(s, time_unit)
60✔
1540

1541
            dt =
60✔
1542
              case timezone do
1543
                nil -> DateTime.to_naive(dt)
34✔
1544
                "UTC" -> dt
8✔
1545
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1546
              end
1547

1548
            decode_rows(types_rest, bin, [dt | row], rows, types)
60✔
1549

1550
          _ ->
1551
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1552
        end
1553

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

1559
          _ ->
UNCOV
1560
            to_be_continued(rows, bin, [type | types_rest], row)
×
1561
        end
1562

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

1568
          _ ->
1569
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1570
        end
1571

1572
      :ipv4 ->
1573
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
24✔
1574

1575
      :ipv6 ->
1576
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
74✔
1577

1578
      :point ->
1579
        decode_point_decode_rows(bin, types_rest, row, rows, types)
176✔
1580
    end
1581
  end
1582

1583
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1584
    rows = :lists.reverse([:lists.reverse(row) | rows])
1,380✔
1585
    {rows, empty, _no_state = nil}
1,380✔
1586
  end
1587

1588
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1589
    row = :lists.reverse(row)
2,151,127✔
1590
    decode_rows(types, bin, [], [row | rows], types)
2,151,127✔
1591
  end
1592

1593
  defp decode_rows([_ | _] = types_rest, <<>> = empty, row, rows, _types) do
UNCOV
1594
    to_be_continued(rows, empty, types_rest, row)
×
1595
  end
1596

1597
  @compile inline: [to_be_continued: 4]
1598
  defp to_be_continued(rows, bin, types_rest, row) do
1599
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,719✔
1600
  end
1601

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

1613
  @compile inline: [time_unit: 1]
1614
  for precision <- 0..9 do
1615
    time_unit = Integer.pow(10, precision)
1616
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1617
  end
1618

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

1630
      # TODO: we could potentially decode ClickHouse's Time/Time64 values as Elixir's Duration when it's out of Elixir's Time range
1631
    end
1632
  end
1633
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