udb 0.4.21

Universal Data Broker — a Rust gRPC broker over multiple databases (Postgres, MySQL, SQLite, MongoDB, ClickHouse, Cassandra, MSSQL, Redis, Qdrant, S3, Neo4j, …) with per-tenant RLS, 2PC, sagas, and CDC.
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
use crate::backend::BackendKind;
use crate::generation::{CatalogManifest, ManifestColumn, ManifestForeignKey, ManifestTable};
use crate::ir::compile::{
    CompileContext, CompileOperation, CompiledRendering, compile_for_backend,
};
use crate::ir::operations::LogicalRead;
use crate::ir::projection::{LogicalProjection, LogicalSort, SortDirection};
use crate::ir::value::LogicalValue;

use super::support::{
    GoldenAggregateRow, GoldenRow, compile_aggregate_sql, compile_delete_sql,
    compile_ensure_name_index_sql, compile_insert_sql, compile_list_customer_indexes_sql,
    compile_read_sql, compile_search_sql, compile_update_sql, customer_manifest,
    expected_after_delete_aggregate_rows, expected_after_delete_rows, expected_after_insert_rows,
    expected_after_update_rows, expected_seed_rows, live_ir_enabled, swap_database,
    unsupported_bind,
};

fn bind<'q>(
    q: sqlx::query::Query<'q, sqlx::MySql, sqlx::mysql::MySqlArguments>,
    value: &LogicalValue,
) -> sqlx::query::Query<'q, sqlx::MySql, sqlx::mysql::MySqlArguments> {
    match value {
        LogicalValue::String(s) => q.bind(s.clone()),
        other => unsupported_bind(other),
    }
}

#[tokio::test]
#[ignore = "requires UDB_IR_LIVE_GOLDEN_TESTS=1 and UDB_MYSQL_DSN"]
async fn mysql_compiled_read_write_delete_match_live_golden_rows() {
    if !live_ir_enabled() {
        eprintln!("skipping: set UDB_IR_LIVE_GOLDEN_TESTS=1 to run live IR golden tests");
        return;
    }
    let Ok(dsn) = std::env::var("UDB_MYSQL_DSN") else {
        eprintln!("UDB_MYSQL_DSN unset - skipping live MySQL IR golden");
        return;
    };

    use sqlx::mysql::MySqlPoolOptions;

    let admin = MySqlPoolOptions::new()
        .max_connections(1)
        .connect(&dsn)
        .await
        .expect("connect to live MySQL");
    let db = format!("udb_ir_live_{}", uuid::Uuid::new_v4().simple());
    sqlx::query(&format!("CREATE DATABASE `{db}`"))
        .execute(&admin)
        .await
        .expect("create throwaway database");
    let pool = MySqlPoolOptions::new()
        .max_connections(2)
        .connect(&swap_database(&dsn, &db))
        .await
        .expect("connect to throwaway MySQL database");
    sqlx::query(&format!(
        "CREATE TABLE `{db}`.`customers` (\
            id varchar(191) PRIMARY KEY, name varchar(191) NOT NULL, \
            email varchar(191) NOT NULL, tenant_id varchar(191) NOT NULL)"
    ))
    .execute(&pool)
    .await
    .expect("create customers table");
    create_search_index(&pool, &db).await;
    seed(&pool, &db).await;

    let manifest = customer_manifest(&db);
    assert_eq!(fetch_rows(&pool, &manifest).await, expected_seed_rows());
    assert_eq!(
        fetch_search_rows(&pool, &manifest).await,
        vec![GoldenRow::new("cust-1", "Alice", "alice@example.com")]
    );

    execute(
        &pool,
        compile_ensure_name_index_sql(BackendKind::Mysql, &manifest),
    )
    .await;
    assert!(
        fetch_index_names(&pool, &manifest)
            .await
            .iter()
            .any(|name| name == "idx_customers_name"),
        "compiled MySQL resource-op index must be visible in SHOW INDEX"
    );

    execute(&pool, compile_insert_sql(BackendKind::Mysql, &manifest)).await;
    assert_eq!(
        fetch_rows(&pool, &manifest).await,
        expected_after_insert_rows()
    );

    execute(&pool, compile_update_sql(BackendKind::Mysql, &manifest)).await;
    assert_eq!(
        fetch_rows(&pool, &manifest).await,
        expected_after_update_rows()
    );

    execute(&pool, compile_delete_sql(BackendKind::Mysql, &manifest)).await;
    assert_eq!(
        fetch_rows(&pool, &manifest).await,
        expected_after_delete_rows()
    );
    assert_eq!(
        fetch_aggregate_rows(&pool, &manifest).await,
        expected_after_delete_aggregate_rows()
    );

    pool.close().await;
    let _ = sqlx::query(&format!("DROP DATABASE IF EXISTS `{db}`"))
        .execute(&admin)
        .await;
}

#[tokio::test]
#[ignore = "requires UDB_IR_LIVE_GOLDEN_TESTS=1 and UDB_MYSQL_DSN"]
async fn mysql_eager_include_loads_belongs_to_in_one_compiled_query_live() {
    if !live_ir_enabled() {
        eprintln!("skipping: set UDB_IR_LIVE_GOLDEN_TESTS=1 to run live IR golden tests");
        return;
    }
    let Ok(dsn) = std::env::var("UDB_MYSQL_DSN") else {
        eprintln!("UDB_MYSQL_DSN unset - skipping live MySQL include golden");
        return;
    };

    use sqlx::Row;
    use sqlx::mysql::MySqlPoolOptions;

    let admin = MySqlPoolOptions::new()
        .max_connections(1)
        .connect(&dsn)
        .await
        .expect("connect to live MySQL");
    let db = format!("udb_ir_include_{}", uuid::Uuid::new_v4().simple());
    sqlx::query(&format!("CREATE DATABASE `{db}`"))
        .execute(&admin)
        .await
        .expect("create throwaway include database");
    let pool = MySqlPoolOptions::new()
        .max_connections(2)
        .connect(&swap_database(&dsn, &db))
        .await
        .expect("connect to throwaway MySQL include database");
    create_invoice_customer_tables(&pool, &db).await;
    seed_invoice_customer_rows(&pool, &db).await;

    let manifest = invoice_relation_manifest(&db);
    let read = LogicalRead::message("billing.v1.Invoice")
        .with_projection(LogicalProjection::fields([
            "invoice_id".to_string(),
            "customer_id".to_string(),
            "total_cents".to_string(),
        ]))
        .with_include("customer")
        .with_sort(vec![LogicalSort {
            field: "invoice_id".to_string(),
            direction: SortDirection::Asc,
            nulls: crate::ir::projection::NullOrder::Default,
        }]);
    let ctx = CompileContext::new(&manifest);
    let (statement, params) =
        match compile_for_backend(&BackendKind::Mysql, CompileOperation::Read(&read), &ctx)
            .expect("MySQL compiler registered")
            .expect("include read compiles")
        {
            CompiledRendering::Sql {
                backend,
                statement,
                params,
            } => {
                assert_eq!(backend, BackendKind::Mysql);
                (statement, params)
            }
            other => panic!("expected MySQL SQL rendering, got {other:?}"),
        };
    assert!(params.is_empty(), "include query should not add binds");
    assert!(
        statement.contains("JSON_OBJECT("),
        "include must be projected by the compiled SQL; got: {statement}"
    );

    let rows = sqlx::query(&statement)
        .fetch_all(&pool)
        .await
        .expect("execute compiled MySQL eager include read");
    assert_eq!(rows.len(), 2);
    let first_invoice: String = rows[0].try_get("invoice_id").expect("invoice_id");
    let first_customer = mysql_json_value(&rows[0], "customer");
    assert_eq!(first_invoice, "inv-1");
    assert_eq!(first_customer["customer_id"], "cust-1");
    assert_eq!(first_customer["name"], "Alice");
    let second_invoice: String = rows[1].try_get("invoice_id").expect("invoice_id");
    let second_customer = mysql_json_value(&rows[1], "customer");
    assert_eq!(second_invoice, "inv-2");
    assert_eq!(second_customer["customer_id"], "cust-2");
    assert_eq!(second_customer["name"], "Ana");

    let read_many = LogicalRead::message("crm.v1.Customer")
        .with_projection(LogicalProjection::fields([
            "customer_id".to_string(),
            "name".to_string(),
        ]))
        .with_include("invoices")
        .with_sort(vec![LogicalSort {
            field: "customer_id".to_string(),
            direction: SortDirection::Asc,
            nulls: crate::ir::projection::NullOrder::Default,
        }]);
    let (statement, params) = match compile_for_backend(
        &BackendKind::Mysql,
        CompileOperation::Read(&read_many),
        &ctx,
    )
    .expect("MySQL compiler registered")
    .expect("has-many include read compiles")
    {
        CompiledRendering::Sql {
            backend,
            statement,
            params,
        } => {
            assert_eq!(backend, BackendKind::Mysql);
            (statement, params)
        }
        other => panic!("expected MySQL SQL rendering, got {other:?}"),
    };
    assert!(
        params.is_empty(),
        "has-many include query should not add binds"
    );
    assert!(
        statement.contains("JSON_ARRAYAGG(JSON_OBJECT("),
        "has-many include must be projected by one compiled SQL query; got: {statement}"
    );
    let rows = sqlx::query(&statement)
        .fetch_all(&pool)
        .await
        .expect("execute compiled MySQL has-many eager include read");
    assert_eq!(rows.len(), 2);
    let first_customer_id: String = rows[0].try_get("customer_id").expect("customer_id");
    let first_invoices = mysql_json_value(&rows[0], "invoices");
    assert_eq!(first_customer_id, "cust-1");
    assert_eq!(first_invoices.as_array().expect("invoices array").len(), 1);
    assert_eq!(first_invoices[0]["invoice_id"], "inv-1");

    pool.close().await;
    let _ = sqlx::query(&format!("DROP DATABASE IF EXISTS `{db}`"))
        .execute(&admin)
        .await;
}

async fn fetch_rows(
    pool: &sqlx::MySqlPool,
    manifest: &crate::generation::CatalogManifest,
) -> Vec<GoldenRow> {
    use sqlx::Row;

    let (statement, params) = compile_read_sql(BackendKind::Mysql, manifest);
    let mut query = sqlx::query(&statement);
    for value in &params {
        query = bind(query, value);
    }
    query
        .fetch_all(pool)
        .await
        .expect("execute compiled MySQL read")
        .into_iter()
        .map(|row| GoldenRow {
            id: row.try_get("id").expect("id"),
            name: row.try_get("name").expect("name"),
            email: row.try_get("email").expect("email"),
        })
        .collect()
}

async fn fetch_aggregate_rows(
    pool: &sqlx::MySqlPool,
    manifest: &crate::generation::CatalogManifest,
) -> Vec<GoldenAggregateRow> {
    use sqlx::Row;

    let (statement, params) = compile_aggregate_sql(BackendKind::Mysql, manifest);
    let mut query = sqlx::query(&statement);
    for value in &params {
        query = bind(query, value);
    }
    query
        .fetch_all(pool)
        .await
        .expect("execute compiled MySQL aggregate")
        .into_iter()
        .map(|row| GoldenAggregateRow {
            tenant_id: row.try_get("tenant_id").expect("tenant_id"),
            row_count: row.try_get("row_count").expect("row_count"),
        })
        .collect()
}

async fn fetch_search_rows(
    pool: &sqlx::MySqlPool,
    manifest: &crate::generation::CatalogManifest,
) -> Vec<GoldenRow> {
    use sqlx::Row;

    let (statement, params) = compile_search_sql(BackendKind::Mysql, manifest);
    let mut query = sqlx::query(&statement);
    for value in &params {
        query = bind(query, value);
    }
    query
        .fetch_all(pool)
        .await
        .expect("execute compiled MySQL fulltext search")
        .into_iter()
        .map(|row| GoldenRow {
            id: row.try_get("id").expect("id"),
            name: row.try_get("name").expect("name"),
            email: row.try_get("email").expect("email"),
        })
        .collect()
}

async fn fetch_index_names(
    pool: &sqlx::MySqlPool,
    manifest: &crate::generation::CatalogManifest,
) -> Vec<String> {
    use sqlx::Row;

    let (statement, params) = compile_list_customer_indexes_sql(BackendKind::Mysql, manifest);
    let mut query = sqlx::query(&statement);
    for value in &params {
        query = bind(query, value);
    }
    query
        .fetch_all(pool)
        .await
        .expect("execute compiled MySQL resource-op list indexes")
        .into_iter()
        .map(|row| row.try_get("Key_name").expect("index name"))
        .collect()
}

async fn execute(pool: &sqlx::MySqlPool, (statement, params): (String, Vec<LogicalValue>)) {
    let mut query = sqlx::query(&statement);
    for value in &params {
        query = bind(query, value);
    }
    query
        .execute(pool)
        .await
        .expect("execute compiled MySQL mutation");
}

async fn seed(pool: &sqlx::MySqlPool, db: &str) {
    sqlx::query(&format!(
        "INSERT INTO `{db}`.`customers` (id, name, email, tenant_id) \
         VALUES (?, ?, ?, ?), (?, ?, ?, ?), (?, ?, ?, ?)"
    ))
    .bind("cust-1")
    .bind("Alice")
    .bind("alice@example.com")
    .bind("tenant-a")
    .bind("cust-2")
    .bind("Ana")
    .bind("ana@example.com")
    .bind("tenant-a")
    .bind("cust-3")
    .bind("Bob")
    .bind("bob@example.com")
    .bind("tenant-b")
    .execute(pool)
    .await
    .expect("seed MySQL golden rows");
}

async fn create_search_index(pool: &sqlx::MySqlPool, db: &str) {
    sqlx::query(&format!(
        "CREATE FULLTEXT INDEX `idx_customers_fulltext` \
         ON `{db}`.`customers` (`id`, `name`, `email`, `tenant_id`)"
    ))
    .execute(pool)
    .await
    .expect("create MySQL fulltext index");
}

async fn create_invoice_customer_tables(pool: &sqlx::MySqlPool, db: &str) {
    sqlx::query(&format!(
        "CREATE TABLE `{db}`.`customers` (\
            customer_id varchar(191) PRIMARY KEY, name varchar(191) NOT NULL)"
    ))
    .execute(pool)
    .await
    .expect("create include customers table");
    sqlx::query(&format!(
        "CREATE TABLE `{db}`.`invoices` (\
            invoice_id varchar(191) PRIMARY KEY, \
            customer_id varchar(191) NOT NULL, \
            total_cents bigint NOT NULL, \
            CONSTRAINT `fk_invoice_customer` FOREIGN KEY (`customer_id`) \
                REFERENCES `{db}`.`customers` (`customer_id`))"
    ))
    .execute(pool)
    .await
    .expect("create include invoices table");
}

fn invoice_relation_manifest(schema: &str) -> CatalogManifest {
    CatalogManifest {
        tables: vec![
            ManifestTable {
                message_name: "Invoice".to_string(),
                proto_package: "billing.v1".to_string(),
                schema: schema.to_string(),
                table: "invoices".to_string(),
                primary_key: vec!["invoice_id".to_string()],
                columns: vec![
                    include_column("invoice_id", "string", "varchar(191)", true),
                    include_column("customer_id", "string", "varchar(191)", false),
                    include_column("total_cents", "int64", "bigint", false),
                ],
                foreign_keys: vec![ManifestForeignKey {
                    name: "fk_invoice_customer".to_string(),
                    columns: vec!["customer_id".to_string()],
                    ref_table: "customers".to_string(),
                    ref_columns: vec!["customer_id".to_string()],
                    ..Default::default()
                }],
                ..Default::default()
            },
            ManifestTable {
                message_name: "Customer".to_string(),
                proto_package: "crm.v1".to_string(),
                schema: schema.to_string(),
                table: "customers".to_string(),
                primary_key: vec!["customer_id".to_string()],
                columns: vec![
                    include_column("customer_id", "string", "varchar(191)", true),
                    include_column("name", "string", "varchar(191)", false),
                ],
                ..Default::default()
            },
        ],
        ..Default::default()
    }
}

fn include_column(name: &str, proto_type: &str, sql_type: &str, primary: bool) -> ManifestColumn {
    ManifestColumn {
        field_name: name.to_string(),
        column_name: name.to_string(),
        proto_type: proto_type.to_string(),
        sql_type: sql_type.to_string(),
        is_primary: primary,
        not_null: true,
        ..Default::default()
    }
}

async fn seed_invoice_customer_rows(pool: &sqlx::MySqlPool, db: &str) {
    sqlx::query(&format!(
        "INSERT INTO `{db}`.`customers` (customer_id, name) VALUES (?, ?), (?, ?)"
    ))
    .bind("cust-1")
    .bind("Alice")
    .bind("cust-2")
    .bind("Ana")
    .execute(pool)
    .await
    .expect("seed include customers");
    sqlx::query(&format!(
        "INSERT INTO `{db}`.`invoices` (invoice_id, customer_id, total_cents) \
         VALUES (?, ?, ?), (?, ?, ?)"
    ))
    .bind("inv-1")
    .bind("cust-1")
    .bind(1200_i64)
    .bind("inv-2")
    .bind("cust-2")
    .bind(3400_i64)
    .execute(pool)
    .await
    .expect("seed include invoices");
}

fn mysql_json_value(row: &sqlx::mysql::MySqlRow, column: &str) -> serde_json::Value {
    use sqlx::Row;

    // MySQL 8.4 types JSON_OBJECT()/JSON_ARRAYAGG() projections as JSON, which
    // sqlx refuses to decode as `String` (mismatched types); decode the typed
    // JSON value first and keep the text decode as a fallback for engines that
    // report the projection as VARCHAR.
    row.try_get::<serde_json::Value, _>(column)
        .or_else(|_| {
            row.try_get::<String, _>(column)
                .map(|raw| serde_json::from_str(&raw).expect("parse MySQL JSON_OBJECT text"))
        })
        .expect("JSON_OBJECT result")
}