drizzle 0.3.1

A type-safe SQL query builder for Rust
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
#![cfg(any(feature = "rusqlite", feature = "turso", feature = "libsql"))]

use drizzle::core::expr::*;
use drizzle::sqlite::prelude::*;

// Test enums with different representations
#[derive(SQLiteEnum, PartialEq, Clone, Default, Debug)]
pub enum UserRole {
    #[default]
    Guest,
    Member,
    Admin,
}

#[derive(SQLiteEnum, Default, Debug, Clone, PartialEq)]
pub enum AccountStatus {
    Suspended = -1,
    #[default]
    Inactive = 3,
    Active,
}

#[derive(SQLiteEnum, Default, Debug, Clone, Copy, PartialEq, Eq)]
#[repr(i64)]
enum SharedJobStatus {
    #[default]
    Queued = 0,
    Complete = 1,
}

// Table with enum fields using different column types
#[SQLiteTable]
struct UserAccount {
    #[column(PRIMARY, AUTOINCREMENT)]
    id: i64,
    name: String,
    #[column(ENUM)]
    role: UserRole,
    #[column(integer, ENUM)]
    status: AccountStatus,
}

#[SQLiteTable]
struct PrimaryJob {
    #[column(PRIMARY, AUTOINCREMENT)]
    id: i64,
    status: SharedJobStatus,
}

#[SQLiteTable]
struct SecondaryJob {
    #[column(PRIMARY, AUTOINCREMENT)]
    id: i64,
    status: SharedJobStatus,
}

#[SQLiteTable]
struct NullableJob {
    #[column(PRIMARY, AUTOINCREMENT)]
    id: i64,
    #[column(integer, ENUM)]
    status: Option<SharedJobStatus>,
}

#[derive(SQLiteSchema)]
pub struct Schema {
    user_account: UserAccount,
    primary_job: PrimaryJob,
    secondary_job: SecondaryJob,
    nullable_job: NullableJob,
}

// `User.role: UserRole` used to generate a column type named `UserRole`, the
// enum's own name. Column types live in the table's module now: `user::Role`.
#[SQLiteTable]
struct User {
    #[column(PRIMARY, AUTOINCREMENT)]
    id: i64,
    #[column(ENUM)]
    role: UserRole,
}

#[derive(SQLiteSchema)]
pub struct UserSchema {
    user: User,
}

#[test]
fn test_enum() {
    // Test basic enum functionality works
    let role = UserRole::Admin;
    let status = AccountStatus::Active;

    // Test Display
    assert_eq!(format!("{}", role), "Admin");
    assert_eq!(format!("{}", status), "Active");

    // Test FromStr
    assert_eq!("Member".parse::<UserRole>().unwrap(), UserRole::Member);
    assert_eq!(
        "Suspended".parse::<AccountStatus>().unwrap(),
        AccountStatus::Suspended
    );
    assert!(SharedJobStatus::decode(SQLiteValueRef::Text("Complete")).is_err());
    assert!(UserRole::decode(SQLiteValueRef::Integer(0)).is_err());
}

#[cfg(feature = "query")]
#[test]
fn enum_query_codec_rejects_wrong_storage_class() {
    let integer_as_text = drizzle::core::serde_json::json!({
        "$drizzle_storage": "text",
        "$drizzle_value": "Complete",
    });
    let text_as_integer = drizzle::core::serde_json::json!({
        "$drizzle_storage": "integer",
        "$drizzle_value": 0,
    });

    assert!(SharedJobStatus::decode_json(&integer_as_text).is_err());
    assert!(UserRole::decode_json(&text_as_integer).is_err());
}

#[test]
fn test_table_generation() {
    // Just test that the table compiles and has the expected structure
    let _table = UserAccount::new();

    // Test that we can create insert and update models
    let insert_model = InsertUserAccount::new("test", UserRole::Member, AccountStatus::Suspended);
    let update_model = UpdateUserAccount::default();

    // Test convenience methods work with enums
    let _insert_with_role = insert_model.with_role(UserRole::Member);
    let _update_with_status = update_model.with_status(AccountStatus::Suspended);

    // Basic smoke test - if this compiles, the From implementations were generated correctly
    let table_ref = &<UserAccount as drizzle::core::DrizzleTable>::TABLE_REF;
    assert!(!table_ref.columns.is_empty());
}

#[test]
fn repr_enum_without_column_marker_uses_integer_ddl_in_multiple_tables() {
    assert!(
        PrimaryJob::create_table_sql().contains("`status` INTEGER NOT NULL"),
        "primary table must use the enum's INTEGER storage authority"
    );
    assert!(
        SecondaryJob::create_table_sql().contains("`status` INTEGER NOT NULL"),
        "secondary table must use the same enum's INTEGER storage authority"
    );
    assert_eq!(
        <PrimaryJob as drizzle::core::DrizzleTable>::TABLE_REF.columns[1].sql_type,
        "INTEGER"
    );
}

#[cfg(feature = "rusqlite")]
#[test]
fn repr_enum_rusqlite_parameter_binds_as_integer() {
    let connection = rusqlite::Connection::open_in_memory().unwrap();
    connection
        .execute_batch("CREATE TABLE jobs (status INTEGER NOT NULL) STRICT")
        .unwrap();
    connection
        .execute(
            "INSERT INTO jobs (status) VALUES (?1)",
            rusqlite::params![SharedJobStatus::Complete],
        )
        .unwrap();
    let storage_class: String = connection
        .query_row("SELECT typeof(status) FROM jobs", [], |row| row.get(0))
        .unwrap();

    assert_eq!(storage_class, "integer");
    assert!(
        connection
            .query_row("SELECT 'Complete'", [], |row| {
                row.get::<_, SharedJobStatus>(0)
            })
            .is_err()
    );
}

#[cfg(feature = "libsql")]
#[tokio::test]
async fn nullable_libsql_enum_rejects_invalid_non_null_value() {
    let database = libsql::Builder::new_local(":memory:")
        .build()
        .await
        .unwrap();
    let connection = database.connect().unwrap();
    connection
        .execute(
            "CREATE TABLE nullable_job (id INTEGER PRIMARY KEY, status INTEGER)",
            (),
        )
        .await
        .unwrap();
    connection
        .execute("INSERT INTO nullable_job VALUES (1, 99)", ())
        .await
        .unwrap();
    connection
        .execute("INSERT INTO nullable_job VALUES (2, NULL)", ())
        .await
        .unwrap();
    let mut rows = connection
        .query("SELECT id, status FROM nullable_job WHERE id = 1", ())
        .await
        .unwrap();
    let row = rows.next().await.unwrap().unwrap();

    let error = SelectNullableJob::try_from(&row).expect_err("99 is not a valid enum value");
    assert!(
        error.to_string().contains("99"),
        "unexpected error: {error}"
    );

    let mut rows = connection
        .query("SELECT id, status FROM nullable_job WHERE id = 2", ())
        .await
        .unwrap();
    let row = rows.next().await.unwrap().unwrap();
    let decoded = SelectNullableJob::try_from(&row).unwrap();
    assert_eq!(decoded.status, None);
}

// Enum types work directly in FromRow for all drivers (rusqlite, libsql, turso)
// - rusqlite: Uses FromSql trait generated by SQLiteEnum
// - libsql/turso: Uses TryFrom<i64> and TryFrom<&str> generated by SQLiteEnum
#[allow(dead_code)]
#[derive(Debug, SQLiteFromRow)]
struct UserAccountResult {
    id: i64,
    name: String,
    role: UserRole,        // Direct enum type - works with TEXT storage
    status: AccountStatus, // Direct enum type - works with INTEGER storage
}

#[drizzle::test]
fn test_enum_database_roundtrip(db: &mut TestDb<Schema>) {
    let Schema { user_account, .. } = schema;

    // Insert test data with different enum values
    let test_users = vec![
        InsertUserAccount::new("guest_user", UserRole::Guest, AccountStatus::Inactive),
        InsertUserAccount::new("member_user", UserRole::Member, AccountStatus::Active),
        InsertUserAccount::new("admin_user", UserRole::Admin, AccountStatus::Suspended),
    ];

    let inserted = db.insert(user_account).values(test_users).execute();
    assert_eq!(inserted, 3);

    // Select and verify the data
    let results: Vec<UserAccountResult> = db
        .select((
            user_account.id,
            user_account.name,
            user_account.role,
            user_account.status,
        ))
        .from(user_account)
        .all();

    assert_eq!(results.len(), 3);

    // Verify guest user - enum types work for all drivers
    let guest = results.iter().find(|u| u.name == "guest_user").unwrap();
    assert_eq!(guest.role, UserRole::Guest);
    assert_eq!(guest.status, AccountStatus::Inactive);

    // Verify member user
    let member = results.iter().find(|u| u.name == "member_user").unwrap();
    assert_eq!(member.role, UserRole::Member);
    assert_eq!(member.status, AccountStatus::Active);

    // Verify admin user
    let admin = results.iter().find(|u| u.name == "admin_user").unwrap();
    assert_eq!(admin.role, UserRole::Admin);
    assert_eq!(admin.status, AccountStatus::Suspended);

    // Test filtering by enum values
    let admin_users: Vec<UserAccountResult> = db
        .select((
            user_account.id,
            user_account.name,
            user_account.role,
            user_account.status,
        ))
        .from(user_account)
        .r#where(eq(UserAccount::role, UserRole::Admin))
        .all();

    assert_eq!(admin_users.len(), 1);
    assert_eq!(admin_users[0].name, "admin_user");

    // Test filtering by integer enum
    let suspended_users: Vec<UserAccountResult> = db
        .select((
            user_account.id,
            user_account.name,
            user_account.role,
            user_account.status,
        ))
        .from(user_account)
        .r#where(eq(UserAccount::status, AccountStatus::Suspended))
        .all();

    assert_eq!(suspended_users.len(), 1);
    assert_eq!(suspended_users[0].name, "admin_user");
}

#[drizzle::test]
fn repr_enum_shared_by_two_tables_filters_and_round_trips(db: &mut TestDb<Schema>) {
    let Schema {
        primary_job,
        secondary_job,
        ..
    } = schema;

    let primary_inserted = db
        .insert(primary_job)
        .values([
            InsertPrimaryJob::new(SharedJobStatus::Queued),
            InsertPrimaryJob::new(SharedJobStatus::Complete),
        ])
        .execute();
    let secondary_inserted = db
        .insert(secondary_job)
        .values([
            InsertSecondaryJob::new(SharedJobStatus::Complete),
            InsertSecondaryJob::new(SharedJobStatus::Queued),
        ])
        .execute();
    assert_eq!(primary_inserted, 2);
    assert_eq!(secondary_inserted, 2);

    let primary: Vec<SelectPrimaryJob> = db
        .select(())
        .from(primary_job)
        .r#where(eq(primary_job.status, SharedJobStatus::Complete))
        .all();
    let secondary: Vec<SelectSecondaryJob> = db
        .select(())
        .from(secondary_job)
        .r#where(eq(secondary_job.status, SharedJobStatus::Queued))
        .all();

    let tuple_rows: Vec<(i64, SharedJobStatus)> = db
        .select((primary_job.id, primary_job.status))
        .from(primary_job)
        .r#where(in_array(
            primary_job.status,
            [SharedJobStatus::Queued, SharedJobStatus::Complete],
        ))
        .order_by([asc(primary_job.id)])
        .all();
    let excluded_rows: Vec<(i64, SharedJobStatus)> = db
        .select((primary_job.id, primary_job.status))
        .from(primary_job)
        .r#where(not_in_array(
            primary_job.status,
            [SharedJobStatus::Complete],
        ))
        .all();

    assert_eq!(primary.len(), 1);
    assert_eq!(primary[0].status, SharedJobStatus::Complete);
    assert_eq!(secondary.len(), 1);
    assert_eq!(secondary[0].status, SharedJobStatus::Queued);
    assert_eq!(tuple_rows.len(), 2);
    assert_eq!(tuple_rows[0].1, SharedJobStatus::Queued);
    assert_eq!(tuple_rows[1].1, SharedJobStatus::Complete);
    assert_eq!(excluded_rows.len(), 1);
    assert_eq!(excluded_rows[0].1, SharedJobStatus::Queued);
}

#[cfg(feature = "query")]
#[drizzle::test]
fn marker_free_enum_query_uses_enum_owned_decoder(db: &mut TestDb<Schema>) {
    let Schema { primary_job, .. } = schema;
    db.insert(primary_job)
        .values([InsertPrimaryJob::new(SharedJobStatus::Complete)])
        .execute();

    let rows = db.query(primary_job).find_many();
    assert_eq!(rows.len(), 1);
    assert_eq!(rows[0].status, SharedJobStatus::Complete);
}

#[drizzle::test]
fn column_type_does_not_take_the_name_of_its_enum(db: &mut TestDb<UserSchema>) {
    let UserSchema { user } = schema;

    // `with_role` spells `UserRole` beside the insert-state parameters.
    db.insert(user)
        .values([InsertUser::new(UserRole::Member).with_role(UserRole::Admin)])
        .execute();

    let rows: Vec<SelectUser> = db.select(()).from(user).all();
    assert_eq!(rows[0].role, UserRole::Admin);

    let column: user::Role = user.role;
    assert_eq!(column, user::Role);
}