feat: support byte-string params, implement Primitive for bytes::Bytes{Mut} (#376)

Author: abonander

Cargo.toml

@@ -127,7 +127,7 @@ clickhouse-types = { version = "0.1.1", path = "types" }
 
 thiserror = "2.0"
 serde = "1.0.106"
-bytes = "1.5.0"
+bytes = { version = "1.5.0", features = ["serde"] }
 tokio = { version = "1.0.1", features = ["rt", "macros"] }
 http-body-util = "0.1.2"
 hyper = "1.4"

src/row.rs

@@ -204,7 +204,24 @@ macro_rules! impl_primitive_for {
 
 // TODO: char? &str? SocketAddr? Path? Duration? NonZero*?
 impl_primitive_for![
-    bool, String, u8, u16, u32, u64, u128, usize, i8, i16, i32, i64, i128, isize, f32, f64,
+    bool,
+    String,
+    u8,
+    u16,
+    u32,
+    u64,
+    u128,
+    usize,
+    i8,
+    i16,
+    i32,
+    i64,
+    i128,
+    isize,
+    f32,
+    f64,
+    bytes::Bytes,
+    bytes::BytesMut,
 ];
 
 macro_rules! count_tokens {

src/sql/escape.rs

@@ -29,6 +29,10 @@ pub(crate) fn escape(src: &str, dst: &mut impl fmt::Write) -> fmt::Result {
     dst.write_str(rest)
 }
 
+pub(crate) fn escape_ascii(s: &[u8], dst: &mut impl fmt::Write) -> fmt::Result {
+    write!(dst, "{}", s.escape_ascii())
+}
+
 // See https://clickhouse.com/docs/en/sql-reference/syntax#string
 pub(crate) fn hex_bytes(s: &[u8], dst: &mut impl fmt::Write) -> fmt::Result {
     dst.write_char('X')?;

src/sql/ser.rs

@@ -358,7 +358,6 @@ impl<'a, W: Write> Serializer for ParamSerializer<'a, W> {
 
     unsupported!(
         serialize_map(Option<usize>) -> Result<Impossible>,
-        serialize_bytes(&[u8]),
         serialize_unit,
         serialize_unit_struct(&'static str),
     );
@@ -379,6 +378,11 @@ impl<'a, W: Write> Serializer for ParamSerializer<'a, W> {
         serialize_bool(bool),
     );
 
+    #[inline]
+    fn serialize_bytes(self, v: &[u8]) -> std::result::Result<Self::Ok, Self::Error> {
+        Ok(escape::escape_ascii(v, self.writer)?)
+    }
+
     #[inline]
     fn serialize_char(self, value: char) -> Result {
         let mut tmp = [0u8; 4];

tests/it/query.rs

@@ -1,3 +1,4 @@
+use bytes::Bytes;
 use serde::{Deserialize, Serialize};
 
 use clickhouse::sql::Identifier;
@@ -122,6 +123,16 @@ async fn server_side_param() {
         .await
         .expect("failed to fetch string");
     assert_eq!(result, &["a", "bc"]);
+
+    // Should not be valid UTF-8
+    let bytes = Bytes::from_static(b"Hello, world!\\\0\t\r\n\x00\x01\xFF\xFE\xFD");
+    let result = client
+        .query("SELECT {val1: String} AS result")
+        .param("val1", &bytes)
+        .fetch_one::<Bytes>()
+        .await
+        .expect("failed to fetch bytes");
+    assert_eq!(result, bytes);
 }
 
 // See #19.