Complete rawQuery implementation with comprehensive tests

- Add Query::raw() method for executing SQL queries with literal question marks
- Implement comprehensive test suite covering various question mark scenarios
- Fix fetch() method to handle raw queries without field binding
- Support struct-based fetching with raw queries
- Add error handling for bind function

Author: ozgurcancal

examples/README.md

@@ -9,6 +9,7 @@ If something is missing, or you found a mistake in one of these examples, please
 ### General usage
 
 - [usage.rs](usage.rs) - creating tables, executing other DDLs, inserting the data, and selecting it back. Additionally, it covers `WATCH` queries. Optional cargo features: `inserter`, `watch`.
+- [query_raw.rs](query_raw.rs) - raw queries without parameter binding, with question mark escaping. FORMAT is the RowBinary by default
 - [mock.rs](mock.rs) - writing tests with `mock` feature. Cargo features: requires `test-util`.
 - [inserter.rs](inserter.rs) - using the client-side batching via the `inserter` feature. Cargo features: requires `inserter`.
 - [async_insert.rs](async_insert.rs) - using the server-side batching via the [asynchronous inserts](https://clickhouse.com/docs/en/optimize/asynchronous-inserts) ClickHouse feature

src/lib.rs

@@ -313,6 +313,11 @@ impl Client {
         query::Query::new(self, query)
     }
 
+    /// Starts a new SELECT/DDL query that will be used as-is without any processing.
+    pub fn query_raw(&self, query: &str) -> query::Query {
+        query::Query::raw(self, query)
+    }
+
     /// Starts a new WATCH query.
     ///
     /// The `query` can be either the table name or a SELECT query.

src/query.rs

@@ -23,13 +23,23 @@ use crate::headers::with_authentication;
 pub struct Query {
     client: Client,
     sql: SqlBuilder,
+    raw: bool,
 }
 
 impl Query {
     pub(crate) fn new(client: &Client, template: &str) -> Self {
         Self {
             client: client.clone(),
             sql: SqlBuilder::new(template),
+            raw: false,
+        }
+    }
+    /// Creates a new query that will be used as-is without any processing.
+    pub(crate) fn raw(client: &Client, query: &str) -> Self {
+        Self {
+            client: client.clone(),
+            sql: SqlBuilder::raw(query),
+            raw: true,
         }
     }
 
@@ -53,6 +63,9 @@ impl Query {
     /// [`Identifier`]: crate::sql::Identifier
     #[track_caller]
     pub fn bind(mut self, value: impl Bind) -> Self {
+        if self.raw {
+            panic!("bind() cannot be used with raw queries");
+        }
         self.sql.bind_arg(value);
         self
     }
@@ -84,9 +97,10 @@ impl Query {
     /// # Ok(()) }
     /// ```
     pub fn fetch<T: Row>(mut self) -> Result<RowCursor<T>> {
-        self.sql.bind_fields::<T>();
+        if !self.raw {
+            self.sql.bind_fields::<T>();
+        }
         self.sql.set_output_format("RowBinary");
-
         let response = self.do_execute(true)?;
         Ok(RowCursor::new(response))
     }

src/sql/mod.rs

@@ -74,6 +74,9 @@ impl SqlBuilder {
 
         SqlBuilder::InProgress(parts, None)
     }
+    pub(crate) fn raw(query: &str) -> Self {
+        Self::InProgress(vec![Part::Text(query.to_string())], None)
+    }
 
     pub(crate) fn set_output_format(&mut self, format: impl Into<String>) {
         if let Self::InProgress(_, format_opt) = self {

tests/it/main.rs

@@ -123,6 +123,7 @@ mod ip;
 mod mock;
 mod nested;
 mod query;
+mod query_raw;
 mod time;
 mod user_agent;
 mod uuid;

tests/it/query_raw.rs

@@ -0,0 +1,303 @@
+use clickhouse::Row;
+use serde::{Deserialize, Serialize};
+
+#[derive(Row, Deserialize, Debug)]
+struct PersonName<'a> {
+    name: &'a str,
+}
+
+#[derive(Row, Deserialize, Debug)]
+struct PersonInfo {
+    name: String,
+    age: u32,
+}
+
+#[tokio::test]
+async fn verify_raw_query_basic_functionality() {
+    let client = prepare_database!();
+
+    // The key test: verify that ? characters don't cause binding errors
+    // Use fetch_bytes to avoid the RowBinary format issue
+    let result = client
+        .query_raw("SELECT 1 WHERE 'test?' = 'test?'")
+        .fetch_bytes("TSV")
+        .unwrap();
+
+    let mut data = Vec::new();
+    let mut cursor = result;
+    while let Some(chunk) = cursor.next().await.unwrap() {
+        data.extend_from_slice(&chunk);
+    }
+    let response = String::from_utf8(data).unwrap();
+
+    // Should return "1\n" - proving the query executed successfully
+    assert_eq!(response.trim(), "1");
+
+    // Contrast: regular query with ? should fail
+    let regular_result = client
+        .query("SELECT 1 WHERE 'test?' = 'test?'")
+        .fetch_bytes("TSV");
+
+    // This should fail because ? is treated as a bind parameter
+    assert!(regular_result.is_err());
+    if let Err(error) = regular_result {
+        let error_msg = error.to_string();
+        assert!(error_msg.contains("unbound"));
+    }
+}
+
+#[tokio::test]
+async fn fetch_with_single_field_struct() {
+    let client = prepare_database!();
+
+    // Create a test table
+    client
+        .query("CREATE TABLE test_users(name String) ENGINE = Memory")
+        .execute()
+        .await
+        .unwrap();
+
+    // Insert test data
+    client
+        .query_raw("INSERT INTO test_users VALUES ('Alice?'), ('Bob??'), ('Charlie???')")
+        .execute()
+        .await
+        .unwrap();
+
+    // Test raw query with struct fetching (FORMAT is RowBinary by default)
+    let sql = "SELECT name FROM test_users ORDER BY name";
+
+    let mut cursor = client.query_raw(sql).fetch::<PersonName<'_>>().unwrap();
+
+    let mut names = Vec::new();
+    while let Some(PersonName { name }) = cursor.next().await.unwrap() {
+        names.push(name.to_string());
+    }
+
+    assert_eq!(names, vec!["Alice?", "Bob??", "Charlie???"]);
+}
+
+#[tokio::test]
+async fn fetch_with_multi_field_struct() {
+    let client = prepare_database!();
+
+    // Create a test table
+    client
+        .query("CREATE TABLE test_persons(name String, age UInt32) ENGINE = Memory")
+        .execute()
+        .await
+        .unwrap();
+
+    // Insert test data with question marks in names
+    client
+        .query_raw("INSERT INTO test_persons VALUES ('What?', 25), ('How??', 30), ('Why???', 35)")
+        .execute()
+        .await
+        .unwrap();
+
+    // Test raw query with multi-field struct (FORMAT is RowBinary by default)
+    let sql = "SELECT name, age FROM test_persons ORDER BY age";
+
+    let mut cursor = client.query_raw(sql).fetch::<PersonInfo>().unwrap();
+
+    let mut persons = Vec::new();
+    while let Some(person) = cursor.next().await.unwrap() {
+        persons.push((person.name.clone(), person.age));
+    }
+
+    assert_eq!(
+        persons,
+        vec![
+            ("What?".to_string(), 25),
+            ("How??".to_string(), 30),
+            ("Why???".to_string(), 35)
+        ]
+    );
+}
+
+#[tokio::test]
+async fn compare_raw_vs_regular_query_with_structs() {
+    let client = prepare_database!();
+
+    // Create a test table
+    client
+        .query("CREATE TABLE test_comparison(name String) ENGINE = Memory")
+        .execute()
+        .await
+        .unwrap();
+
+    // Insert test data
+    client
+        .query_raw("INSERT INTO test_comparison VALUES ('Alice?')")
+        .execute()
+        .await
+        .unwrap();
+
+    // Regular query with ? should fail due to unbound parameter
+    let regular_result = client
+        .query("SELECT name FROM test_comparison WHERE name = 'Alice?'")
+        .fetch::<PersonName<'_>>();
+
+    assert!(regular_result.is_err());
+    if let Err(error) = regular_result {
+        let error_msg = error.to_string();
+        assert!(error_msg.contains("unbound"));
+    }
+
+    // Raw query with ? should succeed (FORMAT will be added automatically)
+    let raw_result = client
+        .query_raw("SELECT name FROM test_comparison WHERE name = 'Alice?'")
+        .fetch::<PersonName<'_>>()
+        .unwrap();
+
+    let mut names = Vec::new();
+    let mut cursor = raw_result;
+    while let Some(PersonName { name }) = cursor.next().await.unwrap() {
+        names.push(name.to_string());
+    }
+
+    assert_eq!(names, vec!["Alice?"]);
+}
+
+#[tokio::test]
+async fn mixed_question_mark() {
+    let client = prepare_database!();
+
+    // Test various question mark patterns with bytes fetch to avoid format issues
+    let patterns = vec![
+        ("SELECT 1 WHERE 'test?' = 'test?'", "?"),
+        ("SELECT 2 WHERE 'test??' = 'test??'", "??"),
+        ("SELECT 3 WHERE 'test???' = 'test???'", "???"),
+        (
+            "SELECT 4 WHERE 'What? How?? Why???' = 'What? How?? Why???'",
+            "mixed",
+        ),
+    ];
+
+    for (sql, pattern_type) in patterns {
+        let result = client.query_raw(sql).fetch_bytes("TSV").unwrap();
+
+        let mut data = Vec::new();
+        let mut cursor = result;
+        while let Some(chunk) = cursor.next().await.unwrap() {
+            data.extend_from_slice(&chunk);
+        }
+        let response = String::from_utf8(data).unwrap();
+
+        // Should return the expected number
+        assert!(
+            !response.trim().is_empty(),
+            "Query should return data for pattern: {}",
+            pattern_type
+        );
+    }
+}
+
+#[tokio::test]
+async fn question_marks_in_comments() {
+    let client = prepare_database!();
+
+    // Test question marks in SQL comments - should work without binding
+    let result = client
+        .query_raw("SELECT 1 /* What? How?? Why??? */ WHERE 1=1")
+        .fetch_bytes("TSV")
+        .unwrap();
+
+    let mut data = Vec::new();
+    let mut cursor = result;
+    while let Some(chunk) = cursor.next().await.unwrap() {
+        data.extend_from_slice(&chunk);
+    }
+    let response = String::from_utf8(data).unwrap();
+
+    assert_eq!(response.trim(), "1");
+}
+
+#[tokio::test]
+async fn contrast_with_regular_query() {
+    let client = prepare_database!();
+
+    // This should fail with regular query because of unbound parameter
+    let result = client
+        .query("SELECT 1 WHERE 'test?' = 'test?'")
+        .fetch_bytes("TSV");
+
+    // Regular query should fail due to unbound ?
+    assert!(result.is_err());
+    if let Err(error) = result {
+        let error_msg = error.to_string();
+        assert!(error_msg.contains("unbound"));
+    }
+
+    // But raw query should succeed
+    let raw_result = client
+        .query_raw("SELECT 1 WHERE 'test?' = 'test?'")
+        .fetch_bytes("TSV")
+        .unwrap();
+
+    let mut data = Vec::new();
+    let mut cursor = raw_result;
+    while let Some(chunk) = cursor.next().await.unwrap() {
+        data.extend_from_slice(&chunk);
+    }
+    let response = String::from_utf8(data).unwrap();
+
+    assert_eq!(response.trim(), "1");
+}
+
+#[tokio::test]
+async fn complex_sql_with_question_marks() {
+    use clickhouse::Row;
+    use serde::{Deserialize, Serialize};
+
+    #[derive(Debug, Row, Serialize, Deserialize)]
+    struct TestResult {
+        question: String,
+        confusion: String,
+        bewilderment: String,
+        answer: String,
+    }
+
+    let client = prepare_database!();
+
+    // Test a more complex SQL query with question marks in various contexts
+    let sql = r#"
+        SELECT 
+            'What is this?' as question,
+            'How does this work??' as confusion,
+            'Why would you do this???' as bewilderment,
+            CASE 
+                WHEN 1=1 THEN 'Yes?'
+                ELSE 'No??'
+            END as answer
+        WHERE 'test?' LIKE '%?'
+    "#;
+
+    let result = client.query_raw(sql).fetch_one::<TestResult>().await;
+
+    assert!(result.is_ok());
+    let row = result.unwrap();
+    assert_eq!(row.question, "What is this?");
+    assert_eq!(row.confusion, "How does this work??");
+    assert_eq!(row.bewilderment, "Why would you do this???");
+    assert_eq!(row.answer, "Yes?");
+}
+
+#[tokio::test]
+async fn query_raw_preserves_exact_sql() {
+    let client = prepare_database!();
+
+    // Test that raw query preserves the exact SQL including whitespace and formatting
+    let sql = "SELECT   1   WHERE   'test?'   =   'test?'   ";
+
+    let result = client.query_raw(sql).fetch_bytes("TSV").unwrap();
+
+    let mut data = Vec::new();
+    let mut cursor = result;
+    while let Some(chunk) = cursor.next().await.unwrap() {
+        data.extend_from_slice(&chunk);
+    }
+    let response = String::from_utf8(data).unwrap();
+
+    assert_eq!(response.trim(), "1");
+}