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

plausible / ch / d624ecd72c9bd78a34c7824a639cf423fad3d8d2

20 Apr 2026 02:58PM UTC coverage: 91.494% (-0.6%) from 92.089%
d624ecd72c9bd78a34c7824a639cf423fad3d8d2

push

github

web-flow
RowBinary: de- and encode dynamic JSON (#296)

* RowBinary: decode dynamic JSON

* Fix typos

* Fix CI (enable enable_time_time64_type)

* RowBinary: encode dynamic JSON (and DateTime) values

17 of 25 new or added lines in 1 file covered. (68.0%)

1 existing line in 1 file now uncovered.

925 of 1011 relevant lines covered (91.49%)

79645.06 hits per line

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

88.45
/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_naive_datetime NaiveDateTime.new!(@epoch_date, ~T[00:00:00])
11
  @epoch_utc_datetime DateTime.new!(@epoch_date, ~T[00:00:00])
12

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

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

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

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

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

33
  Examples:
34

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

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

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

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

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

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

55
  Examples:
56

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

332
  def encode(:datetime, %NaiveDateTime{} = datetime) do
333
    <<NaiveDateTime.diff(datetime, @epoch_naive_datetime)::32-little>>
18✔
334
  end
335

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

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

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

346
  def encode({:datetime64, time_unit}, %NaiveDateTime{} = datetime) do
347
    <<NaiveDateTime.diff(datetime, @epoch_naive_datetime, time_unit)::64-little-signed>>
8✔
348
  end
349

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

622
  Example:
623

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

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

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

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

640
  Example:
641

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

645
  """
646
  def decode_names_and_rows(row_binary_with_names_and_types)
647

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

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

657
  Example:
658

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

831
  @compile inline: [decode_string_decode_rows: 5]
832

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

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

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

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

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

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

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

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

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

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

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

890
  @compile inline: [decode_string_json_decode_rows: 5]
891

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

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

908
  @compile inline: [decode_binary_decode_rows: 5]
909

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

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

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

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

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

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

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

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

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

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

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

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

1016
  # TODO compile inline?
1017

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1261
  @compile inline: [decode_dynamic_continue: 6]
1262

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1458
      {:datetime, timezone} ->
1459
        case bin do
88✔
1460
          <<s::32-little, bin::bytes>> ->
1461
            dt =
66✔
1462
              case timezone do
1463
                nil -> NaiveDateTime.add(@epoch_naive_datetime, s)
26✔
1464
                "UTC" -> DateTime.from_unix!(s)
22✔
1465
                _ -> s |> DateTime.from_unix!() |> DateTime.shift_zone!(timezone)
18✔
1466
              end
1467

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1535
      {:datetime64, time_unit, timezone} ->
1536
        case bin do
122✔
1537
          <<s::64-little-signed, bin::bytes>> ->
1538
            dt =
60✔
1539
              case timezone do
1540
                nil ->
1541
                  NaiveDateTime.add(@epoch_naive_datetime, s, time_unit)
1542
                  |> truncate(time_unit)
34✔
1543

1544
                "UTC" ->
1545
                  DateTime.from_unix!(s, time_unit)
8✔
1546

1547
                _ ->
1548
                  s
1549
                  |> DateTime.from_unix!(time_unit)
1550
                  |> DateTime.shift_zone!(timezone)
18✔
1551
              end
1552

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1622
    defp time_unit(unquote(precision)), do: unquote(time_unit)
183✔
1623
    defp time_prec(unquote(time_unit)), do: unquote(precision)
34✔
1624
  end
1625

1626
  defp truncate(%{microsecond: {micros, _prec}} = date, time_unit),
1627
    do: %{date | microsecond: {micros, time_prec(time_unit)}}
34✔
1628

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

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