clickhouse-arrow 0.1.5

ClickHouse Arrow Client for Rust
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
use std::str::FromStr;

use tokio::io::AsyncReadExt;

use super::connection::ClientMetadata;
use crate::formats::DeserializerState;
use crate::formats::sealed::ClientFormatImpl;
use crate::io::ClickHouseRead;
use crate::native::block::Block;
use crate::native::progress::Progress;
use crate::native::protocol::{
    ChunkedProtocolMode, DBMS_MIN_PROTOCOL_VERSION_WITH_CHUNKED_PACKETS,
    DBMS_MIN_PROTOCOL_VERSION_WITH_PASSWORD_COMPLEXITY_RULES,
    DBMS_MIN_PROTOCOL_VERSION_WITH_PROFILE_EVENTS_IN_INSERT,
    DBMS_MIN_PROTOCOL_VERSION_WITH_SERVER_QUERY_TIME_IN_PROGRESS,
    DBMS_MIN_PROTOCOL_VERSION_WITH_TOTAL_BYTES_IN_PROGRESS,
    DBMS_MIN_REVISION_WITH_CLIENT_WRITE_INFO, DBMS_MIN_REVISION_WITH_INTERSERVER_SECRET_V2,
    DBMS_MIN_REVISION_WITH_QUERY_PLAN_SERIALIZATION,
    DBMS_MIN_REVISION_WITH_ROWS_BEFORE_AGGREGATION, DBMS_MIN_REVISION_WITH_SERVER_DISPLAY_NAME,
    DBMS_MIN_REVISION_WITH_SERVER_LOGS, DBMS_MIN_REVISION_WITH_SERVER_SETTINGS,
    DBMS_MIN_REVISION_WITH_SERVER_TIMEZONE, DBMS_MIN_REVISION_WITH_VERSION_PATCH,
    DBMS_MIN_REVISION_WITH_VERSIONED_PARALLEL_REPLICAS_PROTOCOL, LogData, MAX_STRING_SIZE,
    ProfileEvent, ProfileInfo, ServerData, ServerException, ServerHello, ServerPacket,
    ServerPacketId, TableColumns, TableStatus, TablesStatusResponse,
};
use crate::prelude::*;
use crate::{Error, FxIndexMap, Result};

#[derive(Debug, Clone, Copy)]
pub(super) struct Reader<R: ClickHouseRead> {
    _phantom: std::marker::PhantomData<R>,
}

impl<R: ClickHouseRead + 'static> Reader<R> {
    pub(super) async fn receive_hello(
        reader: &mut R,
        client_revision: u64,
        chunked_modes: (ChunkedProtocolMode, ChunkedProtocolMode),
        cid: u16,
    ) -> Result<ServerHello> {
        let packet = ServerPacketId::from_u64(reader.read_var_uint().await?)
            .inspect(|id| trace!({ ATT_PID } = id.as_ref(), "Reading packet ID"))
            .inspect_err(|error| error!(?error, "Failed to read packet ID"))?;
        match packet {
            ServerPacketId::Hello => Self::read_hello(reader, client_revision, chunked_modes, cid)
                .await
                .inspect_err(|error| {
                    error!(?error, { ATT_CID } = cid, "Failed to receive hello");
                }),
            ServerPacketId::Exception => Err(Self::read_exception(reader).await?.emit().into()),
            packet => {
                Err(Error::Protocol(format!("Unexpected packet {packet:?}, expected server hello")))
            }
        }
    }

    /// Receive header packet (empty native block)
    pub(super) async fn receive_header<T: ClientFormat>(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
    ) -> Result<ServerPacket<T::Data>> {
        let packet = ServerPacketId::from_u64(reader.read_var_uint().await?)
            .inspect_err(|error| error!(?error, "Failed to read packet ID"))?;
        trace!({ ATT_PID } = packet.as_ref(), "Read packet ID (header)");
        match packet {
            ServerPacketId::Data => Self::read_block(reader, revision, metadata)
                .await?
                .ok_or(Error::Protocol("Expected valid block for header".into()))
                .map(ServerPacket::Header),
            // NOTE: For DDL queries and some other cases, the server will not send a header but
            // will send a progress packet or table columns instead.
            ServerPacketId::Progress => {
                Self::read_progress(reader, revision).await.map(ServerPacket::Progress)
            }
            ServerPacketId::TableColumns => {
                Self::read_table_columns(reader).await.map(ServerPacket::TableColumns)
            }
            ServerPacketId::EndOfStream => Ok(ServerPacket::EndOfStream),
            // Errors
            ServerPacketId::Exception => {
                Self::read_exception(reader).await.map(ServerPacket::Exception)
            }
            ServerPacketId::Hello => {
                Err(Error::Protocol("Unexpected hello received from server".to_string()))
            }
            packet => {
                Err(Error::Protocol(format!("expected header packet, got: {}", packet.as_ref())))
            }
        }
    }

    /// Receive any packet from the server
    pub(super) async fn receive_packet<T: ClientFormat>(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
        state: &mut DeserializerState<T::Deser>,
    ) -> Result<ServerPacket<T::Data>> {
        let packet = ServerPacketId::from_u64(reader.read_var_uint().await?)
            .inspect_err(|error| error!(?error, "Failed to read packet ID"))?;
        trace!({ ATT_PID } = packet.as_ref(), "Read packet ID");
        match packet {
            ServerPacketId::Pong => Ok(ServerPacket::Pong),
            ServerPacketId::Data => Ok(Self::read_data::<T>(reader, revision, metadata, state)
                .await?
                .map_or(ServerPacket::Ignore(ServerPacketId::Data), ServerPacket::Data)),
            ServerPacketId::Exception => {
                Self::read_exception(reader).await.map(ServerPacket::Exception)
            }
            ServerPacketId::Progress => {
                Self::read_progress(reader, revision).await.map(ServerPacket::Progress)
            }
            ServerPacketId::EndOfStream => Ok(ServerPacket::EndOfStream),
            ServerPacketId::ProfileInfo => {
                Self::read_profile_info(reader, revision).await.map(ServerPacket::ProfileInfo)
            }
            ServerPacketId::Totals => Ok(Self::read_data::<T>(reader, revision, metadata, state)
                .await?
                .map_or(ServerPacket::Ignore(ServerPacketId::Totals), ServerPacket::Totals)),
            ServerPacketId::Extremes => Ok(Self::read_data::<T>(reader, revision, metadata, state)
                .await?
                .map_or(ServerPacket::Ignore(ServerPacketId::Extremes), ServerPacket::Extremes)),
            ServerPacketId::TablesStatusResponse => Self::read_table_status_response(reader)
                .await
                .map(ServerPacket::TablesStatusResponse),
            ServerPacketId::Log => {
                Self::read_log_data(reader, revision, metadata).await.map(ServerPacket::Log)
            }
            ServerPacketId::TableColumns => {
                Self::read_table_columns(reader).await.map(ServerPacket::TableColumns)
            }
            ServerPacketId::PartUUIDs => {
                Self::read_part_uuids(reader).await.map(ServerPacket::PartUUIDs)
            }
            ServerPacketId::ReadTaskRequest => {
                Self::read_task_request(reader).await.map(ServerPacket::ReadTaskRequest)
            }
            ServerPacketId::ProfileEvents => Self::read_profile_events(reader, revision, metadata)
                .await
                .map(ServerPacket::ProfileEvents),
            // TODO: These currently are not correct. They are placeholders but must be deserialized
            ServerPacketId::MergeTreeAllRangesAnnouncement => {
                Ok(ServerPacket::MergeTreeAllRangesAnnouncement)
            }
            ServerPacketId::MergeTreeReadTaskRequest => Ok(ServerPacket::MergeTreeReadTaskRequest),
            ServerPacketId::TimezoneUpdate => Ok(ServerPacket::TimezoneUpdate),
            ServerPacketId::SSHChallenge => Ok(ServerPacket::SSHChallenge),
            ServerPacketId::Hello => {
                Err(Error::Protocol("Uexpected hello received from server".to_string()))
            }
        }
    }

    pub(super) async fn read_exception(reader: &mut R) -> Result<ServerException> {
        let code = reader.read_i32_le().await?;
        let name = reader.read_utf8_string().await?;
        let message = String::from_utf8_lossy(reader.read_string().await?.as_ref()).to_string();
        let stack_trace = reader.read_utf8_string().await?;
        let has_nested = reader.read_u8().await? != 0;

        Ok(ServerException { code, name, message, stack_trace, has_nested })
    }

    async fn read_hello(
        reader: &mut R,
        client_revision: u64,
        // (send, recv)
        chunked_modes: (ChunkedProtocolMode, ChunkedProtocolMode),
        cid: u16,
    ) -> Result<ServerHello> {
        trace!({ ATT_CID } = cid, "Receiving server hello packet");

        let server_name = reader.read_utf8_string().await?;
        let major_version = reader.read_var_uint().await?;
        let minor_version = reader.read_var_uint().await?;

        let server_revision = reader.read_var_uint().await?;
        let revision_version = std::cmp::min(server_revision, client_revision);

        if revision_version >= DBMS_MIN_REVISION_WITH_VERSIONED_PARALLEL_REPLICAS_PROTOCOL {
            let _ = reader.read_var_uint().await?;
        }

        let timezone = if revision_version >= DBMS_MIN_REVISION_WITH_SERVER_TIMEZONE {
            Some(reader.read_utf8_string().await?)
        } else {
            None
        };

        let display_name = if revision_version >= DBMS_MIN_REVISION_WITH_SERVER_DISPLAY_NAME {
            Some(reader.read_utf8_string().await?)
        } else {
            None
        };
        let patch_version = if revision_version >= DBMS_MIN_REVISION_WITH_VERSION_PATCH {
            reader.read_var_uint().await?
        } else {
            revision_version
        };

        let (chunked_send, chunked_recv) =
            if revision_version >= DBMS_MIN_PROTOCOL_VERSION_WITH_CHUNKED_PACKETS {
                // proto_send_chunked_srv
                let srv_chunked_send = ChunkedProtocolMode::from_str(
                    String::from_utf8_lossy(&reader.read_string().await?).as_ref(),
                )
                .ok()
                .unwrap_or_default();
                // proto_recv_chunked_srv
                let srv_chunked_recv = ChunkedProtocolMode::from_str(
                    String::from_utf8_lossy(&reader.read_string().await?).as_ref(),
                )
                .ok()
                .unwrap_or_default();

                let cl_chunked_send = chunked_modes.0;
                let cl_chunked_recv = chunked_modes.1;

                (
                    ChunkedProtocolMode::negotiate(srv_chunked_send, cl_chunked_send, "send")?,
                    ChunkedProtocolMode::negotiate(srv_chunked_recv, cl_chunked_recv, "recv")?,
                )
            } else {
                (ChunkedProtocolMode::default(), ChunkedProtocolMode::default())
            };

        tracing::trace!(
            recv = chunked_recv.as_ref(),
            send = chunked_send.as_ref(),
            "Negotiated chunking"
        );

        if revision_version >= DBMS_MIN_PROTOCOL_VERSION_WITH_PASSWORD_COMPLEXITY_RULES {
            let rules_size = reader.read_var_uint().await?;
            for _ in 0..rules_size {
                drop(reader.read_utf8_string().await?); // original_pattern
                drop(reader.read_utf8_string().await?); // exception_message
            }
        }

        if revision_version >= DBMS_MIN_REVISION_WITH_INTERSERVER_SECRET_V2 {
            let _ = reader.read_u64_le().await?;
        }

        // Read server settings if supported
        let settings = if revision_version >= DBMS_MIN_REVISION_WITH_SERVER_SETTINGS {
            Some(Settings::decode(reader).await?)
        } else {
            None
        };

        let _query_plan_version =
            if revision_version >= DBMS_MIN_REVISION_WITH_QUERY_PLAN_SERIALIZATION {
                Some(reader.read_var_uint().await?)
            } else {
                None
            };

        let _server_cluster_function_porotocl_version =
            if revision_version >= DBMS_MIN_REVISION_WITH_VERSIONED_CLUSTER_FUNCTION_PROTOCOL {
                Some(reader.read_var_uint().await?)
            } else {
                None
            };

        trace!(
            server_name,
            version = format!("{major_version}.{minor_version}.{patch_version}"),
            revision = revision_version,
            chunked_send = chunked_send.as_ref(),
            chunked_recv = chunked_recv.as_ref(),
            { ATT_CID } = cid,
            "Connected to server",
        );

        Ok(ServerHello {
            server_name,
            version: (major_version, minor_version, patch_version),
            revision_version,
            timezone,
            display_name,
            settings,
            chunked_send,
            chunked_recv,
        })
    }

    async fn read_log_data(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
    ) -> Result<Vec<LogData>> {
        let mut state = DeserializerState::default();
        let Some(data) = Self::read_data::<NativeFormat>(
            reader,
            revision,
            metadata.disable_compression(),
            &mut state,
        )
        .await?
        else {
            return Ok(vec![]);
        };
        Ok(LogData::from_block(data.block)
            .inspect_err(|error| error!(?error, "Log data parsing failed"))
            .unwrap_or_default())
    }

    async fn read_progress(reader: &mut R, revision: u64) -> Result<Progress> {
        let read_rows = reader.read_var_uint().await?;
        let read_bytes = reader.read_var_uint().await?;
        let total_rows_to_read = if revision >= DBMS_MIN_REVISION_WITH_SERVER_LOGS {
            reader.read_var_uint().await?
        } else {
            0
        };
        let total_bytes_to_read =
            if revision >= DBMS_MIN_PROTOCOL_VERSION_WITH_TOTAL_BYTES_IN_PROGRESS {
                Some(reader.read_var_uint().await?)
            } else {
                None
            };

        let written = if revision >= DBMS_MIN_REVISION_WITH_CLIENT_WRITE_INFO {
            Some((reader.read_var_uint().await?, reader.read_var_uint().await?))
        } else {
            None
        };
        let elapsed_ns = if revision >= DBMS_MIN_PROTOCOL_VERSION_WITH_SERVER_QUERY_TIME_IN_PROGRESS
        {
            Some(reader.read_var_uint().await?)
        } else {
            None
        };

        Ok(Progress {
            read_rows,
            read_bytes,
            total_rows_to_read,
            total_bytes_to_read,
            written_rows: written.map(|w| w.0),
            written_bytes: written.map(|w| w.1),
            elapsed_ns,
        })
    }

    async fn read_profile_info(reader: &mut R, revision: u64) -> Result<ProfileInfo> {
        let rows = reader.read_var_uint().await?;
        let blocks = reader.read_var_uint().await?;
        let bytes = reader.read_var_uint().await?;
        let applied_limit = reader.read_u8().await? != 0;
        let rows_before_limit = reader.read_var_uint().await?;
        // Obsolete according to ClickHouse
        let calculated_rows_before_limit = reader.read_u8().await? != 0;

        let (applied_aggregation, rows_before_aggregation) =
            if revision >= DBMS_MIN_REVISION_WITH_ROWS_BEFORE_AGGREGATION {
                (reader.read_u8().await? != 0, reader.read_var_uint().await?)
            } else {
                (false, 0)
            };

        Ok(ProfileInfo {
            rows,
            blocks,
            bytes,
            applied_limit,
            rows_before_limit,
            calculated_rows_before_limit,
            applied_aggregation,
            rows_before_aggregation,
        })
    }

    async fn read_profile_events(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
    ) -> Result<Vec<ProfileEvent>> {
        if revision < DBMS_MIN_PROTOCOL_VERSION_WITH_PROFILE_EVENTS_IN_INSERT {
            return Err(Error::Protocol(format!(
                "unexpected profile events for revision {revision}"
            )));
        }
        let mut state = DeserializerState::default();
        let Some(data) = Self::read_data::<NativeFormat>(
            reader,
            revision,
            metadata.disable_compression(),
            &mut state,
        )
        .await?
        else {
            return Ok(vec![]);
        };
        Ok(ProfileEvent::from_block(data.block)
            .inspect_err(|error| error!(?error, "Profile event parsing failed"))
            .unwrap_or_default())
    }

    async fn read_table_status_response(reader: &mut R) -> Result<TablesStatusResponse> {
        let mut response = TablesStatusResponse { database_tables: FxIndexMap::default() };
        let size = reader.read_var_uint().await?;

        #[expect(clippy::cast_possible_truncation)]
        if size as usize > MAX_STRING_SIZE {
            return Err(Error::Protocol(format!(
                "table status response size too large. {size} > {MAX_STRING_SIZE}"
            )));
        }
        for _ in 0..size {
            let database_name = reader.read_utf8_string().await?;
            let table_name = reader.read_utf8_string().await?;
            let is_replicated = reader.read_u8().await? != 0;
            #[expect(clippy::cast_possible_truncation)]
            let absolute_delay =
                if is_replicated { reader.read_var_uint().await? as u32 } else { 0 };
            let _ = response
                .database_tables
                .entry(database_name)
                .or_default()
                .insert(table_name, TableStatus { is_replicated, absolute_delay });
        }
        Ok(response)
    }

    async fn read_task_request(reader: &mut R) -> Result<Option<String>> {
        Ok(reader
            .read_utf8_string()
            .await
            .inspect_err(|error| error!(?error, "Error reading task request"))
            .ok())
    }

    async fn read_part_uuids(reader: &mut R) -> Result<Vec<uuid::Uuid>> {
        #[expect(clippy::cast_possible_truncation)]
        let len = reader.read_var_uint().await? as usize;
        if len > MAX_STRING_SIZE {
            return Err(Error::Protocol(format!(
                "PartUUIDs response size too large. {len} > {MAX_STRING_SIZE}"
            )));
        }
        let mut out = Vec::with_capacity(len);
        let mut bytes = [0u8; 16];
        for _ in 0..len {
            let _ = reader.read_exact(&mut bytes[..]).await?;
            out.push(uuid::Uuid::from_bytes(bytes));
        }
        Ok(out)
    }

    async fn read_table_columns(reader: &mut R) -> Result<TableColumns> {
        Ok(TableColumns {
            name:        reader.read_utf8_string().await?,
            description: reader.read_utf8_string().await?,
        })
    }

    /// Read a data packet from the server and deserialize into [`crate::Block`]
    async fn read_block(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
    ) -> Result<Option<ServerData<Block>>> {
        drop(reader.read_string().await?);
        let mut state = DeserializerState::default();
        let Some(block) = NativeFormat::read(reader, revision, metadata, &mut state)
            .await
            .inspect_err(|error| {
                error!(?error, { ATT_CID } = metadata.client_id, "Block read fail");
            })?
        else {
            return Ok(None);
        };
        Ok(Some(ServerData { block }))
    }

    /// Read a data packet from the server and deserialize into [`ClientFormat`]
    async fn read_data<T: ClientFormat>(
        reader: &mut R,
        revision: u64,
        metadata: ClientMetadata,
        state: &mut DeserializerState<T::Deser>,
    ) -> Result<Option<ServerData<T::Data>>> {
        drop(reader.read_string().await?);
        let Some(block) =
            T::read(reader, revision, metadata, state).await.inspect_err(|error| {
                error!(?error, { ATT_CID } = metadata.client_id, "Data read fail");
            })?
        else {
            return Ok(None);
        };
        Ok(Some(ServerData { block }))
    }
}