libsqlconv 0.1.1

Core library for sql-to-csv: SQL dump parsing, DDL conversion, and CSV/TSV emission
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
use std::collections::HashSet;
use std::io::Read;

use crate::errors::ConvertError;
use crate::lexer::{LexerEvent, LexerState};
use crate::types::{SqlDialect, StatementEntry, StatementIndex, StatementKind};

const BUF_SIZE: usize = 256 * 1024; // 256 KB
const PREFIX_CAP: usize = 256;

/// Auto-detect the SQL dialect from the first few KB of the dump.
pub fn detect_dialect<R: Read>(reader: &mut R) -> Result<(SqlDialect, Vec<u8>), ConvertError> {
    let mut head = vec![0u8; 8 * 1024];
    let n = reader.read(&mut head)?;
    head.truncate(n);

    let text = String::from_utf8_lossy(&head);
    let upper = text.to_ascii_uppercase();

    let dialect = if upper.contains("/*!") || upper.contains("ENGINE=") || upper.contains("AUTO_INCREMENT") || (upper.contains("INSERT INTO `") || upper.contains("CREATE TABLE `")) {
        SqlDialect::Mysql
    } else if upper.contains("\\COPY") || upper.contains("COPY ") && upper.contains("FROM STDIN") || upper.contains("PG_DUMP") || upper.contains("POSTGRESQL") || upper.contains("SET CLIENT_ENCODING") {
        SqlDialect::Postgresql
    } else if upper.contains("[DBO]") || upper.contains("SET IDENTITY_INSERT") || upper.contains("NVARCHAR") || upper.contains("\nGO\n") || upper.contains("\nGO\r") || upper.contains("SET NOCOUNT") {
        SqlDialect::Mssql
    } else if upper.contains("SPOOL") || upper.contains("VARCHAR2") || upper.contains("NUMBER(") || upper.contains("REM ") || upper.contains("ORACLE") {
        SqlDialect::Oracle
    } else if upper.contains("BEGIN TRANSACTION") || upper.contains("SQLITE") || upper.contains("INTEGER PRIMARY KEY AUTOINCREMENT") {
        SqlDialect::Sqlite
    } else {
        // Default to MySQL as the most common dump format
        SqlDialect::Mysql
    };

    Ok((dialect, head))
}

/// Build an index of all SQL statements in the input stream.
/// This is Phase 1: a sequential scan that records byte offsets.
pub fn build_index<R: Read>(
    mut reader: R,
    dialect: SqlDialect,
) -> Result<StatementIndex, ConvertError> {
    let mut state = LexerState::Normal;
    let mut entries = Vec::new();
    let mut tables_seen = HashSet::new();

    let mut buf = vec![0u8; BUF_SIZE];
    let mut global_offset: u64 = 0;
    let mut line_number: u64 = 1;

    let mut stmt_start: u64 = 0;
    let mut stmt_start_line: u64 = 1;
    let mut prefix = Vec::with_capacity(PREFIX_CAP);
    let mut in_conditional = false;

    // For PostgreSQL COPY FROM stdin detection
    let mut in_copy_data = false;
    let mut copy_table_name: Option<String> = None;
    let mut line_buf = Vec::new();

    loop {
        let n = reader.read(&mut buf)?;
        if n == 0 {
            break;
        }

        for i in 0..n {
            let b = buf[i];
            let cur_offset = global_offset + i as u64;

            if b == b'\n' {
                line_number += 1;
            }

            // PostgreSQL COPY data mode: read line-by-line until `\.`
            if in_copy_data {
                if b == b'\n' {
                    if line_buf == b"\\." {
                        // End of COPY data block
                        let byte_length = cur_offset - stmt_start + 1;
                        entries.push(StatementEntry {
                            kind: StatementKind::CopyData,
                            table_name: copy_table_name.take(),
                            byte_offset: stmt_start,
                            byte_length,
                            approx_line: stmt_start_line,
                        });
                        in_copy_data = false;
                        stmt_start = cur_offset + 1;
                        stmt_start_line = line_number;
                        prefix.clear();
                    }
                    line_buf.clear();
                } else {
                    line_buf.push(b);
                }
                continue;
            }

            // MySQL conditional comment detection
            if state == LexerState::BlockComment && !in_conditional && b == b'!'
                && dialect == SqlDialect::Mysql
            {
                state = LexerState::ConditionalComment;
                in_conditional = true;
                if prefix.len() < PREFIX_CAP {
                    prefix.push(b);
                }
                continue;
            }

            let (new_state, event) = state.feed(b);

            if new_state == LexerState::ConditionalComment
                || new_state == LexerState::ConditionalMaybeEnd
            {
                in_conditional = true;
            }
            if in_conditional && new_state == LexerState::Normal && state != LexerState::Normal {
                in_conditional = false;
            }

            state = new_state;

            if event == LexerEvent::Semicolon {
                let byte_length = cur_offset - stmt_start + 1;
                let kind = classify_statement(&prefix, dialect);
                let table_name = extract_table_name(&prefix, kind, dialect);

                if let Some(ref name) = table_name {
                    tables_seen.insert(name.clone());
                }

                // Check if this is a PostgreSQL COPY ... FROM stdin
                if dialect == SqlDialect::Postgresql && kind == StatementKind::CopyData {
                    in_copy_data = true;
                    copy_table_name = table_name;
                    line_buf.clear();
                    // Don't emit the statement yet — wait for `\.`
                    // Keep stmt_start pointing to the COPY header
                    prefix.clear();
                } else {
                    entries.push(StatementEntry {
                        kind,
                        table_name,
                        byte_offset: stmt_start,
                        byte_length,
                        approx_line: stmt_start_line,
                    });

                    stmt_start = cur_offset + 1;
                    stmt_start_line = line_number;
                    prefix.clear();
                }
            } else if prefix.len() < PREFIX_CAP {
                prefix.push(b);
            }
        }

        global_offset += n as u64;
    }

    // Handle SQL Server GO batch separators (post-processing)
    if dialect == SqlDialect::Mssql {
        // GO batches are handled as Other statements; no special handling needed
        // since MSSQL dumps typically use semicolons for INSERT statements.
    }

    Ok(StatementIndex {
        entries,
        tables_seen,
    })
}

/// Build an index with prepended data (from dialect detection).
pub fn build_index_with_head<R: Read>(
    head: &[u8],
    reader: R,
    dialect: SqlDialect,
) -> Result<StatementIndex, ConvertError> {
    let combined = std::io::Cursor::new(head.to_vec()).chain(reader);
    build_index(combined, dialect)
}

fn classify_statement(prefix: &[u8], dialect: SqlDialect) -> StatementKind {
    let trimmed = skip_whitespace(prefix);
    let upper: Vec<u8> = trimmed
        .iter()
        .take(30)
        .map(|b| b.to_ascii_uppercase())
        .collect();
    let s = String::from_utf8_lossy(&upper);

    if s.starts_with("CREATE TABLE") || s.starts_with("CREATE TEMPORARY TABLE") {
        StatementKind::CreateTable
    } else if s.starts_with("DROP TABLE") {
        StatementKind::DropTable
    } else if s.starts_with("INSERT INTO")
        || s.starts_with("INSERT IGNORE INTO")
        || s.starts_with("INSERT [")
    {
        StatementKind::InsertInto
    } else if s.starts_with("COPY ") && dialect == SqlDialect::Postgresql {
        // PostgreSQL COPY ... FROM stdin
        let full: String = prefix
            .iter()
            .take(200)
            .map(|&b| b.to_ascii_uppercase() as char)
            .collect();
        if full.contains("FROM STDIN") {
            StatementKind::CopyData
        } else {
            StatementKind::Other
        }
    } else if s.starts_with("SET ") || s.starts_with("SELECT PG_CATALOG") {
        StatementKind::SetVariable
    } else if s.starts_with("LOCK ") {
        StatementKind::LockTable
    } else if s.starts_with("UNLOCK ") {
        StatementKind::UnlockTables
    } else if s.starts_with("--") || s.starts_with("/*") || s.starts_with("REM ") {
        StatementKind::Comment
    } else {
        StatementKind::Other
    }
}

fn extract_table_name(
    prefix: &[u8],
    kind: StatementKind,
    dialect: SqlDialect,
) -> Option<String> {
    match kind {
        StatementKind::CreateTable => {
            extract_name_after_keywords(prefix, &[b"CREATE", b"TABLE"], dialect)
        }
        StatementKind::DropTable => {
            extract_name_after_keywords(prefix, &[b"DROP", b"TABLE"], dialect)
        }
        StatementKind::InsertInto => {
            extract_name_after_keywords(prefix, &[b"INSERT", b"INTO"], dialect)
        }
        StatementKind::CopyData => {
            // COPY table_name FROM stdin
            extract_name_after_keywords(prefix, &[b"COPY"], dialect)
        }
        _ => None,
    }
}

/// Skip keywords in order, then extract the next SQL identifier.
fn extract_name_after_keywords(
    prefix: &[u8],
    keywords: &[&[u8]],
    dialect: SqlDialect,
) -> Option<String> {
    let mut pos = 0;
    let trimmed = skip_whitespace(prefix);

    for kw in keywords {
        pos = skip_whitespace_offset(trimmed, pos);
        let upper: Vec<u8> = trimmed[pos..]
            .iter()
            .take(kw.len())
            .map(|b| b.to_ascii_uppercase())
            .collect();
        if upper.as_slice() != *kw {
            let mut found = false;
            for scan in pos..trimmed.len().saturating_sub(kw.len()) {
                if trimmed[scan].is_ascii_whitespace() {
                    let candidate: Vec<u8> = trimmed[scan..]
                        .iter()
                        .skip_while(|b| b.is_ascii_whitespace())
                        .take(kw.len())
                        .map(|b| b.to_ascii_uppercase())
                        .collect();
                    if candidate.as_slice() == *kw {
                        pos = skip_whitespace_offset(trimmed, scan);
                        break;
                    }
                }
                if scan > pos + 50 {
                    found = false;
                    break;
                }
                found = true;
            }
            if !found && pos >= trimmed.len() {
                return None;
            }
            let re_pos = skip_whitespace_offset(trimmed, pos);
            let re_upper: Vec<u8> = trimmed[re_pos..]
                .iter()
                .take(kw.len())
                .map(|b| b.to_ascii_uppercase())
                .collect();
            if re_upper.as_slice() == *kw {
                pos = re_pos + kw.len();
            } else {
                pos += kw.len();
            }
        } else {
            pos += kw.len();
        }
    }

    // Skip optional IF NOT EXISTS / IF EXISTS
    pos = skip_whitespace_offset(trimmed, pos);
    let rest: Vec<u8> = trimmed[pos..]
        .iter()
        .take(20)
        .map(|b| b.to_ascii_uppercase())
        .collect();
    let rest_str = String::from_utf8_lossy(&rest);
    if rest_str.starts_with("IF NOT EXISTS") {
        pos += 13;
        pos = skip_whitespace_offset(trimmed, pos);
    } else if rest_str.starts_with("IF EXISTS") {
        pos += 9;
        pos = skip_whitespace_offset(trimmed, pos);
    } else if rest_str.starts_with("IGNORE INTO") {
        pos += 11;
        pos = skip_whitespace_offset(trimmed, pos);
    }

    extract_identifier(trimmed, pos, dialect)
}

fn extract_identifier(data: &[u8], pos: usize, dialect: SqlDialect) -> Option<String> {
    if pos >= data.len() {
        return None;
    }

    match data[pos] {
        b'`' => {
            // Backtick-quoted (MySQL)
            let start = pos + 1;
            let end = data[start..].iter().position(|&b| b == b'`')?;
            Some(String::from_utf8_lossy(&data[start..start + end]).into_owned())
        }
        b'"' => {
            // Double-quoted (PostgreSQL/Oracle/SQLite/standard)
            let start = pos + 1;
            let end = data[start..].iter().position(|&b| b == b'"')?;
            Some(String::from_utf8_lossy(&data[start..start + end]).into_owned())
        }
        b'[' => {
            // Square-bracket quoted (SQL Server)
            let start = pos + 1;
            let end = data[start..].iter().position(|&b| b == b']')?;
            let name = String::from_utf8_lossy(&data[start..start + end]).into_owned();

            // Handle schema.table: [dbo].[table_name]
            let after = start + end + 1;
            if after < data.len() && data[after] == b'.' {
                let table_start = after + 1;
                if table_start < data.len() && data[table_start] == b'[' {
                    let inner = table_start + 1;
                    if let Some(inner_end) = data[inner..].iter().position(|&b| b == b']') {
                        return Some(
                            String::from_utf8_lossy(&data[inner..inner + inner_end]).into_owned(),
                        );
                    }
                }
            }
            Some(name)
        }
        _ if dialect == SqlDialect::Mssql || dialect == SqlDialect::Oracle => {
            // Schema-qualified bare names: schema.table
            let start = pos;
            let end = data[start..]
                .iter()
                .position(|&b| {
                    b.is_ascii_whitespace() || b == b'(' || b == b';' || b == b','
                })
                .unwrap_or(data.len() - start);
            if end == 0 {
                return None;
            }
            let full = String::from_utf8_lossy(&data[start..start + end]).into_owned();
            // Return only the table part after the last dot
            if let Some(dot_pos) = full.rfind('.') {
                Some(full[dot_pos + 1..].to_string())
            } else {
                Some(full)
            }
        }
        _ => {
            // Bare identifier
            let start = pos;
            let end = data[start..]
                .iter()
                .position(|&b| {
                    b.is_ascii_whitespace() || b == b'(' || b == b';' || b == b','
                })
                .unwrap_or(data.len() - start);
            if end == 0 {
                return None;
            }
            Some(String::from_utf8_lossy(&data[start..start + end]).into_owned())
        }
    }
}

fn skip_whitespace(data: &[u8]) -> &[u8] {
    let start = data
        .iter()
        .position(|b| !b.is_ascii_whitespace())
        .unwrap_or(data.len());
    &data[start..]
}

fn skip_whitespace_offset(data: &[u8], from: usize) -> usize {
    data[from..]
        .iter()
        .position(|b| !b.is_ascii_whitespace())
        .map(|p| from + p)
        .unwrap_or(data.len())
}

#[cfg(test)]
mod tests {
    use super::*;

    fn index_of(sql: &[u8]) -> StatementIndex {
        build_index(std::io::Cursor::new(sql), SqlDialect::Mysql).unwrap()
    }

    fn index_of_dialect(sql: &[u8], dialect: SqlDialect) -> StatementIndex {
        build_index(std::io::Cursor::new(sql), dialect).unwrap()
    }

    // --- MySQL tests ---

    #[test]
    fn single_insert() {
        let idx = index_of(b"INSERT INTO `users` VALUES (1,'alice');");
        assert_eq!(idx.entries.len(), 1);
        assert_eq!(idx.entries[0].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    #[test]
    fn create_and_insert() {
        let sql = b"CREATE TABLE `t` (id INT);\nINSERT INTO `t` VALUES (1);";
        let idx = index_of(sql);
        assert_eq!(idx.entries.len(), 2);
        assert_eq!(idx.entries[0].kind, StatementKind::CreateTable);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("t"));
        assert_eq!(idx.entries[1].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[1].table_name.as_deref(), Some("t"));
    }

    #[test]
    fn multiple_tables() {
        let sql = b"INSERT INTO `a` VALUES (1);\nINSERT INTO `b` VALUES (2);";
        let idx = index_of(sql);
        assert_eq!(idx.tables_seen.len(), 2);
        assert!(idx.tables_seen.contains("a"));
        assert!(idx.tables_seen.contains("b"));
    }

    #[test]
    fn drop_table_if_exists() {
        let idx = index_of(b"DROP TABLE IF EXISTS `users`;");
        assert_eq!(idx.entries[0].kind, StatementKind::DropTable);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    #[test]
    fn set_and_lock_statements() {
        let sql = b"SET NAMES utf8;\nLOCK TABLES `t` WRITE;\nUNLOCK TABLES;";
        let idx = index_of(sql);
        assert_eq!(idx.entries[0].kind, StatementKind::SetVariable);
        assert_eq!(idx.entries[1].kind, StatementKind::LockTable);
        assert_eq!(idx.entries[2].kind, StatementKind::UnlockTables);
    }

    #[test]
    fn semicolons_inside_strings_not_boundaries() {
        let sql = b"INSERT INTO `t` VALUES ('a;b;c');";
        let idx = index_of(sql);
        assert_eq!(idx.entries.len(), 1);
    }

    #[test]
    fn byte_offsets_correct() {
        let sql = b"SELECT 1;\nSELECT 2;";
        let idx = index_of(sql);
        assert_eq!(idx.entries.len(), 2);
        assert_eq!(idx.entries[0].byte_offset, 0);
        assert_eq!(idx.entries[0].byte_length, 9);
        assert_eq!(idx.entries[1].byte_offset, 9);
        assert_eq!(idx.entries[1].byte_length, 10);
    }

    // --- SQL Server tests ---

    #[test]
    fn mssql_square_bracket_insert() {
        let sql = b"INSERT INTO [dbo].[users] ([id],[name]) VALUES (1,N'alice');";
        let idx = index_of_dialect(sql, SqlDialect::Mssql);
        assert_eq!(idx.entries.len(), 1);
        assert_eq!(idx.entries[0].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    #[test]
    fn mssql_create_table() {
        let sql = b"CREATE TABLE [dbo].[orders] ([id] INT NOT NULL);";
        let idx = index_of_dialect(sql, SqlDialect::Mssql);
        assert_eq!(idx.entries[0].kind, StatementKind::CreateTable);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("orders"));
    }

    // --- PostgreSQL tests ---

    #[test]
    fn pg_double_quoted_insert() {
        let sql = b"INSERT INTO \"users\" VALUES (1,'alice');";
        let idx = index_of_dialect(sql, SqlDialect::Postgresql);
        assert_eq!(idx.entries[0].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    #[test]
    fn pg_copy_from_stdin() {
        let sql = b"COPY users FROM stdin;\n1\talice\n2\tbob\n\\.\n";
        let idx = index_of_dialect(sql, SqlDialect::Postgresql);
        assert_eq!(idx.entries.len(), 1);
        assert_eq!(idx.entries[0].kind, StatementKind::CopyData);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    // --- Oracle tests ---

    #[test]
    fn oracle_insert() {
        let sql = b"INSERT INTO \"USERS\" VALUES (1,'alice');";
        let idx = index_of_dialect(sql, SqlDialect::Oracle);
        assert_eq!(idx.entries[0].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("USERS"));
    }

    // --- SQLite tests ---

    #[test]
    fn sqlite_insert() {
        let sql = b"INSERT INTO users VALUES (1,'alice');";
        let idx = index_of_dialect(sql, SqlDialect::Sqlite);
        assert_eq!(idx.entries[0].kind, StatementKind::InsertInto);
        assert_eq!(idx.entries[0].table_name.as_deref(), Some("users"));
    }

    // --- Auto-detection ---

    #[test]
    fn detect_mysql() {
        let mut data = &b"/*!40101 SET NAMES utf8 */;\nCREATE TABLE `t` (id INT);"[..];
        let (dialect, _) = detect_dialect(&mut data).unwrap();
        assert_eq!(dialect, SqlDialect::Mysql);
    }

    #[test]
    fn detect_mssql() {
        let mut data =
            &b"SET NOCOUNT ON;\nINSERT INTO [dbo].[users] VALUES (1);"[..];
        let (dialect, _) = detect_dialect(&mut data).unwrap();
        assert_eq!(dialect, SqlDialect::Mssql);
    }

    #[test]
    fn detect_postgresql() {
        let mut data = &b"SET client_encoding = 'UTF8';\nCOPY users FROM stdin;"[..];
        let (dialect, _) = detect_dialect(&mut data).unwrap();
        assert_eq!(dialect, SqlDialect::Postgresql);
    }

    #[test]
    fn detect_sqlite() {
        let mut data = &b"BEGIN TRANSACTION;\nCREATE TABLE users (id INTEGER PRIMARY KEY);"[..];
        let (dialect, _) = detect_dialect(&mut data).unwrap();
        assert_eq!(dialect, SqlDialect::Sqlite);
    }
}