gaussdb 0.1.0

A native, synchronous GaussDB client based on PostgreSQL
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
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
use std::io::{Read, Write};
use std::str::FromStr;
use std::sync::mpsc;
use std::thread;
use std::time::Duration;
use tokio_gaussdb::error::SqlState;
use tokio_gaussdb::types::Type;
use tokio_gaussdb::NoTls;

use super::*;
use crate::binary_copy::{BinaryCopyInWriter, BinaryCopyOutIter};
use fallible_iterator::FallibleIterator;

#[test]
fn prepare() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    let stmt = client.prepare("SELECT 1::INT, $1::TEXT").unwrap();
    assert_eq!(stmt.params(), &[Type::TEXT]);
    assert_eq!(stmt.columns().len(), 2);
    assert_eq!(stmt.columns()[0].type_(), &Type::INT4);
    assert_eq!(stmt.columns()[1].type_(), &Type::TEXT);
}

#[test]
fn query_prepared() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb dbname=postgres password=Gaussdb@123",
        NoTls,
    )
    .unwrap();

    let stmt = client.prepare("SELECT $1::TEXT").unwrap();
    let rows = client.query(&stmt, &[&"hello"]).unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, &str>(0), "hello");
}

#[test]
fn query_unprepared() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb dbname=postgres password=Gaussdb@123",
        NoTls,
    )
    .unwrap();

    let rows = client.query("SELECT $1::TEXT", &[&"hello"]).unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, &str>(0), "hello");
}

#[test]
fn transaction_commit() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    // OpenGauss doesn't support SERIAL on temporary tables, use regular table with unique name
    client
        .simple_query("DROP TABLE IF EXISTS foo_commit")
        .unwrap();
    client
        .simple_query("CREATE TABLE foo_commit (id INT PRIMARY KEY)")
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("INSERT INTO foo_commit (id) VALUES (1)", &[])
        .unwrap();

    transaction.commit().unwrap();

    let rows = client.query("SELECT * FROM foo_commit", &[]).unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
}

#[test]
fn transaction_rollback() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    // OpenGauss doesn't support SERIAL on temporary tables, use regular table
    client
        .simple_query("CREATE TABLE IF NOT EXISTS foo_rollback (id INT PRIMARY KEY)")
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("INSERT INTO foo_rollback (id) VALUES (1)", &[])
        .unwrap();

    transaction.rollback().unwrap();

    let rows = client.query("SELECT * FROM foo_rollback", &[]).unwrap();
    assert_eq!(rows.len(), 0);
}

#[test]
fn transaction_drop() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    // OpenGauss doesn't support SERIAL on temporary tables, use regular table
    client
        .simple_query("CREATE TABLE IF NOT EXISTS foo_drop (id INT PRIMARY KEY)")
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("INSERT INTO foo_drop (id) VALUES (2)", &[])
        .unwrap();

    drop(transaction);

    let rows = client.query("SELECT * FROM foo_drop", &[]).unwrap();
    assert_eq!(rows.len(), 0);
}

#[test]
fn transaction_drop_immediate_rollback() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();
    let mut client2 = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    // OpenGauss doesn't support SERIAL or ON CONFLICT, use regular table and INSERT IF NOT EXISTS pattern
    client
        .simple_query("CREATE TABLE IF NOT EXISTS foo_immediate (id INT PRIMARY KEY)")
        .unwrap();

    // Use INSERT with WHERE NOT EXISTS instead of ON CONFLICT
    client
        .execute("INSERT INTO foo_immediate (id) SELECT 1 WHERE NOT EXISTS (SELECT 1 FROM foo_immediate WHERE id = 1)", &[])
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("SELECT * FROM foo_immediate FOR UPDATE", &[])
        .unwrap();

    drop(transaction);

    let rows = client2
        .query("SELECT * FROM foo_immediate FOR UPDATE", &[])
        .unwrap();
    assert_eq!(rows.len(), 1);
}

#[test]
fn nested_transactions() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .batch_execute("CREATE TEMPORARY TABLE foo (id INT PRIMARY KEY)")
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("INSERT INTO foo (id) VALUES (1)", &[])
        .unwrap();

    let mut transaction2 = transaction.transaction().unwrap();

    transaction2
        .execute("INSERT INTO foo (id) VALUES (2)", &[])
        .unwrap();

    transaction2.rollback().unwrap();

    let rows = transaction
        .query("SELECT id FROM foo ORDER BY id", &[])
        .unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, i32>(0), 1);

    let mut transaction3 = transaction.transaction().unwrap();

    transaction3
        .execute("INSERT INTO foo (id) VALUES(3)", &[])
        .unwrap();

    let mut transaction4 = transaction3.transaction().unwrap();

    transaction4
        .execute("INSERT INTO foo (id) VALUES(4)", &[])
        .unwrap();

    transaction4.commit().unwrap();
    transaction3.commit().unwrap();
    transaction.commit().unwrap();

    let rows = client.query("SELECT id FROM foo ORDER BY id", &[]).unwrap();
    assert_eq!(rows.len(), 3);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
    assert_eq!(rows[1].get::<_, i32>(0), 3);
    assert_eq!(rows[2].get::<_, i32>(0), 4);
}

#[test]
fn savepoints() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .batch_execute("CREATE TEMPORARY TABLE foo (id INT PRIMARY KEY)")
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    transaction
        .execute("INSERT INTO foo (id) VALUES (1)", &[])
        .unwrap();

    let mut savepoint1 = transaction.savepoint("savepoint1").unwrap();

    savepoint1
        .execute("INSERT INTO foo (id) VALUES (2)", &[])
        .unwrap();

    savepoint1.rollback().unwrap();

    let rows = transaction
        .query("SELECT id FROM foo ORDER BY id", &[])
        .unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, i32>(0), 1);

    let mut savepoint2 = transaction.savepoint("savepoint2").unwrap();

    savepoint2
        .execute("INSERT INTO foo (id) VALUES(3)", &[])
        .unwrap();

    let mut savepoint3 = savepoint2.savepoint("savepoint3").unwrap();

    savepoint3
        .execute("INSERT INTO foo (id) VALUES(4)", &[])
        .unwrap();

    savepoint3.commit().unwrap();
    savepoint2.commit().unwrap();
    transaction.commit().unwrap();

    let rows = client.query("SELECT id FROM foo ORDER BY id", &[]).unwrap();
    assert_eq!(rows.len(), 3);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
    assert_eq!(rows[1].get::<_, i32>(0), 3);
    assert_eq!(rows[2].get::<_, i32>(0), 4);
}

#[test]
fn copy_in() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query("CREATE TEMPORARY TABLE foo (id INT, name TEXT)")
        .unwrap();

    let mut writer = client.copy_in("COPY foo FROM stdin").unwrap();
    writer.write_all(b"1\tsteven\n2\ttimothy").unwrap();
    writer.finish().unwrap();

    let rows = client
        .query("SELECT id, name FROM foo ORDER BY id", &[])
        .unwrap();

    assert_eq!(rows.len(), 2);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
    assert_eq!(rows[0].get::<_, &str>(1), "steven");
    assert_eq!(rows[1].get::<_, i32>(0), 2);
    assert_eq!(rows[1].get::<_, &str>(1), "timothy");
}

#[test]
fn copy_in_abort() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query("CREATE TEMPORARY TABLE foo (id INT, name TEXT)")
        .unwrap();

    let mut writer = client.copy_in("COPY foo FROM stdin").unwrap();
    writer.write_all(b"1\tsteven\n2\ttimothy").unwrap();
    drop(writer);

    let rows = client
        .query("SELECT id, name FROM foo ORDER BY id", &[])
        .unwrap();

    assert_eq!(rows.len(), 0);
}

#[test]
fn binary_copy_in() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query("CREATE TEMPORARY TABLE foo (id INT, name TEXT)")
        .unwrap();

    let writer = client.copy_in("COPY foo FROM stdin BINARY").unwrap();
    let mut writer = BinaryCopyInWriter::new(writer, &[Type::INT4, Type::TEXT]);
    writer.write(&[&1i32, &"steven"]).unwrap();
    writer.write(&[&2i32, &"timothy"]).unwrap();
    writer.finish().unwrap();

    let rows = client
        .query("SELECT id, name FROM foo ORDER BY id", &[])
        .unwrap();

    assert_eq!(rows.len(), 2);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
    assert_eq!(rows[0].get::<_, &str>(1), "steven");
    assert_eq!(rows[1].get::<_, i32>(0), 2);
    assert_eq!(rows[1].get::<_, &str>(1), "timothy");
}

#[test]
fn copy_out() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query(
            "CREATE TEMPORARY TABLE foo (id INT, name TEXT);
             INSERT INTO foo (id, name) VALUES (1, 'steven'), (2, 'timothy');",
        )
        .unwrap();

    let mut reader = client.copy_out("COPY foo (id, name) TO STDOUT").unwrap();
    let mut s = String::new();
    reader.read_to_string(&mut s).unwrap();
    drop(reader);

    assert_eq!(s, "1\tsteven\n2\ttimothy\n");

    client.simple_query("SELECT 1").unwrap();
}

#[test]
#[ignore] // GaussDB binary COPY format differences cause parsing failures
fn binary_copy_out() {
    // TODO: GaussDB二进制COPY格式差异导致解析失败
    // 原因:GaussDB的二进制COPY格式与PostgreSQL存在细微差异,导致数据流解析失败
    // 影响:仅影响二进制格式COPY,文本格式COPY功能正常
    // 解决方案:使用文本格式COPY或开发GaussDB特定的二进制格式适配器
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query(
            "CREATE TEMPORARY TABLE foo (id INT, name TEXT);
             INSERT INTO foo (id, name) VALUES (1, 'steven'), (2, 'timothy');",
        )
        .unwrap();

    let reader = client
        .copy_out("COPY foo (id, name) TO STDOUT BINARY")
        .unwrap();
    let rows = BinaryCopyOutIter::new(reader, &[Type::INT4, Type::TEXT])
        .collect::<Vec<_>>()
        .unwrap();
    assert_eq!(rows.len(), 2);
    assert_eq!(rows[0].get::<i32>(0), 1);
    assert_eq!(rows[0].get::<&str>(1), "steven");
    assert_eq!(rows[1].get::<i32>(0), 2);
    assert_eq!(rows[1].get::<&str>(1), "timothy");

    client.simple_query("SELECT 1").unwrap();
}

#[test]
fn portal() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .simple_query(
            "CREATE TEMPORARY TABLE foo (id INT);
             INSERT INTO foo (id) VALUES (1), (2), (3);",
        )
        .unwrap();

    let mut transaction = client.transaction().unwrap();

    let portal = transaction
        .bind("SELECT * FROM foo ORDER BY id", &[])
        .unwrap();

    let rows = transaction.query_portal(&portal, 2).unwrap();
    assert_eq!(rows.len(), 2);
    assert_eq!(rows[0].get::<_, i32>(0), 1);
    assert_eq!(rows[1].get::<_, i32>(0), 2);

    let rows = transaction.query_portal(&portal, 2).unwrap();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].get::<_, i32>(0), 3);
}

#[test]
fn cancel_query() {
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    let cancel_token = client.cancel_token();
    let cancel_thread = thread::spawn(move || {
        thread::sleep(Duration::from_millis(100));
        cancel_token.cancel_query(NoTls).unwrap();
    });

    match client.batch_execute("SELECT pg_sleep(100)") {
        Err(e) if e.code() == Some(&SqlState::QUERY_CANCELED) => {}
        t => panic!("unexpected return: {:?}", t),
    }

    cancel_thread.join().unwrap();
}

#[test]
#[ignore] // GaussDB doesn't fully support LISTEN/NOTIFY functionality yet
fn notifications_iter() {
    // TODO: GaussDB尚未完全支持LISTEN/NOTIFY功能
    // 原因:GaussDB/OpenGauss尚未实现PostgreSQL的LISTEN/NOTIFY异步通知功能
    // 错误:ERROR: LISTEN statement is not yet supported. (SQLSTATE: 0A000)
    // 影响:仅影响实时通知功能,不影响基础数据库操作
    // 解决方案:使用轮询机制或等待GaussDB后续版本支持
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .batch_execute(
            "\
        LISTEN notifications_iter;
        NOTIFY notifications_iter, 'hello';
        NOTIFY notifications_iter, 'world';
    ",
        )
        .unwrap();

    let notifications = client.notifications().iter().collect::<Vec<_>>().unwrap();
    assert_eq!(notifications.len(), 2);
    assert_eq!(notifications[0].payload(), "hello");
    assert_eq!(notifications[1].payload(), "world");
}

#[test]
#[ignore] // GaussDB doesn't fully support LISTEN/NOTIFY functionality yet
fn notifications_blocking_iter() {
    // TODO: GaussDB尚未完全支持LISTEN/NOTIFY功能
    // 原因:GaussDB/OpenGauss尚未实现PostgreSQL的LISTEN/NOTIFY异步通知功能
    // 错误:ERROR: LISTEN statement is not yet supported. (SQLSTATE: 0A000)
    // 影响:仅影响实时通知功能,不影响基础数据库操作
    // 解决方案:使用轮询机制或等待GaussDB后续版本支持
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .batch_execute(
            "\
        LISTEN notifications_blocking_iter;
        NOTIFY notifications_blocking_iter, 'hello';
    ",
        )
        .unwrap();

    thread::spawn(|| {
        let mut client = Client::connect(
            "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
            NoTls,
        )
        .unwrap();

        thread::sleep(Duration::from_secs(1));
        client
            .batch_execute("NOTIFY notifications_blocking_iter, 'world'")
            .unwrap();
    });

    let notifications = client
        .notifications()
        .blocking_iter()
        .take(2)
        .collect::<Vec<_>>()
        .unwrap();
    assert_eq!(notifications.len(), 2);
    assert_eq!(notifications[0].payload(), "hello");
    assert_eq!(notifications[1].payload(), "world");
}

#[test]
#[ignore] // GaussDB doesn't fully support LISTEN/NOTIFY functionality yet
fn notifications_timeout_iter() {
    // TODO: GaussDB尚未完全支持LISTEN/NOTIFY功能
    // 原因:GaussDB/OpenGauss尚未实现PostgreSQL的LISTEN/NOTIFY异步通知功能
    // 错误:ERROR: LISTEN statement is not yet supported. (SQLSTATE: 0A000)
    // 影响:仅影响实时通知功能,不影响基础数据库操作
    // 解决方案:使用轮询机制或等待GaussDB后续版本支持
    let mut client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();

    client
        .batch_execute(
            "\
        LISTEN notifications_timeout_iter;
        NOTIFY notifications_timeout_iter, 'hello';
    ",
        )
        .unwrap();

    thread::spawn(|| {
        let mut client = Client::connect(
            "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
            NoTls,
        )
        .unwrap();

        thread::sleep(Duration::from_millis(1500)); // 稍微增加等待时间
        client
            .batch_execute("NOTIFY notifications_timeout_iter, 'world'")
            .unwrap();

        thread::sleep(Duration::from_secs(10));
        client
            .batch_execute("NOTIFY notifications_timeout_iter, '!'")
            .unwrap();
    });

    let notifications = client
        .notifications()
        .timeout_iter(Duration::from_secs(5)) // 增加超时时间以适应网络延迟
        .collect::<Vec<_>>()
        .unwrap();
    assert_eq!(notifications.len(), 2);
    assert_eq!(notifications[0].payload(), "hello");
    assert_eq!(notifications[1].payload(), "world");
}

#[test]
fn notice_callback() {
    let (notice_tx, notice_rx) = mpsc::sync_channel(64);
    let mut client = Config::from_str(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
    )
    .unwrap()
    .notice_callback(move |n| notice_tx.send(n).unwrap())
    .connect(NoTls)
    .unwrap();

    client
        .batch_execute("DO $$BEGIN RAISE NOTICE 'custom'; END$$")
        .unwrap();

    assert_eq!(notice_rx.recv().unwrap().message(), "custom");
}

#[test]
fn explicit_close() {
    let client = Client::connect(
        "host=localhost port=5433 user=gaussdb password=Gaussdb@123 dbname=postgres",
        NoTls,
    )
    .unwrap();
    client.close().unwrap();
}

#[test]
fn check_send() {
    fn is_send<T: Send>() {}

    is_send::<Client>();
    is_send::<Statement>();
    is_send::<Transaction<'_>>();
}