sqlcx-core 0.2.1

SQL-first cross-language type-safe code generator — core library
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
// database/sql driver generator for Go

use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::path::Path;

use crate::error::Result;
use crate::generator::go::common::{
    escape_sql, func_params, generate_result_struct, generate_row_struct, query_args, scan_fields,
    sql_const_name,
};
use crate::generator::{DriverGenerator, GeneratedFile};
use crate::ir::{ColumnDef, QueryCommand, QueryDef, SqlcxIR};
use crate::utils::pascal_case;

use super::structs::go_imports_for_columns;

/// Go's `database/sql` package is driver-agnostic — any third-party driver
/// can plug into the same interface. The generated code is identical across
/// backends; only the SQL placeholder style differs (Postgres uses `$1,
/// $2, ...`; MySQL and SQLite use `?`). `DatabaseSqlBackend` parameterizes
/// which placeholder style the generated SQL constant uses.
#[derive(Debug, Clone, Copy)]
pub enum DatabaseSqlBackend {
    Postgres,
    MySql,
    Sqlite,
}

impl DatabaseSqlBackend {
    /// Rewrite `$N` placeholders to the style this backend expects. For
    /// Postgres, returns the SQL unchanged with empty occurrence indices.
    /// For MySQL/SQLite, replaces every `$N` outside a single-quoted
    /// string literal with `?`, and returns the `$N` indices in document
    /// order so callers can emit args in positional order (handles reused
    /// and out-of-order params correctly).
    fn rewrite_placeholders(self, sql: &str) -> (String, Vec<u32>) {
        match self {
            DatabaseSqlBackend::Postgres => (sql.to_string(), Vec::new()),
            DatabaseSqlBackend::MySql | DatabaseSqlBackend::Sqlite => {
                let mut out = String::with_capacity(sql.len());
                let mut indices = Vec::new();
                let mut chars = sql.chars().peekable();
                let mut in_string = false;
                while let Some(c) = chars.next() {
                    if c == '\'' {
                        if in_string && chars.peek() == Some(&'\'') {
                            out.push(c);
                            out.push(chars.next().unwrap());
                            continue;
                        }
                        in_string = !in_string;
                        out.push(c);
                        continue;
                    }
                    if !in_string && c == '$' && chars.peek().is_some_and(|ch| ch.is_ascii_digit())
                    {
                        let mut num = String::new();
                        while chars.peek().is_some_and(|ch| ch.is_ascii_digit()) {
                            num.push(chars.next().unwrap());
                        }
                        indices.push(num.parse::<u32>().unwrap_or(0));
                        out.push('?');
                    } else {
                        out.push(c);
                    }
                }
                (out, indices)
            }
        }
    }
}

pub struct DatabaseSqlGenerator {
    backend: DatabaseSqlBackend,
}

impl DatabaseSqlGenerator {
    pub fn postgres() -> Self {
        Self {
            backend: DatabaseSqlBackend::Postgres,
        }
    }

    pub fn mysql() -> Self {
        Self {
            backend: DatabaseSqlBackend::MySql,
        }
    }

    pub fn sqlite() -> Self {
        Self {
            backend: DatabaseSqlBackend::Sqlite,
        }
    }
}

impl Default for DatabaseSqlGenerator {
    fn default() -> Self {
        Self::postgres()
    }
}

// ── Client file ───────────────────────────────────────────────────────────────

fn generate_client() -> String {
    r#"// Code generated by sqlcx. DO NOT EDIT.
package db

import (
	"context"
	"database/sql"
)

type DBTX interface {
	ExecContext(ctx context.Context, query string, args ...interface{}) (sql.Result, error)
	QueryContext(ctx context.Context, query string, args ...interface{}) (*sql.Rows, error)
	QueryRowContext(ctx context.Context, query string, args ...interface{}) *sql.Row
}

type Queries struct {
	db DBTX
}

func New(db DBTX) *Queries {
	return &Queries{db: db}
}"#
    .to_string()
}

// ── Query generation ──────────────────────────────────────────────────────────

/// Generate a full query function. `backend` determines the placeholder
/// style in the emitted SQL constant.
fn generate_query_function(backend: DatabaseSqlBackend, query: &QueryDef) -> String {
    let const_name = sql_const_name(&query.name);
    let func_name = pascal_case(&query.name);
    let params = func_params(query);

    let mut parts: Vec<String> = Vec::new();

    // SQL constant — placeholder style depends on backend.
    let (rewritten_sql, occurrence_indices) = backend.rewrite_placeholders(&query.sql);
    parts.push(format!(
        "const {} = \"{}\"",
        const_name,
        escape_sql(&rewritten_sql),
    ));

    // Args — Postgres binds each unique param once (query_args default),
    // MySQL/SQLite bind one arg per placeholder occurrence (handles reused
    // and out-of-order $N correctly).
    let args = if occurrence_indices.is_empty() {
        query_args(query)
    } else {
        let names: Vec<String> = occurrence_indices
            .iter()
            .map(|idx| {
                query
                    .params
                    .iter()
                    .find(|p| p.index == *idx)
                    .map(|p| p.name.clone())
                    .unwrap_or_else(|| "nil".to_string())
            })
            .collect();
        if names.is_empty() {
            String::new()
        } else {
            format!(", {}", names.join(", "))
        }
    };

    match query.command {
        QueryCommand::One => {
            let row_type = format!("{}Row", pascal_case(&query.name));
            if let Some(row_struct) = generate_row_struct(query) {
                parts.push(row_struct);
            }
            let scans = scan_fields(&query.returns);
            parts.push(format!(
                "func (q *Queries) {}({}) (*{}, error) {{\n\
                \trow := q.db.QueryRowContext(ctx, {}{})
\tvar i {}
\terr := row.Scan({})
\tif err == sql.ErrNoRows {{
\t\treturn nil, nil
\t}}
\tif err != nil {{
\t\treturn nil, err
\t}}
\treturn &i, nil\n}}",
                func_name, params, row_type, const_name, args, row_type, scans,
            ));
        }
        QueryCommand::Many => {
            let row_type = format!("{}Row", pascal_case(&query.name));
            if let Some(row_struct) = generate_row_struct(query) {
                parts.push(row_struct);
            }
            let scans = scan_fields(&query.returns);
            parts.push(format!(
                "func (q *Queries) {}({}) ([]{}, error) {{\n\
                \trows, err := q.db.QueryContext(ctx, {}{})
\tif err != nil {{
\t\treturn nil, err
\t}}
\tdefer rows.Close()
\tvar items []{}
\tfor rows.Next() {{
\t\tvar i {}
\t\tif err := rows.Scan({}); err != nil {{
\t\t\treturn nil, err
\t\t}}
\t\titems = append(items, i)
\t}}
\treturn items, rows.Err()\n}}",
                func_name, params, row_type, const_name, args, row_type, row_type, scans,
            ));
        }
        QueryCommand::Exec => {
            parts.push(format!(
                "func (q *Queries) {}({}) error {{\n\
                \t_, err := q.db.ExecContext(ctx, {}{})\n\treturn err\n}}",
                func_name, params, const_name, args,
            ));
        }
        QueryCommand::ExecResult => {
            let result_type = format!("{}Result", pascal_case(&query.name));
            parts.push(generate_result_struct(query));
            parts.push(format!(
                "func (q *Queries) {}({}) (*{}, error) {{\n\
                \tresult, err := q.db.ExecContext(ctx, {}{})
\tif err != nil {{
\t\treturn nil, err
\t}}
\taffected, err := result.RowsAffected()
\tif err != nil {{
\t\treturn nil, err
\t}}
\treturn &{}{{RowsAffected: affected}}, nil\n}}",
                func_name, params, result_type, const_name, args, result_type,
            ));
        }
    }

    parts.join("\n\n")
}

/// Collect imports needed for a set of queries.
fn collect_query_imports(queries: &[QueryDef]) -> BTreeSet<String> {
    let mut imports = BTreeSet::new();
    imports.insert("context".to_string());

    let mut needs_database_sql = false;
    for query in queries {
        // Check return columns
        let ret_imports = go_imports_for_columns(&query.returns);
        imports.extend(ret_imports);

        // Check if we need database/sql (for ErrNoRows or Result)
        match query.command {
            QueryCommand::One | QueryCommand::ExecResult => {
                needs_database_sql = true;
            }
            _ => {}
        }

        // Check params for time/json imports
        for param in &query.params {
            let col = ColumnDef {
                name: param.name.clone(),
                alias: None,
                source_table: None,
                sql_type: param.sql_type.clone(),
                nullable: false,
                has_default: false,
            };
            let col_imports = go_imports_for_columns(&[col]);
            imports.extend(col_imports);
        }
    }

    if needs_database_sql {
        imports.insert("database/sql".to_string());
    }

    imports
}

// ── Public API ────────────────────────────────────────────────────────────────

impl DatabaseSqlGenerator {
    pub fn generate_client(&self) -> String {
        generate_client()
    }

    pub fn generate_query_file(&self, queries: &[QueryDef]) -> String {
        let imports = collect_query_imports(queries);
        let imports_str = if imports.is_empty() {
            String::new()
        } else {
            let lines: Vec<String> = imports.iter().map(|i| format!("\t\"{}\"", i)).collect();
            format!("\nimport (\n{}\n)\n", lines.join("\n"))
        };

        let functions: Vec<String> = queries
            .iter()
            .map(|q| generate_query_function(self.backend, q))
            .collect();

        let mut content = String::new();
        content.push_str("// Code generated by sqlcx. DO NOT EDIT.\npackage db\n");
        content.push_str(&imports_str);
        if !functions.is_empty() {
            content.push('\n');
            content.push_str(&functions.join("\n\n"));
            content.push('\n');
        }
        content
    }
}

impl DriverGenerator for DatabaseSqlGenerator {
    fn generate(&self, ir: &SqlcxIR) -> Result<Vec<GeneratedFile>> {
        let mut files = Vec::new();

        // client.go
        files.push(GeneratedFile {
            path: "client.go".to_string(),
            content: self.generate_client(),
        });

        // Group queries by source_file → one .queries.go per file
        let mut grouped: BTreeMap<String, Vec<&QueryDef>> = BTreeMap::new();
        for query in &ir.queries {
            grouped
                .entry(query.source_file.clone())
                .or_default()
                .push(query);
        }
        for (source_file, queries) in &grouped {
            let basename = Path::new(source_file)
                .file_stem()
                .unwrap_or_default()
                .to_string_lossy();
            let owned: Vec<QueryDef> = queries.iter().map(|q| (*q).clone()).collect();
            files.push(GeneratedFile {
                path: format!("{}.queries.go", basename),
                content: self.generate_query_file(&owned),
            });
        }

        Ok(files)
    }
}

// ── Tests ─────────────────────────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;
    use crate::parser::DatabaseParser;
    use crate::parser::postgres::PostgresParser;

    fn parse_fixture_ir() -> SqlcxIR {
        let schema_sql = include_str!("../../../../../tests/fixtures/schema.sql");
        let queries_sql = include_str!("../../../../../tests/fixtures/queries/users.sql");
        let parser = PostgresParser::new();
        let (tables, enums) = parser.parse_schema(schema_sql).unwrap();
        let queries = parser
            .parse_queries(queries_sql, &tables, &enums, "queries/users.sql")
            .unwrap();
        SqlcxIR {
            tables,
            queries,
            enums,
        }
    }

    #[test]
    fn generates_client_file() {
        let gen_ = DatabaseSqlGenerator::postgres();
        let content = gen_.generate_client();
        assert!(content.contains("type DBTX interface"));
        assert!(content.contains("type Queries struct"));
        assert!(content.contains("func New(db DBTX) *Queries"));
        insta::assert_snapshot!("go_database_sql_client", content);
    }

    #[test]
    fn generates_query_file() {
        let ir = parse_fixture_ir();
        let gen_ = DatabaseSqlGenerator::postgres();
        let content = gen_.generate_query_file(&ir.queries);
        assert!(content.contains("func (q *Queries) GetUser"));
        assert!(content.contains("func (q *Queries) ListUsers"));
        assert!(content.contains("func (q *Queries) CreateUser"));
        assert!(content.contains("func (q *Queries) DeleteUser"));
        // Postgres keeps $N placeholders.
        assert!(content.contains("WHERE id = $1"));
        insta::assert_snapshot!("go_database_sql_queries", content);
    }

    #[test]
    fn mysql_backend_rewrites_placeholders_to_question_marks() {
        let ir = parse_fixture_ir();
        let gen_ = DatabaseSqlGenerator::mysql();
        let content = gen_.generate_query_file(&ir.queries);
        // MySQL: `$1` → `?`.
        assert!(content.contains("WHERE id = ?"));
        assert!(!content.contains("WHERE id = $1"));
        insta::assert_snapshot!("go_database_sql_mysql_queries", content);
    }

    #[test]
    fn sqlite_backend_rewrites_placeholders_to_question_marks() {
        let ir = parse_fixture_ir();
        let gen_ = DatabaseSqlGenerator::sqlite();
        let content = gen_.generate_query_file(&ir.queries);
        assert!(content.contains("WHERE id = ?"));
        assert!(!content.contains("WHERE id = $1"));
        insta::assert_snapshot!("go_database_sql_sqlite_queries", content);
    }

    #[test]
    fn placeholder_rewrite_preserves_dollar_in_string_literals() {
        let (rewritten, idx) =
            DatabaseSqlBackend::MySql.rewrite_placeholders("SELECT '$1' FROM x WHERE a = $1");
        assert_eq!(rewritten, "SELECT '$1' FROM x WHERE a = ?");
        assert_eq!(idx, vec![1]);
    }

    #[test]
    fn reused_param_emits_repeated_args_in_mysql() {
        // WHERE x = $1 OR y = $1 must produce two `?` AND pass the arg twice.
        use crate::ir::{ParamDef, SqlType, SqlTypeCategory};
        let query = QueryDef {
            name: "Search".to_string(),
            command: QueryCommand::Many,
            sql: "SELECT id FROM users WHERE name = $1 OR email = $1".to_string(),
            params: vec![ParamDef {
                index: 1,
                name: "q".to_string(),
                sql_type: SqlType {
                    raw: "text".to_string(),
                    normalized: "text".to_string(),
                    category: SqlTypeCategory::String,
                    element_type: None,
                    enum_name: None,
                    enum_values: None,
                    json_shape: None,
                },
            }],
            returns: vec![],
            source_file: "q.sql".to_string(),
        };
        let out = generate_query_function(DatabaseSqlBackend::MySql, &query);
        // Two `?` in the SQL const.
        assert_eq!(out.matches('?').count(), 2);
        // Two `q` args in the Query/Exec call.
        assert!(out.contains(", q, q)"), "expected `, q, q)` in: {out}");
    }

    #[test]
    fn out_of_order_params_bind_in_document_order_in_sqlite() {
        // WHERE b = $2 AND a = $1 — first ? binds param with index 2,
        // second binds param with index 1.
        use crate::ir::{ParamDef, SqlType, SqlTypeCategory};
        let int_type = SqlType {
            raw: "integer".to_string(),
            normalized: "integer".to_string(),
            category: SqlTypeCategory::Number,
            element_type: None,
            enum_name: None,
            enum_values: None,
            json_shape: None,
        };
        let query = QueryDef {
            name: "Range".to_string(),
            command: QueryCommand::Many,
            sql: "SELECT id FROM t WHERE b = $2 AND a = $1".to_string(),
            params: vec![
                ParamDef {
                    index: 1,
                    name: "a".to_string(),
                    sql_type: int_type.clone(),
                },
                ParamDef {
                    index: 2,
                    name: "b".to_string(),
                    sql_type: int_type,
                },
            ],
            returns: vec![],
            source_file: "q.sql".to_string(),
        };
        let out = generate_query_function(DatabaseSqlBackend::Sqlite, &query);
        // Must be `, b, a)` (document order), NOT `, a, b)` (param-index order).
        assert!(out.contains(", b, a)"), "expected `, b, a)` in: {out}");
        assert!(!out.contains(", a, b)"));
    }
}