polyglot-sql 0.3.6

SQL parsing, validating, formatting, and dialect translation 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
/// Regression tests for Snowflake SQL parsing issues.
///
/// These tests cover SQL patterns generated by the Snowflake Python Connector
/// (snowflake-connector-python) that previously failed to parse.
///
/// Related: https://github.com/tobilg/polyglot/issues/164
use polyglot_sql::dialects::DialectType;
use polyglot_sql::{parse_one, transpile};

fn parse_and_generate(sql: &str) -> String {
    let result = transpile(sql, DialectType::Snowflake, DialectType::Snowflake).unwrap();
    result.join(";\n")
}

// =====================================================================
// Category 1: TIMESTAMP_TZ(N) precision casts
// =====================================================================

#[test]
fn test_snowflake_timestamp_tz_cast_precision() {
    let sql = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMP_TZ(9)"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "TIMESTAMP_TZ(9) cast failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_timestamp_ntz_cast_precision() {
    let sql = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMP_NTZ(9)"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "TIMESTAMP_NTZ(9) cast failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_timestamp_ltz_cast_precision() {
    let sql = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMP_LTZ(9)"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "TIMESTAMP_LTZ(9) cast failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_timestamptz_no_underscore_precision() {
    let sql = r#"SELECT '2024-01-01'::TIMESTAMPTZ(6)"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "TIMESTAMPTZ(6) cast failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_timestamp_tz_in_insert() {
    let sql = r#"INSERT INTO t (id, dt)
        SELECT seq4() + 0, '1987-01-30 23:59:59.123456789'::TIMESTAMP_TZ(9)
        FROM TABLE(GENERATOR(ROWCOUNT => 10000))"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "TIMESTAMP_TZ(9) in INSERT failed: {:?}",
        result.err()
    );
}

// Roundtrip: verify the generated SQL re-parses correctly
#[test]
fn test_snowflake_timestamp_cast_roundtrip() {
    let sql = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMP_TZ(9)"#;
    let gen = parse_and_generate(sql);
    assert_eq!(
        gen,
        "SELECT CAST('1987-01-30 23:59:59.123456789' AS TIMESTAMPTZ(9))"
    );

    let sql2 = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMP_NTZ(9)"#;
    let gen2 = parse_and_generate(sql2);
    assert_eq!(
        gen2,
        "SELECT CAST('1987-01-30 23:59:59.123456789' AS TIMESTAMPNTZ(9))"
    );

    let sql3 = r#"SELECT '1987-01-30 23:59:59.123456789'::TIMESTAMPLTZ(9)"#;
    let gen3 = parse_and_generate(sql3);
    assert_eq!(
        gen3,
        "SELECT CAST('1987-01-30 23:59:59.123456789' AS TIMESTAMPLTZ(9))"
    );
}

// =====================================================================
// Category 2: PUT file upload commands
// =====================================================================

#[test]
fn test_snowflake_put_file_to_stage() {
    let sql = "PUT 'file:///tmp/file0.txt' @my_stage parallel=4 source_compression=auto_detect";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with quoted file URI failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_put_file_with_placeholder() {
    let sql = "PUT file:///tmp/data.csv ?";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with ? placeholder failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_put_quoted_stage() {
    let sql = "PUT 'file:///tmp/data.csv' '@SYSTEM$BIND/1234/0/data_0_0_0.snappy.parquet' OVERWRITE=TRUE AUTO_COMPRESS=FALSE SOURCE_COMPRESSION=NONE";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with quoted stage failed: {:?}",
        result.err()
    );
}

// Minimal PUT with just source and ? target
#[test]
fn test_snowflake_put_minimal_placeholder() {
    let sql = "PUT 'file:///tmp/f.csv' ?";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT minimal with ? failed: {:?}",
        result.err()
    );
}

// PUT roundtrip
#[test]
fn test_snowflake_put_roundtrip() {
    let sql = "PUT 'file:///tmp/data.csv' @my_stage";
    let gen = parse_and_generate(sql);
    // Verify the generated SQL re-parses
    let result = parse_one(&gen, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT roundtrip failed to re-parse: {:?}",
        result.err()
    );
}

// =====================================================================
// Category 3: COPY INTO with bind params
// =====================================================================

#[test]
fn test_snowflake_copy_placeholder_target() {
    let sql = r#"COPY INTO "DB"."SCHEMA"."TABLE" FROM ? FILE_FORMAT = (TYPE = CSV)"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "COPY INTO with ? source failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_copy_into_with_on_error_placeholder() {
    let sql = r#"COPY INTO identifier(?) (name,points)
        FROM (SELECT $1:name::TEXT,$1:points::NUMBER(38, 0)
        FROM '@SNOWPARK_TEMP_STAGE_ABC123')
        FILE_FORMAT=(TYPE=PARQUET USE_VECTORIZED_SCANNER=False
        COMPRESSION=auto BINARY_AS_TEXT=FALSE) PURGE=TRUE ON_ERROR=?"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(result.is_ok(), "COPY ON_ERROR=? failed: {:?}", result.err());
}

#[test]
fn test_snowflake_copy_into_with_use_logical_type() {
    let sql = r#"COPY INTO identifier(?) ("DT")
        FROM (SELECT $1:"DT" FROM '@"STAGE_ABC"')
        FILE_FORMAT=(TYPE=PARQUET USE_VECTORIZED_SCANNER=False
        COMPRESSION=auto USE_LOGICAL_TYPE = TRUE) PURGE=TRUE ON_ERROR=?"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "USE_LOGICAL_TYPE failed: {:?}",
        result.err()
    );
}

// Reversed parameter order: ON_ERROR before PURGE
#[test]
fn test_snowflake_copy_reversed_param_order() {
    let sql = r#"COPY INTO identifier(?) ("A")
        FROM (SELECT $1:"A" FROM '@"STG"')
        FILE_FORMAT=(TYPE=PARQUET COMPRESSION=auto) ON_ERROR=? PURGE=TRUE"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "COPY reversed param order failed: {:?}",
        result.err()
    );
}

// Minimal COPY with ? source
#[test]
fn test_snowflake_copy_minimal_placeholder() {
    let sql = r#"COPY INTO "T" FROM ?"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "COPY minimal with ? source failed: {:?}",
        result.err()
    );
}

// COPY roundtrip
#[test]
fn test_snowflake_copy_roundtrip() {
    let sql = r#"COPY INTO "DB"."SCHEMA"."TABLE" FROM ? FILE_FORMAT = (TYPE = CSV)"#;
    let gen = parse_and_generate(sql);
    let result = parse_one(&gen, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "COPY roundtrip failed to re-parse: {:?}",
        result.err()
    );
}

// =====================================================================
// Category 5: INSERT OVERWRITE ALL
// =====================================================================

#[test]
fn test_snowflake_insert_overwrite_all() {
    let sql = "INSERT OVERWRITE ALL INTO x SELECT 1";
    let gen = parse_and_generate(sql);
    assert_eq!(gen, "INSERT OVERWRITE ALL INTO x SELECT 1");
}

// =====================================================================
// Exact SQL from issue #164 — verifies the issue is resolved
// =====================================================================

#[test]
fn issue_164_cat1_placeholder_bind_params() {
    let sql = r#"COPY INTO identifier(?) /* Python:snowflake.connector.pandas_tools.write_pandas() */ ("name","points") FROM (SELECT $1:"name"::TEXT,$1:"points"::NUMBER(38, 0) FROM '@"SNOWPARK_TEMP_STAGE_A49SXIO2Z6"') FILE_FORMAT=(TYPE=PARQUET USE_VECTORIZED_SCANNER=False COMPRESSION=auto BINARY_AS_TEXT=FALSE) PURGE=TRUE ON_ERROR=?"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(result.is_ok(), "Issue #164 Cat1 failed: {:?}", result.err());
}

#[test]
fn issue_164_cat2_put_placeholder_stage() {
    let sql =
        "PUT 'file:///var/folders/temp/file0.txt' ? parallel=4 source_compression=auto_detect";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(result.is_ok(), "Issue #164 Cat2 failed: {:?}", result.err());
}

#[test]
fn issue_164_cat3_timestamp_precision() {
    let sql = "INSERT INTO test_timestamp_mixed_batches (id, dt) SELECT seq4() + 0, '1987-01-30 23:59:59.123456789'::TIMESTAMP_NTZ(9) FROM TABLE(GENERATOR(ROWCOUNT => 10000))";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(result.is_ok(), "Issue #164 Cat3 failed: {:?}", result.err());
}

#[test]
fn issue_164_cat4_insert_overwrite_all() {
    let sql = "insert overwrite all when c1 > 20 then into test_tgt1 values (c1) when c1 > 10 then into test_tgt1 values (c1) into test_tgt2 values (c1) else into test_tgt2 values (c1) select c1 from test_src_multi";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(result.is_ok(), "Issue #164 Cat4 failed: {:?}", result.err());
}

/// Category 5: `name%` is a non-standard unquoted identifier generated by
/// the Snowflake Python connector's `write_pandas()`. This is arguably a
/// connector-side bug — the identifier should be quoted as `"name%"`.
/// Documenting as a known limitation; not addressed in this PR.
#[test]
fn issue_164_cat5_name_percent_known_limitation() {
    let sql = r#"CREATE TABLE IF NOT EXISTS identifier(?) (name% TEXT, points NUMBER(38, 0)) /* Python:snowflake.connector.pandas_tools.write_pandas() */"#;
    let result = parse_one(sql, DialectType::Snowflake);
    // Expected to fail — unquoted identifiers with % are not valid SQL.
    // The connector should quote these as "name%" instead.
    assert!(
        result.is_err(),
        "name% should fail to parse (known limitation)"
    );
}

// =====================================================================
// Compatibility: verify non-COPY/PUT Snowflake syntax still works
// =====================================================================

#[test]
fn test_snowflake_regular_select_unaffected() {
    let sql = r#"SELECT a, b FROM "DB"."SCHEMA"."TABLE" WHERE a > 1"#;
    let gen = parse_and_generate(sql);
    let result = parse_one(&gen, DialectType::Snowflake);
    assert!(result.is_ok(), "Regular SELECT broken: {:?}", result.err());
}

#[test]
fn test_snowflake_cte_unaffected() {
    let sql = "WITH cte AS (SELECT 1 AS x) SELECT x FROM cte";
    let gen = parse_and_generate(sql);
    let result = parse_one(&gen, DialectType::Snowflake);
    assert!(result.is_ok(), "CTE broken: {:?}", result.err());
}

#[test]
fn test_snowflake_create_table_unaffected() {
    let sql = r#"CREATE TABLE "DB"."S"."T" (id INT, name TEXT)"#;
    let gen = parse_and_generate(sql);
    let result = parse_one(&gen, DialectType::Snowflake);
    assert!(result.is_ok(), "CREATE TABLE broken: {:?}", result.err());
}

// =====================================================================
// Category A: DollarString in PUT (source/target)
// Related: https://github.com/tobilg/polyglot/issues/165
// =====================================================================

#[test]
fn test_snowflake_put_dollar_quoted_stage() {
    // JDBC driver wraps stage references in $$...$$ for special characters
    let sql = r#"put file:///tmp/placeholder $$@%"ice cream (nice)"$$ overwrite=true"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with dollar-quoted stage target failed: {:?}",
        result.err()
    );
}

// =====================================================================
// Category B: DollarString as table source in SELECT FROM
// Related: https://github.com/tobilg/polyglot/issues/165
// =====================================================================

#[test]
fn test_snowflake_select_from_dollar_quoted_stage() {
    // JDBC driver uses $$...$$ for stage paths in FROM clause
    let sql = r#"SELECT $1 FROM $$@%"ice cream (nice)"/$$"#;
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "SELECT FROM dollar-quoted stage path failed: {:?}",
        result.err()
    );
}

// =====================================================================
// Category C: @~ user stage with UUID path segments
// Related: https://github.com/tobilg/polyglot/issues/165
// =====================================================================

#[test]
fn test_snowflake_put_user_stage_uuid_path() {
    let sql =
        "put file:///tmp/placeholder @~/00626646-bb1e-4729-a1ab-d4b96aebbed5/testUploadStream overwrite=true";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with @~/UUID/name path failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_put_user_stage_uuid_path_compress() {
    let sql =
        "put file:///tmp/placeholder @~/00626646-bb1e-4729-a1ab-d4b96aebbed5/testCompressAndUploadStream overwrite=true";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with @~/UUID/compressUpload path failed: {:?}",
        result.err()
    );
}

// =====================================================================
// Category D: Named stage with UUID subpath + AUTO_COMPRESS
// Related: https://github.com/tobilg/polyglot/issues/165
// =====================================================================

#[test]
fn test_snowflake_put_named_stage_uuid_subpath_auto_compress() {
    let sql = "PUT file:///tmp/test_file.csv @teststage/c8b31cea-a6d1-4413-936d-bf8c9d63ab9f AUTO_COMPRESS=FALSE";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with @stage/UUID AUTO_COMPRESS=FALSE failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_put_named_stage_uuid_subpath_auto_compress_true() {
    let sql = "PUT file:///tmp/test_file.csv @teststage/c8b31cea-a6d1-4413-936d-bf8c9d63ab9f AUTO_COMPRESS=TRUE";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with @stage/UUID AUTO_COMPRESS=TRUE failed: {:?}",
        result.err()
    );
}

#[test]
fn test_snowflake_put_long_path_stage_uuid() {
    // Real JDBC test path with long file URI and named stage + UUID
    let sql = "PUT file:///Users/test/projects/test_file.csv @testeb07cda9279e4320a061356c5a1eef53/c8b31cea-a6d1-4413-936d-bf8c9d63ab9f AUTO_COMPRESS=FALSE";
    let result = parse_one(sql, DialectType::Snowflake);
    assert!(
        result.is_ok(),
        "PUT with long path + @stage/UUID failed: {:?}",
        result.err()
    );
}