-
Notifications
You must be signed in to change notification settings - Fork 145
Expand file tree
/
Copy pathanalyzer_utils.py
More file actions
1658 lines (1446 loc) · 45.1 KB
/
analyzer_utils.py
File metadata and controls
1658 lines (1446 loc) · 45.1 KB
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python3
#
# Copyright (c) 2012-2025 Snowflake Computing Inc. All rights reserved.
#
import math
import sys
from typing import Any, Dict, List, Optional, Tuple, Union
from snowflake.snowpark._internal.analyzer.binary_plan_node import (
AsOf,
Except,
Intersect,
JoinType,
LeftAnti,
LeftSemi,
NaturalJoin,
UsingJoin,
)
from snowflake.snowpark._internal.analyzer.datatype_mapper import (
schema_expression,
to_sql,
)
from snowflake.snowpark._internal.analyzer.expression import Attribute
from snowflake.snowpark._internal.type_utils import convert_sp_to_sf_type
from snowflake.snowpark._internal.utils import (
ALREADY_QUOTED,
DOUBLE_QUOTE,
EMPTY_STRING,
TempObjectType,
escape_quotes,
escape_single_quotes,
get_temp_type_for_object,
is_single_quoted,
is_sql_select_statement,
quote_name,
random_name_for_temp_object,
)
from snowflake.snowpark.row import Row
from snowflake.snowpark.types import DataType
# Python 3.8 needs to use typing.Iterable because collections.abc.Iterable is not subscriptable
# Python 3.9 can use both
# Python 3.10 needs to use collections.abc.Iterable because typing.Iterable is removed
if sys.version_info <= (3, 9):
from typing import Iterable
else:
from collections.abc import Iterable
LEFT_PARENTHESIS = "("
RIGHT_PARENTHESIS = ")"
LEFT_BRACKET = "["
RIGHT_BRACKET = "]"
AS = " AS "
AND = " AND "
OR = " OR "
NOT = " NOT "
STAR = " * "
SPACE = " "
SINGLE_QUOTE = "'"
COMMA = ", "
MINUS = " - "
PLUS = " + "
DISTINCT = " DISTINCT "
LIKE = " LIKE "
CAST = " CAST "
TRY_CAST = " TRY_CAST "
IN = " IN "
GROUP_BY = " GROUP BY "
PARTITION_BY = " PARTITION BY "
ORDER_BY = " ORDER BY "
CLUSTER_BY = " CLUSTER BY "
REFRESH_MODE = " REFRESH_MODE "
INITIALIZE = " INITIALIZE "
DATA_RETENTION_TIME_IN_DAYS = " DATA_RETENTION_TIME_IN_DAYS "
MAX_DATA_EXTENSION_TIME_IN_DAYS = " MAX_DATA_EXTENSION_TIME_IN_DAYS "
OVER = " OVER "
SELECT = " SELECT "
FROM = " FROM "
WHERE = " WHERE "
LIMIT = " LIMIT "
OFFSET = " OFFSET "
PIVOT = " PIVOT "
UNPIVOT = " UNPIVOT "
FOR = " FOR "
ON = " ON "
USING = " USING "
JOIN = " JOIN "
NATURAL = " NATURAL "
ASOF = " ASOF "
MATCH_CONDITION = " MATCH_CONDITION "
EXISTS = " EXISTS "
CREATE = " CREATE "
TABLE = " TABLE "
REPLACE = " REPLACE "
VIEW = " VIEW "
DYNAMIC = " DYNAMIC "
LAG = " LAG "
WAREHOUSE = " WAREHOUSE "
TEMPORARY = " TEMPORARY "
TRANSIENT = " TRANSIENT "
IF = " If "
INSERT = " INSERT "
OVERWRITE = " OVERWRITE "
INTO = " INTO "
VALUES = " VALUES "
SEQ8 = " SEQ8() "
ROW_NUMBER = " ROW_NUMBER() "
ONE = " 1 "
GENERATOR = "GENERATOR"
ROW_COUNT = "ROWCOUNT"
RIGHT_ARROW = " => "
NUMBER = " NUMBER "
STRING = " STRING "
UNSAT_FILTER = " 1 = 0 "
BETWEEN = " BETWEEN "
FOLLOWING = " FOLLOWING "
PRECEDING = " PRECEDING "
DOLLAR = "$"
DOUBLE_COLON = "::"
DROP = " DROP "
FILE = " FILE "
FILES = " FILES "
FORMAT = " FORMAT "
TYPE = " TYPE "
EQUALS = " = "
LOCATION = " LOCATION "
FILE_FORMAT = " FILE_FORMAT "
FORMAT_NAME = " FORMAT_NAME "
COPY = " COPY "
COPY_GRANTS = " COPY GRANTS "
ENABLE_SCHEMA_EVOLUTION = " ENABLE_SCHEMA_EVOLUTION "
DATA_RETENTION_TIME_IN_DAYS = " DATA_RETENTION_TIME_IN_DAYS "
MAX_DATA_EXTENSION_TIME_IN_DAYS = " MAX_DATA_EXTENSION_TIME_IN_DAYS "
CHANGE_TRACKING = " CHANGE_TRACKING "
EXTERNAL_VOLUME = " EXTERNAL_VOLUME "
CATALOG = " CATALOG "
BASE_LOCATION = " BASE_LOCATION "
CATALOG_SYNC = " CATALOG_SYNC "
STORAGE_SERIALIZATION_POLICY = " STORAGE_SERIALIZATION_POLICY "
REG_EXP = " REGEXP "
COLLATE = " COLLATE "
RESULT_SCAN = " RESULT_SCAN"
INFER_SCHEMA = " INFER_SCHEMA "
SAMPLE = " SAMPLE "
ROWS = " ROWS "
CASE = " CASE "
WHEN = " WHEN "
THEN = " THEN "
ELSE = " ELSE "
END = " END "
FLATTEN = " FLATTEN "
INPUT = " INPUT "
PATH = " PATH "
OUTER = " OUTER "
RECURSIVE = " RECURSIVE "
MODE = " MODE "
LATERAL = " LATERAL "
PUT = " PUT "
GET = " GET "
GROUPING_SETS = " GROUPING SETS "
QUESTION_MARK = "?"
PERCENT_S = r"%s"
SINGLE_COLON = ":"
PATTERN = " PATTERN "
WITHIN_GROUP = " WITHIN GROUP "
VALIDATION_MODE = " VALIDATION_MODE "
UPDATE = " UPDATE "
DELETE = " DELETE "
SET = " SET "
MERGE = " MERGE "
MATCHED = " MATCHED "
LISTAGG = " LISTAGG "
HEADER = " HEADER "
COMMENT = " COMMENT "
IGNORE_NULLS = " IGNORE NULLS "
INCLUDE_NULLS = " INCLUDE NULLS "
UNION = " UNION "
UNION_ALL = " UNION ALL "
RENAME = " RENAME "
INTERSECT = f" {Intersect.sql} "
EXCEPT = f" {Except.sql} "
NOT_NULL = " NOT NULL "
WITH = "WITH "
DEFAULT_ON_NULL = " DEFAULT ON NULL "
ANY = " ANY "
ICEBERG = " ICEBERG "
RENAME_FIELDS = " RENAME FIELDS"
ADD_FIELDS = " ADD FIELDS"
TEMPORARY_STRING_SET = frozenset(["temporary", "temp"])
def validate_iceberg_config(iceberg_config: Optional[dict]) -> Dict[str, str]:
if iceberg_config is None:
return dict()
iceberg_config = {k.lower(): v for k, v in iceberg_config.items()}
if "base_location" not in iceberg_config:
raise ValueError("Iceberg table configuration requires base_location be set.")
return {
EXTERNAL_VOLUME: iceberg_config.get("external_volume", None),
CATALOG: iceberg_config.get("catalog", None),
BASE_LOCATION: iceberg_config.get("base_location", None),
CATALOG_SYNC: iceberg_config.get("catalog_sync", None),
STORAGE_SERIALIZATION_POLICY: iceberg_config.get(
"storage_serialization_policy", None
),
}
def result_scan_statement(uuid_place_holder: str) -> str:
return (
SELECT
+ STAR
+ FROM
+ TABLE
+ LEFT_PARENTHESIS
+ RESULT_SCAN
+ LEFT_PARENTHESIS
+ SINGLE_QUOTE
+ uuid_place_holder
+ SINGLE_QUOTE
+ RIGHT_PARENTHESIS
+ RIGHT_PARENTHESIS
)
def function_expression(name: str, children: List[str], is_distinct: bool) -> str:
return (
name
+ LEFT_PARENTHESIS
+ f"{DISTINCT if is_distinct else EMPTY_STRING}"
+ COMMA.join(children)
+ RIGHT_PARENTHESIS
)
def named_arguments_function(name: str, args: Dict[str, str]) -> str:
return (
name
+ LEFT_PARENTHESIS
+ COMMA.join([key + RIGHT_ARROW + value for key, value in args.items()])
+ RIGHT_PARENTHESIS
)
def partition_spec(col_exprs: List[str]) -> str:
return f"PARTITION BY {COMMA.join(col_exprs)}" if col_exprs else EMPTY_STRING
def order_by_spec(col_exprs: List[str]) -> str:
return f" ORDER BY {COMMA.join(col_exprs)}" if col_exprs else EMPTY_STRING
def table_function_partition_spec(
over: bool, partition_exprs: List[str], order_exprs: List[str]
) -> str:
return (
f"{OVER}{LEFT_PARENTHESIS}{partition_spec(partition_exprs)}{SPACE}{order_by_spec(order_exprs)}{RIGHT_PARENTHESIS}"
if over
else EMPTY_STRING
)
def subquery_expression(child: str) -> str:
return LEFT_PARENTHESIS + child + RIGHT_PARENTHESIS
def binary_arithmetic_expression(op: str, left: str, right: str) -> str:
return LEFT_PARENTHESIS + left + SPACE + op + SPACE + right + RIGHT_PARENTHESIS
def alias_expression(origin: str, alias: str) -> str:
return origin + AS + alias
def within_group_expression(column: str, order_by_cols: List[str]) -> str:
return (
column
+ WITHIN_GROUP
+ LEFT_PARENTHESIS
+ ORDER_BY
+ COMMA.join(order_by_cols)
+ RIGHT_PARENTHESIS
)
def limit_expression(num: int) -> str:
return LIMIT + str(num)
def grouping_set_expression(args: List[List[str]]) -> str:
flat_args = [LEFT_PARENTHESIS + COMMA.join(arg) + RIGHT_PARENTHESIS for arg in args]
return GROUPING_SETS + LEFT_PARENTHESIS + COMMA.join(flat_args) + RIGHT_PARENTHESIS
def like_expression(expr: str, pattern: str) -> str:
return expr + LIKE + pattern
def block_expression(expressions: List[str]) -> str:
return LEFT_PARENTHESIS + COMMA.join(expressions) + RIGHT_PARENTHESIS
def in_expression(column: str, values: List[str]) -> str:
return column + IN + block_expression(values)
def regexp_expression(expr: str, pattern: str, parameters: Optional[str] = None) -> str:
if parameters is not None:
return function_expression("RLIKE", [expr, pattern, parameters], False)
else:
return expr + REG_EXP + pattern
def collate_expression(expr: str, collation_spec: str) -> str:
return expr + COLLATE + single_quote(collation_spec)
def subfield_expression(expr: str, field: Union[str, int]) -> str:
return (
expr
+ LEFT_BRACKET
+ (
SINGLE_QUOTE + field + SINGLE_QUOTE
if isinstance(field, str)
else str(field)
)
+ RIGHT_BRACKET
)
def flatten_expression(
input_: str, path: Optional[str], outer: bool, recursive: bool, mode: str
) -> str:
return (
FLATTEN
+ LEFT_PARENTHESIS
+ INPUT
+ RIGHT_ARROW
+ input_
+ COMMA
+ PATH
+ RIGHT_ARROW
+ SINGLE_QUOTE
+ (path or EMPTY_STRING)
+ SINGLE_QUOTE
+ COMMA
+ OUTER
+ RIGHT_ARROW
+ str(outer).upper()
+ COMMA
+ RECURSIVE
+ RIGHT_ARROW
+ str(recursive).upper()
+ COMMA
+ MODE
+ RIGHT_ARROW
+ SINGLE_QUOTE
+ mode
+ SINGLE_QUOTE
+ RIGHT_PARENTHESIS
)
def lateral_statement(lateral_expression: str, child: str) -> str:
return (
SELECT
+ STAR
+ FROM
+ LEFT_PARENTHESIS
+ child
+ RIGHT_PARENTHESIS
+ COMMA
+ LATERAL
+ lateral_expression
)
def join_table_function_statement(
func: str,
child: str,
left_cols: List[str],
right_cols: List[str],
use_constant_subquery_alias: bool,
) -> str:
LEFT_ALIAS = (
"T_LEFT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
RIGHT_ALIAS = (
"T_RIGHT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
left_cols = [f"{LEFT_ALIAS}.{col}" for col in left_cols]
right_cols = [f"{RIGHT_ALIAS}.{col}" for col in right_cols]
select_cols = COMMA.join(left_cols + right_cols)
return (
SELECT
+ select_cols
+ FROM
+ LEFT_PARENTHESIS
+ child
+ RIGHT_PARENTHESIS
+ AS
+ LEFT_ALIAS
+ JOIN
+ table(func)
+ AS
+ RIGHT_ALIAS
)
def table_function_statement(func: str, operators: Optional[List[str]] = None) -> str:
if operators is None:
return project_statement([], table(func))
return project_statement(operators, table(func))
def case_when_expression(branches: List[Tuple[str, str]], else_value: str) -> str:
return (
CASE
+ EMPTY_STRING.join(
[WHEN + condition + THEN + value for condition, value in branches]
)
+ ELSE
+ else_value
+ END
)
def project_statement(project: List[str], child: str, is_distinct: bool = False) -> str:
return (
SELECT
+ f"{DISTINCT if is_distinct else EMPTY_STRING}"
+ f"{STAR if not project else COMMA.join(project)}"
+ FROM
+ LEFT_PARENTHESIS
+ child
+ RIGHT_PARENTHESIS
)
def filter_statement(condition: str, child: str) -> str:
return project_statement([], child) + WHERE + condition
def sample_statement(
child: str,
probability_fraction: Optional[float] = None,
row_count: Optional[int] = None,
):
"""Generates the sql text for the sample part of the plan being executed"""
if probability_fraction is not None:
return (
project_statement([], child)
+ SAMPLE
+ LEFT_PARENTHESIS
+ str(probability_fraction * 100)
+ RIGHT_PARENTHESIS
)
elif row_count is not None:
return (
project_statement([], child)
+ SAMPLE
+ LEFT_PARENTHESIS
+ str(row_count)
+ ROWS
+ RIGHT_PARENTHESIS
)
# this shouldn't happen because upstream code will validate either probability_fraction or row_count will have a value.
else: # pragma: no cover
raise ValueError(
"Either 'probability_fraction' or 'row_count' must not be None."
)
def aggregate_statement(
grouping_exprs: List[str], aggregate_exprs: List[str], child: str
) -> str:
# add limit 1 because aggregate may be on non-aggregate function in a scalar aggregation
# for example, df.agg(lit(1))
return project_statement(aggregate_exprs, child) + (
limit_expression(1)
if not grouping_exprs
else (GROUP_BY + COMMA.join(grouping_exprs))
)
def sort_statement(order: List[str], child: str) -> str:
return project_statement([], child) + ORDER_BY + COMMA.join(order)
def range_statement(start: int, end: int, step: int, column_name: str) -> str:
range = end - start
if (range > 0 > step) or (range < 0 < step):
count = 0
else:
count = math.ceil(range / step)
return project_statement(
[
LEFT_PARENTHESIS
+ ROW_NUMBER
+ OVER
+ LEFT_PARENTHESIS
+ ORDER_BY
+ SEQ8
+ RIGHT_PARENTHESIS
+ MINUS
+ ONE
+ RIGHT_PARENTHESIS
+ STAR
+ LEFT_PARENTHESIS
+ str(step)
+ RIGHT_PARENTHESIS
+ PLUS
+ LEFT_PARENTHESIS
+ str(start)
+ RIGHT_PARENTHESIS
+ AS
+ column_name
],
table(generator(0 if count < 0 else count)),
)
def schema_query_for_values_statement(output: List[Attribute]) -> str:
cells = [schema_expression(attr.datatype, attr.nullable) for attr in output]
query = (
SELECT
+ COMMA.join([f"{DOLLAR}{i+1}{AS}{attr.name}" for i, attr in enumerate(output)])
+ FROM
+ VALUES
+ LEFT_PARENTHESIS
+ COMMA.join(cells)
+ RIGHT_PARENTHESIS
)
return query
def values_statement(output: List[Attribute], data: List[Row]) -> str:
data_types = [attr.datatype for attr in output]
names = [quote_name(attr.name) for attr in output]
rows = []
for row in data:
cells = [
to_sql(value, data_type, from_values_statement=True)
for value, data_type in zip(row, data_types)
]
rows.append(LEFT_PARENTHESIS + COMMA.join(cells) + RIGHT_PARENTHESIS)
query = (
SELECT
+ COMMA.join([f"{DOLLAR}{i+1}{AS}{c}" for i, c in enumerate(names)])
+ FROM
+ VALUES
+ COMMA.join(rows)
)
return query
def empty_values_statement(output: List[Attribute]) -> str:
data = [Row(*[None] * len(output))]
return filter_statement(UNSAT_FILTER, values_statement(output, data))
def set_operator_statement(left: str, right: str, operator: str) -> str:
return (
LEFT_PARENTHESIS
+ left
+ RIGHT_PARENTHESIS
+ SPACE
+ operator
+ SPACE
+ LEFT_PARENTHESIS
+ right
+ RIGHT_PARENTHESIS
)
def left_semi_or_anti_join_statement(
left: str,
right: str,
join_type: JoinType,
condition: str,
use_constant_subquery_alias: bool,
) -> str:
left_alias = (
"SNOWPARK_LEFT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
right_alias = (
"SNOWPARK_RIGHT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
if isinstance(join_type, LeftSemi):
where_condition = WHERE + EXISTS
else:
where_condition = WHERE + NOT + EXISTS
# this generates sql like "Where a = b"
join_condition = WHERE + condition
return (
SELECT
+ STAR
+ FROM
+ LEFT_PARENTHESIS
+ left
+ RIGHT_PARENTHESIS
+ AS
+ left_alias
+ where_condition
+ LEFT_PARENTHESIS
+ SELECT
+ STAR
+ FROM
+ LEFT_PARENTHESIS
+ right
+ RIGHT_PARENTHESIS
+ AS
+ right_alias
+ f"{join_condition if join_condition else EMPTY_STRING}"
+ RIGHT_PARENTHESIS
)
def asof_join_statement(
left: str,
right: str,
join_condition: str,
match_condition: str,
use_constant_subquery_alias: bool,
):
left_alias = (
"SNOWPARK_LEFT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
right_alias = (
"SNOWPARK_RIGHT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
on_sql = ON + join_condition if join_condition else EMPTY_STRING
return (
SELECT
+ STAR
+ FROM
+ LEFT_PARENTHESIS
+ left
+ RIGHT_PARENTHESIS
+ AS
+ left_alias
+ ASOF
+ JOIN
+ LEFT_PARENTHESIS
+ right
+ RIGHT_PARENTHESIS
+ AS
+ right_alias
+ MATCH_CONDITION
+ LEFT_PARENTHESIS
+ match_condition
+ RIGHT_PARENTHESIS
+ on_sql
)
def snowflake_supported_join_statement(
left: str,
right: str,
join_type: JoinType,
condition: str,
match_condition: str,
use_constant_subquery_alias: bool,
) -> str:
left_alias = (
"SNOWPARK_LEFT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
right_alias = (
"SNOWPARK_RIGHT"
if use_constant_subquery_alias
else random_name_for_temp_object(TempObjectType.TABLE)
)
if isinstance(join_type, UsingJoin):
join_sql = join_type.tpe.sql
elif isinstance(join_type, NaturalJoin):
join_sql = NATURAL + join_type.tpe.sql
else:
join_sql = join_type.sql
# This generates sql like "USING(a, b)"
using_condition = None
if isinstance(join_type, UsingJoin):
if len(join_type.using_columns) != 0:
using_condition = (
USING
+ LEFT_PARENTHESIS
+ COMMA.join(join_type.using_columns)
+ RIGHT_PARENTHESIS
)
# This generates sql like "ON a = b"
join_condition = None
if condition:
join_condition = ON + condition
if using_condition and join_condition:
raise ValueError("A join should either have using clause or a join condition")
match_condition = (
(MATCH_CONDITION + match_condition) if match_condition else EMPTY_STRING
)
source = (
LEFT_PARENTHESIS
+ left
+ RIGHT_PARENTHESIS
+ AS
+ left_alias
+ SPACE
+ join_sql
+ JOIN
+ LEFT_PARENTHESIS
+ right
+ RIGHT_PARENTHESIS
+ AS
+ right_alias
+ f"{match_condition if match_condition else EMPTY_STRING}"
+ f"{using_condition if using_condition else EMPTY_STRING}"
+ f"{join_condition if join_condition else EMPTY_STRING}"
)
return project_statement([], source)
def join_statement(
left: str,
right: str,
join_type: JoinType,
join_condition: str,
match_condition: str,
use_constant_subquery_alias: bool,
) -> str:
if isinstance(join_type, (LeftSemi, LeftAnti)):
return left_semi_or_anti_join_statement(
left, right, join_type, join_condition, use_constant_subquery_alias
)
if isinstance(join_type, AsOf):
return asof_join_statement(
left, right, join_condition, match_condition, use_constant_subquery_alias
)
if isinstance(join_type, UsingJoin) and isinstance(
join_type.tpe, (LeftSemi, LeftAnti)
):
raise ValueError(f"Unexpected using clause in {join_type.tpe} join")
return snowflake_supported_join_statement(
left,
right,
join_type,
join_condition,
match_condition,
use_constant_subquery_alias,
)
def get_comment_sql(comment: Optional[str]) -> str:
return (
COMMENT + EQUALS + SINGLE_QUOTE + escape_single_quotes(comment) + SINGLE_QUOTE
if comment
else EMPTY_STRING
)
def create_table_statement(
table_name: str,
schema: str,
replace: bool = False,
error: bool = True,
table_type: str = EMPTY_STRING,
clustering_key: Optional[Iterable[str]] = None,
comment: Optional[str] = None,
enable_schema_evolution: Optional[bool] = None,
data_retention_time: Optional[int] = None,
max_data_extension_time: Optional[int] = None,
change_tracking: Optional[bool] = None,
copy_grants: bool = False,
*,
use_scoped_temp_objects: bool = False,
is_generated: bool = False,
iceberg_config: Optional[dict] = None,
) -> str:
cluster_by_clause = (
(CLUSTER_BY + LEFT_PARENTHESIS + COMMA.join(clustering_key) + RIGHT_PARENTHESIS)
if clustering_key
else EMPTY_STRING
)
comment_sql = get_comment_sql(comment)
options = {
ENABLE_SCHEMA_EVOLUTION: enable_schema_evolution,
DATA_RETENTION_TIME_IN_DAYS: data_retention_time,
MAX_DATA_EXTENSION_TIME_IN_DAYS: max_data_extension_time,
CHANGE_TRACKING: change_tracking,
}
iceberg_config = validate_iceberg_config(iceberg_config)
options.update(iceberg_config)
options_statement = get_options_statement(options)
return (
f"{CREATE}{(OR + REPLACE) if replace else EMPTY_STRING}"
f" {(get_temp_type_for_object(use_scoped_temp_objects, is_generated) if table_type.lower() in TEMPORARY_STRING_SET else table_type).upper()} "
f"{ICEBERG if iceberg_config else EMPTY_STRING}{TABLE}{table_name}{(IF + NOT + EXISTS) if not replace and not error else EMPTY_STRING}"
f"{LEFT_PARENTHESIS}{schema}{RIGHT_PARENTHESIS}{cluster_by_clause}"
f"{options_statement}{COPY_GRANTS if copy_grants else EMPTY_STRING}{comment_sql}"
)
def insert_into_statement(
table_name: str,
child: str,
column_names: Optional[Iterable[str]] = None,
overwrite: bool = False,
) -> str:
table_columns = f"({COMMA.join(column_names)})" if column_names else EMPTY_STRING
if is_sql_select_statement(child):
return f"{INSERT}{OVERWRITE if overwrite else EMPTY_STRING}{INTO}{table_name}{table_columns}{SPACE}{child}"
return f"{INSERT}{INTO}{table_name}{table_columns}{project_statement([], child)}"
def batch_insert_into_statement(
table_name: str, column_names: List[str], paramstyle: Optional[str]
) -> str:
num_cols = len(column_names)
# paramstyle is initialized as None is stored proc environment
paramstyle = paramstyle.lower() if paramstyle else "qmark"
supported_paramstyle = ["qmark", "numeric", "format", "pyformat"]
if paramstyle == "qmark":
placeholder_marks = [QUESTION_MARK] * num_cols
elif paramstyle == "numeric":
placeholder_marks = [f"{SINGLE_COLON}{i+1}" for i in range(num_cols)]
elif paramstyle in ("format", "pyformat"):
placeholder_marks = [PERCENT_S] * num_cols
else:
raise ValueError(
f"'{paramstyle}' is not a recognized paramstyle. "
f"Supported values are: {', '.join(supported_paramstyle)}"
)
return (
f"{INSERT}{INTO}{table_name}"
f"{LEFT_PARENTHESIS}{COMMA.join(column_names)}{RIGHT_PARENTHESIS}"
f"{VALUES}{LEFT_PARENTHESIS}"
f"{COMMA.join(placeholder_marks)}{RIGHT_PARENTHESIS}"
)
def create_table_as_select_statement(
table_name: str,
child: str,
column_definition: Optional[str],
replace: bool = False,
error: bool = True,
table_type: str = EMPTY_STRING,
clustering_key: Optional[Iterable[str]] = None,
comment: Optional[str] = None,
enable_schema_evolution: Optional[bool] = None,
data_retention_time: Optional[int] = None,
max_data_extension_time: Optional[int] = None,
change_tracking: Optional[bool] = None,
copy_grants: bool = False,
iceberg_config: Optional[dict] = None,
*,
use_scoped_temp_objects: bool = False,
is_generated: bool = False,
) -> str:
column_definition_sql = (
f"{LEFT_PARENTHESIS}{column_definition}{RIGHT_PARENTHESIS}"
if column_definition
else EMPTY_STRING
)
cluster_by_clause = (
(CLUSTER_BY + LEFT_PARENTHESIS + COMMA.join(clustering_key) + RIGHT_PARENTHESIS)
if clustering_key
else EMPTY_STRING
)
comment_sql = get_comment_sql(comment)
options = {
ENABLE_SCHEMA_EVOLUTION: enable_schema_evolution,
DATA_RETENTION_TIME_IN_DAYS: data_retention_time,
MAX_DATA_EXTENSION_TIME_IN_DAYS: max_data_extension_time,
CHANGE_TRACKING: change_tracking,
}
iceberg_config = validate_iceberg_config(iceberg_config)
options.update(iceberg_config)
options_statement = get_options_statement(options)
return (
f"{CREATE}{OR + REPLACE if replace else EMPTY_STRING}"
f" {(get_temp_type_for_object(use_scoped_temp_objects, is_generated) if table_type.lower() in TEMPORARY_STRING_SET else table_type).upper()} "
f"{ICEBERG if iceberg_config else EMPTY_STRING}{TABLE}"
f"{IF + NOT + EXISTS if not replace and not error else EMPTY_STRING} "
f"{table_name}{column_definition_sql}{cluster_by_clause}{options_statement}"
f"{COPY_GRANTS if copy_grants else EMPTY_STRING}{comment_sql} {AS}{project_statement([], child)}"
)
def limit_statement(
row_count: str, offset: str, child: str, on_top_of_order_by: bool
) -> str:
return (
f"{child if on_top_of_order_by else project_statement([], child)}"
+ LIMIT
+ row_count
+ OFFSET
+ offset
)
def schema_cast_seq(schema: List[Attribute]) -> List[str]:
res = []
for index, attr in enumerate(schema):
name = (
DOLLAR
+ str(index + 1)
+ DOUBLE_COLON
+ convert_sp_to_sf_type(attr.datatype)
)
res.append(name + AS + quote_name(attr.name))
return res
def schema_cast_named(schema: List[Tuple[str, str]]) -> List[str]:
return [s[0] + AS + quote_name_without_upper_casing(s[1]) for s in schema]
def create_file_format_statement(
format_name: str,
file_type: str,
options: Dict,
temp: bool,
if_not_exist: bool,
*,
use_scoped_temp_objects: bool = False,
is_generated: bool = False,
) -> str:
type_str = TYPE + EQUALS + file_type + SPACE
options_str = (
type_str if "TYPE" not in options else EMPTY_STRING
) + get_options_statement(options)
return (
CREATE
+ (
get_temp_type_for_object(use_scoped_temp_objects, is_generated)
if temp
else EMPTY_STRING
)
+ FILE
+ FORMAT
+ (IF + NOT + EXISTS if if_not_exist else EMPTY_STRING)
+ format_name
+ options_str
)
def infer_schema_statement(
path: str, file_format_name: str, options: Optional[Dict[str, str]] = None
) -> str:
return (
SELECT
+ STAR
+ FROM
+ TABLE
+ LEFT_PARENTHESIS
+ INFER_SCHEMA
+ LEFT_PARENTHESIS
+ LOCATION
+ RIGHT_ARROW
+ (path if is_single_quoted(path) else SINGLE_QUOTE + path + SINGLE_QUOTE)
+ COMMA
+ FILE_FORMAT
+ RIGHT_ARROW