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

plausible / ch / 34c9cca0c5b330809b8954c3ac95a0ade322f48b-PR-311

20 Apr 2026 07:23PM UTC coverage: 91.527% (+0.03%) from 91.494%
34c9cca0c5b330809b8954c3ac95a0ade322f48b-PR-311

Pull #311

github

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

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

28 existing lines in 1 file now uncovered.

929 of 1015 relevant lines covered (91.53%)

79334.59 hits per line

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

88.56
/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{} = naive) do
333
    {seconds, _micros} = NaiveDateTime.to_gregorian_seconds(naive)
18✔
334
    epoch_seconds = seconds - @epoch_gregorian_seconds
18✔
335
    <<epoch_seconds::32-little>>
18✔
336
  end
337

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

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

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

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

351
    t =
8✔
352
      (seconds - @epoch_gregorian_seconds) * time_unit + div(micros * time_unit, 1_000_000)
353

354
    <<t::64-little-signed>>
8✔
355
  end
356

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

361
  def encode({:datetime64, _time_unit}, %DateTime{} = datetime) do
UNCOV
362
    raise ArgumentError, "non-UTC timezones are not supported for encoding: #{datetime}"
×
363
  end
364

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

367
  def encode(:date, %Date{} = date) do
368
    <<Date.diff(date, @epoch_date)::16-little>>
13✔
369
  end
370

371
  def encode(:date, nil), do: <<0::16>>
1✔
372

373
  def encode(:date32, %Date{} = date) do
374
    <<Date.diff(date, @epoch_date)::32-little-signed>>
8✔
375
  end
376

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

379
  def encode(:time, %Time{} = time) do
380
    {s, _micros} = Time.to_seconds_after_midnight(time)
10✔
381
    <<s::32-little-signed>>
10✔
382
  end
383

UNCOV
384
  def encode(:time, nil), do: <<0::32>>
×
385

386
  def encode({:time64, time_unit}, %Time{} = time) do
387
    {s, micros} = Time.to_seconds_after_midnight(time)
34✔
388

389
    micros_as_ticks =
34✔
390
      cond do
391
        time_unit < 1_000_000 -> div(micros, time_unit)
12✔
392
        time_unit == 1_000_000 -> micros
22✔
393
        true -> micros * div(time_unit, 1_000_000)
10✔
394
      end
395

396
    ticks = s * time_unit + micros_as_ticks
34✔
397
    <<ticks::64-little-signed>>
34✔
398
  end
399

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

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

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

415
    encode(:uuid, raw)
1✔
416
  end
417

418
  def encode(:uuid, nil), do: <<0::128>>
1✔
419

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

423
  def encode(:ipv6, {b1, b2, b3, b4, b5, b6, b7, b8}) do
424
    <<b1::16, b2::16, b3::16, b4::16, b5::16, b6::16, b7::16, b8::16>>
4✔
425
  end
426

UNCOV
427
  def encode(:ipv6, <<_::128>> = encoded), do: encoded
×
UNCOV
428
  def encode(:ipv6, nil), do: <<0::128>>
×
429

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

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

451
  # TODO enum8 and enum16 nil
452
  for size <- [8, 16] do
453
    enum_t = :"enum#{size}"
454
    int_t = :"i#{size}"
455

456
    def encode({unquote(enum_t), mapping}, e) do
457
      i =
12✔
458
        case e do
459
          _ when is_integer(e) ->
460
            e
4✔
461

462
          _ when is_binary(e) ->
463
            case Map.fetch(mapping, e) do
8✔
464
              {:ok, res} ->
465
                res
8✔
466

467
              :error ->
UNCOV
468
                raise ArgumentError,
×
469
                      "enum value #{inspect(e)} not found in mapping: #{inspect(mapping)}"
470
            end
471
        end
472

473
      encode(unquote(int_t), i)
12✔
474
    end
475
  end
476

477
  def encode({:nullable, _type}, nil), do: 1
12✔
478

479
  def encode({:nullable, type}, value) do
480
    case encode(type, value) do
11✔
481
      e when is_list(e) or is_binary(e) -> [0 | e]
11✔
UNCOV
482
      e -> [0, e]
×
483
    end
484
  end
485

486
  defp encode_varint_cont(i) when i < 128, do: <<i>>
8✔
487

488
  defp encode_varint_cont(i) do
12✔
489
    [(i &&& 0b0111_1111) ||| 0b1000_0000 | encode_varint_cont(i >>> 7)]
490
  end
491

492
  defp encode_many([el | rest], type), do: [encode(type, el) | encode_many(rest, type)]
129✔
493
  defp encode_many([] = done, _type), do: done
57✔
494

495
  defp encode_many_kv([{key, value} | rest], key_type, value_type) do
19✔
496
    [
497
      encode(key_type, key),
498
      encode(value_type, value)
499
      | encode_many_kv(rest, key_type, value_type)
500
    ]
501
  end
502

503
  defp encode_many_kv([] = done, _key_type, _value_type), do: done
14✔
504

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

516
  defp try_encode_variant([], _idx, value) do
UNCOV
517
    raise ArgumentError, "no matching type found for encoding #{inspect(value)} as Variant"
×
518
  end
519

520
  @compile {:inline, d: 1}
521

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

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

573
  @doc false
574
  @spec decode_header(binary()) ::
575
          {:ok, names :: [String.t()], types :: [term], rest :: binary} | :more
576
  def decode_header(row_binary_with_names_and_types)
577

578
  for {pattern, value} <- varints do
579
    def decode_header(<<unquote(pattern), rest::bytes>>) do
580
      decode_header_names(rest, unquote(value), unquote(value), _acc = [])
42✔
581
    end
582
  end
583

584
  def decode_header(<<_bin::bytes>>) do
1✔
585
    :more
586
  end
587

588
  defp decode_header_names(<<rest::bytes>>, 0, count, names) do
589
    decode_header_types(rest, count, _acc = [], :lists.reverse(names))
27✔
590
  end
591

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

603
  defp decode_header_names(<<_bin::bytes>>, _left, _count, _acc) do
15✔
604
    :more
605
  end
606

607
  defp decode_header_types(<<rest::bytes>>, 0, types, names) do
608
    {:ok, names, decoding_types_reverse(types), rest}
7✔
609
  end
610

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

622
  defp decode_header_types(<<_bin::bytes>>, _count, _acc, _names) do
20✔
623
    :more
624
  end
625

626
  @doc """
627
  Decodes [RowBinaryWithNamesAndTypes](https://clickhouse.com/docs/en/interfaces/formats/RowBinaryWithNamesAndTypes) into rows.
628

629
  Example:
630

631
      iex> decode_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
632
      [[2]]
633

634
  """
635
  def decode_rows(row_binary_with_names_and_types)
636
  def decode_rows(<<>>), do: []
1✔
637

638
  for {pattern, value} <- varints do
639
    def decode_rows(<<unquote(pattern), rest::bytes>>) do
640
      skip_names(rest, unquote(value), unquote(value))
7✔
641
    end
642
  end
643

644
  @doc """
645
  Same as `decode_rows/1` but the first element is a list of column names.
646

647
  Example:
648

649
      iex> decode_names_and_rows(<<1, 3, "1+1"::bytes, 5, "UInt8"::bytes, 2>>)
650
      [["1+1"], [2]]
651

652
  """
653
  def decode_names_and_rows(row_binary_with_names_and_types)
654

655
  for {pattern, value} <- varints do
656
    def decode_names_and_rows(<<unquote(pattern), rest::bytes>>) do
657
      decode_names(rest, unquote(value), unquote(value), _acc = [])
1,452✔
658
    end
659
  end
660

661
  @doc """
662
  Decodes [RowBinary](https://clickhouse.com/docs/en/interfaces/formats/RowBinary) into rows.
663

664
  Example:
665

666
      iex> decode_rows(<<1>>, ["UInt8"])
667
      [[1]]
668

669
  """
670
  def decode_rows(row_binary, types)
671
  def decode_rows(<<>>, _types), do: []
1✔
672

673
  def decode_rows(<<data::bytes>>, types) do
674
    decode_rows!(data, decoding_types(types))
13✔
675
  end
676

677
  defp decode_rows!(data, types) do
678
    {rows, remaining_data, state} = decode_rows(types, data, [], [], types)
1,323✔
679

680
    case state do
1,289✔
681
      nil ->
682
        rows
1,287✔
683

684
      {:cont, types_rest, row} ->
685
        raise ArgumentError, """
2✔
686
        incomplete RowBinary data: ran out of bytes while decoding
687

688
        Expected to decode: #{inspect(types_rest)}
689
        Remaining bytes: #{byte_size(remaining_data)} bytes
2✔
690
        Partial row: #{inspect(row)}
691
        Completed rows: #{length(rows)}
2✔
692
        """
693
    end
694
  end
695

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

704
  @doc false
705
  def decoding_types([type | types]) do
129✔
706
    [decoding_type(type) | decoding_types(types)]
707
  end
708

709
  def decoding_types([] = done), do: done
85✔
710

711
  defp decoding_types_reverse(types), do: decoding_types_reverse(types, [])
1,317✔
712

713
  defp decoding_types_reverse([type | types], acc) do
714
    decoding_types_reverse(types, [decoding_type(type) | acc])
4,174✔
715
  end
716

717
  defp decoding_types_reverse([], acc), do: acc
1,317✔
718

719
  defp decoding_type(t) when is_binary(t) do
720
    decoding_type(Ch.Types.decode(t))
4,289✔
721
  end
722

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

742
  defp decoding_type({:datetime, _tz} = t), do: t
32✔
743
  defp decoding_type({:fixed_string, _len} = t), do: t
22✔
744

745
  for size <- [8, 16, 32, 64, 128, 256] do
746
    defp decoding_type(unquote(:"u#{size}") = u), do: u
2,670✔
747
    defp decoding_type(unquote(:"i#{size}") = i), do: i
98✔
748
  end
749

750
  for size <- [32, 64] do
751
    defp decoding_type(unquote(:"f#{size}") = f), do: f
44✔
752
  end
753

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

756
  defp decoding_type({:array = a, t}), do: {a, decoding_type(t)}
124✔
757

758
  defp decoding_type({:tuple = t, ts}) do
18✔
759
    {t, Enum.map(ts, &decoding_type/1)}
760
  end
761

762
  defp decoding_type({:variant = v, ts}) do
28✔
763
    {v, Enum.map(ts, &decoding_type/1)}
764
  end
765

766
  defp decoding_type({:map = m, kt, vt}) do
767
    {m, decoding_type(kt), decoding_type(vt)}
25✔
768
  end
769

770
  defp decoding_type({:nullable = n, t}), do: {n, decoding_type(t)}
58✔
771
  defp decoding_type({:low_cardinality, t}), do: decoding_type(t)
147✔
772

773
  defp decoding_type({:decimal = t, p, s}), do: {t, decimal_size(p), s}
62✔
774
  defp decoding_type({:decimal32, s}), do: {:decimal, 32, s}
1✔
775
  defp decoding_type({:decimal64, s}), do: {:decimal, 64, s}
1✔
776
  defp decoding_type({:decimal128, s}), do: {:decimal, 128, s}
1✔
777
  defp decoding_type({:decimal256, s}), do: {:decimal, 256, s}
1✔
778

779
  defp decoding_type({:datetime64 = t, p}), do: {t, time_unit(p), _tz = nil}
33✔
780
  defp decoding_type({:datetime64 = t, p, tz}), do: {t, time_unit(p), tz}
20✔
781

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

784
  defp decoding_type({e, mappings}) when e in [:enum8, :enum16] do
17✔
785
    {e, Map.new(mappings, fn {k, v} -> {v, k} end)}
34✔
786
  end
787

788
  defp decoding_type({:simple_aggregate_function, _f, t}), do: decoding_type(t)
6✔
789

790
  defp decoding_type(:ring), do: {:array, :point}
6✔
791
  defp decoding_type(:polygon), do: {:array, {:array, :point}}
6✔
792
  defp decoding_type(:multipolygon), do: {:array, {:array, {:array, :point}}}
6✔
793
  defp decoding_type({:json, _opts}), do: :json
6✔
794

795
  defp decoding_type(type) do
UNCOV
796
    raise ArgumentError, "unsupported type for decoding: #{inspect(type)}"
×
797
  end
798

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

801
  for {pattern, value} <- varints do
802
    defp skip_names(<<unquote(pattern), _::size(unquote(value))-bytes, rest::bytes>>, left, count) do
803
      skip_names(rest, left - 1, count)
77✔
804
    end
805
  end
806

807
  defp decode_names(<<rest::bytes>>, 0, count, names) do
1,452✔
808
    [:lists.reverse(names) | decode_types(rest, count, _acc = [])]
809
  end
810

811
  for {pattern, value} <- varints do
812
    defp decode_names(
813
           <<unquote(pattern), name::size(unquote(value))-bytes, rest::bytes>>,
814
           left,
815
           count,
816
           acc
817
         ) do
818
      decode_names(rest, left - 1, count, [name | acc])
4,240✔
819
    end
820
  end
821

822
  defp decode_types(<<>>, 0, _types), do: []
149✔
823

824
  defp decode_types(<<rest::bytes>>, 0, types) do
825
    decode_rows!(rest, decoding_types_reverse(types))
1,310✔
826
  end
827

828
  for {pattern, value} <- varints do
829
    defp decode_types(
830
           <<unquote(pattern), type::size(unquote(value))-bytes, rest::bytes>>,
831
           count,
832
           acc
833
         ) do
834
      decode_types(rest, count - 1, [type | acc])
4,317✔
835
    end
836
  end
837

838
  @compile inline: [decode_string_decode_rows: 5]
839

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

852
  defp decode_string_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
853
    to_be_continued(rows, bin, [:string | types_rest], row)
100,165✔
854
  end
855

856
  @doc false
857
  def to_utf8(str) do
858
    utf8 = to_utf8(str, 0, 0, str, [])
1,129✔
859
    IO.iodata_to_binary(utf8)
1,129✔
860
  end
861

862
  @dialyzer {:no_improper_lists, to_utf8: 5, to_utf8_escape: 5}
863

864
  defp to_utf8(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
865
    to_utf8(rest, from, len + utf8_size(valid), original, acc)
30,139,399✔
866
  end
867

868
  defp to_utf8(<<_invalid, rest::bytes>>, from, len, original, acc) do
869
    acc = [acc | binary_part(original, from, len)]
6✔
870
    to_utf8_escape(rest, from + len, 1, original, acc)
6✔
871
  end
872

873
  defp to_utf8(<<>>, from, len, original, acc) do
1,128✔
874
    [acc | binary_part(original, from, len)]
875
  end
876

877
  defp to_utf8_escape(<<valid::utf8, rest::bytes>>, from, len, original, acc) do
878
    acc = [acc | "�"]
5✔
879
    to_utf8(rest, from + len, utf8_size(valid), original, acc)
5✔
880
  end
881

882
  defp to_utf8_escape(<<_invalid, rest::bytes>>, from, len, original, acc) do
883
    to_utf8_escape(rest, from, len + 1, original, acc)
7✔
884
  end
885

886
  defp to_utf8_escape(<<>>, _from, _len, _original, acc) do
1✔
887
    [acc | "�"]
888
  end
889

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

897
  @compile inline: [decode_string_json_decode_rows: 5]
898

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

911
  defp decode_string_json_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
912
    to_be_continued(rows, bin, [:json | types_rest], row)
46✔
913
  end
914

915
  @compile inline: [decode_binary_decode_rows: 5]
916

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

929
  defp decode_binary_decode_rows(<<bin::bytes>>, types_rest, row, rows, _types) do
930
    to_be_continued(rows, bin, [:binary | types_rest], row)
100,007✔
931
  end
932

933
  @compile inline: [decode_array_decode_rows: 6]
934
  defp decode_array_decode_rows(<<0, bin::bytes>>, _type, types_rest, row, rows, types) do
935
    decode_rows(types_rest, bin, [[] | row], rows, types)
85✔
936
  end
937

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

953
  defp decode_array_decode_rows(<<bin::bytes>>, type, types_rest, row, rows, _types) do
954
    to_be_continued(rows, bin, [{:array, type} | types_rest], row)
12✔
955
  end
956

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

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

983
      decode_rows(types_rest, bin, [], rows, types)
32✔
984
    end
985
  end
986

987
  defp decode_map_decode_rows(<<bin::bytes>>, key_type, value_type, types_rest, row, rows, _types) do
988
    to_be_continued(rows, bin, [{:map, key_type, value_type} | types_rest], row)
6✔
989
  end
990

991
  defp map_types(count, key_type, value_type) when count > 0 do
57✔
992
    [key_type, value_type | map_types(count - 1, key_type, value_type)]
993
  end
994

995
  defp map_types(0, _key_type, _value_types), do: []
32✔
996

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

1023
  # TODO compile inline?
1024

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

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

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

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

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

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

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

1142
  # Array(T) 0x1E <nested_type_encoding>
1143
  defp decode_dynamic(<<0x1E, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1144
    decode_dynamic_continue(rest, [:array | dynamic], types_rest, row, rows, types)
74✔
1145
  end
1146

1147
  # Nullable(T)        0x23 <nested_type_encoding>
1148
  defp decode_dynamic(<<0x23, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1149
    decode_dynamic_continue(rest, [:nullable | dynamic], types_rest, row, rows, types)
12✔
1150
  end
1151

1152
  # LowCardinality(T) 0x26 <nested_type_encoding>
1153
  defp decode_dynamic(<<0x26, rest::bytes>>, dynamic, types_rest, row, rows, types) do
1154
    decode_dynamic_continue(rest, [:low_cardinality | dynamic], types_rest, row, rows, types)
4✔
1155
  end
1156

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

1162
    # Skip var_int_max_dynamic_paths
1163
    {_paths, rest} = read_varint(rest)
16✔
1164

1165
    # Skip uint8_max_dynamic_types
1166
    <<_val, rest::bytes>> = rest
16✔
1167

1168
    # Read var_uint_number_of_typed_paths
1169
    {typed_paths, rest} = read_varint(rest)
16✔
1170

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

1179
    # Read var_uint_number_of_skip_paths
1180
    {skip_paths, rest} = read_varint(rest)
14✔
1181

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

1190
    # Read var_uint_number_of_skip_path_regexps
1191
    {skip_path_regexes, rest} = read_varint(rest)
14✔
1192

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

1201
    decode_dynamic_continue(rest, [:json | dynamic], types_rest, row, rows, types)
14✔
1202
  end
1203

1204
  for {pattern, value} <- varints do
1205
    defp read_varint(<<unquote(pattern), rest::bytes>>), do: {unquote(value), rest}
62✔
1206
  end
1207

1208
  other_dynamic_types = [
1209
    datetime: 0x11,
1210
    set: 0x21,
1211
    bfloat16: 0x31,
1212
    time: 0x32
1213
  ]
1214

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

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

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

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

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

1264
  defp decode_dynamic(<<bin::bytes>>, dynamic, types_rest, row, rows, _types) do
1265
    to_be_continued(rows, bin, [{:dynamic, dynamic} | types_rest], row)
2✔
1266
  end
1267

1268
  @compile inline: [decode_dynamic_continue: 6]
1269

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

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

1287
  defp build_dynamic_type([type]), do: type
290✔
1288

1289
  defp build_dynamic_type(type) do
1290
    case type do
88✔
1291
      [:array | rest] -> {:array, build_dynamic_type(rest)}
72✔
1292
      [:nullable | rest] -> {:nullable, build_dynamic_type(rest)}
12✔
1293
      [:low_cardinality | rest] -> build_dynamic_type(rest)
4✔
1294
    end
1295
  end
1296

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

1353
  for {type, clauses} <- simple_types do
1354
    fun = :"decode_#{type}_decode_rows"
1355
    @compile inline: [{fun, 5}]
1356

1357
    for %{pattern: pattern, value: value} <- List.wrap(clauses) do
1358
      defp unquote(fun)(<<unquote(pattern), rest::bytes>>, types_rest, row, rows, types) do
1359
        decode_rows(types_rest, rest, [unquote(value) | row], rows, types)
2,154,378✔
1360
      end
1361
    end
1362

1363
    defp unquote(fun)(<<bin::bytes>>, types_rest, row, rows, _types) do
1364
      to_be_continued(rows, bin, [unquote(type) | types_rest], row)
582✔
1365
    end
1366
  end
1367

1368
  defp decode_rows([type | types_rest], <<bin::bytes>>, row, rows, types) do
1369
    case type do
2,358,485✔
1370
      :u8 ->
1371
        decode_u8_decode_rows(bin, types_rest, row, rows, types)
1,218✔
1372

1373
      :u16 ->
1374
        decode_u16_decode_rows(bin, types_rest, row, rows, types)
1,524✔
1375

1376
      :u32 ->
1377
        decode_u32_decode_rows(bin, types_rest, row, rows, types)
73✔
1378

1379
      :u64 ->
1380
        decode_u64_decode_rows(bin, types_rest, row, rows, types)
2,150,989✔
1381

1382
      :u128 ->
1383
        decode_u128_decode_rows(bin, types_rest, row, rows, types)
40✔
1384

1385
      :u256 ->
1386
        decode_u256_decode_rows(bin, types_rest, row, rows, types)
72✔
1387

1388
      :i8 ->
1389
        decode_i8_decode_rows(bin, types_rest, row, rows, types)
40✔
1390

1391
      :i16 ->
1392
        decode_i16_decode_rows(bin, types_rest, row, rows, types)
20✔
1393

1394
      :i32 ->
1395
        decode_i32_decode_rows(bin, types_rest, row, rows, types)
42✔
1396

1397
      :i64 ->
1398
        decode_i64_decode_rows(bin, types_rest, row, rows, types)
178✔
1399

1400
      :i128 ->
1401
        decode_i128_decode_rows(bin, types_rest, row, rows, types)
41✔
1402

1403
      :i256 ->
1404
        decode_i256_decode_rows(bin, types_rest, row, rows, types)
73✔
1405

1406
      :f32 ->
1407
        decode_f32_decode_rows(bin, types_rest, row, rows, types)
36✔
1408

1409
      :f64 ->
1410
        decode_f64_decode_rows(bin, types_rest, row, rows, types)
60✔
1411

1412
      :string ->
1413
        decode_string_decode_rows(bin, types_rest, row, rows, types)
101,294✔
1414

1415
      :binary ->
1416
        decode_binary_decode_rows(bin, types_rest, row, rows, types)
100,011✔
1417

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

1424
      :dynamic ->
1425
        decode_dynamic(bin, _dynamic = [], types_rest, row, rows, types)
306✔
1426

1427
      {:dynamic, dynamic} ->
1428
        decode_dynamic(bin, dynamic, types_rest, row, rows, types)
2✔
1429

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

1436
          _ ->
1437
            to_be_continued(rows, bin, [type | types_rest], row)
14✔
1438
        end
1439

1440
      :boolean ->
1441
        decode_boolean_decode_rows(bin, types_rest, row, rows, types)
66✔
1442

1443
      :uuid ->
1444
        decode_uuid_decode_rows(bin, types_rest, row, rows, types)
86✔
1445

1446
      :date ->
1447
        decode_date_decode_rows(bin, types_rest, row, rows, types)
42✔
1448

1449
      :date32 ->
1450
        decode_date32_decode_rows(bin, types_rest, row, rows, types)
40✔
1451

1452
      :time ->
1453
        decode_time_decode_rows(bin, types_rest, row, rows, types)
46✔
1454

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

1461
          _ ->
1462
            to_be_continued(rows, bin, [type | types_rest], row)
30✔
1463
        end
1464

1465
      {:datetime, timezone} ->
1466
        case bin do
88✔
1467
          <<s::32-little, bin::bytes>> ->
1468
            dt = DateTime.from_unix!(s)
66✔
1469

1470
            dt =
66✔
1471
              case timezone do
1472
                nil -> DateTime.to_naive(dt)
26✔
1473
                "UTC" -> dt
22✔
1474
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1475
              end
1476

1477
            decode_rows(types_rest, bin, [dt | row], rows, types)
64✔
1478

1479
          _ ->
1480
            to_be_continued(rows, bin, [type | types_rest], row)
22✔
1481
        end
1482

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

1490
          _ ->
1491
            to_be_continued(rows, bin, [type | types_rest], row)
118✔
1492
        end
1493

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

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

1506
      :nothing ->
1507
        decode_rows(types_rest, bin, [nil | row], rows, types)
62✔
1508

1509
      {:array, inner_type} ->
1510
        decode_array_decode_rows(bin, inner_type, types_rest, row, rows, types)
382✔
1511

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

1515
      {:map, key_type, value_type} ->
1516
        decode_map_decode_rows(bin, key_type, value_type, types_rest, row, rows, types)
48✔
1517

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

1522
      {:tuple, tuple_types} ->
1523
        decode_rows(tuple_types ++ [{:tuple_over, row} | types_rest], bin, [], rows, types)
26✔
1524

1525
      {:tuple_over, original_row} ->
1526
        tuple = row |> :lists.reverse() |> List.to_tuple()
26✔
1527
        decode_rows(types_rest, bin, [tuple | original_row], rows, types)
26✔
1528

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

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

1540
          _ ->
1541
            to_be_continued(rows, bin, [type | types_rest], row)
3✔
1542
        end
1543

1544
      {:datetime64, time_unit, timezone} ->
1545
        case bin do
122✔
1546
          <<s::64-little-signed, bin::bytes>> ->
1547
            dt = DateTime.from_unix!(s, time_unit)
60✔
1548

1549
            dt =
60✔
1550
              case timezone do
1551
                nil -> DateTime.to_naive(dt)
34✔
1552
                "UTC" -> dt
8✔
1553
                _ -> DateTime.shift_zone!(dt, timezone)
18✔
1554
              end
1555

1556
            decode_rows(types_rest, bin, [dt | row], rows, types)
60✔
1557

1558
          _ ->
1559
            to_be_continued(rows, bin, [type | types_rest], row)
62✔
1560
        end
1561

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

1567
          _ ->
UNCOV
1568
            to_be_continued(rows, bin, [type | types_rest], row)
×
1569
        end
1570

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

1576
          _ ->
1577
            to_be_continued(rows, bin, [type | types_rest], row)
4✔
1578
        end
1579

1580
      :ipv4 ->
1581
        decode_ipv4_decode_rows(bin, types_rest, row, rows, types)
24✔
1582

1583
      :ipv6 ->
1584
        decode_ipv6_decode_rows(bin, types_rest, row, rows, types)
74✔
1585

1586
      :point ->
1587
        decode_point_decode_rows(bin, types_rest, row, rows, types)
176✔
1588
    end
1589
  end
1590

1591
  defp decode_rows([], <<>> = empty, row, rows, _types) do
1592
    rows = :lists.reverse([:lists.reverse(row) | rows])
1,379✔
1593
    {rows, empty, _no_state = nil}
1,379✔
1594
  end
1595

1596
  defp decode_rows([], <<bin::bytes>>, row, rows, types) do
1597
    row = :lists.reverse(row)
2,151,127✔
1598
    decode_rows(types, bin, [], [row | rows], types)
2,151,127✔
1599
  end
1600

1601
  defp decode_rows([_ | _] = types_rest, <<>> = empty, row, rows, _types) do
UNCOV
1602
    to_be_continued(rows, empty, types_rest, row)
×
1603
  end
1604

1605
  @compile inline: [to_be_continued: 4]
1606
  defp to_be_continued(rows, bin, types_rest, row) do
1607
    {:lists.reverse(rows), bin, {:cont, types_rest, row}}
200,719✔
1608
  end
1609

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

1621
  @compile inline: [time_unit: 1]
1622
  for precision <- 0..9 do
1623
    time_unit = round(:math.pow(10, precision))
1624
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1625
  end
1626

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

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