chdb-rust 1.3.1

chDB FFI bindings for Rust(Experimental)
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
//! Test examples for chdb-rust
//!
//! Note: These tests may fail when run in parallel due to connection resource contention
//! in the chDB library. Run with `RUST_TEST_THREADS=1 cargo test --test examples`
//! to ensure reliable execution.

use chdb_rust::arg::Arg;
use chdb_rust::error::Result;
use chdb_rust::execute;
use chdb_rust::format::InputFormat;
use chdb_rust::format::OutputFormat;
use chdb_rust::log_level::LogLevel;
use chdb_rust::session::SessionBuilder;
use std::fs;

#[test]
fn test_stateful() -> Result<()> {
    //
    // Create session.
    //
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_arg(Arg::LogLevel(LogLevel::Debug))
        .with_arg(Arg::Custom("priority".into(), Some("1".into())))
        .with_auto_cleanup(true)
        .build()?;

    //
    // Create database.
    //

    session.execute("CREATE DATABASE demo; USE demo", Some(&[Arg::MultiQuery]))?;

    //
    // Create table.
    //

    session.execute(
        "CREATE TABLE logs (id UInt64, msg String) ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    //
    // Insert into table.
    //

    session.execute("INSERT INTO logs (id, msg) VALUES (1, 'test')", None)?;

    //
    // Select from table.
    //
    let len = session.execute(
        "SELECT COUNT(*) FROM logs",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    assert_eq!(len.data_utf8_lossy(), "{\"COUNT()\":1}\n");

    let result = session.execute(
        "SELECT * FROM logs",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;
    assert_eq!(result.data_utf8_lossy(), "{\"id\":1,\"msg\":\"test\"}\n");
    Ok(())
}

#[test]
fn test_stateless() -> Result<()> {
    let query = format!(
        "SELECT * FROM file('tests/logs.csv', {})",
        InputFormat::CSV.as_str()
    );

    let result = execute(
        &query,
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    assert_eq!(result.data_utf8_lossy(), "{\"id\":1,\"msg\":\"test\"}\n");
    Ok(())
}

#[test]
fn test_sql_syntax_error() {
    let result = execute("aaa", Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]));
    assert!(result.is_err(), "Expected error for invalid SQL");
}

#[test]
fn test_output_formats() -> Result<()> {
    let query = "SELECT 1 AS a, 'test' AS b, 3.14 AS pi";

    // Test JSONEachRow
    let result = execute(query, Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]))?;
    let json_output = result.data_utf8_lossy();
    assert!(json_output.contains("\"a\":1"));
    assert!(json_output.contains("\"b\":\"test\""));

    // Test CSVWithNames
    let result = execute(
        query,
        Some(&[Arg::OutputFormat(OutputFormat::CSVWithNames)]),
    )?;
    let csv_output = result.data_utf8_lossy();
    // CSV format may have quotes or different formatting, so check for key elements
    assert!(csv_output.contains("a") && csv_output.contains("b") && csv_output.contains("pi"));
    assert!(csv_output.contains("1") && csv_output.contains("test"));
    assert!(!csv_output.is_empty());

    // Test Pretty format
    let result = execute(query, Some(&[Arg::OutputFormat(OutputFormat::Pretty)]))?;
    let pretty_output = result.data_utf8_lossy();
    assert!(!pretty_output.is_empty());

    // Test TabSeparated (default)
    let result = execute(query, None)?;
    let ts_output = result.data_utf8_lossy();
    assert!(ts_output.contains("1"));
    assert!(ts_output.contains("test"));

    Ok(())
}

#[test]
fn test_query_result_statistics() -> Result<()> {
    let result = execute(
        "SELECT number FROM numbers(100)",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    // Check that we read rows
    assert!(result.rows_read() > 0);
    assert_eq!(result.rows_read(), 100);

    // Check that we read bytes
    assert!(result.bytes_read() > 0);

    // Check elapsed time (should be very small but >= 0)
    let elapsed = result.elapsed();
    assert!(elapsed.as_secs_f64() >= 0.0);

    // Check data is not empty
    let data = result.data_utf8_lossy();
    assert!(!data.is_empty());
    assert!(data.contains("\"number\":0"));
    assert!(data.contains("\"number\":99"));

    Ok(())
}

#[test]
fn test_query_result_data_methods() -> Result<()> {
    let result = execute(
        "SELECT 'Hello, World!' AS greeting",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    // Test data_utf8_lossy
    let lossy = result.data_utf8_lossy();
    assert!(lossy.contains("Hello, World!"));

    // Test data_utf8 (should work for valid UTF-8)
    let result = execute(
        "SELECT 'Hello, World!' AS greeting",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;
    let utf8 = result.data_utf8()?;
    assert!(utf8.contains("Hello, World!"));

    // Test data_ref
    let result = execute(
        "SELECT 'Hello' AS msg",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;
    let bytes = result.data_ref();
    assert!(!bytes.is_empty());

    Ok(())
}

#[test]
fn test_multiple_inserts_and_aggregation() -> Result<()> {
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_auto_cleanup(true)
        .build()?;

    session.execute(
        "CREATE DATABASE testdb; USE testdb",
        Some(&[Arg::MultiQuery]),
    )?;

    session.execute(
        "CREATE TABLE products (id UInt64, name String, price Float64) \
         ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    // Insert multiple rows
    session.execute(
        "INSERT INTO products VALUES \
         (1, 'Apple', 1.50), \
         (2, 'Banana', 0.75), \
         (3, 'Orange', 2.00), \
         (4, 'Apple', 1.50)",
        None,
    )?;

    // Test aggregation
    let result = session.execute(
        "SELECT name, COUNT(*) AS count, SUM(price) AS total, AVG(price) AS avg_price \
         FROM products GROUP BY name ORDER BY name",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    let output = result.data_utf8_lossy();
    assert!(output.contains("Apple"));
    assert!(output.contains("Banana"));
    assert!(output.contains("Orange"));
    assert_eq!(result.rows_read(), 3);

    // Test filtering
    let result = session.execute(
        "SELECT COUNT(*) FROM products WHERE price > 1.0",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;
    assert!(result.data_utf8_lossy().contains("\"COUNT()\":3"));

    Ok(())
}

#[test]
fn test_different_data_types() -> Result<()> {
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_auto_cleanup(true)
        .build()?;

    session.execute(
        "CREATE DATABASE testdb; USE testdb",
        Some(&[Arg::MultiQuery]),
    )?;

    session.execute(
        "CREATE TABLE types_test (
            id UInt64,
            name String,
            age UInt8,
            salary Float64,
            active Bool,
            created Date
        ) ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    session.execute(
        "INSERT INTO types_test VALUES \
         (1, 'Alice', 30, 50000.5, true, '2024-01-01'), \
         (2, 'Bob', 25, 45000.0, false, '2024-01-02')",
        None,
    )?;

    let result = session.execute(
        "SELECT * FROM types_test ORDER BY id",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    let output = result.data_utf8_lossy();
    assert!(output.contains("\"id\":1"));
    assert!(output.contains("\"name\":\"Alice\""));
    assert!(output.contains("\"age\":30"));
    assert!(output.contains("\"active\":true"));
    assert_eq!(result.rows_read(), 2);

    Ok(())
}

#[test]
fn test_error_handling_table_not_found() {
    let result = execute(
        "SELECT * FROM nonexistent_table_12345",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    );
    assert!(result.is_err(), "Expected error for non-existent table");

    if let Err(e) = result {
        match e {
            chdb_rust::error::Error::QueryError(_) => {}
            _ => {
                panic!("Expected QueryError, got {e:?}");
            }
        }
    }
}

#[test]
fn test_error_handling_invalid_syntax() {
    let result = execute(
        "SELECT * FROM WHERE invalid",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    );
    assert!(result.is_err(), "Expected error for invalid SQL syntax");
}

#[test]
fn test_session_auto_cleanup() -> Result<()> {
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let data_path = tmp.path().to_path_buf();

    {
        let session = SessionBuilder::new()
            .with_data_path(&data_path)
            .with_auto_cleanup(true)
            .build()?;

        session.execute(
            "CREATE DATABASE testdb; USE testdb",
            Some(&[Arg::MultiQuery]),
        )?;
        session.execute(
            "CREATE TABLE test (id UInt64) ENGINE = MergeTree() ORDER BY id",
            None,
        )?;
        session.execute("INSERT INTO test VALUES (1)", None)?;

        // Session should exist and work
        let result = session.execute("SELECT COUNT(*) FROM test", None)?;
        assert_eq!(result.rows_read(), 1);

        // Check the folder was created
        assert!(fs::metadata(&data_path).is_ok());
    } // Session dropped here, auto_cleanup should trigger

    // Check the folder was deleted
    assert!(fs::metadata(&data_path).is_err());

    Ok(())
}

#[test]
fn test_complex_query_with_joins() -> Result<()> {
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_auto_cleanup(true)
        .build()?;

    session.execute(
        "CREATE DATABASE testdb; USE testdb",
        Some(&[Arg::MultiQuery]),
    )?;

    // Create orders table
    session.execute(
        "CREATE TABLE orders (id UInt64, customer_id UInt64, total Float64) \
         ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    // Create customers table
    session.execute(
        "CREATE TABLE customers (id UInt64, name String) \
         ENGINE = MergeTree() ORDER BY id",
        None,
    )?;

    session.execute(
        "INSERT INTO customers VALUES (1, 'Alice'), (2, 'Bob')",
        None,
    )?;

    session.execute(
        "INSERT INTO orders VALUES (1, 1, 100.0), (2, 1, 50.0), (3, 2, 75.0)",
        None,
    )?;

    // Test join query
    let result = session.execute(
        "SELECT c.name, COUNT(o.id) AS order_count, SUM(o.total) AS total_spent \
         FROM customers c \
         LEFT JOIN orders o ON c.id = o.customer_id \
         GROUP BY c.name \
         ORDER BY c.name",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    let output = result.data_utf8_lossy();
    assert!(output.contains("Alice"));
    assert!(output.contains("Bob"));
    assert_eq!(result.rows_read(), 2);

    Ok(())
}

#[test]
fn test_numbers_function() -> Result<()> {
    // Test ClickHouse numbers() function
    let result = execute(
        "SELECT number, number * 2 AS doubled FROM numbers(10) WHERE number < 5",
        Some(&[Arg::OutputFormat(OutputFormat::JSONEachRow)]),
    )?;

    assert_eq!(result.rows_read(), 5);
    let output = result.data_utf8_lossy();
    assert!(output.contains("\"number\":0"));
    assert!(output.contains("\"number\":4"));
    assert!(output.contains("\"doubled\":0"));
    assert!(output.contains("\"doubled\":8"));

    Ok(())
}

#[test]
fn test_default_output_format() -> Result<()> {
    // Test that default format (TabSeparated) works
    let result = execute("SELECT 1 AS a, 'test' AS b", None)?;
    let output = result.data_utf8_lossy();
    assert!(!output.is_empty());
    assert!(output.contains("1"));
    assert!(output.contains("test"));

    Ok(())
}

#[test]
fn test_session_without_auto_cleanup() -> Result<()> {
    let tmp = tempdir::TempDir::new("chdb-rust")?;
    let session = SessionBuilder::new()
        .with_data_path(tmp.path())
        .with_auto_cleanup(false) // Explicitly disable cleanup
        .build()?;

    session.execute(
        "CREATE DATABASE testdb; USE testdb",
        Some(&[Arg::MultiQuery]),
    )?;
    session.execute(
        "CREATE TABLE test (id UInt64) ENGINE = MergeTree() ORDER BY id",
        None,
    )?;
    session.execute("INSERT INTO test VALUES (1), (2), (3)", None)?;

    let result = session.execute("SELECT COUNT(*) FROM test", None)?;
    assert_eq!(result.rows_read(), 1);

    // Check the folder was not deleted
    assert!(fs::metadata(tmp.path()).is_ok());

    Ok(())
}