sqlglot.generator
1from __future__ import annotations 2 3import logging 4import typing as t 5from collections import defaultdict 6from functools import reduce 7 8from sqlglot import exp 9from sqlglot.errors import ErrorLevel, UnsupportedError, concat_messages 10from sqlglot.helper import apply_index_offset, csv, seq_get 11from sqlglot.time import format_time 12from sqlglot.tokens import Tokenizer, TokenType 13 14if t.TYPE_CHECKING: 15 from sqlglot._typing import E 16 17logger = logging.getLogger("sqlglot") 18 19 20class Generator: 21 """ 22 Generator converts a given syntax tree to the corresponding SQL string. 23 24 Args: 25 pretty: Whether or not to format the produced SQL string. 26 Default: False. 27 identify: Determines when an identifier should be quoted. Possible values are: 28 False (default): Never quote, except in cases where it's mandatory by the dialect. 29 True or 'always': Always quote. 30 'safe': Only quote identifiers that are case insensitive. 31 normalize: Whether or not to normalize identifiers to lowercase. 32 Default: False. 33 pad: Determines the pad size in a formatted string. 34 Default: 2. 35 indent: Determines the indentation size in a formatted string. 36 Default: 2. 37 normalize_functions: Whether or not to normalize all function names. Possible values are: 38 "upper" or True (default): Convert names to uppercase. 39 "lower": Convert names to lowercase. 40 False: Disables function name normalization. 41 unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. 42 Default ErrorLevel.WARN. 43 max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. 44 This is only relevant if unsupported_level is ErrorLevel.RAISE. 45 Default: 3 46 leading_comma: Determines whether or not the comma is leading or trailing in select expressions. 47 This is only relevant when generating in pretty mode. 48 Default: False 49 max_text_width: The max number of characters in a segment before creating new lines in pretty mode. 50 The default is on the smaller end because the length only represents a segment and not the true 51 line length. 52 Default: 80 53 comments: Whether or not to preserve comments in the output SQL code. 54 Default: True 55 """ 56 57 TRANSFORMS = { 58 exp.DateAdd: lambda self, e: self.func( 59 "DATE_ADD", e.this, e.expression, exp.Literal.string(e.text("unit")) 60 ), 61 exp.TsOrDsAdd: lambda self, e: self.func( 62 "TS_OR_DS_ADD", e.this, e.expression, exp.Literal.string(e.text("unit")) 63 ), 64 exp.CaseSpecificColumnConstraint: lambda self, e: f"{'NOT ' if e.args.get('not_') else ''}CASESPECIFIC", 65 exp.CharacterSetColumnConstraint: lambda self, e: f"CHARACTER SET {self.sql(e, 'this')}", 66 exp.CharacterSetProperty: lambda self, e: f"{'DEFAULT ' if e.args.get('default') else ''}CHARACTER SET={self.sql(e, 'this')}", 67 exp.CheckColumnConstraint: lambda self, e: f"CHECK ({self.sql(e, 'this')})", 68 exp.ClusteredColumnConstraint: lambda self, e: f"CLUSTERED ({self.expressions(e, 'this', indent=False)})", 69 exp.CollateColumnConstraint: lambda self, e: f"COLLATE {self.sql(e, 'this')}", 70 exp.CopyGrantsProperty: lambda self, e: "COPY GRANTS", 71 exp.CommentColumnConstraint: lambda self, e: f"COMMENT {self.sql(e, 'this')}", 72 exp.DateFormatColumnConstraint: lambda self, e: f"FORMAT {self.sql(e, 'this')}", 73 exp.DefaultColumnConstraint: lambda self, e: f"DEFAULT {self.sql(e, 'this')}", 74 exp.EncodeColumnConstraint: lambda self, e: f"ENCODE {self.sql(e, 'this')}", 75 exp.ExecuteAsProperty: lambda self, e: self.naked_property(e), 76 exp.ExternalProperty: lambda self, e: "EXTERNAL", 77 exp.HeapProperty: lambda self, e: "HEAP", 78 exp.InlineLengthColumnConstraint: lambda self, e: f"INLINE LENGTH {self.sql(e, 'this')}", 79 exp.InputModelProperty: lambda self, e: f"INPUT{self.sql(e, 'this')}", 80 exp.IntervalSpan: lambda self, e: f"{self.sql(e, 'this')} TO {self.sql(e, 'expression')}", 81 exp.LanguageProperty: lambda self, e: self.naked_property(e), 82 exp.LocationProperty: lambda self, e: self.naked_property(e), 83 exp.LogProperty: lambda self, e: f"{'NO ' if e.args.get('no') else ''}LOG", 84 exp.MaterializedProperty: lambda self, e: "MATERIALIZED", 85 exp.NoPrimaryIndexProperty: lambda self, e: "NO PRIMARY INDEX", 86 exp.NonClusteredColumnConstraint: lambda self, e: f"NONCLUSTERED ({self.expressions(e, 'this', indent=False)})", 87 exp.NotForReplicationColumnConstraint: lambda self, e: "NOT FOR REPLICATION", 88 exp.OnCommitProperty: lambda self, e: f"ON COMMIT {'DELETE' if e.args.get('delete') else 'PRESERVE'} ROWS", 89 exp.OnProperty: lambda self, e: f"ON {self.sql(e, 'this')}", 90 exp.OnUpdateColumnConstraint: lambda self, e: f"ON UPDATE {self.sql(e, 'this')}", 91 exp.OutputModelProperty: lambda self, e: f"OUTPUT{self.sql(e, 'this')}", 92 exp.PathColumnConstraint: lambda self, e: f"PATH {self.sql(e, 'this')}", 93 exp.RemoteWithConnectionModelProperty: lambda self, e: f"REMOTE WITH CONNECTION {self.sql(e, 'this')}", 94 exp.ReturnsProperty: lambda self, e: self.naked_property(e), 95 exp.SampleProperty: lambda self, e: f"SAMPLE BY {self.sql(e, 'this')}", 96 exp.SetProperty: lambda self, e: f"{'MULTI' if e.args.get('multi') else ''}SET", 97 exp.SettingsProperty: lambda self, e: f"SETTINGS{self.seg('')}{(self.expressions(e))}", 98 exp.SqlSecurityProperty: lambda self, e: f"SQL SECURITY {'DEFINER' if e.args.get('definer') else 'INVOKER'}", 99 exp.StabilityProperty: lambda self, e: e.name, 100 exp.TemporaryProperty: lambda self, e: f"TEMPORARY", 101 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 102 exp.TransientProperty: lambda self, e: "TRANSIENT", 103 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 104 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 105 exp.UppercaseColumnConstraint: lambda self, e: f"UPPERCASE", 106 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 107 exp.VolatileProperty: lambda self, e: "VOLATILE", 108 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 109 } 110 111 # Whether the base comes first 112 LOG_BASE_FIRST = True 113 114 # Whether or not null ordering is supported in order by 115 NULL_ORDERING_SUPPORTED = True 116 117 # Whether or not locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 118 LOCKING_READS_SUPPORTED = False 119 120 # Always do union distinct or union all 121 EXPLICIT_UNION = False 122 123 # Wrap derived values in parens, usually standard but spark doesn't support it 124 WRAP_DERIVED_VALUES = True 125 126 # Whether or not create function uses an AS before the RETURN 127 CREATE_FUNCTION_RETURN_AS = True 128 129 # Whether or not MERGE ... WHEN MATCHED BY SOURCE is allowed 130 MATCHED_BY_SOURCE = True 131 132 # Whether or not the INTERVAL expression works only with values like '1 day' 133 SINGLE_STRING_INTERVAL = False 134 135 # Whether or not the plural form of date parts like day (i.e. "days") is supported in INTERVALs 136 INTERVAL_ALLOWS_PLURAL_FORM = True 137 138 # Whether or not the TABLESAMPLE clause supports a method name, like BERNOULLI 139 TABLESAMPLE_WITH_METHOD = True 140 141 # Whether or not to treat the number in TABLESAMPLE (50) as a percentage 142 TABLESAMPLE_SIZE_IS_PERCENT = False 143 144 # Whether or not limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 145 LIMIT_FETCH = "ALL" 146 147 # Whether or not limit and fetch allows expresions or just limits 148 LIMIT_ONLY_LITERALS = False 149 150 # Whether or not a table is allowed to be renamed with a db 151 RENAME_TABLE_WITH_DB = True 152 153 # The separator for grouping sets and rollups 154 GROUPINGS_SEP = "," 155 156 # The string used for creating an index on a table 157 INDEX_ON = "ON" 158 159 # Whether or not join hints should be generated 160 JOIN_HINTS = True 161 162 # Whether or not table hints should be generated 163 TABLE_HINTS = True 164 165 # Whether or not query hints should be generated 166 QUERY_HINTS = True 167 168 # What kind of separator to use for query hints 169 QUERY_HINT_SEP = ", " 170 171 # Whether or not comparing against booleans (e.g. x IS TRUE) is supported 172 IS_BOOL_ALLOWED = True 173 174 # Whether or not to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 175 DUPLICATE_KEY_UPDATE_WITH_SET = True 176 177 # Whether or not to generate the limit as TOP <value> instead of LIMIT <value> 178 LIMIT_IS_TOP = False 179 180 # Whether or not to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 181 RETURNING_END = True 182 183 # Whether or not to generate the (+) suffix for columns used in old-style join conditions 184 COLUMN_JOIN_MARKS_SUPPORTED = False 185 186 # Whether or not to generate an unquoted value for EXTRACT's date part argument 187 EXTRACT_ALLOWS_QUOTES = True 188 189 # Whether or not TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 190 TZ_TO_WITH_TIME_ZONE = False 191 192 # Whether or not the NVL2 function is supported 193 NVL2_SUPPORTED = True 194 195 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 196 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 197 198 # Whether or not VALUES statements can be used as derived tables. 199 # MySQL 5 and Redshift do not allow this, so when False, it will convert 200 # SELECT * VALUES into SELECT UNION 201 VALUES_AS_TABLE = True 202 203 # Whether or not the word COLUMN is included when adding a column with ALTER TABLE 204 ALTER_TABLE_ADD_COLUMN_KEYWORD = True 205 206 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 207 UNNEST_WITH_ORDINALITY = True 208 209 # Whether or not FILTER (WHERE cond) can be used for conditional aggregation 210 AGGREGATE_FILTER_SUPPORTED = True 211 212 # Whether or not JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 213 SEMI_ANTI_JOIN_WITH_SIDE = True 214 215 # Whether or not session variables / parameters are supported, e.g. @x in T-SQL 216 SUPPORTS_PARAMETERS = True 217 218 # Whether or not to include the type of a computed column in the CREATE DDL 219 COMPUTED_COLUMN_WITH_TYPE = True 220 221 # Whether or not CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 222 SUPPORTS_TABLE_COPY = True 223 224 # Whether or not parentheses are required around the table sample's expression 225 TABLESAMPLE_REQUIRES_PARENS = True 226 227 # Whether or not COLLATE is a function instead of a binary operator 228 COLLATE_IS_FUNC = False 229 230 # Whether or not data types support additional specifiers like e.g. CHAR or BYTE (oracle) 231 DATA_TYPE_SPECIFIERS_ALLOWED = False 232 233 # Whether or not conditions require booleans WHERE x = 0 vs WHERE x 234 ENSURE_BOOLS = False 235 236 # Whether or not the "RECURSIVE" keyword is required when defining recursive CTEs 237 CTE_RECURSIVE_KEYWORD_REQUIRED = True 238 239 # Whether the behavior of a / b depends on the types of a and b. 240 # False means a / b is always float division. 241 # True means a / b is integer division if both a and b are integers. 242 TYPED_DIVISION = False 243 244 # False means 1 / 0 throws an error. 245 # True means 1 / 0 returns null. 246 SAFE_DIVISION = False 247 248 TYPE_MAPPING = { 249 exp.DataType.Type.NCHAR: "CHAR", 250 exp.DataType.Type.NVARCHAR: "VARCHAR", 251 exp.DataType.Type.MEDIUMTEXT: "TEXT", 252 exp.DataType.Type.LONGTEXT: "TEXT", 253 exp.DataType.Type.TINYTEXT: "TEXT", 254 exp.DataType.Type.MEDIUMBLOB: "BLOB", 255 exp.DataType.Type.LONGBLOB: "BLOB", 256 exp.DataType.Type.TINYBLOB: "BLOB", 257 exp.DataType.Type.INET: "INET", 258 } 259 260 STAR_MAPPING = { 261 "except": "EXCEPT", 262 "replace": "REPLACE", 263 } 264 265 TIME_PART_SINGULARS = { 266 "microseconds": "microsecond", 267 "seconds": "second", 268 "minutes": "minute", 269 "hours": "hour", 270 "days": "day", 271 "weeks": "week", 272 "months": "month", 273 "quarters": "quarter", 274 "years": "year", 275 } 276 277 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 278 279 STRUCT_DELIMITER = ("<", ">") 280 281 PARAMETER_TOKEN = "@" 282 283 PROPERTIES_LOCATION = { 284 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 285 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 286 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 287 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 288 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 289 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 290 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 291 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 292 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 293 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 294 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 295 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 296 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 297 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 298 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 299 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 300 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 301 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 302 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 303 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 304 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 305 exp.HeapProperty: exp.Properties.Location.POST_WITH, 306 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 307 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 308 exp.JournalProperty: exp.Properties.Location.POST_NAME, 309 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 310 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 311 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 312 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 313 exp.LogProperty: exp.Properties.Location.POST_NAME, 314 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 315 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 316 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 317 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 318 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 319 exp.Order: exp.Properties.Location.POST_SCHEMA, 320 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 321 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 322 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 323 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 324 exp.Property: exp.Properties.Location.POST_WITH, 325 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 326 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 327 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 328 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 329 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 330 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 331 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 332 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 333 exp.Set: exp.Properties.Location.POST_SCHEMA, 334 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 335 exp.SetProperty: exp.Properties.Location.POST_CREATE, 336 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 337 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 338 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 339 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 340 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 341 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 342 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 343 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 344 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 345 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 346 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 347 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 348 } 349 350 # Keywords that can't be used as unquoted identifier names 351 RESERVED_KEYWORDS: t.Set[str] = set() 352 353 # Expressions whose comments are separated from them for better formatting 354 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 355 exp.Create, 356 exp.Delete, 357 exp.Drop, 358 exp.From, 359 exp.Insert, 360 exp.Join, 361 exp.Select, 362 exp.Update, 363 exp.Where, 364 exp.With, 365 ) 366 367 # Expressions that should not have their comments generated in maybe_comment 368 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 369 exp.Binary, 370 exp.Union, 371 ) 372 373 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 374 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 375 exp.Column, 376 exp.Literal, 377 exp.Neg, 378 exp.Paren, 379 ) 380 381 # Expressions that need to have all CTEs under them bubbled up to them 382 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 383 384 KEY_VALUE_DEFINITONS = (exp.Bracket, exp.EQ, exp.PropertyEQ, exp.Slice) 385 386 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 387 388 # Autofilled 389 INVERSE_TIME_MAPPING: t.Dict[str, str] = {} 390 INVERSE_TIME_TRIE: t.Dict = {} 391 INVERSE_ESCAPE_SEQUENCES: t.Dict[str, str] = {} 392 INDEX_OFFSET = 0 393 UNNEST_COLUMN_ONLY = False 394 ALIAS_POST_TABLESAMPLE = False 395 IDENTIFIERS_CAN_START_WITH_DIGIT = False 396 STRICT_STRING_CONCAT = False 397 NORMALIZE_FUNCTIONS: bool | str = "upper" 398 NULL_ORDERING = "nulls_are_small" 399 400 can_identify: t.Callable[[str, str | bool], bool] 401 402 # Delimiters for quotes, identifiers and the corresponding escape characters 403 QUOTE_START = "'" 404 QUOTE_END = "'" 405 IDENTIFIER_START = '"' 406 IDENTIFIER_END = '"' 407 TOKENIZER_CLASS = Tokenizer 408 409 # Delimiters for bit, hex, byte and raw literals 410 BIT_START: t.Optional[str] = None 411 BIT_END: t.Optional[str] = None 412 HEX_START: t.Optional[str] = None 413 HEX_END: t.Optional[str] = None 414 BYTE_START: t.Optional[str] = None 415 BYTE_END: t.Optional[str] = None 416 417 __slots__ = ( 418 "pretty", 419 "identify", 420 "normalize", 421 "pad", 422 "_indent", 423 "normalize_functions", 424 "unsupported_level", 425 "max_unsupported", 426 "leading_comma", 427 "max_text_width", 428 "comments", 429 "unsupported_messages", 430 "_escaped_quote_end", 431 "_escaped_identifier_end", 432 ) 433 434 def __init__( 435 self, 436 pretty: t.Optional[bool] = None, 437 identify: str | bool = False, 438 normalize: bool = False, 439 pad: int = 2, 440 indent: int = 2, 441 normalize_functions: t.Optional[str | bool] = None, 442 unsupported_level: ErrorLevel = ErrorLevel.WARN, 443 max_unsupported: int = 3, 444 leading_comma: bool = False, 445 max_text_width: int = 80, 446 comments: bool = True, 447 ): 448 import sqlglot 449 450 self.pretty = pretty if pretty is not None else sqlglot.pretty 451 self.identify = identify 452 self.normalize = normalize 453 self.pad = pad 454 self._indent = indent 455 self.unsupported_level = unsupported_level 456 self.max_unsupported = max_unsupported 457 self.leading_comma = leading_comma 458 self.max_text_width = max_text_width 459 self.comments = comments 460 461 # This is both a Dialect property and a Generator argument, so we prioritize the latter 462 self.normalize_functions = ( 463 self.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 464 ) 465 466 self.unsupported_messages: t.List[str] = [] 467 self._escaped_quote_end: str = self.TOKENIZER_CLASS.STRING_ESCAPES[0] + self.QUOTE_END 468 self._escaped_identifier_end: str = ( 469 self.TOKENIZER_CLASS.IDENTIFIER_ESCAPES[0] + self.IDENTIFIER_END 470 ) 471 472 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 473 """ 474 Generates the SQL string corresponding to the given syntax tree. 475 476 Args: 477 expression: The syntax tree. 478 copy: Whether or not to copy the expression. The generator performs mutations so 479 it is safer to copy. 480 481 Returns: 482 The SQL string corresponding to `expression`. 483 """ 484 if copy: 485 expression = expression.copy() 486 487 # Some dialects only support CTEs at the top level expression for certain expression 488 # types, so we need to bubble up nested CTEs to that level in order to produce a 489 # syntactically valid expression. This transformation happens here to minimize code 490 # duplication, since many expressions support CTEs. 491 if ( 492 not expression.parent 493 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 494 and any(node.parent is not expression for node in expression.find_all(exp.With)) 495 ): 496 from sqlglot.transforms import move_ctes_to_top_level 497 498 expression = move_ctes_to_top_level(expression) 499 500 if self.ENSURE_BOOLS: 501 from sqlglot.transforms import ensure_bools 502 503 expression = ensure_bools(expression) 504 505 self.unsupported_messages = [] 506 sql = self.sql(expression).strip() 507 508 if self.unsupported_level == ErrorLevel.IGNORE: 509 return sql 510 511 if self.unsupported_level == ErrorLevel.WARN: 512 for msg in self.unsupported_messages: 513 logger.warning(msg) 514 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 515 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 516 517 if self.pretty: 518 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 519 return sql 520 521 def unsupported(self, message: str) -> None: 522 if self.unsupported_level == ErrorLevel.IMMEDIATE: 523 raise UnsupportedError(message) 524 self.unsupported_messages.append(message) 525 526 def sep(self, sep: str = " ") -> str: 527 return f"{sep.strip()}\n" if self.pretty else sep 528 529 def seg(self, sql: str, sep: str = " ") -> str: 530 return f"{self.sep(sep)}{sql}" 531 532 def pad_comment(self, comment: str) -> str: 533 comment = " " + comment if comment[0].strip() else comment 534 comment = comment + " " if comment[-1].strip() else comment 535 return comment 536 537 def maybe_comment( 538 self, 539 sql: str, 540 expression: t.Optional[exp.Expression] = None, 541 comments: t.Optional[t.List[str]] = None, 542 ) -> str: 543 comments = ( 544 ((expression and expression.comments) if comments is None else comments) # type: ignore 545 if self.comments 546 else None 547 ) 548 549 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 550 return sql 551 552 comments_sql = " ".join( 553 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 554 ) 555 556 if not comments_sql: 557 return sql 558 559 if isinstance(expression, self.WITH_SEPARATED_COMMENTS): 560 return ( 561 f"{self.sep()}{comments_sql}{sql}" 562 if sql[0].isspace() 563 else f"{comments_sql}{self.sep()}{sql}" 564 ) 565 566 return f"{sql} {comments_sql}" 567 568 def wrap(self, expression: exp.Expression | str) -> str: 569 this_sql = self.indent( 570 self.sql(expression) 571 if isinstance(expression, (exp.Select, exp.Union)) 572 else self.sql(expression, "this"), 573 level=1, 574 pad=0, 575 ) 576 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 577 578 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 579 original = self.identify 580 self.identify = False 581 result = func(*args, **kwargs) 582 self.identify = original 583 return result 584 585 def normalize_func(self, name: str) -> str: 586 if self.normalize_functions == "upper" or self.normalize_functions is True: 587 return name.upper() 588 if self.normalize_functions == "lower": 589 return name.lower() 590 return name 591 592 def indent( 593 self, 594 sql: str, 595 level: int = 0, 596 pad: t.Optional[int] = None, 597 skip_first: bool = False, 598 skip_last: bool = False, 599 ) -> str: 600 if not self.pretty: 601 return sql 602 603 pad = self.pad if pad is None else pad 604 lines = sql.split("\n") 605 606 return "\n".join( 607 line 608 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 609 else f"{' ' * (level * self._indent + pad)}{line}" 610 for i, line in enumerate(lines) 611 ) 612 613 def sql( 614 self, 615 expression: t.Optional[str | exp.Expression], 616 key: t.Optional[str] = None, 617 comment: bool = True, 618 ) -> str: 619 if not expression: 620 return "" 621 622 if isinstance(expression, str): 623 return expression 624 625 if key: 626 value = expression.args.get(key) 627 if value: 628 return self.sql(value) 629 return "" 630 631 transform = self.TRANSFORMS.get(expression.__class__) 632 633 if callable(transform): 634 sql = transform(self, expression) 635 elif transform: 636 sql = transform 637 elif isinstance(expression, exp.Expression): 638 exp_handler_name = f"{expression.key}_sql" 639 640 if hasattr(self, exp_handler_name): 641 sql = getattr(self, exp_handler_name)(expression) 642 elif isinstance(expression, exp.Func): 643 sql = self.function_fallback_sql(expression) 644 elif isinstance(expression, exp.Property): 645 sql = self.property_sql(expression) 646 else: 647 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 648 else: 649 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 650 651 return self.maybe_comment(sql, expression) if self.comments and comment else sql 652 653 def uncache_sql(self, expression: exp.Uncache) -> str: 654 table = self.sql(expression, "this") 655 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 656 return f"UNCACHE TABLE{exists_sql} {table}" 657 658 def cache_sql(self, expression: exp.Cache) -> str: 659 lazy = " LAZY" if expression.args.get("lazy") else "" 660 table = self.sql(expression, "this") 661 options = expression.args.get("options") 662 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 663 sql = self.sql(expression, "expression") 664 sql = f" AS{self.sep()}{sql}" if sql else "" 665 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 666 return self.prepend_ctes(expression, sql) 667 668 def characterset_sql(self, expression: exp.CharacterSet) -> str: 669 if isinstance(expression.parent, exp.Cast): 670 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 671 default = "DEFAULT " if expression.args.get("default") else "" 672 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 673 674 def column_sql(self, expression: exp.Column) -> str: 675 join_mark = " (+)" if expression.args.get("join_mark") else "" 676 677 if join_mark and not self.COLUMN_JOIN_MARKS_SUPPORTED: 678 join_mark = "" 679 self.unsupported("Outer join syntax using the (+) operator is not supported.") 680 681 column = ".".join( 682 self.sql(part) 683 for part in ( 684 expression.args.get("catalog"), 685 expression.args.get("db"), 686 expression.args.get("table"), 687 expression.args.get("this"), 688 ) 689 if part 690 ) 691 692 return f"{column}{join_mark}" 693 694 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 695 this = self.sql(expression, "this") 696 this = f" {this}" if this else "" 697 position = self.sql(expression, "position") 698 return f"{position}{this}" 699 700 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 701 column = self.sql(expression, "this") 702 kind = self.sql(expression, "kind") 703 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 704 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 705 kind = f"{sep}{kind}" if kind else "" 706 constraints = f" {constraints}" if constraints else "" 707 position = self.sql(expression, "position") 708 position = f" {position}" if position else "" 709 710 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 711 kind = "" 712 713 return f"{exists}{column}{kind}{constraints}{position}" 714 715 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 716 this = self.sql(expression, "this") 717 kind_sql = self.sql(expression, "kind").strip() 718 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 719 720 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 721 this = self.sql(expression, "this") 722 if expression.args.get("not_null"): 723 persisted = " PERSISTED NOT NULL" 724 elif expression.args.get("persisted"): 725 persisted = " PERSISTED" 726 else: 727 persisted = "" 728 return f"AS {this}{persisted}" 729 730 def autoincrementcolumnconstraint_sql(self, _) -> str: 731 return self.token_sql(TokenType.AUTO_INCREMENT) 732 733 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 734 if isinstance(expression.this, list): 735 this = self.wrap(self.expressions(expression, key="this", flat=True)) 736 else: 737 this = self.sql(expression, "this") 738 739 return f"COMPRESS {this}" 740 741 def generatedasidentitycolumnconstraint_sql( 742 self, expression: exp.GeneratedAsIdentityColumnConstraint 743 ) -> str: 744 this = "" 745 if expression.this is not None: 746 on_null = " ON NULL" if expression.args.get("on_null") else "" 747 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 748 749 start = expression.args.get("start") 750 start = f"START WITH {start}" if start else "" 751 increment = expression.args.get("increment") 752 increment = f" INCREMENT BY {increment}" if increment else "" 753 minvalue = expression.args.get("minvalue") 754 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 755 maxvalue = expression.args.get("maxvalue") 756 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 757 cycle = expression.args.get("cycle") 758 cycle_sql = "" 759 760 if cycle is not None: 761 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 762 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 763 764 sequence_opts = "" 765 if start or increment or cycle_sql: 766 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 767 sequence_opts = f" ({sequence_opts.strip()})" 768 769 expr = self.sql(expression, "expression") 770 expr = f"({expr})" if expr else "IDENTITY" 771 772 return f"GENERATED{this} AS {expr}{sequence_opts}" 773 774 def generatedasrowcolumnconstraint_sql( 775 self, expression: exp.GeneratedAsRowColumnConstraint 776 ) -> str: 777 start = "START" if expression.args["start"] else "END" 778 hidden = " HIDDEN" if expression.args.get("hidden") else "" 779 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 780 781 def periodforsystemtimeconstraint_sql( 782 self, expression: exp.PeriodForSystemTimeConstraint 783 ) -> str: 784 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 785 786 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 787 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 788 789 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 790 desc = expression.args.get("desc") 791 if desc is not None: 792 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 793 return f"PRIMARY KEY" 794 795 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 796 this = self.sql(expression, "this") 797 this = f" {this}" if this else "" 798 index_type = expression.args.get("index_type") 799 index_type = f" USING {index_type}" if index_type else "" 800 return f"UNIQUE{this}{index_type}" 801 802 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 803 return self.sql(expression, "this") 804 805 def create_sql(self, expression: exp.Create) -> str: 806 kind = self.sql(expression, "kind").upper() 807 properties = expression.args.get("properties") 808 properties_locs = self.locate_properties(properties) if properties else defaultdict() 809 810 this = self.createable_sql(expression, properties_locs) 811 812 properties_sql = "" 813 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 814 exp.Properties.Location.POST_WITH 815 ): 816 properties_sql = self.sql( 817 exp.Properties( 818 expressions=[ 819 *properties_locs[exp.Properties.Location.POST_SCHEMA], 820 *properties_locs[exp.Properties.Location.POST_WITH], 821 ] 822 ) 823 ) 824 825 begin = " BEGIN" if expression.args.get("begin") else "" 826 end = " END" if expression.args.get("end") else "" 827 828 expression_sql = self.sql(expression, "expression") 829 if expression_sql: 830 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 831 832 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 833 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 834 postalias_props_sql = self.properties( 835 exp.Properties( 836 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 837 ), 838 wrapped=False, 839 ) 840 expression_sql = f" AS {postalias_props_sql}{expression_sql}" 841 else: 842 expression_sql = f" AS{expression_sql}" 843 844 postindex_props_sql = "" 845 if properties_locs.get(exp.Properties.Location.POST_INDEX): 846 postindex_props_sql = self.properties( 847 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 848 wrapped=False, 849 prefix=" ", 850 ) 851 852 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 853 indexes = f" {indexes}" if indexes else "" 854 index_sql = indexes + postindex_props_sql 855 856 replace = " OR REPLACE" if expression.args.get("replace") else "" 857 unique = " UNIQUE" if expression.args.get("unique") else "" 858 859 postcreate_props_sql = "" 860 if properties_locs.get(exp.Properties.Location.POST_CREATE): 861 postcreate_props_sql = self.properties( 862 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 863 sep=" ", 864 prefix=" ", 865 wrapped=False, 866 ) 867 868 modifiers = "".join((replace, unique, postcreate_props_sql)) 869 870 postexpression_props_sql = "" 871 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 872 postexpression_props_sql = self.properties( 873 exp.Properties( 874 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 875 ), 876 sep=" ", 877 prefix=" ", 878 wrapped=False, 879 ) 880 881 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 882 no_schema_binding = ( 883 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 884 ) 885 886 clone = self.sql(expression, "clone") 887 clone = f" {clone}" if clone else "" 888 889 expression_sql = f"CREATE{modifiers} {kind}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 890 return self.prepend_ctes(expression, expression_sql) 891 892 def clone_sql(self, expression: exp.Clone) -> str: 893 this = self.sql(expression, "this") 894 shallow = "SHALLOW " if expression.args.get("shallow") else "" 895 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 896 this = f"{shallow}{keyword} {this}" 897 when = self.sql(expression, "when") 898 899 if when: 900 kind = self.sql(expression, "kind") 901 expr = self.sql(expression, "expression") 902 return f"{this} {when} ({kind} => {expr})" 903 904 return this 905 906 def describe_sql(self, expression: exp.Describe) -> str: 907 return f"DESCRIBE {self.sql(expression, 'this')}" 908 909 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 910 with_ = self.sql(expression, "with") 911 if with_: 912 sql = f"{with_}{self.sep()}{sql}" 913 return sql 914 915 def with_sql(self, expression: exp.With) -> str: 916 sql = self.expressions(expression, flat=True) 917 recursive = ( 918 "RECURSIVE " 919 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 920 else "" 921 ) 922 923 return f"WITH {recursive}{sql}" 924 925 def cte_sql(self, expression: exp.CTE) -> str: 926 alias = self.sql(expression, "alias") 927 return f"{alias} AS {self.wrap(expression)}" 928 929 def tablealias_sql(self, expression: exp.TableAlias) -> str: 930 alias = self.sql(expression, "this") 931 columns = self.expressions(expression, key="columns", flat=True) 932 columns = f"({columns})" if columns else "" 933 934 if not alias and not self.UNNEST_COLUMN_ONLY: 935 alias = "_t" 936 937 return f"{alias}{columns}" 938 939 def bitstring_sql(self, expression: exp.BitString) -> str: 940 this = self.sql(expression, "this") 941 if self.BIT_START: 942 return f"{self.BIT_START}{this}{self.BIT_END}" 943 return f"{int(this, 2)}" 944 945 def hexstring_sql(self, expression: exp.HexString) -> str: 946 this = self.sql(expression, "this") 947 if self.HEX_START: 948 return f"{self.HEX_START}{this}{self.HEX_END}" 949 return f"{int(this, 16)}" 950 951 def bytestring_sql(self, expression: exp.ByteString) -> str: 952 this = self.sql(expression, "this") 953 if self.BYTE_START: 954 return f"{self.BYTE_START}{this}{self.BYTE_END}" 955 return this 956 957 def rawstring_sql(self, expression: exp.RawString) -> str: 958 string = self.escape_str(expression.this.replace("\\", "\\\\")) 959 return f"{self.QUOTE_START}{string}{self.QUOTE_END}" 960 961 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 962 this = self.sql(expression, "this") 963 specifier = self.sql(expression, "expression") 964 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 965 return f"{this}{specifier}" 966 967 def datatype_sql(self, expression: exp.DataType) -> str: 968 type_value = expression.this 969 970 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 971 type_sql = self.sql(expression, "kind") 972 else: 973 type_sql = ( 974 self.TYPE_MAPPING.get(type_value, type_value.value) 975 if isinstance(type_value, exp.DataType.Type) 976 else type_value 977 ) 978 979 nested = "" 980 interior = self.expressions(expression, flat=True) 981 values = "" 982 983 if interior: 984 if expression.args.get("nested"): 985 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 986 if expression.args.get("values") is not None: 987 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 988 values = self.expressions(expression, key="values", flat=True) 989 values = f"{delimiters[0]}{values}{delimiters[1]}" 990 elif type_value == exp.DataType.Type.INTERVAL: 991 nested = f" {interior}" 992 else: 993 nested = f"({interior})" 994 995 type_sql = f"{type_sql}{nested}{values}" 996 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 997 exp.DataType.Type.TIMETZ, 998 exp.DataType.Type.TIMESTAMPTZ, 999 ): 1000 type_sql = f"{type_sql} WITH TIME ZONE" 1001 1002 return type_sql 1003 1004 def directory_sql(self, expression: exp.Directory) -> str: 1005 local = "LOCAL " if expression.args.get("local") else "" 1006 row_format = self.sql(expression, "row_format") 1007 row_format = f" {row_format}" if row_format else "" 1008 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1009 1010 def delete_sql(self, expression: exp.Delete) -> str: 1011 this = self.sql(expression, "this") 1012 this = f" FROM {this}" if this else "" 1013 using = self.sql(expression, "using") 1014 using = f" USING {using}" if using else "" 1015 where = self.sql(expression, "where") 1016 returning = self.sql(expression, "returning") 1017 limit = self.sql(expression, "limit") 1018 tables = self.expressions(expression, key="tables") 1019 tables = f" {tables}" if tables else "" 1020 if self.RETURNING_END: 1021 expression_sql = f"{this}{using}{where}{returning}{limit}" 1022 else: 1023 expression_sql = f"{returning}{this}{using}{where}{limit}" 1024 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1025 1026 def drop_sql(self, expression: exp.Drop) -> str: 1027 this = self.sql(expression, "this") 1028 kind = expression.args["kind"] 1029 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1030 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1031 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1032 cascade = " CASCADE" if expression.args.get("cascade") else "" 1033 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1034 purge = " PURGE" if expression.args.get("purge") else "" 1035 return ( 1036 f"DROP{temporary}{materialized} {kind}{exists_sql}{this}{cascade}{constraints}{purge}" 1037 ) 1038 1039 def except_sql(self, expression: exp.Except) -> str: 1040 return self.prepend_ctes( 1041 expression, 1042 self.set_operation(expression, self.except_op(expression)), 1043 ) 1044 1045 def except_op(self, expression: exp.Except) -> str: 1046 return f"EXCEPT{'' if expression.args.get('distinct') else ' ALL'}" 1047 1048 def fetch_sql(self, expression: exp.Fetch) -> str: 1049 direction = expression.args.get("direction") 1050 direction = f" {direction.upper()}" if direction else "" 1051 count = expression.args.get("count") 1052 count = f" {count}" if count else "" 1053 if expression.args.get("percent"): 1054 count = f"{count} PERCENT" 1055 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1056 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1057 1058 def filter_sql(self, expression: exp.Filter) -> str: 1059 if self.AGGREGATE_FILTER_SUPPORTED: 1060 this = self.sql(expression, "this") 1061 where = self.sql(expression, "expression").strip() 1062 return f"{this} FILTER({where})" 1063 1064 agg = expression.this 1065 agg_arg = agg.this 1066 cond = expression.expression.this 1067 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1068 return self.sql(agg) 1069 1070 def hint_sql(self, expression: exp.Hint) -> str: 1071 if not self.QUERY_HINTS: 1072 self.unsupported("Hints are not supported") 1073 return "" 1074 1075 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1076 1077 def index_sql(self, expression: exp.Index) -> str: 1078 unique = "UNIQUE " if expression.args.get("unique") else "" 1079 primary = "PRIMARY " if expression.args.get("primary") else "" 1080 amp = "AMP " if expression.args.get("amp") else "" 1081 name = self.sql(expression, "this") 1082 name = f"{name} " if name else "" 1083 table = self.sql(expression, "table") 1084 table = f"{self.INDEX_ON} {table}" if table else "" 1085 using = self.sql(expression, "using") 1086 using = f" USING {using}" if using else "" 1087 index = "INDEX " if not table else "" 1088 columns = self.expressions(expression, key="columns", flat=True) 1089 columns = f"({columns})" if columns else "" 1090 partition_by = self.expressions(expression, key="partition_by", flat=True) 1091 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1092 where = self.sql(expression, "where") 1093 return f"{unique}{primary}{amp}{index}{name}{table}{using}{columns}{partition_by}{where}" 1094 1095 def identifier_sql(self, expression: exp.Identifier) -> str: 1096 text = expression.name 1097 lower = text.lower() 1098 text = lower if self.normalize and not expression.quoted else text 1099 text = text.replace(self.IDENTIFIER_END, self._escaped_identifier_end) 1100 if ( 1101 expression.quoted 1102 or self.can_identify(text, self.identify) 1103 or lower in self.RESERVED_KEYWORDS 1104 or (not self.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1105 ): 1106 text = f"{self.IDENTIFIER_START}{text}{self.IDENTIFIER_END}" 1107 return text 1108 1109 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1110 input_format = self.sql(expression, "input_format") 1111 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1112 output_format = self.sql(expression, "output_format") 1113 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1114 return self.sep().join((input_format, output_format)) 1115 1116 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1117 string = self.sql(exp.Literal.string(expression.name)) 1118 return f"{prefix}{string}" 1119 1120 def partition_sql(self, expression: exp.Partition) -> str: 1121 return f"PARTITION({self.expressions(expression, flat=True)})" 1122 1123 def properties_sql(self, expression: exp.Properties) -> str: 1124 root_properties = [] 1125 with_properties = [] 1126 1127 for p in expression.expressions: 1128 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1129 if p_loc == exp.Properties.Location.POST_WITH: 1130 with_properties.append(p) 1131 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1132 root_properties.append(p) 1133 1134 return self.root_properties( 1135 exp.Properties(expressions=root_properties) 1136 ) + self.with_properties(exp.Properties(expressions=with_properties)) 1137 1138 def root_properties(self, properties: exp.Properties) -> str: 1139 if properties.expressions: 1140 return self.sep() + self.expressions(properties, indent=False, sep=" ") 1141 return "" 1142 1143 def properties( 1144 self, 1145 properties: exp.Properties, 1146 prefix: str = "", 1147 sep: str = ", ", 1148 suffix: str = "", 1149 wrapped: bool = True, 1150 ) -> str: 1151 if properties.expressions: 1152 expressions = self.expressions(properties, sep=sep, indent=False) 1153 if expressions: 1154 expressions = self.wrap(expressions) if wrapped else expressions 1155 return f"{prefix}{' ' if prefix and prefix != ' ' else ''}{expressions}{suffix}" 1156 return "" 1157 1158 def with_properties(self, properties: exp.Properties) -> str: 1159 return self.properties(properties, prefix=self.seg("WITH")) 1160 1161 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1162 properties_locs = defaultdict(list) 1163 for p in properties.expressions: 1164 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1165 if p_loc != exp.Properties.Location.UNSUPPORTED: 1166 properties_locs[p_loc].append(p) 1167 else: 1168 self.unsupported(f"Unsupported property {p.key}") 1169 1170 return properties_locs 1171 1172 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1173 if isinstance(expression.this, exp.Dot): 1174 return self.sql(expression, "this") 1175 return f"'{expression.name}'" if string_key else expression.name 1176 1177 def property_sql(self, expression: exp.Property) -> str: 1178 property_cls = expression.__class__ 1179 if property_cls == exp.Property: 1180 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1181 1182 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1183 if not property_name: 1184 self.unsupported(f"Unsupported property {expression.key}") 1185 1186 return f"{property_name}={self.sql(expression, 'this')}" 1187 1188 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1189 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1190 options = f" {options}" if options else "" 1191 return f"LIKE {self.sql(expression, 'this')}{options}" 1192 1193 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1194 no = "NO " if expression.args.get("no") else "" 1195 protection = " PROTECTION" if expression.args.get("protection") else "" 1196 return f"{no}FALLBACK{protection}" 1197 1198 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1199 no = "NO " if expression.args.get("no") else "" 1200 local = expression.args.get("local") 1201 local = f"{local} " if local else "" 1202 dual = "DUAL " if expression.args.get("dual") else "" 1203 before = "BEFORE " if expression.args.get("before") else "" 1204 after = "AFTER " if expression.args.get("after") else "" 1205 return f"{no}{local}{dual}{before}{after}JOURNAL" 1206 1207 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1208 freespace = self.sql(expression, "this") 1209 percent = " PERCENT" if expression.args.get("percent") else "" 1210 return f"FREESPACE={freespace}{percent}" 1211 1212 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1213 if expression.args.get("default"): 1214 property = "DEFAULT" 1215 elif expression.args.get("on"): 1216 property = "ON" 1217 else: 1218 property = "OFF" 1219 return f"CHECKSUM={property}" 1220 1221 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1222 if expression.args.get("no"): 1223 return "NO MERGEBLOCKRATIO" 1224 if expression.args.get("default"): 1225 return "DEFAULT MERGEBLOCKRATIO" 1226 1227 percent = " PERCENT" if expression.args.get("percent") else "" 1228 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1229 1230 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1231 default = expression.args.get("default") 1232 minimum = expression.args.get("minimum") 1233 maximum = expression.args.get("maximum") 1234 if default or minimum or maximum: 1235 if default: 1236 prop = "DEFAULT" 1237 elif minimum: 1238 prop = "MINIMUM" 1239 else: 1240 prop = "MAXIMUM" 1241 return f"{prop} DATABLOCKSIZE" 1242 units = expression.args.get("units") 1243 units = f" {units}" if units else "" 1244 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1245 1246 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1247 autotemp = expression.args.get("autotemp") 1248 always = expression.args.get("always") 1249 default = expression.args.get("default") 1250 manual = expression.args.get("manual") 1251 never = expression.args.get("never") 1252 1253 if autotemp is not None: 1254 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1255 elif always: 1256 prop = "ALWAYS" 1257 elif default: 1258 prop = "DEFAULT" 1259 elif manual: 1260 prop = "MANUAL" 1261 elif never: 1262 prop = "NEVER" 1263 return f"BLOCKCOMPRESSION={prop}" 1264 1265 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1266 no = expression.args.get("no") 1267 no = " NO" if no else "" 1268 concurrent = expression.args.get("concurrent") 1269 concurrent = " CONCURRENT" if concurrent else "" 1270 1271 for_ = "" 1272 if expression.args.get("for_all"): 1273 for_ = " FOR ALL" 1274 elif expression.args.get("for_insert"): 1275 for_ = " FOR INSERT" 1276 elif expression.args.get("for_none"): 1277 for_ = " FOR NONE" 1278 return f"WITH{no}{concurrent} ISOLATED LOADING{for_}" 1279 1280 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1281 if isinstance(expression.this, list): 1282 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1283 if expression.this: 1284 modulus = self.sql(expression, "this") 1285 remainder = self.sql(expression, "expression") 1286 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1287 1288 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1289 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1290 return f"FROM ({from_expressions}) TO ({to_expressions})" 1291 1292 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1293 this = self.sql(expression, "this") 1294 1295 for_values_or_default = expression.expression 1296 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1297 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1298 else: 1299 for_values_or_default = " DEFAULT" 1300 1301 return f"PARTITION OF {this}{for_values_or_default}" 1302 1303 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1304 kind = expression.args.get("kind") 1305 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1306 for_or_in = expression.args.get("for_or_in") 1307 for_or_in = f" {for_or_in}" if for_or_in else "" 1308 lock_type = expression.args.get("lock_type") 1309 override = " OVERRIDE" if expression.args.get("override") else "" 1310 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1311 1312 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1313 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1314 statistics = expression.args.get("statistics") 1315 statistics_sql = "" 1316 if statistics is not None: 1317 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1318 return f"{data_sql}{statistics_sql}" 1319 1320 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1321 sql = "WITH(SYSTEM_VERSIONING=ON" 1322 1323 if expression.this: 1324 history_table = self.sql(expression, "this") 1325 sql = f"{sql}(HISTORY_TABLE={history_table}" 1326 1327 if expression.expression: 1328 data_consistency_check = self.sql(expression, "expression") 1329 sql = f"{sql}, DATA_CONSISTENCY_CHECK={data_consistency_check}" 1330 1331 sql = f"{sql})" 1332 1333 return f"{sql})" 1334 1335 def insert_sql(self, expression: exp.Insert) -> str: 1336 overwrite = expression.args.get("overwrite") 1337 1338 if isinstance(expression.this, exp.Directory): 1339 this = " OVERWRITE" if overwrite else " INTO" 1340 else: 1341 this = " OVERWRITE TABLE" if overwrite else " INTO" 1342 1343 alternative = expression.args.get("alternative") 1344 alternative = f" OR {alternative}" if alternative else "" 1345 ignore = " IGNORE" if expression.args.get("ignore") else "" 1346 1347 this = f"{this} {self.sql(expression, 'this')}" 1348 1349 exists = " IF EXISTS" if expression.args.get("exists") else "" 1350 partition_sql = ( 1351 f" {self.sql(expression, 'partition')}" if expression.args.get("partition") else "" 1352 ) 1353 where = self.sql(expression, "where") 1354 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1355 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1356 conflict = self.sql(expression, "conflict") 1357 by_name = " BY NAME" if expression.args.get("by_name") else "" 1358 returning = self.sql(expression, "returning") 1359 1360 if self.RETURNING_END: 1361 expression_sql = f"{expression_sql}{conflict}{returning}" 1362 else: 1363 expression_sql = f"{returning}{expression_sql}{conflict}" 1364 1365 sql = f"INSERT{alternative}{ignore}{this}{by_name}{exists}{partition_sql}{where}{expression_sql}" 1366 return self.prepend_ctes(expression, sql) 1367 1368 def intersect_sql(self, expression: exp.Intersect) -> str: 1369 return self.prepend_ctes( 1370 expression, 1371 self.set_operation(expression, self.intersect_op(expression)), 1372 ) 1373 1374 def intersect_op(self, expression: exp.Intersect) -> str: 1375 return f"INTERSECT{'' if expression.args.get('distinct') else ' ALL'}" 1376 1377 def introducer_sql(self, expression: exp.Introducer) -> str: 1378 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1379 1380 def kill_sql(self, expression: exp.Kill) -> str: 1381 kind = self.sql(expression, "kind") 1382 kind = f" {kind}" if kind else "" 1383 this = self.sql(expression, "this") 1384 this = f" {this}" if this else "" 1385 return f"KILL{kind}{this}" 1386 1387 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1388 return expression.name.upper() 1389 1390 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1391 return expression.name.upper() 1392 1393 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1394 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1395 constraint = self.sql(expression, "constraint") 1396 if constraint: 1397 constraint = f"ON CONSTRAINT {constraint}" 1398 key = self.expressions(expression, key="key", flat=True) 1399 do = "" if expression.args.get("duplicate") else " DO " 1400 nothing = "NOTHING" if expression.args.get("nothing") else "" 1401 expressions = self.expressions(expression, flat=True) 1402 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1403 if expressions: 1404 expressions = f"UPDATE {set_keyword}{expressions}" 1405 return f"{self.seg(conflict)} {constraint}{key}{do}{nothing}{expressions}" 1406 1407 def returning_sql(self, expression: exp.Returning) -> str: 1408 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1409 1410 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1411 fields = expression.args.get("fields") 1412 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1413 escaped = expression.args.get("escaped") 1414 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1415 items = expression.args.get("collection_items") 1416 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1417 keys = expression.args.get("map_keys") 1418 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1419 lines = expression.args.get("lines") 1420 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1421 null = expression.args.get("null") 1422 null = f" NULL DEFINED AS {null}" if null else "" 1423 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1424 1425 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1426 return f"WITH ({self.expressions(expression, flat=True)})" 1427 1428 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1429 this = f"{self.sql(expression, 'this')} INDEX" 1430 target = self.sql(expression, "target") 1431 target = f" FOR {target}" if target else "" 1432 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1433 1434 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1435 table = ".".join( 1436 part 1437 for part in [ 1438 self.sql(expression, "catalog"), 1439 self.sql(expression, "db"), 1440 self.sql(expression, "this"), 1441 ] 1442 if part 1443 ) 1444 1445 version = self.sql(expression, "version") 1446 version = f" {version}" if version else "" 1447 alias = self.sql(expression, "alias") 1448 alias = f"{sep}{alias}" if alias else "" 1449 hints = self.expressions(expression, key="hints", sep=" ") 1450 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1451 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 1452 pivots = f" {pivots}" if pivots else "" 1453 joins = self.expressions(expression, key="joins", sep="", skip_first=True) 1454 laterals = self.expressions(expression, key="laterals", sep="") 1455 1456 file_format = self.sql(expression, "format") 1457 if file_format: 1458 pattern = self.sql(expression, "pattern") 1459 pattern = f", PATTERN => {pattern}" if pattern else "" 1460 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1461 1462 index = self.sql(expression, "index") 1463 index = f" AT {index}" if index else "" 1464 1465 ordinality = expression.args.get("ordinality") or "" 1466 if ordinality: 1467 ordinality = f" WITH ORDINALITY{alias}" 1468 alias = "" 1469 1470 return f"{table}{version}{file_format}{alias}{index}{hints}{pivots}{joins}{laterals}{ordinality}" 1471 1472 def tablesample_sql( 1473 self, expression: exp.TableSample, seed_prefix: str = "SEED", sep=" AS " 1474 ) -> str: 1475 if self.ALIAS_POST_TABLESAMPLE and expression.this and expression.this.alias: 1476 table = expression.this.copy() 1477 table.set("alias", None) 1478 this = self.sql(table) 1479 alias = f"{sep}{self.sql(expression.this, 'alias')}" 1480 else: 1481 this = self.sql(expression, "this") 1482 alias = "" 1483 1484 method = self.sql(expression, "method") 1485 method = f"{method.upper()} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1486 numerator = self.sql(expression, "bucket_numerator") 1487 denominator = self.sql(expression, "bucket_denominator") 1488 field = self.sql(expression, "bucket_field") 1489 field = f" ON {field}" if field else "" 1490 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1491 percent = self.sql(expression, "percent") 1492 percent = f"{percent} PERCENT" if percent else "" 1493 rows = self.sql(expression, "rows") 1494 rows = f"{rows} ROWS" if rows else "" 1495 1496 size = self.sql(expression, "size") 1497 if size and self.TABLESAMPLE_SIZE_IS_PERCENT: 1498 size = f"{size} PERCENT" 1499 1500 seed = self.sql(expression, "seed") 1501 seed = f" {seed_prefix} ({seed})" if seed else "" 1502 kind = expression.args.get("kind", "TABLESAMPLE") 1503 1504 expr = f"{bucket}{percent}{rows}{size}" 1505 if self.TABLESAMPLE_REQUIRES_PARENS: 1506 expr = f"({expr})" 1507 1508 return f"{this} {kind} {method}{expr}{seed}{alias}" 1509 1510 def pivot_sql(self, expression: exp.Pivot) -> str: 1511 expressions = self.expressions(expression, flat=True) 1512 1513 if expression.this: 1514 this = self.sql(expression, "this") 1515 if not expressions: 1516 return f"UNPIVOT {this}" 1517 1518 on = f"{self.seg('ON')} {expressions}" 1519 using = self.expressions(expression, key="using", flat=True) 1520 using = f"{self.seg('USING')} {using}" if using else "" 1521 group = self.sql(expression, "group") 1522 return f"PIVOT {this}{on}{using}{group}" 1523 1524 alias = self.sql(expression, "alias") 1525 alias = f" AS {alias}" if alias else "" 1526 unpivot = expression.args.get("unpivot") 1527 direction = "UNPIVOT" if unpivot else "PIVOT" 1528 field = self.sql(expression, "field") 1529 include_nulls = expression.args.get("include_nulls") 1530 if include_nulls is not None: 1531 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1532 else: 1533 nulls = "" 1534 return f"{direction}{nulls}({expressions} FOR {field}){alias}" 1535 1536 def version_sql(self, expression: exp.Version) -> str: 1537 this = f"FOR {expression.name}" 1538 kind = expression.text("kind") 1539 expr = self.sql(expression, "expression") 1540 return f"{this} {kind} {expr}" 1541 1542 def tuple_sql(self, expression: exp.Tuple) -> str: 1543 return f"({self.expressions(expression, flat=True)})" 1544 1545 def update_sql(self, expression: exp.Update) -> str: 1546 this = self.sql(expression, "this") 1547 set_sql = self.expressions(expression, flat=True) 1548 from_sql = self.sql(expression, "from") 1549 where_sql = self.sql(expression, "where") 1550 returning = self.sql(expression, "returning") 1551 order = self.sql(expression, "order") 1552 limit = self.sql(expression, "limit") 1553 if self.RETURNING_END: 1554 expression_sql = f"{from_sql}{where_sql}{returning}" 1555 else: 1556 expression_sql = f"{returning}{from_sql}{where_sql}" 1557 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 1558 return self.prepend_ctes(expression, sql) 1559 1560 def values_sql(self, expression: exp.Values) -> str: 1561 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 1562 if self.VALUES_AS_TABLE or not expression.find_ancestor(exp.From, exp.Join): 1563 args = self.expressions(expression) 1564 alias = self.sql(expression, "alias") 1565 values = f"VALUES{self.seg('')}{args}" 1566 values = ( 1567 f"({values})" 1568 if self.WRAP_DERIVED_VALUES and (alias or isinstance(expression.parent, exp.From)) 1569 else values 1570 ) 1571 return f"{values} AS {alias}" if alias else values 1572 1573 # Converts `VALUES...` expression into a series of select unions. 1574 alias_node = expression.args.get("alias") 1575 column_names = alias_node and alias_node.columns 1576 1577 selects: t.List[exp.Subqueryable] = [] 1578 1579 for i, tup in enumerate(expression.expressions): 1580 row = tup.expressions 1581 1582 if i == 0 and column_names: 1583 row = [ 1584 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 1585 ] 1586 1587 selects.append(exp.Select(expressions=row)) 1588 1589 if self.pretty: 1590 # This may result in poor performance for large-cardinality `VALUES` tables, due to 1591 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 1592 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 1593 subqueryable = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 1594 return self.subquery_sql( 1595 subqueryable.subquery(alias_node and alias_node.this, copy=False) 1596 ) 1597 1598 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 1599 unions = " UNION ALL ".join(self.sql(select) for select in selects) 1600 return f"({unions}){alias}" 1601 1602 def var_sql(self, expression: exp.Var) -> str: 1603 return self.sql(expression, "this") 1604 1605 def into_sql(self, expression: exp.Into) -> str: 1606 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1607 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 1608 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 1609 1610 def from_sql(self, expression: exp.From) -> str: 1611 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 1612 1613 def group_sql(self, expression: exp.Group) -> str: 1614 group_by = self.op_expressions("GROUP BY", expression) 1615 1616 if expression.args.get("all"): 1617 return f"{group_by} ALL" 1618 1619 grouping_sets = self.expressions(expression, key="grouping_sets", indent=False) 1620 grouping_sets = ( 1621 f"{self.seg('GROUPING SETS')} {self.wrap(grouping_sets)}" if grouping_sets else "" 1622 ) 1623 1624 cube = expression.args.get("cube", []) 1625 if seq_get(cube, 0) is True: 1626 return f"{group_by}{self.seg('WITH CUBE')}" 1627 else: 1628 cube_sql = self.expressions(expression, key="cube", indent=False) 1629 cube_sql = f"{self.seg('CUBE')} {self.wrap(cube_sql)}" if cube_sql else "" 1630 1631 rollup = expression.args.get("rollup", []) 1632 if seq_get(rollup, 0) is True: 1633 return f"{group_by}{self.seg('WITH ROLLUP')}" 1634 else: 1635 rollup_sql = self.expressions(expression, key="rollup", indent=False) 1636 rollup_sql = f"{self.seg('ROLLUP')} {self.wrap(rollup_sql)}" if rollup_sql else "" 1637 1638 groupings = csv( 1639 grouping_sets, 1640 cube_sql, 1641 rollup_sql, 1642 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 1643 sep=self.GROUPINGS_SEP, 1644 ) 1645 1646 if expression.args.get("expressions") and groupings: 1647 group_by = f"{group_by}{self.GROUPINGS_SEP}" 1648 1649 return f"{group_by}{groupings}" 1650 1651 def having_sql(self, expression: exp.Having) -> str: 1652 this = self.indent(self.sql(expression, "this")) 1653 return f"{self.seg('HAVING')}{self.sep()}{this}" 1654 1655 def connect_sql(self, expression: exp.Connect) -> str: 1656 start = self.sql(expression, "start") 1657 start = self.seg(f"START WITH {start}") if start else "" 1658 connect = self.sql(expression, "connect") 1659 connect = self.seg(f"CONNECT BY {connect}") 1660 return start + connect 1661 1662 def prior_sql(self, expression: exp.Prior) -> str: 1663 return f"PRIOR {self.sql(expression, 'this')}" 1664 1665 def join_sql(self, expression: exp.Join) -> str: 1666 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 1667 side = None 1668 else: 1669 side = expression.side 1670 1671 op_sql = " ".join( 1672 op 1673 for op in ( 1674 expression.method, 1675 "GLOBAL" if expression.args.get("global") else None, 1676 side, 1677 expression.kind, 1678 expression.hint if self.JOIN_HINTS else None, 1679 ) 1680 if op 1681 ) 1682 on_sql = self.sql(expression, "on") 1683 using = expression.args.get("using") 1684 1685 if not on_sql and using: 1686 on_sql = csv(*(self.sql(column) for column in using)) 1687 1688 this_sql = self.sql(expression, "this") 1689 1690 if on_sql: 1691 on_sql = self.indent(on_sql, skip_first=True) 1692 space = self.seg(" " * self.pad) if self.pretty else " " 1693 if using: 1694 on_sql = f"{space}USING ({on_sql})" 1695 else: 1696 on_sql = f"{space}ON {on_sql}" 1697 elif not op_sql: 1698 return f", {this_sql}" 1699 1700 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 1701 return f"{self.seg(op_sql)} {this_sql}{on_sql}" 1702 1703 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 1704 args = self.expressions(expression, flat=True) 1705 args = f"({args})" if len(args.split(",")) > 1 else args 1706 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 1707 1708 def lateral_sql(self, expression: exp.Lateral) -> str: 1709 this = self.sql(expression, "this") 1710 1711 if expression.args.get("view"): 1712 alias = expression.args["alias"] 1713 columns = self.expressions(alias, key="columns", flat=True) 1714 table = f" {alias.name}" if alias.name else "" 1715 columns = f" AS {columns}" if columns else "" 1716 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 1717 return f"{op_sql}{self.sep()}{this}{table}{columns}" 1718 1719 alias = self.sql(expression, "alias") 1720 alias = f" AS {alias}" if alias else "" 1721 return f"LATERAL {this}{alias}" 1722 1723 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 1724 this = self.sql(expression, "this") 1725 1726 args = [ 1727 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 1728 for e in (expression.args.get(k) for k in ("offset", "expression")) 1729 if e 1730 ] 1731 1732 args_sql = ", ".join(self.sql(e) for e in args) 1733 args_sql = f"({args_sql})" if any(top and not e.is_number for e in args) else args_sql 1734 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}" 1735 1736 def offset_sql(self, expression: exp.Offset) -> str: 1737 this = self.sql(expression, "this") 1738 expression = expression.expression 1739 expression = ( 1740 self._simplify_unless_literal(expression) if self.LIMIT_ONLY_LITERALS else expression 1741 ) 1742 return f"{this}{self.seg('OFFSET')} {self.sql(expression)}" 1743 1744 def setitem_sql(self, expression: exp.SetItem) -> str: 1745 kind = self.sql(expression, "kind") 1746 kind = f"{kind} " if kind else "" 1747 this = self.sql(expression, "this") 1748 expressions = self.expressions(expression) 1749 collate = self.sql(expression, "collate") 1750 collate = f" COLLATE {collate}" if collate else "" 1751 global_ = "GLOBAL " if expression.args.get("global") else "" 1752 return f"{global_}{kind}{this}{expressions}{collate}" 1753 1754 def set_sql(self, expression: exp.Set) -> str: 1755 expressions = ( 1756 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 1757 ) 1758 tag = " TAG" if expression.args.get("tag") else "" 1759 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 1760 1761 def pragma_sql(self, expression: exp.Pragma) -> str: 1762 return f"PRAGMA {self.sql(expression, 'this')}" 1763 1764 def lock_sql(self, expression: exp.Lock) -> str: 1765 if not self.LOCKING_READS_SUPPORTED: 1766 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 1767 return "" 1768 1769 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 1770 expressions = self.expressions(expression, flat=True) 1771 expressions = f" OF {expressions}" if expressions else "" 1772 wait = expression.args.get("wait") 1773 1774 if wait is not None: 1775 if isinstance(wait, exp.Literal): 1776 wait = f" WAIT {self.sql(wait)}" 1777 else: 1778 wait = " NOWAIT" if wait else " SKIP LOCKED" 1779 1780 return f"{lock_type}{expressions}{wait or ''}" 1781 1782 def literal_sql(self, expression: exp.Literal) -> str: 1783 text = expression.this or "" 1784 if expression.is_string: 1785 text = f"{self.QUOTE_START}{self.escape_str(text)}{self.QUOTE_END}" 1786 return text 1787 1788 def escape_str(self, text: str) -> str: 1789 text = text.replace(self.QUOTE_END, self._escaped_quote_end) 1790 if self.INVERSE_ESCAPE_SEQUENCES: 1791 text = "".join(self.INVERSE_ESCAPE_SEQUENCES.get(ch, ch) for ch in text) 1792 elif self.pretty: 1793 text = text.replace("\n", self.SENTINEL_LINE_BREAK) 1794 return text 1795 1796 def loaddata_sql(self, expression: exp.LoadData) -> str: 1797 local = " LOCAL" if expression.args.get("local") else "" 1798 inpath = f" INPATH {self.sql(expression, 'inpath')}" 1799 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 1800 this = f" INTO TABLE {self.sql(expression, 'this')}" 1801 partition = self.sql(expression, "partition") 1802 partition = f" {partition}" if partition else "" 1803 input_format = self.sql(expression, "input_format") 1804 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 1805 serde = self.sql(expression, "serde") 1806 serde = f" SERDE {serde}" if serde else "" 1807 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 1808 1809 def null_sql(self, *_) -> str: 1810 return "NULL" 1811 1812 def boolean_sql(self, expression: exp.Boolean) -> str: 1813 return "TRUE" if expression.this else "FALSE" 1814 1815 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 1816 this = self.sql(expression, "this") 1817 this = f"{this} " if this else this 1818 return self.op_expressions(f"{this}ORDER BY", expression, flat=this or flat) # type: ignore 1819 1820 def cluster_sql(self, expression: exp.Cluster) -> str: 1821 return self.op_expressions("CLUSTER BY", expression) 1822 1823 def distribute_sql(self, expression: exp.Distribute) -> str: 1824 return self.op_expressions("DISTRIBUTE BY", expression) 1825 1826 def sort_sql(self, expression: exp.Sort) -> str: 1827 return self.op_expressions("SORT BY", expression) 1828 1829 def ordered_sql(self, expression: exp.Ordered) -> str: 1830 desc = expression.args.get("desc") 1831 asc = not desc 1832 1833 nulls_first = expression.args.get("nulls_first") 1834 nulls_last = not nulls_first 1835 nulls_are_large = self.NULL_ORDERING == "nulls_are_large" 1836 nulls_are_small = self.NULL_ORDERING == "nulls_are_small" 1837 nulls_are_last = self.NULL_ORDERING == "nulls_are_last" 1838 1839 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 1840 nulls_sort_change = "" 1841 if nulls_first and ( 1842 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 1843 ): 1844 nulls_sort_change = " NULLS FIRST" 1845 elif ( 1846 nulls_last 1847 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 1848 and not nulls_are_last 1849 ): 1850 nulls_sort_change = " NULLS LAST" 1851 1852 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 1853 self.unsupported( 1854 "Sorting in an ORDER BY on NULLS FIRST/NULLS LAST is not supported by this dialect" 1855 ) 1856 nulls_sort_change = "" 1857 1858 return f"{self.sql(expression, 'this')}{sort_order}{nulls_sort_change}" 1859 1860 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 1861 partition = self.partition_by_sql(expression) 1862 order = self.sql(expression, "order") 1863 measures = self.expressions(expression, key="measures") 1864 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 1865 rows = self.sql(expression, "rows") 1866 rows = self.seg(rows) if rows else "" 1867 after = self.sql(expression, "after") 1868 after = self.seg(after) if after else "" 1869 pattern = self.sql(expression, "pattern") 1870 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 1871 definition_sqls = [ 1872 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 1873 for definition in expression.args.get("define", []) 1874 ] 1875 definitions = self.expressions(sqls=definition_sqls) 1876 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 1877 body = "".join( 1878 ( 1879 partition, 1880 order, 1881 measures, 1882 rows, 1883 after, 1884 pattern, 1885 define, 1886 ) 1887 ) 1888 alias = self.sql(expression, "alias") 1889 alias = f" {alias}" if alias else "" 1890 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 1891 1892 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 1893 limit: t.Optional[exp.Fetch | exp.Limit] = expression.args.get("limit") 1894 1895 # If the limit is generated as TOP, we need to ensure it's not generated twice 1896 with_offset_limit_modifiers = not isinstance(limit, exp.Limit) or not self.LIMIT_IS_TOP 1897 1898 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 1899 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 1900 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 1901 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 1902 1903 fetch = isinstance(limit, exp.Fetch) 1904 1905 offset_limit_modifiers = ( 1906 self.offset_limit_modifiers(expression, fetch, limit) 1907 if with_offset_limit_modifiers 1908 else [] 1909 ) 1910 1911 return csv( 1912 *sqls, 1913 *[self.sql(join) for join in expression.args.get("joins") or []], 1914 self.sql(expression, "connect"), 1915 self.sql(expression, "match"), 1916 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 1917 self.sql(expression, "where"), 1918 self.sql(expression, "group"), 1919 self.sql(expression, "having"), 1920 *self.after_having_modifiers(expression), 1921 self.sql(expression, "order"), 1922 *offset_limit_modifiers, 1923 *self.after_limit_modifiers(expression), 1924 sep="", 1925 ) 1926 1927 def offset_limit_modifiers( 1928 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 1929 ) -> t.List[str]: 1930 return [ 1931 self.sql(expression, "offset") if fetch else self.sql(limit), 1932 self.sql(limit) if fetch else self.sql(expression, "offset"), 1933 ] 1934 1935 def after_having_modifiers(self, expression: exp.Expression) -> t.List[str]: 1936 return [ 1937 self.sql(expression, "qualify"), 1938 self.seg("WINDOW ") + self.expressions(expression, key="windows", flat=True) 1939 if expression.args.get("windows") 1940 else "", 1941 self.sql(expression, "distribute"), 1942 self.sql(expression, "sort"), 1943 self.sql(expression, "cluster"), 1944 ] 1945 1946 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 1947 locks = self.expressions(expression, key="locks", sep=" ") 1948 locks = f" {locks}" if locks else "" 1949 return [locks, self.sql(expression, "sample")] 1950 1951 def select_sql(self, expression: exp.Select) -> str: 1952 hint = self.sql(expression, "hint") 1953 distinct = self.sql(expression, "distinct") 1954 distinct = f" {distinct}" if distinct else "" 1955 kind = self.sql(expression, "kind").upper() 1956 limit = expression.args.get("limit") 1957 top = ( 1958 self.limit_sql(limit, top=True) 1959 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP 1960 else "" 1961 ) 1962 1963 expressions = self.expressions(expression) 1964 1965 if kind: 1966 if kind in self.SELECT_KINDS: 1967 kind = f" AS {kind}" 1968 else: 1969 if kind == "STRUCT": 1970 expressions = self.expressions( 1971 sqls=[ 1972 self.sql( 1973 exp.Struct( 1974 expressions=[ 1975 exp.column(e.output_name).eq( 1976 e.this if isinstance(e, exp.Alias) else e 1977 ) 1978 for e in expression.expressions 1979 ] 1980 ) 1981 ) 1982 ] 1983 ) 1984 kind = "" 1985 1986 expressions = f"{self.sep()}{expressions}" if expressions else expressions 1987 sql = self.query_modifiers( 1988 expression, 1989 f"SELECT{top}{hint}{distinct}{kind}{expressions}", 1990 self.sql(expression, "into", comment=False), 1991 self.sql(expression, "from", comment=False), 1992 ) 1993 return self.prepend_ctes(expression, sql) 1994 1995 def schema_sql(self, expression: exp.Schema) -> str: 1996 this = self.sql(expression, "this") 1997 sql = self.schema_columns_sql(expression) 1998 return f"{this} {sql}" if this and sql else this or sql 1999 2000 def schema_columns_sql(self, expression: exp.Schema) -> str: 2001 if expression.expressions: 2002 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2003 return "" 2004 2005 def star_sql(self, expression: exp.Star) -> str: 2006 except_ = self.expressions(expression, key="except", flat=True) 2007 except_ = f"{self.seg(self.STAR_MAPPING['except'])} ({except_})" if except_ else "" 2008 replace = self.expressions(expression, key="replace", flat=True) 2009 replace = f"{self.seg(self.STAR_MAPPING['replace'])} ({replace})" if replace else "" 2010 return f"*{except_}{replace}" 2011 2012 def parameter_sql(self, expression: exp.Parameter) -> str: 2013 this = self.sql(expression, "this") 2014 return f"{self.PARAMETER_TOKEN}{this}" if self.SUPPORTS_PARAMETERS else this 2015 2016 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2017 this = self.sql(expression, "this") 2018 kind = expression.text("kind") 2019 if kind: 2020 kind = f"{kind}." 2021 return f"@@{kind}{this}" 2022 2023 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2024 return f":{expression.name}" if expression.name else "?" 2025 2026 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2027 alias = self.sql(expression, "alias") 2028 alias = f"{sep}{alias}" if alias else "" 2029 2030 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 2031 pivots = f" {pivots}" if pivots else "" 2032 2033 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2034 return self.prepend_ctes(expression, sql) 2035 2036 def qualify_sql(self, expression: exp.Qualify) -> str: 2037 this = self.indent(self.sql(expression, "this")) 2038 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2039 2040 def union_sql(self, expression: exp.Union) -> str: 2041 return self.prepend_ctes( 2042 expression, 2043 self.set_operation(expression, self.union_op(expression)), 2044 ) 2045 2046 def union_op(self, expression: exp.Union) -> str: 2047 kind = " DISTINCT" if self.EXPLICIT_UNION else "" 2048 kind = kind if expression.args.get("distinct") else " ALL" 2049 by_name = " BY NAME" if expression.args.get("by_name") else "" 2050 return f"UNION{kind}{by_name}" 2051 2052 def unnest_sql(self, expression: exp.Unnest) -> str: 2053 args = self.expressions(expression, flat=True) 2054 2055 alias = expression.args.get("alias") 2056 offset = expression.args.get("offset") 2057 2058 if self.UNNEST_WITH_ORDINALITY: 2059 if alias and isinstance(offset, exp.Expression): 2060 alias.append("columns", offset) 2061 2062 if alias and self.UNNEST_COLUMN_ONLY: 2063 columns = alias.columns 2064 alias = self.sql(columns[0]) if columns else "" 2065 else: 2066 alias = self.sql(alias) 2067 2068 alias = f" AS {alias}" if alias else alias 2069 if self.UNNEST_WITH_ORDINALITY: 2070 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2071 else: 2072 if isinstance(offset, exp.Expression): 2073 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2074 elif offset: 2075 suffix = f"{alias} WITH OFFSET" 2076 else: 2077 suffix = alias 2078 2079 return f"UNNEST({args}){suffix}" 2080 2081 def where_sql(self, expression: exp.Where) -> str: 2082 this = self.indent(self.sql(expression, "this")) 2083 return f"{self.seg('WHERE')}{self.sep()}{this}" 2084 2085 def window_sql(self, expression: exp.Window) -> str: 2086 this = self.sql(expression, "this") 2087 partition = self.partition_by_sql(expression) 2088 order = expression.args.get("order") 2089 order = self.order_sql(order, flat=True) if order else "" 2090 spec = self.sql(expression, "spec") 2091 alias = self.sql(expression, "alias") 2092 over = self.sql(expression, "over") or "OVER" 2093 2094 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2095 2096 first = expression.args.get("first") 2097 if first is None: 2098 first = "" 2099 else: 2100 first = "FIRST" if first else "LAST" 2101 2102 if not partition and not order and not spec and alias: 2103 return f"{this} {alias}" 2104 2105 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2106 return f"{this} ({args})" 2107 2108 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2109 partition = self.expressions(expression, key="partition_by", flat=True) 2110 return f"PARTITION BY {partition}" if partition else "" 2111 2112 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2113 kind = self.sql(expression, "kind") 2114 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2115 end = ( 2116 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2117 or "CURRENT ROW" 2118 ) 2119 return f"{kind} BETWEEN {start} AND {end}" 2120 2121 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2122 this = self.sql(expression, "this") 2123 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2124 return f"{this} WITHIN GROUP ({expression_sql})" 2125 2126 def between_sql(self, expression: exp.Between) -> str: 2127 this = self.sql(expression, "this") 2128 low = self.sql(expression, "low") 2129 high = self.sql(expression, "high") 2130 return f"{this} BETWEEN {low} AND {high}" 2131 2132 def bracket_sql(self, expression: exp.Bracket) -> str: 2133 expressions = apply_index_offset(expression.this, expression.expressions, self.INDEX_OFFSET) 2134 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2135 2136 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2137 2138 def safebracket_sql(self, expression: exp.SafeBracket) -> str: 2139 return self.bracket_sql(expression) 2140 2141 def all_sql(self, expression: exp.All) -> str: 2142 return f"ALL {self.wrap(expression)}" 2143 2144 def any_sql(self, expression: exp.Any) -> str: 2145 this = self.sql(expression, "this") 2146 if isinstance(expression.this, exp.Subqueryable): 2147 this = self.wrap(this) 2148 return f"ANY {this}" 2149 2150 def exists_sql(self, expression: exp.Exists) -> str: 2151 return f"EXISTS{self.wrap(expression)}" 2152 2153 def case_sql(self, expression: exp.Case) -> str: 2154 this = self.sql(expression, "this") 2155 statements = [f"CASE {this}" if this else "CASE"] 2156 2157 for e in expression.args["ifs"]: 2158 statements.append(f"WHEN {self.sql(e, 'this')}") 2159 statements.append(f"THEN {self.sql(e, 'true')}") 2160 2161 default = self.sql(expression, "default") 2162 2163 if default: 2164 statements.append(f"ELSE {default}") 2165 2166 statements.append("END") 2167 2168 if self.pretty and self.text_width(statements) > self.max_text_width: 2169 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2170 2171 return " ".join(statements) 2172 2173 def constraint_sql(self, expression: exp.Constraint) -> str: 2174 this = self.sql(expression, "this") 2175 expressions = self.expressions(expression, flat=True) 2176 return f"CONSTRAINT {this} {expressions}" 2177 2178 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2179 order = expression.args.get("order") 2180 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2181 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2182 2183 def extract_sql(self, expression: exp.Extract) -> str: 2184 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2185 expression_sql = self.sql(expression, "expression") 2186 return f"EXTRACT({this} FROM {expression_sql})" 2187 2188 def trim_sql(self, expression: exp.Trim) -> str: 2189 trim_type = self.sql(expression, "position") 2190 2191 if trim_type == "LEADING": 2192 return self.func("LTRIM", expression.this) 2193 elif trim_type == "TRAILING": 2194 return self.func("RTRIM", expression.this) 2195 else: 2196 return self.func("TRIM", expression.this, expression.expression) 2197 2198 def safeconcat_sql(self, expression: exp.SafeConcat) -> str: 2199 expressions = expression.expressions 2200 if self.STRICT_STRING_CONCAT: 2201 expressions = [exp.cast(e, "text") for e in expressions] 2202 return self.func("CONCAT", *expressions) 2203 2204 def check_sql(self, expression: exp.Check) -> str: 2205 this = self.sql(expression, key="this") 2206 return f"CHECK ({this})" 2207 2208 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2209 expressions = self.expressions(expression, flat=True) 2210 reference = self.sql(expression, "reference") 2211 reference = f" {reference}" if reference else "" 2212 delete = self.sql(expression, "delete") 2213 delete = f" ON DELETE {delete}" if delete else "" 2214 update = self.sql(expression, "update") 2215 update = f" ON UPDATE {update}" if update else "" 2216 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}" 2217 2218 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2219 expressions = self.expressions(expression, flat=True) 2220 options = self.expressions(expression, key="options", flat=True, sep=" ") 2221 options = f" {options}" if options else "" 2222 return f"PRIMARY KEY ({expressions}){options}" 2223 2224 def if_sql(self, expression: exp.If) -> str: 2225 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2226 2227 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2228 modifier = expression.args.get("modifier") 2229 modifier = f" {modifier}" if modifier else "" 2230 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2231 2232 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2233 return f"{self.sql(expression, 'this')}: {self.sql(expression, 'expression')}" 2234 2235 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2236 return f"{self.sql(expression, 'this')} FORMAT JSON" 2237 2238 def jsonobject_sql(self, expression: exp.JSONObject) -> str: 2239 null_handling = expression.args.get("null_handling") 2240 null_handling = f" {null_handling}" if null_handling else "" 2241 unique_keys = expression.args.get("unique_keys") 2242 if unique_keys is not None: 2243 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2244 else: 2245 unique_keys = "" 2246 return_type = self.sql(expression, "return_type") 2247 return_type = f" RETURNING {return_type}" if return_type else "" 2248 encoding = self.sql(expression, "encoding") 2249 encoding = f" ENCODING {encoding}" if encoding else "" 2250 return self.func( 2251 "JSON_OBJECT", 2252 *expression.expressions, 2253 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2254 ) 2255 2256 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2257 null_handling = expression.args.get("null_handling") 2258 null_handling = f" {null_handling}" if null_handling else "" 2259 return_type = self.sql(expression, "return_type") 2260 return_type = f" RETURNING {return_type}" if return_type else "" 2261 strict = " STRICT" if expression.args.get("strict") else "" 2262 return self.func( 2263 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2264 ) 2265 2266 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2267 this = self.sql(expression, "this") 2268 order = self.sql(expression, "order") 2269 null_handling = expression.args.get("null_handling") 2270 null_handling = f" {null_handling}" if null_handling else "" 2271 return_type = self.sql(expression, "return_type") 2272 return_type = f" RETURNING {return_type}" if return_type else "" 2273 strict = " STRICT" if expression.args.get("strict") else "" 2274 return self.func( 2275 "JSON_ARRAYAGG", 2276 this, 2277 suffix=f"{order}{null_handling}{return_type}{strict})", 2278 ) 2279 2280 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2281 path = self.sql(expression, "path") 2282 path = f" PATH {path}" if path else "" 2283 nested_schema = self.sql(expression, "nested_schema") 2284 2285 if nested_schema: 2286 return f"NESTED{path} {nested_schema}" 2287 2288 this = self.sql(expression, "this") 2289 kind = self.sql(expression, "kind") 2290 kind = f" {kind}" if kind else "" 2291 return f"{this}{kind}{path}" 2292 2293 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2294 return self.func("COLUMNS", *expression.expressions) 2295 2296 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2297 this = self.sql(expression, "this") 2298 path = self.sql(expression, "path") 2299 path = f", {path}" if path else "" 2300 error_handling = expression.args.get("error_handling") 2301 error_handling = f" {error_handling}" if error_handling else "" 2302 empty_handling = expression.args.get("empty_handling") 2303 empty_handling = f" {empty_handling}" if empty_handling else "" 2304 schema = self.sql(expression, "schema") 2305 return self.func( 2306 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2307 ) 2308 2309 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2310 this = self.sql(expression, "this") 2311 kind = self.sql(expression, "kind") 2312 path = self.sql(expression, "path") 2313 path = f" {path}" if path else "" 2314 as_json = " AS JSON" if expression.args.get("as_json") else "" 2315 return f"{this} {kind}{path}{as_json}" 2316 2317 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2318 this = self.sql(expression, "this") 2319 path = self.sql(expression, "path") 2320 path = f", {path}" if path else "" 2321 expressions = self.expressions(expression) 2322 with_ = ( 2323 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2324 if expressions 2325 else "" 2326 ) 2327 return f"OPENJSON({this}{path}){with_}" 2328 2329 def in_sql(self, expression: exp.In) -> str: 2330 query = expression.args.get("query") 2331 unnest = expression.args.get("unnest") 2332 field = expression.args.get("field") 2333 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2334 2335 if query: 2336 in_sql = self.wrap(query) 2337 elif unnest: 2338 in_sql = self.in_unnest_op(unnest) 2339 elif field: 2340 in_sql = self.sql(field) 2341 else: 2342 in_sql = f"({self.expressions(expression, flat=True)})" 2343 2344 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 2345 2346 def in_unnest_op(self, unnest: exp.Unnest) -> str: 2347 return f"(SELECT {self.sql(unnest)})" 2348 2349 def interval_sql(self, expression: exp.Interval) -> str: 2350 unit = self.sql(expression, "unit") 2351 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2352 unit = self.TIME_PART_SINGULARS.get(unit.lower(), unit) 2353 unit = f" {unit}" if unit else "" 2354 2355 if self.SINGLE_STRING_INTERVAL: 2356 this = expression.this.name if expression.this else "" 2357 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2358 2359 this = self.sql(expression, "this") 2360 if this: 2361 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2362 this = f" {this}" if unwrapped else f" ({this})" 2363 2364 return f"INTERVAL{this}{unit}" 2365 2366 def return_sql(self, expression: exp.Return) -> str: 2367 return f"RETURN {self.sql(expression, 'this')}" 2368 2369 def reference_sql(self, expression: exp.Reference) -> str: 2370 this = self.sql(expression, "this") 2371 expressions = self.expressions(expression, flat=True) 2372 expressions = f"({expressions})" if expressions else "" 2373 options = self.expressions(expression, key="options", flat=True, sep=" ") 2374 options = f" {options}" if options else "" 2375 return f"REFERENCES {this}{expressions}{options}" 2376 2377 def anonymous_sql(self, expression: exp.Anonymous) -> str: 2378 return self.func(expression.name, *expression.expressions) 2379 2380 def paren_sql(self, expression: exp.Paren) -> str: 2381 if isinstance(expression.unnest(), exp.Select): 2382 sql = self.wrap(expression) 2383 else: 2384 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 2385 sql = f"({sql}{self.seg(')', sep='')}" 2386 2387 return self.prepend_ctes(expression, sql) 2388 2389 def neg_sql(self, expression: exp.Neg) -> str: 2390 # This makes sure we don't convert "- - 5" to "--5", which is a comment 2391 this_sql = self.sql(expression, "this") 2392 sep = " " if this_sql[0] == "-" else "" 2393 return f"-{sep}{this_sql}" 2394 2395 def not_sql(self, expression: exp.Not) -> str: 2396 return f"NOT {self.sql(expression, 'this')}" 2397 2398 def alias_sql(self, expression: exp.Alias) -> str: 2399 alias = self.sql(expression, "alias") 2400 alias = f" AS {alias}" if alias else "" 2401 return f"{self.sql(expression, 'this')}{alias}" 2402 2403 def aliases_sql(self, expression: exp.Aliases) -> str: 2404 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 2405 2406 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 2407 this = self.sql(expression, "this") 2408 zone = self.sql(expression, "zone") 2409 return f"{this} AT TIME ZONE {zone}" 2410 2411 def add_sql(self, expression: exp.Add) -> str: 2412 return self.binary(expression, "+") 2413 2414 def and_sql(self, expression: exp.And) -> str: 2415 return self.connector_sql(expression, "AND") 2416 2417 def xor_sql(self, expression: exp.Xor) -> str: 2418 return self.connector_sql(expression, "XOR") 2419 2420 def connector_sql(self, expression: exp.Connector, op: str) -> str: 2421 if not self.pretty: 2422 return self.binary(expression, op) 2423 2424 sqls = tuple( 2425 self.maybe_comment(self.sql(e), e, e.parent.comments or []) if i != 1 else self.sql(e) 2426 for i, e in enumerate(expression.flatten(unnest=False)) 2427 ) 2428 2429 sep = "\n" if self.text_width(sqls) > self.max_text_width else " " 2430 return f"{sep}{op} ".join(sqls) 2431 2432 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 2433 return self.binary(expression, "&") 2434 2435 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 2436 return self.binary(expression, "<<") 2437 2438 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 2439 return f"~{self.sql(expression, 'this')}" 2440 2441 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 2442 return self.binary(expression, "|") 2443 2444 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 2445 return self.binary(expression, ">>") 2446 2447 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 2448 return self.binary(expression, "^") 2449 2450 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 2451 format_sql = self.sql(expression, "format") 2452 format_sql = f" FORMAT {format_sql}" if format_sql else "" 2453 to_sql = self.sql(expression, "to") 2454 to_sql = f" {to_sql}" if to_sql else "" 2455 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql})" 2456 2457 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 2458 zone = self.sql(expression, "this") 2459 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 2460 2461 def collate_sql(self, expression: exp.Collate) -> str: 2462 if self.COLLATE_IS_FUNC: 2463 return self.function_fallback_sql(expression) 2464 return self.binary(expression, "COLLATE") 2465 2466 def command_sql(self, expression: exp.Command) -> str: 2467 return f"{self.sql(expression, 'this').upper()} {expression.text('expression').strip()}" 2468 2469 def comment_sql(self, expression: exp.Comment) -> str: 2470 this = self.sql(expression, "this") 2471 kind = expression.args["kind"] 2472 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 2473 expression_sql = self.sql(expression, "expression") 2474 return f"COMMENT{exists_sql}ON {kind} {this} IS {expression_sql}" 2475 2476 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 2477 this = self.sql(expression, "this") 2478 delete = " DELETE" if expression.args.get("delete") else "" 2479 recompress = self.sql(expression, "recompress") 2480 recompress = f" RECOMPRESS {recompress}" if recompress else "" 2481 to_disk = self.sql(expression, "to_disk") 2482 to_disk = f" TO DISK {to_disk}" if to_disk else "" 2483 to_volume = self.sql(expression, "to_volume") 2484 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 2485 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 2486 2487 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 2488 where = self.sql(expression, "where") 2489 group = self.sql(expression, "group") 2490 aggregates = self.expressions(expression, key="aggregates") 2491 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 2492 2493 if not (where or group or aggregates) and len(expression.expressions) == 1: 2494 return f"TTL {self.expressions(expression, flat=True)}" 2495 2496 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 2497 2498 def transaction_sql(self, expression: exp.Transaction) -> str: 2499 return "BEGIN" 2500 2501 def commit_sql(self, expression: exp.Commit) -> str: 2502 chain = expression.args.get("chain") 2503 if chain is not None: 2504 chain = " AND CHAIN" if chain else " AND NO CHAIN" 2505 2506 return f"COMMIT{chain or ''}" 2507 2508 def rollback_sql(self, expression: exp.Rollback) -> str: 2509 savepoint = expression.args.get("savepoint") 2510 savepoint = f" TO {savepoint}" if savepoint else "" 2511 return f"ROLLBACK{savepoint}" 2512 2513 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 2514 this = self.sql(expression, "this") 2515 2516 dtype = self.sql(expression, "dtype") 2517 if dtype: 2518 collate = self.sql(expression, "collate") 2519 collate = f" COLLATE {collate}" if collate else "" 2520 using = self.sql(expression, "using") 2521 using = f" USING {using}" if using else "" 2522 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 2523 2524 default = self.sql(expression, "default") 2525 if default: 2526 return f"ALTER COLUMN {this} SET DEFAULT {default}" 2527 2528 if not expression.args.get("drop"): 2529 self.unsupported("Unsupported ALTER COLUMN syntax") 2530 2531 return f"ALTER COLUMN {this} DROP DEFAULT" 2532 2533 def renametable_sql(self, expression: exp.RenameTable) -> str: 2534 if not self.RENAME_TABLE_WITH_DB: 2535 # Remove db from tables 2536 expression = expression.transform( 2537 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 2538 ) 2539 this = self.sql(expression, "this") 2540 return f"RENAME TO {this}" 2541 2542 def altertable_sql(self, expression: exp.AlterTable) -> str: 2543 actions = expression.args["actions"] 2544 2545 if isinstance(actions[0], exp.ColumnDef): 2546 actions = self.add_column_sql(expression) 2547 elif isinstance(actions[0], exp.Schema): 2548 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 2549 elif isinstance(actions[0], exp.Delete): 2550 actions = self.expressions(expression, key="actions", flat=True) 2551 else: 2552 actions = self.expressions(expression, key="actions", flat=True) 2553 2554 exists = " IF EXISTS" if expression.args.get("exists") else "" 2555 only = " ONLY" if expression.args.get("only") else "" 2556 return f"ALTER TABLE{exists}{only} {self.sql(expression, 'this')} {actions}" 2557 2558 def add_column_sql(self, expression: exp.AlterTable) -> str: 2559 if self.ALTER_TABLE_ADD_COLUMN_KEYWORD: 2560 return self.expressions( 2561 expression, 2562 key="actions", 2563 prefix="ADD COLUMN ", 2564 ) 2565 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 2566 2567 def droppartition_sql(self, expression: exp.DropPartition) -> str: 2568 expressions = self.expressions(expression) 2569 exists = " IF EXISTS " if expression.args.get("exists") else " " 2570 return f"DROP{exists}{expressions}" 2571 2572 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 2573 this = self.sql(expression, "this") 2574 expression_ = self.sql(expression, "expression") 2575 add_constraint = f"ADD CONSTRAINT {this}" if this else "ADD" 2576 2577 enforced = expression.args.get("enforced") 2578 if enforced is not None: 2579 return f"{add_constraint} CHECK ({expression_}){' ENFORCED' if enforced else ''}" 2580 2581 return f"{add_constraint} {expression_}" 2582 2583 def distinct_sql(self, expression: exp.Distinct) -> str: 2584 this = self.expressions(expression, flat=True) 2585 this = f" {this}" if this else "" 2586 2587 on = self.sql(expression, "on") 2588 on = f" ON {on}" if on else "" 2589 return f"DISTINCT{this}{on}" 2590 2591 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 2592 return f"{self.sql(expression, 'this')} IGNORE NULLS" 2593 2594 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 2595 return f"{self.sql(expression, 'this')} RESPECT NULLS" 2596 2597 def intdiv_sql(self, expression: exp.IntDiv) -> str: 2598 return self.sql( 2599 exp.Cast( 2600 this=exp.Div(this=expression.this, expression=expression.expression), 2601 to=exp.DataType(this=exp.DataType.Type.INT), 2602 ) 2603 ) 2604 2605 def dpipe_sql(self, expression: exp.DPipe) -> str: 2606 return self.binary(expression, "||") 2607 2608 def safedpipe_sql(self, expression: exp.SafeDPipe) -> str: 2609 if self.STRICT_STRING_CONCAT: 2610 return self.func("CONCAT", *(exp.cast(e, "text") for e in expression.flatten())) 2611 return self.dpipe_sql(expression) 2612 2613 def div_sql(self, expression: exp.Div) -> str: 2614 l, r = expression.left, expression.right 2615 2616 if not self.SAFE_DIVISION and expression.args.get("safe"): 2617 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 2618 2619 if self.TYPED_DIVISION and not expression.args.get("typed"): 2620 if not l.is_type(*exp.DataType.FLOAT_TYPES) and not r.is_type( 2621 *exp.DataType.FLOAT_TYPES 2622 ): 2623 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 2624 2625 elif not self.TYPED_DIVISION and expression.args.get("typed"): 2626 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 2627 return self.sql( 2628 exp.cast( 2629 l / r, 2630 to=exp.DataType.Type.BIGINT, 2631 ) 2632 ) 2633 2634 return self.binary(expression, "/") 2635 2636 def overlaps_sql(self, expression: exp.Overlaps) -> str: 2637 return self.binary(expression, "OVERLAPS") 2638 2639 def distance_sql(self, expression: exp.Distance) -> str: 2640 return self.binary(expression, "<->") 2641 2642 def dot_sql(self, expression: exp.Dot) -> str: 2643 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 2644 2645 def eq_sql(self, expression: exp.EQ) -> str: 2646 return self.binary(expression, "=") 2647 2648 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 2649 return self.binary(expression, "=") 2650 2651 def escape_sql(self, expression: exp.Escape) -> str: 2652 return self.binary(expression, "ESCAPE") 2653 2654 def glob_sql(self, expression: exp.Glob) -> str: 2655 return self.binary(expression, "GLOB") 2656 2657 def gt_sql(self, expression: exp.GT) -> str: 2658 return self.binary(expression, ">") 2659 2660 def gte_sql(self, expression: exp.GTE) -> str: 2661 return self.binary(expression, ">=") 2662 2663 def ilike_sql(self, expression: exp.ILike) -> str: 2664 return self.binary(expression, "ILIKE") 2665 2666 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 2667 return self.binary(expression, "ILIKE ANY") 2668 2669 def is_sql(self, expression: exp.Is) -> str: 2670 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 2671 return self.sql( 2672 expression.this if expression.expression.this else exp.not_(expression.this) 2673 ) 2674 return self.binary(expression, "IS") 2675 2676 def like_sql(self, expression: exp.Like) -> str: 2677 return self.binary(expression, "LIKE") 2678 2679 def likeany_sql(self, expression: exp.LikeAny) -> str: 2680 return self.binary(expression, "LIKE ANY") 2681 2682 def similarto_sql(self, expression: exp.SimilarTo) -> str: 2683 return self.binary(expression, "SIMILAR TO") 2684 2685 def lt_sql(self, expression: exp.LT) -> str: 2686 return self.binary(expression, "<") 2687 2688 def lte_sql(self, expression: exp.LTE) -> str: 2689 return self.binary(expression, "<=") 2690 2691 def mod_sql(self, expression: exp.Mod) -> str: 2692 return self.binary(expression, "%") 2693 2694 def mul_sql(self, expression: exp.Mul) -> str: 2695 return self.binary(expression, "*") 2696 2697 def neq_sql(self, expression: exp.NEQ) -> str: 2698 return self.binary(expression, "<>") 2699 2700 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 2701 return self.binary(expression, "IS NOT DISTINCT FROM") 2702 2703 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 2704 return self.binary(expression, "IS DISTINCT FROM") 2705 2706 def or_sql(self, expression: exp.Or) -> str: 2707 return self.connector_sql(expression, "OR") 2708 2709 def slice_sql(self, expression: exp.Slice) -> str: 2710 return self.binary(expression, ":") 2711 2712 def sub_sql(self, expression: exp.Sub) -> str: 2713 return self.binary(expression, "-") 2714 2715 def trycast_sql(self, expression: exp.TryCast) -> str: 2716 return self.cast_sql(expression, safe_prefix="TRY_") 2717 2718 def log_sql(self, expression: exp.Log) -> str: 2719 args = list(expression.args.values()) 2720 if not self.LOG_BASE_FIRST: 2721 args.reverse() 2722 return self.func("LOG", *args) 2723 2724 def use_sql(self, expression: exp.Use) -> str: 2725 kind = self.sql(expression, "kind") 2726 kind = f" {kind}" if kind else "" 2727 this = self.sql(expression, "this") 2728 this = f" {this}" if this else "" 2729 return f"USE{kind}{this}" 2730 2731 def binary(self, expression: exp.Binary, op: str) -> str: 2732 op = self.maybe_comment(op, comments=expression.comments) 2733 return f"{self.sql(expression, 'this')} {op} {self.sql(expression, 'expression')}" 2734 2735 def function_fallback_sql(self, expression: exp.Func) -> str: 2736 args = [] 2737 2738 for key in expression.arg_types: 2739 arg_value = expression.args.get(key) 2740 2741 if isinstance(arg_value, list): 2742 for value in arg_value: 2743 args.append(value) 2744 elif arg_value is not None: 2745 args.append(arg_value) 2746 2747 if self.normalize_functions: 2748 name = expression.sql_name() 2749 else: 2750 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 2751 2752 return self.func(name, *args) 2753 2754 def func( 2755 self, 2756 name: str, 2757 *args: t.Optional[exp.Expression | str], 2758 prefix: str = "(", 2759 suffix: str = ")", 2760 ) -> str: 2761 return f"{self.normalize_func(name)}{prefix}{self.format_args(*args)}{suffix}" 2762 2763 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 2764 arg_sqls = tuple(self.sql(arg) for arg in args if arg is not None) 2765 if self.pretty and self.text_width(arg_sqls) > self.max_text_width: 2766 return self.indent("\n" + f",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 2767 return ", ".join(arg_sqls) 2768 2769 def text_width(self, args: t.Iterable) -> int: 2770 return sum(len(arg) for arg in args) 2771 2772 def format_time(self, expression: exp.Expression) -> t.Optional[str]: 2773 return format_time( 2774 self.sql(expression, "format"), self.INVERSE_TIME_MAPPING, self.INVERSE_TIME_TRIE 2775 ) 2776 2777 def expressions( 2778 self, 2779 expression: t.Optional[exp.Expression] = None, 2780 key: t.Optional[str] = None, 2781 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 2782 flat: bool = False, 2783 indent: bool = True, 2784 skip_first: bool = False, 2785 sep: str = ", ", 2786 prefix: str = "", 2787 ) -> str: 2788 expressions = expression.args.get(key or "expressions") if expression else sqls 2789 2790 if not expressions: 2791 return "" 2792 2793 if flat: 2794 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 2795 2796 num_sqls = len(expressions) 2797 2798 # These are calculated once in case we have the leading_comma / pretty option set, correspondingly 2799 pad = " " * self.pad 2800 stripped_sep = sep.strip() 2801 2802 result_sqls = [] 2803 for i, e in enumerate(expressions): 2804 sql = self.sql(e, comment=False) 2805 if not sql: 2806 continue 2807 2808 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 2809 2810 if self.pretty: 2811 if self.leading_comma: 2812 result_sqls.append(f"{sep if i > 0 else pad}{prefix}{sql}{comments}") 2813 else: 2814 result_sqls.append( 2815 f"{prefix}{sql}{stripped_sep if i + 1 < num_sqls else ''}{comments}" 2816 ) 2817 else: 2818 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 2819 2820 result_sql = "\n".join(result_sqls) if self.pretty else "".join(result_sqls) 2821 return self.indent(result_sql, skip_first=skip_first) if indent else result_sql 2822 2823 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 2824 flat = flat or isinstance(expression.parent, exp.Properties) 2825 expressions_sql = self.expressions(expression, flat=flat) 2826 if flat: 2827 return f"{op} {expressions_sql}" 2828 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 2829 2830 def naked_property(self, expression: exp.Property) -> str: 2831 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 2832 if not property_name: 2833 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 2834 return f"{property_name} {self.sql(expression, 'this')}" 2835 2836 def set_operation(self, expression: exp.Union, op: str) -> str: 2837 this = self.maybe_comment(self.sql(expression, "this"), comments=expression.comments) 2838 op = self.seg(op) 2839 return self.query_modifiers( 2840 expression, f"{this}{op}{self.sep()}{self.sql(expression, 'expression')}" 2841 ) 2842 2843 def tag_sql(self, expression: exp.Tag) -> str: 2844 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 2845 2846 def token_sql(self, token_type: TokenType) -> str: 2847 return self.TOKEN_MAPPING.get(token_type, token_type.name) 2848 2849 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 2850 this = self.sql(expression, "this") 2851 expressions = self.no_identify(self.expressions, expression) 2852 expressions = ( 2853 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 2854 ) 2855 return f"{this}{expressions}" 2856 2857 def joinhint_sql(self, expression: exp.JoinHint) -> str: 2858 this = self.sql(expression, "this") 2859 expressions = self.expressions(expression, flat=True) 2860 return f"{this}({expressions})" 2861 2862 def kwarg_sql(self, expression: exp.Kwarg) -> str: 2863 return self.binary(expression, "=>") 2864 2865 def when_sql(self, expression: exp.When) -> str: 2866 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 2867 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 2868 condition = self.sql(expression, "condition") 2869 condition = f" AND {condition}" if condition else "" 2870 2871 then_expression = expression.args.get("then") 2872 if isinstance(then_expression, exp.Insert): 2873 then = f"INSERT {self.sql(then_expression, 'this')}" 2874 if "expression" in then_expression.args: 2875 then += f" VALUES {self.sql(then_expression, 'expression')}" 2876 elif isinstance(then_expression, exp.Update): 2877 if isinstance(then_expression.args.get("expressions"), exp.Star): 2878 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 2879 else: 2880 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 2881 else: 2882 then = self.sql(then_expression) 2883 return f"WHEN {matched}{source}{condition} THEN {then}" 2884 2885 def merge_sql(self, expression: exp.Merge) -> str: 2886 table = expression.this 2887 table_alias = "" 2888 2889 hints = table.args.get("hints") 2890 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 2891 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 2892 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 2893 2894 this = self.sql(table) 2895 using = f"USING {self.sql(expression, 'using')}" 2896 on = f"ON {self.sql(expression, 'on')}" 2897 expressions = self.expressions(expression, sep=" ") 2898 2899 return self.prepend_ctes( 2900 expression, f"MERGE INTO {this}{table_alias} {using} {on} {expressions}" 2901 ) 2902 2903 def tochar_sql(self, expression: exp.ToChar) -> str: 2904 if expression.args.get("format"): 2905 self.unsupported("Format argument unsupported for TO_CHAR/TO_VARCHAR function") 2906 2907 return self.sql(exp.cast(expression.this, "text")) 2908 2909 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 2910 this = self.sql(expression, "this") 2911 kind = self.sql(expression, "kind") 2912 settings_sql = self.expressions(expression, key="settings", sep=" ") 2913 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 2914 return f"{this}({kind}{args})" 2915 2916 def dictrange_sql(self, expression: exp.DictRange) -> str: 2917 this = self.sql(expression, "this") 2918 max = self.sql(expression, "max") 2919 min = self.sql(expression, "min") 2920 return f"{this}(MIN {min} MAX {max})" 2921 2922 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 2923 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 2924 2925 def oncluster_sql(self, expression: exp.OnCluster) -> str: 2926 return "" 2927 2928 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 2929 expressions = self.expressions(expression, key="expressions", flat=True) 2930 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 2931 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 2932 buckets = self.sql(expression, "buckets") 2933 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 2934 2935 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 2936 this = self.sql(expression, "this") 2937 having = self.sql(expression, "having") 2938 2939 if having: 2940 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 2941 2942 return self.func("ANY_VALUE", this) 2943 2944 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 2945 transform = self.func("TRANSFORM", *expression.expressions) 2946 row_format_before = self.sql(expression, "row_format_before") 2947 row_format_before = f" {row_format_before}" if row_format_before else "" 2948 record_writer = self.sql(expression, "record_writer") 2949 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 2950 using = f" USING {self.sql(expression, 'command_script')}" 2951 schema = self.sql(expression, "schema") 2952 schema = f" AS {schema}" if schema else "" 2953 row_format_after = self.sql(expression, "row_format_after") 2954 row_format_after = f" {row_format_after}" if row_format_after else "" 2955 record_reader = self.sql(expression, "record_reader") 2956 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 2957 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 2958 2959 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 2960 key_block_size = self.sql(expression, "key_block_size") 2961 if key_block_size: 2962 return f"KEY_BLOCK_SIZE = {key_block_size}" 2963 2964 using = self.sql(expression, "using") 2965 if using: 2966 return f"USING {using}" 2967 2968 parser = self.sql(expression, "parser") 2969 if parser: 2970 return f"WITH PARSER {parser}" 2971 2972 comment = self.sql(expression, "comment") 2973 if comment: 2974 return f"COMMENT {comment}" 2975 2976 visible = expression.args.get("visible") 2977 if visible is not None: 2978 return "VISIBLE" if visible else "INVISIBLE" 2979 2980 engine_attr = self.sql(expression, "engine_attr") 2981 if engine_attr: 2982 return f"ENGINE_ATTRIBUTE = {engine_attr}" 2983 2984 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 2985 if secondary_engine_attr: 2986 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 2987 2988 self.unsupported("Unsupported index constraint option.") 2989 return "" 2990 2991 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 2992 kind = self.sql(expression, "kind") 2993 kind = f"{kind} INDEX" if kind else "INDEX" 2994 this = self.sql(expression, "this") 2995 this = f" {this}" if this else "" 2996 index_type = self.sql(expression, "index_type") 2997 index_type = f" USING {index_type}" if index_type else "" 2998 schema = self.sql(expression, "schema") 2999 schema = f" {schema}" if schema else "" 3000 options = self.expressions(expression, key="options", sep=" ") 3001 options = f" {options}" if options else "" 3002 return f"{kind}{this}{index_type}{schema}{options}" 3003 3004 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3005 if self.NVL2_SUPPORTED: 3006 return self.function_fallback_sql(expression) 3007 3008 case = exp.Case().when( 3009 expression.this.is_(exp.null()).not_(copy=False), 3010 expression.args["true"], 3011 copy=False, 3012 ) 3013 else_cond = expression.args.get("false") 3014 if else_cond: 3015 case.else_(else_cond, copy=False) 3016 3017 return self.sql(case) 3018 3019 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3020 this = self.sql(expression, "this") 3021 expr = self.sql(expression, "expression") 3022 iterator = self.sql(expression, "iterator") 3023 condition = self.sql(expression, "condition") 3024 condition = f" IF {condition}" if condition else "" 3025 return f"{this} FOR {expr} IN {iterator}{condition}" 3026 3027 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3028 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3029 3030 def opclass_sql(self, expression: exp.Opclass) -> str: 3031 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3032 3033 def predict_sql(self, expression: exp.Predict) -> str: 3034 model = self.sql(expression, "this") 3035 model = f"MODEL {model}" 3036 table = self.sql(expression, "expression") 3037 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3038 parameters = self.sql(expression, "params_struct") 3039 return self.func("PREDICT", model, table, parameters or None) 3040 3041 def forin_sql(self, expression: exp.ForIn) -> str: 3042 this = self.sql(expression, "this") 3043 expression_sql = self.sql(expression, "expression") 3044 return f"FOR {this} DO {expression_sql}" 3045 3046 def refresh_sql(self, expression: exp.Refresh) -> str: 3047 this = self.sql(expression, "this") 3048 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3049 return f"REFRESH {table}{this}" 3050 3051 def _simplify_unless_literal(self, expression: E) -> E: 3052 if not isinstance(expression, exp.Literal): 3053 from sqlglot.optimizer.simplify import simplify 3054 3055 expression = simplify(expression) 3056 3057 return expression
logger =
<Logger sqlglot (WARNING)>
class
Generator:
21class Generator: 22 """ 23 Generator converts a given syntax tree to the corresponding SQL string. 24 25 Args: 26 pretty: Whether or not to format the produced SQL string. 27 Default: False. 28 identify: Determines when an identifier should be quoted. Possible values are: 29 False (default): Never quote, except in cases where it's mandatory by the dialect. 30 True or 'always': Always quote. 31 'safe': Only quote identifiers that are case insensitive. 32 normalize: Whether or not to normalize identifiers to lowercase. 33 Default: False. 34 pad: Determines the pad size in a formatted string. 35 Default: 2. 36 indent: Determines the indentation size in a formatted string. 37 Default: 2. 38 normalize_functions: Whether or not to normalize all function names. Possible values are: 39 "upper" or True (default): Convert names to uppercase. 40 "lower": Convert names to lowercase. 41 False: Disables function name normalization. 42 unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. 43 Default ErrorLevel.WARN. 44 max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. 45 This is only relevant if unsupported_level is ErrorLevel.RAISE. 46 Default: 3 47 leading_comma: Determines whether or not the comma is leading or trailing in select expressions. 48 This is only relevant when generating in pretty mode. 49 Default: False 50 max_text_width: The max number of characters in a segment before creating new lines in pretty mode. 51 The default is on the smaller end because the length only represents a segment and not the true 52 line length. 53 Default: 80 54 comments: Whether or not to preserve comments in the output SQL code. 55 Default: True 56 """ 57 58 TRANSFORMS = { 59 exp.DateAdd: lambda self, e: self.func( 60 "DATE_ADD", e.this, e.expression, exp.Literal.string(e.text("unit")) 61 ), 62 exp.TsOrDsAdd: lambda self, e: self.func( 63 "TS_OR_DS_ADD", e.this, e.expression, exp.Literal.string(e.text("unit")) 64 ), 65 exp.CaseSpecificColumnConstraint: lambda self, e: f"{'NOT ' if e.args.get('not_') else ''}CASESPECIFIC", 66 exp.CharacterSetColumnConstraint: lambda self, e: f"CHARACTER SET {self.sql(e, 'this')}", 67 exp.CharacterSetProperty: lambda self, e: f"{'DEFAULT ' if e.args.get('default') else ''}CHARACTER SET={self.sql(e, 'this')}", 68 exp.CheckColumnConstraint: lambda self, e: f"CHECK ({self.sql(e, 'this')})", 69 exp.ClusteredColumnConstraint: lambda self, e: f"CLUSTERED ({self.expressions(e, 'this', indent=False)})", 70 exp.CollateColumnConstraint: lambda self, e: f"COLLATE {self.sql(e, 'this')}", 71 exp.CopyGrantsProperty: lambda self, e: "COPY GRANTS", 72 exp.CommentColumnConstraint: lambda self, e: f"COMMENT {self.sql(e, 'this')}", 73 exp.DateFormatColumnConstraint: lambda self, e: f"FORMAT {self.sql(e, 'this')}", 74 exp.DefaultColumnConstraint: lambda self, e: f"DEFAULT {self.sql(e, 'this')}", 75 exp.EncodeColumnConstraint: lambda self, e: f"ENCODE {self.sql(e, 'this')}", 76 exp.ExecuteAsProperty: lambda self, e: self.naked_property(e), 77 exp.ExternalProperty: lambda self, e: "EXTERNAL", 78 exp.HeapProperty: lambda self, e: "HEAP", 79 exp.InlineLengthColumnConstraint: lambda self, e: f"INLINE LENGTH {self.sql(e, 'this')}", 80 exp.InputModelProperty: lambda self, e: f"INPUT{self.sql(e, 'this')}", 81 exp.IntervalSpan: lambda self, e: f"{self.sql(e, 'this')} TO {self.sql(e, 'expression')}", 82 exp.LanguageProperty: lambda self, e: self.naked_property(e), 83 exp.LocationProperty: lambda self, e: self.naked_property(e), 84 exp.LogProperty: lambda self, e: f"{'NO ' if e.args.get('no') else ''}LOG", 85 exp.MaterializedProperty: lambda self, e: "MATERIALIZED", 86 exp.NoPrimaryIndexProperty: lambda self, e: "NO PRIMARY INDEX", 87 exp.NonClusteredColumnConstraint: lambda self, e: f"NONCLUSTERED ({self.expressions(e, 'this', indent=False)})", 88 exp.NotForReplicationColumnConstraint: lambda self, e: "NOT FOR REPLICATION", 89 exp.OnCommitProperty: lambda self, e: f"ON COMMIT {'DELETE' if e.args.get('delete') else 'PRESERVE'} ROWS", 90 exp.OnProperty: lambda self, e: f"ON {self.sql(e, 'this')}", 91 exp.OnUpdateColumnConstraint: lambda self, e: f"ON UPDATE {self.sql(e, 'this')}", 92 exp.OutputModelProperty: lambda self, e: f"OUTPUT{self.sql(e, 'this')}", 93 exp.PathColumnConstraint: lambda self, e: f"PATH {self.sql(e, 'this')}", 94 exp.RemoteWithConnectionModelProperty: lambda self, e: f"REMOTE WITH CONNECTION {self.sql(e, 'this')}", 95 exp.ReturnsProperty: lambda self, e: self.naked_property(e), 96 exp.SampleProperty: lambda self, e: f"SAMPLE BY {self.sql(e, 'this')}", 97 exp.SetProperty: lambda self, e: f"{'MULTI' if e.args.get('multi') else ''}SET", 98 exp.SettingsProperty: lambda self, e: f"SETTINGS{self.seg('')}{(self.expressions(e))}", 99 exp.SqlSecurityProperty: lambda self, e: f"SQL SECURITY {'DEFINER' if e.args.get('definer') else 'INVOKER'}", 100 exp.StabilityProperty: lambda self, e: e.name, 101 exp.TemporaryProperty: lambda self, e: f"TEMPORARY", 102 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 103 exp.TransientProperty: lambda self, e: "TRANSIENT", 104 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 105 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 106 exp.UppercaseColumnConstraint: lambda self, e: f"UPPERCASE", 107 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 108 exp.VolatileProperty: lambda self, e: "VOLATILE", 109 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 110 } 111 112 # Whether the base comes first 113 LOG_BASE_FIRST = True 114 115 # Whether or not null ordering is supported in order by 116 NULL_ORDERING_SUPPORTED = True 117 118 # Whether or not locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 119 LOCKING_READS_SUPPORTED = False 120 121 # Always do union distinct or union all 122 EXPLICIT_UNION = False 123 124 # Wrap derived values in parens, usually standard but spark doesn't support it 125 WRAP_DERIVED_VALUES = True 126 127 # Whether or not create function uses an AS before the RETURN 128 CREATE_FUNCTION_RETURN_AS = True 129 130 # Whether or not MERGE ... WHEN MATCHED BY SOURCE is allowed 131 MATCHED_BY_SOURCE = True 132 133 # Whether or not the INTERVAL expression works only with values like '1 day' 134 SINGLE_STRING_INTERVAL = False 135 136 # Whether or not the plural form of date parts like day (i.e. "days") is supported in INTERVALs 137 INTERVAL_ALLOWS_PLURAL_FORM = True 138 139 # Whether or not the TABLESAMPLE clause supports a method name, like BERNOULLI 140 TABLESAMPLE_WITH_METHOD = True 141 142 # Whether or not to treat the number in TABLESAMPLE (50) as a percentage 143 TABLESAMPLE_SIZE_IS_PERCENT = False 144 145 # Whether or not limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 146 LIMIT_FETCH = "ALL" 147 148 # Whether or not limit and fetch allows expresions or just limits 149 LIMIT_ONLY_LITERALS = False 150 151 # Whether or not a table is allowed to be renamed with a db 152 RENAME_TABLE_WITH_DB = True 153 154 # The separator for grouping sets and rollups 155 GROUPINGS_SEP = "," 156 157 # The string used for creating an index on a table 158 INDEX_ON = "ON" 159 160 # Whether or not join hints should be generated 161 JOIN_HINTS = True 162 163 # Whether or not table hints should be generated 164 TABLE_HINTS = True 165 166 # Whether or not query hints should be generated 167 QUERY_HINTS = True 168 169 # What kind of separator to use for query hints 170 QUERY_HINT_SEP = ", " 171 172 # Whether or not comparing against booleans (e.g. x IS TRUE) is supported 173 IS_BOOL_ALLOWED = True 174 175 # Whether or not to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 176 DUPLICATE_KEY_UPDATE_WITH_SET = True 177 178 # Whether or not to generate the limit as TOP <value> instead of LIMIT <value> 179 LIMIT_IS_TOP = False 180 181 # Whether or not to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 182 RETURNING_END = True 183 184 # Whether or not to generate the (+) suffix for columns used in old-style join conditions 185 COLUMN_JOIN_MARKS_SUPPORTED = False 186 187 # Whether or not to generate an unquoted value for EXTRACT's date part argument 188 EXTRACT_ALLOWS_QUOTES = True 189 190 # Whether or not TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 191 TZ_TO_WITH_TIME_ZONE = False 192 193 # Whether or not the NVL2 function is supported 194 NVL2_SUPPORTED = True 195 196 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 197 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 198 199 # Whether or not VALUES statements can be used as derived tables. 200 # MySQL 5 and Redshift do not allow this, so when False, it will convert 201 # SELECT * VALUES into SELECT UNION 202 VALUES_AS_TABLE = True 203 204 # Whether or not the word COLUMN is included when adding a column with ALTER TABLE 205 ALTER_TABLE_ADD_COLUMN_KEYWORD = True 206 207 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 208 UNNEST_WITH_ORDINALITY = True 209 210 # Whether or not FILTER (WHERE cond) can be used for conditional aggregation 211 AGGREGATE_FILTER_SUPPORTED = True 212 213 # Whether or not JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 214 SEMI_ANTI_JOIN_WITH_SIDE = True 215 216 # Whether or not session variables / parameters are supported, e.g. @x in T-SQL 217 SUPPORTS_PARAMETERS = True 218 219 # Whether or not to include the type of a computed column in the CREATE DDL 220 COMPUTED_COLUMN_WITH_TYPE = True 221 222 # Whether or not CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 223 SUPPORTS_TABLE_COPY = True 224 225 # Whether or not parentheses are required around the table sample's expression 226 TABLESAMPLE_REQUIRES_PARENS = True 227 228 # Whether or not COLLATE is a function instead of a binary operator 229 COLLATE_IS_FUNC = False 230 231 # Whether or not data types support additional specifiers like e.g. CHAR or BYTE (oracle) 232 DATA_TYPE_SPECIFIERS_ALLOWED = False 233 234 # Whether or not conditions require booleans WHERE x = 0 vs WHERE x 235 ENSURE_BOOLS = False 236 237 # Whether or not the "RECURSIVE" keyword is required when defining recursive CTEs 238 CTE_RECURSIVE_KEYWORD_REQUIRED = True 239 240 # Whether the behavior of a / b depends on the types of a and b. 241 # False means a / b is always float division. 242 # True means a / b is integer division if both a and b are integers. 243 TYPED_DIVISION = False 244 245 # False means 1 / 0 throws an error. 246 # True means 1 / 0 returns null. 247 SAFE_DIVISION = False 248 249 TYPE_MAPPING = { 250 exp.DataType.Type.NCHAR: "CHAR", 251 exp.DataType.Type.NVARCHAR: "VARCHAR", 252 exp.DataType.Type.MEDIUMTEXT: "TEXT", 253 exp.DataType.Type.LONGTEXT: "TEXT", 254 exp.DataType.Type.TINYTEXT: "TEXT", 255 exp.DataType.Type.MEDIUMBLOB: "BLOB", 256 exp.DataType.Type.LONGBLOB: "BLOB", 257 exp.DataType.Type.TINYBLOB: "BLOB", 258 exp.DataType.Type.INET: "INET", 259 } 260 261 STAR_MAPPING = { 262 "except": "EXCEPT", 263 "replace": "REPLACE", 264 } 265 266 TIME_PART_SINGULARS = { 267 "microseconds": "microsecond", 268 "seconds": "second", 269 "minutes": "minute", 270 "hours": "hour", 271 "days": "day", 272 "weeks": "week", 273 "months": "month", 274 "quarters": "quarter", 275 "years": "year", 276 } 277 278 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 279 280 STRUCT_DELIMITER = ("<", ">") 281 282 PARAMETER_TOKEN = "@" 283 284 PROPERTIES_LOCATION = { 285 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 286 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 287 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 288 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 289 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 290 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 291 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 292 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 293 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 294 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 295 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 296 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 297 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 298 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 299 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 300 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 301 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 302 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 303 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 304 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 305 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 306 exp.HeapProperty: exp.Properties.Location.POST_WITH, 307 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 308 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 309 exp.JournalProperty: exp.Properties.Location.POST_NAME, 310 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 311 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 312 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 313 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 314 exp.LogProperty: exp.Properties.Location.POST_NAME, 315 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 316 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 317 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 318 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 319 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 320 exp.Order: exp.Properties.Location.POST_SCHEMA, 321 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 322 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 323 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 324 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 325 exp.Property: exp.Properties.Location.POST_WITH, 326 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 327 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 328 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 329 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 330 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 331 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 332 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 333 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 334 exp.Set: exp.Properties.Location.POST_SCHEMA, 335 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 336 exp.SetProperty: exp.Properties.Location.POST_CREATE, 337 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 338 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 339 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 340 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 341 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 342 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 343 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 344 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 345 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 346 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 347 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 348 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 349 } 350 351 # Keywords that can't be used as unquoted identifier names 352 RESERVED_KEYWORDS: t.Set[str] = set() 353 354 # Expressions whose comments are separated from them for better formatting 355 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 356 exp.Create, 357 exp.Delete, 358 exp.Drop, 359 exp.From, 360 exp.Insert, 361 exp.Join, 362 exp.Select, 363 exp.Update, 364 exp.Where, 365 exp.With, 366 ) 367 368 # Expressions that should not have their comments generated in maybe_comment 369 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 370 exp.Binary, 371 exp.Union, 372 ) 373 374 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 375 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 376 exp.Column, 377 exp.Literal, 378 exp.Neg, 379 exp.Paren, 380 ) 381 382 # Expressions that need to have all CTEs under them bubbled up to them 383 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 384 385 KEY_VALUE_DEFINITONS = (exp.Bracket, exp.EQ, exp.PropertyEQ, exp.Slice) 386 387 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 388 389 # Autofilled 390 INVERSE_TIME_MAPPING: t.Dict[str, str] = {} 391 INVERSE_TIME_TRIE: t.Dict = {} 392 INVERSE_ESCAPE_SEQUENCES: t.Dict[str, str] = {} 393 INDEX_OFFSET = 0 394 UNNEST_COLUMN_ONLY = False 395 ALIAS_POST_TABLESAMPLE = False 396 IDENTIFIERS_CAN_START_WITH_DIGIT = False 397 STRICT_STRING_CONCAT = False 398 NORMALIZE_FUNCTIONS: bool | str = "upper" 399 NULL_ORDERING = "nulls_are_small" 400 401 can_identify: t.Callable[[str, str | bool], bool] 402 403 # Delimiters for quotes, identifiers and the corresponding escape characters 404 QUOTE_START = "'" 405 QUOTE_END = "'" 406 IDENTIFIER_START = '"' 407 IDENTIFIER_END = '"' 408 TOKENIZER_CLASS = Tokenizer 409 410 # Delimiters for bit, hex, byte and raw literals 411 BIT_START: t.Optional[str] = None 412 BIT_END: t.Optional[str] = None 413 HEX_START: t.Optional[str] = None 414 HEX_END: t.Optional[str] = None 415 BYTE_START: t.Optional[str] = None 416 BYTE_END: t.Optional[str] = None 417 418 __slots__ = ( 419 "pretty", 420 "identify", 421 "normalize", 422 "pad", 423 "_indent", 424 "normalize_functions", 425 "unsupported_level", 426 "max_unsupported", 427 "leading_comma", 428 "max_text_width", 429 "comments", 430 "unsupported_messages", 431 "_escaped_quote_end", 432 "_escaped_identifier_end", 433 ) 434 435 def __init__( 436 self, 437 pretty: t.Optional[bool] = None, 438 identify: str | bool = False, 439 normalize: bool = False, 440 pad: int = 2, 441 indent: int = 2, 442 normalize_functions: t.Optional[str | bool] = None, 443 unsupported_level: ErrorLevel = ErrorLevel.WARN, 444 max_unsupported: int = 3, 445 leading_comma: bool = False, 446 max_text_width: int = 80, 447 comments: bool = True, 448 ): 449 import sqlglot 450 451 self.pretty = pretty if pretty is not None else sqlglot.pretty 452 self.identify = identify 453 self.normalize = normalize 454 self.pad = pad 455 self._indent = indent 456 self.unsupported_level = unsupported_level 457 self.max_unsupported = max_unsupported 458 self.leading_comma = leading_comma 459 self.max_text_width = max_text_width 460 self.comments = comments 461 462 # This is both a Dialect property and a Generator argument, so we prioritize the latter 463 self.normalize_functions = ( 464 self.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 465 ) 466 467 self.unsupported_messages: t.List[str] = [] 468 self._escaped_quote_end: str = self.TOKENIZER_CLASS.STRING_ESCAPES[0] + self.QUOTE_END 469 self._escaped_identifier_end: str = ( 470 self.TOKENIZER_CLASS.IDENTIFIER_ESCAPES[0] + self.IDENTIFIER_END 471 ) 472 473 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 474 """ 475 Generates the SQL string corresponding to the given syntax tree. 476 477 Args: 478 expression: The syntax tree. 479 copy: Whether or not to copy the expression. The generator performs mutations so 480 it is safer to copy. 481 482 Returns: 483 The SQL string corresponding to `expression`. 484 """ 485 if copy: 486 expression = expression.copy() 487 488 # Some dialects only support CTEs at the top level expression for certain expression 489 # types, so we need to bubble up nested CTEs to that level in order to produce a 490 # syntactically valid expression. This transformation happens here to minimize code 491 # duplication, since many expressions support CTEs. 492 if ( 493 not expression.parent 494 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 495 and any(node.parent is not expression for node in expression.find_all(exp.With)) 496 ): 497 from sqlglot.transforms import move_ctes_to_top_level 498 499 expression = move_ctes_to_top_level(expression) 500 501 if self.ENSURE_BOOLS: 502 from sqlglot.transforms import ensure_bools 503 504 expression = ensure_bools(expression) 505 506 self.unsupported_messages = [] 507 sql = self.sql(expression).strip() 508 509 if self.unsupported_level == ErrorLevel.IGNORE: 510 return sql 511 512 if self.unsupported_level == ErrorLevel.WARN: 513 for msg in self.unsupported_messages: 514 logger.warning(msg) 515 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 516 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 517 518 if self.pretty: 519 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 520 return sql 521 522 def unsupported(self, message: str) -> None: 523 if self.unsupported_level == ErrorLevel.IMMEDIATE: 524 raise UnsupportedError(message) 525 self.unsupported_messages.append(message) 526 527 def sep(self, sep: str = " ") -> str: 528 return f"{sep.strip()}\n" if self.pretty else sep 529 530 def seg(self, sql: str, sep: str = " ") -> str: 531 return f"{self.sep(sep)}{sql}" 532 533 def pad_comment(self, comment: str) -> str: 534 comment = " " + comment if comment[0].strip() else comment 535 comment = comment + " " if comment[-1].strip() else comment 536 return comment 537 538 def maybe_comment( 539 self, 540 sql: str, 541 expression: t.Optional[exp.Expression] = None, 542 comments: t.Optional[t.List[str]] = None, 543 ) -> str: 544 comments = ( 545 ((expression and expression.comments) if comments is None else comments) # type: ignore 546 if self.comments 547 else None 548 ) 549 550 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 551 return sql 552 553 comments_sql = " ".join( 554 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 555 ) 556 557 if not comments_sql: 558 return sql 559 560 if isinstance(expression, self.WITH_SEPARATED_COMMENTS): 561 return ( 562 f"{self.sep()}{comments_sql}{sql}" 563 if sql[0].isspace() 564 else f"{comments_sql}{self.sep()}{sql}" 565 ) 566 567 return f"{sql} {comments_sql}" 568 569 def wrap(self, expression: exp.Expression | str) -> str: 570 this_sql = self.indent( 571 self.sql(expression) 572 if isinstance(expression, (exp.Select, exp.Union)) 573 else self.sql(expression, "this"), 574 level=1, 575 pad=0, 576 ) 577 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 578 579 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 580 original = self.identify 581 self.identify = False 582 result = func(*args, **kwargs) 583 self.identify = original 584 return result 585 586 def normalize_func(self, name: str) -> str: 587 if self.normalize_functions == "upper" or self.normalize_functions is True: 588 return name.upper() 589 if self.normalize_functions == "lower": 590 return name.lower() 591 return name 592 593 def indent( 594 self, 595 sql: str, 596 level: int = 0, 597 pad: t.Optional[int] = None, 598 skip_first: bool = False, 599 skip_last: bool = False, 600 ) -> str: 601 if not self.pretty: 602 return sql 603 604 pad = self.pad if pad is None else pad 605 lines = sql.split("\n") 606 607 return "\n".join( 608 line 609 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 610 else f"{' ' * (level * self._indent + pad)}{line}" 611 for i, line in enumerate(lines) 612 ) 613 614 def sql( 615 self, 616 expression: t.Optional[str | exp.Expression], 617 key: t.Optional[str] = None, 618 comment: bool = True, 619 ) -> str: 620 if not expression: 621 return "" 622 623 if isinstance(expression, str): 624 return expression 625 626 if key: 627 value = expression.args.get(key) 628 if value: 629 return self.sql(value) 630 return "" 631 632 transform = self.TRANSFORMS.get(expression.__class__) 633 634 if callable(transform): 635 sql = transform(self, expression) 636 elif transform: 637 sql = transform 638 elif isinstance(expression, exp.Expression): 639 exp_handler_name = f"{expression.key}_sql" 640 641 if hasattr(self, exp_handler_name): 642 sql = getattr(self, exp_handler_name)(expression) 643 elif isinstance(expression, exp.Func): 644 sql = self.function_fallback_sql(expression) 645 elif isinstance(expression, exp.Property): 646 sql = self.property_sql(expression) 647 else: 648 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 649 else: 650 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 651 652 return self.maybe_comment(sql, expression) if self.comments and comment else sql 653 654 def uncache_sql(self, expression: exp.Uncache) -> str: 655 table = self.sql(expression, "this") 656 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 657 return f"UNCACHE TABLE{exists_sql} {table}" 658 659 def cache_sql(self, expression: exp.Cache) -> str: 660 lazy = " LAZY" if expression.args.get("lazy") else "" 661 table = self.sql(expression, "this") 662 options = expression.args.get("options") 663 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 664 sql = self.sql(expression, "expression") 665 sql = f" AS{self.sep()}{sql}" if sql else "" 666 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 667 return self.prepend_ctes(expression, sql) 668 669 def characterset_sql(self, expression: exp.CharacterSet) -> str: 670 if isinstance(expression.parent, exp.Cast): 671 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 672 default = "DEFAULT " if expression.args.get("default") else "" 673 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 674 675 def column_sql(self, expression: exp.Column) -> str: 676 join_mark = " (+)" if expression.args.get("join_mark") else "" 677 678 if join_mark and not self.COLUMN_JOIN_MARKS_SUPPORTED: 679 join_mark = "" 680 self.unsupported("Outer join syntax using the (+) operator is not supported.") 681 682 column = ".".join( 683 self.sql(part) 684 for part in ( 685 expression.args.get("catalog"), 686 expression.args.get("db"), 687 expression.args.get("table"), 688 expression.args.get("this"), 689 ) 690 if part 691 ) 692 693 return f"{column}{join_mark}" 694 695 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 696 this = self.sql(expression, "this") 697 this = f" {this}" if this else "" 698 position = self.sql(expression, "position") 699 return f"{position}{this}" 700 701 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 702 column = self.sql(expression, "this") 703 kind = self.sql(expression, "kind") 704 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 705 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 706 kind = f"{sep}{kind}" if kind else "" 707 constraints = f" {constraints}" if constraints else "" 708 position = self.sql(expression, "position") 709 position = f" {position}" if position else "" 710 711 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 712 kind = "" 713 714 return f"{exists}{column}{kind}{constraints}{position}" 715 716 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 717 this = self.sql(expression, "this") 718 kind_sql = self.sql(expression, "kind").strip() 719 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 720 721 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 722 this = self.sql(expression, "this") 723 if expression.args.get("not_null"): 724 persisted = " PERSISTED NOT NULL" 725 elif expression.args.get("persisted"): 726 persisted = " PERSISTED" 727 else: 728 persisted = "" 729 return f"AS {this}{persisted}" 730 731 def autoincrementcolumnconstraint_sql(self, _) -> str: 732 return self.token_sql(TokenType.AUTO_INCREMENT) 733 734 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 735 if isinstance(expression.this, list): 736 this = self.wrap(self.expressions(expression, key="this", flat=True)) 737 else: 738 this = self.sql(expression, "this") 739 740 return f"COMPRESS {this}" 741 742 def generatedasidentitycolumnconstraint_sql( 743 self, expression: exp.GeneratedAsIdentityColumnConstraint 744 ) -> str: 745 this = "" 746 if expression.this is not None: 747 on_null = " ON NULL" if expression.args.get("on_null") else "" 748 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 749 750 start = expression.args.get("start") 751 start = f"START WITH {start}" if start else "" 752 increment = expression.args.get("increment") 753 increment = f" INCREMENT BY {increment}" if increment else "" 754 minvalue = expression.args.get("minvalue") 755 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 756 maxvalue = expression.args.get("maxvalue") 757 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 758 cycle = expression.args.get("cycle") 759 cycle_sql = "" 760 761 if cycle is not None: 762 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 763 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 764 765 sequence_opts = "" 766 if start or increment or cycle_sql: 767 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 768 sequence_opts = f" ({sequence_opts.strip()})" 769 770 expr = self.sql(expression, "expression") 771 expr = f"({expr})" if expr else "IDENTITY" 772 773 return f"GENERATED{this} AS {expr}{sequence_opts}" 774 775 def generatedasrowcolumnconstraint_sql( 776 self, expression: exp.GeneratedAsRowColumnConstraint 777 ) -> str: 778 start = "START" if expression.args["start"] else "END" 779 hidden = " HIDDEN" if expression.args.get("hidden") else "" 780 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 781 782 def periodforsystemtimeconstraint_sql( 783 self, expression: exp.PeriodForSystemTimeConstraint 784 ) -> str: 785 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 786 787 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 788 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 789 790 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 791 desc = expression.args.get("desc") 792 if desc is not None: 793 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 794 return f"PRIMARY KEY" 795 796 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 797 this = self.sql(expression, "this") 798 this = f" {this}" if this else "" 799 index_type = expression.args.get("index_type") 800 index_type = f" USING {index_type}" if index_type else "" 801 return f"UNIQUE{this}{index_type}" 802 803 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 804 return self.sql(expression, "this") 805 806 def create_sql(self, expression: exp.Create) -> str: 807 kind = self.sql(expression, "kind").upper() 808 properties = expression.args.get("properties") 809 properties_locs = self.locate_properties(properties) if properties else defaultdict() 810 811 this = self.createable_sql(expression, properties_locs) 812 813 properties_sql = "" 814 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 815 exp.Properties.Location.POST_WITH 816 ): 817 properties_sql = self.sql( 818 exp.Properties( 819 expressions=[ 820 *properties_locs[exp.Properties.Location.POST_SCHEMA], 821 *properties_locs[exp.Properties.Location.POST_WITH], 822 ] 823 ) 824 ) 825 826 begin = " BEGIN" if expression.args.get("begin") else "" 827 end = " END" if expression.args.get("end") else "" 828 829 expression_sql = self.sql(expression, "expression") 830 if expression_sql: 831 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 832 833 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 834 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 835 postalias_props_sql = self.properties( 836 exp.Properties( 837 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 838 ), 839 wrapped=False, 840 ) 841 expression_sql = f" AS {postalias_props_sql}{expression_sql}" 842 else: 843 expression_sql = f" AS{expression_sql}" 844 845 postindex_props_sql = "" 846 if properties_locs.get(exp.Properties.Location.POST_INDEX): 847 postindex_props_sql = self.properties( 848 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 849 wrapped=False, 850 prefix=" ", 851 ) 852 853 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 854 indexes = f" {indexes}" if indexes else "" 855 index_sql = indexes + postindex_props_sql 856 857 replace = " OR REPLACE" if expression.args.get("replace") else "" 858 unique = " UNIQUE" if expression.args.get("unique") else "" 859 860 postcreate_props_sql = "" 861 if properties_locs.get(exp.Properties.Location.POST_CREATE): 862 postcreate_props_sql = self.properties( 863 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 864 sep=" ", 865 prefix=" ", 866 wrapped=False, 867 ) 868 869 modifiers = "".join((replace, unique, postcreate_props_sql)) 870 871 postexpression_props_sql = "" 872 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 873 postexpression_props_sql = self.properties( 874 exp.Properties( 875 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 876 ), 877 sep=" ", 878 prefix=" ", 879 wrapped=False, 880 ) 881 882 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 883 no_schema_binding = ( 884 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 885 ) 886 887 clone = self.sql(expression, "clone") 888 clone = f" {clone}" if clone else "" 889 890 expression_sql = f"CREATE{modifiers} {kind}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 891 return self.prepend_ctes(expression, expression_sql) 892 893 def clone_sql(self, expression: exp.Clone) -> str: 894 this = self.sql(expression, "this") 895 shallow = "SHALLOW " if expression.args.get("shallow") else "" 896 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 897 this = f"{shallow}{keyword} {this}" 898 when = self.sql(expression, "when") 899 900 if when: 901 kind = self.sql(expression, "kind") 902 expr = self.sql(expression, "expression") 903 return f"{this} {when} ({kind} => {expr})" 904 905 return this 906 907 def describe_sql(self, expression: exp.Describe) -> str: 908 return f"DESCRIBE {self.sql(expression, 'this')}" 909 910 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 911 with_ = self.sql(expression, "with") 912 if with_: 913 sql = f"{with_}{self.sep()}{sql}" 914 return sql 915 916 def with_sql(self, expression: exp.With) -> str: 917 sql = self.expressions(expression, flat=True) 918 recursive = ( 919 "RECURSIVE " 920 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 921 else "" 922 ) 923 924 return f"WITH {recursive}{sql}" 925 926 def cte_sql(self, expression: exp.CTE) -> str: 927 alias = self.sql(expression, "alias") 928 return f"{alias} AS {self.wrap(expression)}" 929 930 def tablealias_sql(self, expression: exp.TableAlias) -> str: 931 alias = self.sql(expression, "this") 932 columns = self.expressions(expression, key="columns", flat=True) 933 columns = f"({columns})" if columns else "" 934 935 if not alias and not self.UNNEST_COLUMN_ONLY: 936 alias = "_t" 937 938 return f"{alias}{columns}" 939 940 def bitstring_sql(self, expression: exp.BitString) -> str: 941 this = self.sql(expression, "this") 942 if self.BIT_START: 943 return f"{self.BIT_START}{this}{self.BIT_END}" 944 return f"{int(this, 2)}" 945 946 def hexstring_sql(self, expression: exp.HexString) -> str: 947 this = self.sql(expression, "this") 948 if self.HEX_START: 949 return f"{self.HEX_START}{this}{self.HEX_END}" 950 return f"{int(this, 16)}" 951 952 def bytestring_sql(self, expression: exp.ByteString) -> str: 953 this = self.sql(expression, "this") 954 if self.BYTE_START: 955 return f"{self.BYTE_START}{this}{self.BYTE_END}" 956 return this 957 958 def rawstring_sql(self, expression: exp.RawString) -> str: 959 string = self.escape_str(expression.this.replace("\\", "\\\\")) 960 return f"{self.QUOTE_START}{string}{self.QUOTE_END}" 961 962 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 963 this = self.sql(expression, "this") 964 specifier = self.sql(expression, "expression") 965 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 966 return f"{this}{specifier}" 967 968 def datatype_sql(self, expression: exp.DataType) -> str: 969 type_value = expression.this 970 971 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 972 type_sql = self.sql(expression, "kind") 973 else: 974 type_sql = ( 975 self.TYPE_MAPPING.get(type_value, type_value.value) 976 if isinstance(type_value, exp.DataType.Type) 977 else type_value 978 ) 979 980 nested = "" 981 interior = self.expressions(expression, flat=True) 982 values = "" 983 984 if interior: 985 if expression.args.get("nested"): 986 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 987 if expression.args.get("values") is not None: 988 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 989 values = self.expressions(expression, key="values", flat=True) 990 values = f"{delimiters[0]}{values}{delimiters[1]}" 991 elif type_value == exp.DataType.Type.INTERVAL: 992 nested = f" {interior}" 993 else: 994 nested = f"({interior})" 995 996 type_sql = f"{type_sql}{nested}{values}" 997 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 998 exp.DataType.Type.TIMETZ, 999 exp.DataType.Type.TIMESTAMPTZ, 1000 ): 1001 type_sql = f"{type_sql} WITH TIME ZONE" 1002 1003 return type_sql 1004 1005 def directory_sql(self, expression: exp.Directory) -> str: 1006 local = "LOCAL " if expression.args.get("local") else "" 1007 row_format = self.sql(expression, "row_format") 1008 row_format = f" {row_format}" if row_format else "" 1009 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1010 1011 def delete_sql(self, expression: exp.Delete) -> str: 1012 this = self.sql(expression, "this") 1013 this = f" FROM {this}" if this else "" 1014 using = self.sql(expression, "using") 1015 using = f" USING {using}" if using else "" 1016 where = self.sql(expression, "where") 1017 returning = self.sql(expression, "returning") 1018 limit = self.sql(expression, "limit") 1019 tables = self.expressions(expression, key="tables") 1020 tables = f" {tables}" if tables else "" 1021 if self.RETURNING_END: 1022 expression_sql = f"{this}{using}{where}{returning}{limit}" 1023 else: 1024 expression_sql = f"{returning}{this}{using}{where}{limit}" 1025 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1026 1027 def drop_sql(self, expression: exp.Drop) -> str: 1028 this = self.sql(expression, "this") 1029 kind = expression.args["kind"] 1030 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1031 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1032 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1033 cascade = " CASCADE" if expression.args.get("cascade") else "" 1034 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1035 purge = " PURGE" if expression.args.get("purge") else "" 1036 return ( 1037 f"DROP{temporary}{materialized} {kind}{exists_sql}{this}{cascade}{constraints}{purge}" 1038 ) 1039 1040 def except_sql(self, expression: exp.Except) -> str: 1041 return self.prepend_ctes( 1042 expression, 1043 self.set_operation(expression, self.except_op(expression)), 1044 ) 1045 1046 def except_op(self, expression: exp.Except) -> str: 1047 return f"EXCEPT{'' if expression.args.get('distinct') else ' ALL'}" 1048 1049 def fetch_sql(self, expression: exp.Fetch) -> str: 1050 direction = expression.args.get("direction") 1051 direction = f" {direction.upper()}" if direction else "" 1052 count = expression.args.get("count") 1053 count = f" {count}" if count else "" 1054 if expression.args.get("percent"): 1055 count = f"{count} PERCENT" 1056 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1057 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1058 1059 def filter_sql(self, expression: exp.Filter) -> str: 1060 if self.AGGREGATE_FILTER_SUPPORTED: 1061 this = self.sql(expression, "this") 1062 where = self.sql(expression, "expression").strip() 1063 return f"{this} FILTER({where})" 1064 1065 agg = expression.this 1066 agg_arg = agg.this 1067 cond = expression.expression.this 1068 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1069 return self.sql(agg) 1070 1071 def hint_sql(self, expression: exp.Hint) -> str: 1072 if not self.QUERY_HINTS: 1073 self.unsupported("Hints are not supported") 1074 return "" 1075 1076 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1077 1078 def index_sql(self, expression: exp.Index) -> str: 1079 unique = "UNIQUE " if expression.args.get("unique") else "" 1080 primary = "PRIMARY " if expression.args.get("primary") else "" 1081 amp = "AMP " if expression.args.get("amp") else "" 1082 name = self.sql(expression, "this") 1083 name = f"{name} " if name else "" 1084 table = self.sql(expression, "table") 1085 table = f"{self.INDEX_ON} {table}" if table else "" 1086 using = self.sql(expression, "using") 1087 using = f" USING {using}" if using else "" 1088 index = "INDEX " if not table else "" 1089 columns = self.expressions(expression, key="columns", flat=True) 1090 columns = f"({columns})" if columns else "" 1091 partition_by = self.expressions(expression, key="partition_by", flat=True) 1092 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1093 where = self.sql(expression, "where") 1094 return f"{unique}{primary}{amp}{index}{name}{table}{using}{columns}{partition_by}{where}" 1095 1096 def identifier_sql(self, expression: exp.Identifier) -> str: 1097 text = expression.name 1098 lower = text.lower() 1099 text = lower if self.normalize and not expression.quoted else text 1100 text = text.replace(self.IDENTIFIER_END, self._escaped_identifier_end) 1101 if ( 1102 expression.quoted 1103 or self.can_identify(text, self.identify) 1104 or lower in self.RESERVED_KEYWORDS 1105 or (not self.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1106 ): 1107 text = f"{self.IDENTIFIER_START}{text}{self.IDENTIFIER_END}" 1108 return text 1109 1110 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1111 input_format = self.sql(expression, "input_format") 1112 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1113 output_format = self.sql(expression, "output_format") 1114 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1115 return self.sep().join((input_format, output_format)) 1116 1117 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1118 string = self.sql(exp.Literal.string(expression.name)) 1119 return f"{prefix}{string}" 1120 1121 def partition_sql(self, expression: exp.Partition) -> str: 1122 return f"PARTITION({self.expressions(expression, flat=True)})" 1123 1124 def properties_sql(self, expression: exp.Properties) -> str: 1125 root_properties = [] 1126 with_properties = [] 1127 1128 for p in expression.expressions: 1129 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1130 if p_loc == exp.Properties.Location.POST_WITH: 1131 with_properties.append(p) 1132 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1133 root_properties.append(p) 1134 1135 return self.root_properties( 1136 exp.Properties(expressions=root_properties) 1137 ) + self.with_properties(exp.Properties(expressions=with_properties)) 1138 1139 def root_properties(self, properties: exp.Properties) -> str: 1140 if properties.expressions: 1141 return self.sep() + self.expressions(properties, indent=False, sep=" ") 1142 return "" 1143 1144 def properties( 1145 self, 1146 properties: exp.Properties, 1147 prefix: str = "", 1148 sep: str = ", ", 1149 suffix: str = "", 1150 wrapped: bool = True, 1151 ) -> str: 1152 if properties.expressions: 1153 expressions = self.expressions(properties, sep=sep, indent=False) 1154 if expressions: 1155 expressions = self.wrap(expressions) if wrapped else expressions 1156 return f"{prefix}{' ' if prefix and prefix != ' ' else ''}{expressions}{suffix}" 1157 return "" 1158 1159 def with_properties(self, properties: exp.Properties) -> str: 1160 return self.properties(properties, prefix=self.seg("WITH")) 1161 1162 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1163 properties_locs = defaultdict(list) 1164 for p in properties.expressions: 1165 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1166 if p_loc != exp.Properties.Location.UNSUPPORTED: 1167 properties_locs[p_loc].append(p) 1168 else: 1169 self.unsupported(f"Unsupported property {p.key}") 1170 1171 return properties_locs 1172 1173 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1174 if isinstance(expression.this, exp.Dot): 1175 return self.sql(expression, "this") 1176 return f"'{expression.name}'" if string_key else expression.name 1177 1178 def property_sql(self, expression: exp.Property) -> str: 1179 property_cls = expression.__class__ 1180 if property_cls == exp.Property: 1181 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1182 1183 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1184 if not property_name: 1185 self.unsupported(f"Unsupported property {expression.key}") 1186 1187 return f"{property_name}={self.sql(expression, 'this')}" 1188 1189 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1190 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1191 options = f" {options}" if options else "" 1192 return f"LIKE {self.sql(expression, 'this')}{options}" 1193 1194 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1195 no = "NO " if expression.args.get("no") else "" 1196 protection = " PROTECTION" if expression.args.get("protection") else "" 1197 return f"{no}FALLBACK{protection}" 1198 1199 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1200 no = "NO " if expression.args.get("no") else "" 1201 local = expression.args.get("local") 1202 local = f"{local} " if local else "" 1203 dual = "DUAL " if expression.args.get("dual") else "" 1204 before = "BEFORE " if expression.args.get("before") else "" 1205 after = "AFTER " if expression.args.get("after") else "" 1206 return f"{no}{local}{dual}{before}{after}JOURNAL" 1207 1208 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1209 freespace = self.sql(expression, "this") 1210 percent = " PERCENT" if expression.args.get("percent") else "" 1211 return f"FREESPACE={freespace}{percent}" 1212 1213 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1214 if expression.args.get("default"): 1215 property = "DEFAULT" 1216 elif expression.args.get("on"): 1217 property = "ON" 1218 else: 1219 property = "OFF" 1220 return f"CHECKSUM={property}" 1221 1222 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1223 if expression.args.get("no"): 1224 return "NO MERGEBLOCKRATIO" 1225 if expression.args.get("default"): 1226 return "DEFAULT MERGEBLOCKRATIO" 1227 1228 percent = " PERCENT" if expression.args.get("percent") else "" 1229 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1230 1231 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1232 default = expression.args.get("default") 1233 minimum = expression.args.get("minimum") 1234 maximum = expression.args.get("maximum") 1235 if default or minimum or maximum: 1236 if default: 1237 prop = "DEFAULT" 1238 elif minimum: 1239 prop = "MINIMUM" 1240 else: 1241 prop = "MAXIMUM" 1242 return f"{prop} DATABLOCKSIZE" 1243 units = expression.args.get("units") 1244 units = f" {units}" if units else "" 1245 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1246 1247 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1248 autotemp = expression.args.get("autotemp") 1249 always = expression.args.get("always") 1250 default = expression.args.get("default") 1251 manual = expression.args.get("manual") 1252 never = expression.args.get("never") 1253 1254 if autotemp is not None: 1255 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1256 elif always: 1257 prop = "ALWAYS" 1258 elif default: 1259 prop = "DEFAULT" 1260 elif manual: 1261 prop = "MANUAL" 1262 elif never: 1263 prop = "NEVER" 1264 return f"BLOCKCOMPRESSION={prop}" 1265 1266 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1267 no = expression.args.get("no") 1268 no = " NO" if no else "" 1269 concurrent = expression.args.get("concurrent") 1270 concurrent = " CONCURRENT" if concurrent else "" 1271 1272 for_ = "" 1273 if expression.args.get("for_all"): 1274 for_ = " FOR ALL" 1275 elif expression.args.get("for_insert"): 1276 for_ = " FOR INSERT" 1277 elif expression.args.get("for_none"): 1278 for_ = " FOR NONE" 1279 return f"WITH{no}{concurrent} ISOLATED LOADING{for_}" 1280 1281 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1282 if isinstance(expression.this, list): 1283 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1284 if expression.this: 1285 modulus = self.sql(expression, "this") 1286 remainder = self.sql(expression, "expression") 1287 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1288 1289 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1290 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1291 return f"FROM ({from_expressions}) TO ({to_expressions})" 1292 1293 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1294 this = self.sql(expression, "this") 1295 1296 for_values_or_default = expression.expression 1297 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1298 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1299 else: 1300 for_values_or_default = " DEFAULT" 1301 1302 return f"PARTITION OF {this}{for_values_or_default}" 1303 1304 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1305 kind = expression.args.get("kind") 1306 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1307 for_or_in = expression.args.get("for_or_in") 1308 for_or_in = f" {for_or_in}" if for_or_in else "" 1309 lock_type = expression.args.get("lock_type") 1310 override = " OVERRIDE" if expression.args.get("override") else "" 1311 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1312 1313 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1314 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1315 statistics = expression.args.get("statistics") 1316 statistics_sql = "" 1317 if statistics is not None: 1318 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1319 return f"{data_sql}{statistics_sql}" 1320 1321 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1322 sql = "WITH(SYSTEM_VERSIONING=ON" 1323 1324 if expression.this: 1325 history_table = self.sql(expression, "this") 1326 sql = f"{sql}(HISTORY_TABLE={history_table}" 1327 1328 if expression.expression: 1329 data_consistency_check = self.sql(expression, "expression") 1330 sql = f"{sql}, DATA_CONSISTENCY_CHECK={data_consistency_check}" 1331 1332 sql = f"{sql})" 1333 1334 return f"{sql})" 1335 1336 def insert_sql(self, expression: exp.Insert) -> str: 1337 overwrite = expression.args.get("overwrite") 1338 1339 if isinstance(expression.this, exp.Directory): 1340 this = " OVERWRITE" if overwrite else " INTO" 1341 else: 1342 this = " OVERWRITE TABLE" if overwrite else " INTO" 1343 1344 alternative = expression.args.get("alternative") 1345 alternative = f" OR {alternative}" if alternative else "" 1346 ignore = " IGNORE" if expression.args.get("ignore") else "" 1347 1348 this = f"{this} {self.sql(expression, 'this')}" 1349 1350 exists = " IF EXISTS" if expression.args.get("exists") else "" 1351 partition_sql = ( 1352 f" {self.sql(expression, 'partition')}" if expression.args.get("partition") else "" 1353 ) 1354 where = self.sql(expression, "where") 1355 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1356 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1357 conflict = self.sql(expression, "conflict") 1358 by_name = " BY NAME" if expression.args.get("by_name") else "" 1359 returning = self.sql(expression, "returning") 1360 1361 if self.RETURNING_END: 1362 expression_sql = f"{expression_sql}{conflict}{returning}" 1363 else: 1364 expression_sql = f"{returning}{expression_sql}{conflict}" 1365 1366 sql = f"INSERT{alternative}{ignore}{this}{by_name}{exists}{partition_sql}{where}{expression_sql}" 1367 return self.prepend_ctes(expression, sql) 1368 1369 def intersect_sql(self, expression: exp.Intersect) -> str: 1370 return self.prepend_ctes( 1371 expression, 1372 self.set_operation(expression, self.intersect_op(expression)), 1373 ) 1374 1375 def intersect_op(self, expression: exp.Intersect) -> str: 1376 return f"INTERSECT{'' if expression.args.get('distinct') else ' ALL'}" 1377 1378 def introducer_sql(self, expression: exp.Introducer) -> str: 1379 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1380 1381 def kill_sql(self, expression: exp.Kill) -> str: 1382 kind = self.sql(expression, "kind") 1383 kind = f" {kind}" if kind else "" 1384 this = self.sql(expression, "this") 1385 this = f" {this}" if this else "" 1386 return f"KILL{kind}{this}" 1387 1388 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1389 return expression.name.upper() 1390 1391 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1392 return expression.name.upper() 1393 1394 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1395 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1396 constraint = self.sql(expression, "constraint") 1397 if constraint: 1398 constraint = f"ON CONSTRAINT {constraint}" 1399 key = self.expressions(expression, key="key", flat=True) 1400 do = "" if expression.args.get("duplicate") else " DO " 1401 nothing = "NOTHING" if expression.args.get("nothing") else "" 1402 expressions = self.expressions(expression, flat=True) 1403 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1404 if expressions: 1405 expressions = f"UPDATE {set_keyword}{expressions}" 1406 return f"{self.seg(conflict)} {constraint}{key}{do}{nothing}{expressions}" 1407 1408 def returning_sql(self, expression: exp.Returning) -> str: 1409 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1410 1411 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1412 fields = expression.args.get("fields") 1413 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1414 escaped = expression.args.get("escaped") 1415 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1416 items = expression.args.get("collection_items") 1417 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1418 keys = expression.args.get("map_keys") 1419 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1420 lines = expression.args.get("lines") 1421 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1422 null = expression.args.get("null") 1423 null = f" NULL DEFINED AS {null}" if null else "" 1424 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1425 1426 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1427 return f"WITH ({self.expressions(expression, flat=True)})" 1428 1429 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1430 this = f"{self.sql(expression, 'this')} INDEX" 1431 target = self.sql(expression, "target") 1432 target = f" FOR {target}" if target else "" 1433 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1434 1435 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1436 table = ".".join( 1437 part 1438 for part in [ 1439 self.sql(expression, "catalog"), 1440 self.sql(expression, "db"), 1441 self.sql(expression, "this"), 1442 ] 1443 if part 1444 ) 1445 1446 version = self.sql(expression, "version") 1447 version = f" {version}" if version else "" 1448 alias = self.sql(expression, "alias") 1449 alias = f"{sep}{alias}" if alias else "" 1450 hints = self.expressions(expression, key="hints", sep=" ") 1451 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1452 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 1453 pivots = f" {pivots}" if pivots else "" 1454 joins = self.expressions(expression, key="joins", sep="", skip_first=True) 1455 laterals = self.expressions(expression, key="laterals", sep="") 1456 1457 file_format = self.sql(expression, "format") 1458 if file_format: 1459 pattern = self.sql(expression, "pattern") 1460 pattern = f", PATTERN => {pattern}" if pattern else "" 1461 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1462 1463 index = self.sql(expression, "index") 1464 index = f" AT {index}" if index else "" 1465 1466 ordinality = expression.args.get("ordinality") or "" 1467 if ordinality: 1468 ordinality = f" WITH ORDINALITY{alias}" 1469 alias = "" 1470 1471 return f"{table}{version}{file_format}{alias}{index}{hints}{pivots}{joins}{laterals}{ordinality}" 1472 1473 def tablesample_sql( 1474 self, expression: exp.TableSample, seed_prefix: str = "SEED", sep=" AS " 1475 ) -> str: 1476 if self.ALIAS_POST_TABLESAMPLE and expression.this and expression.this.alias: 1477 table = expression.this.copy() 1478 table.set("alias", None) 1479 this = self.sql(table) 1480 alias = f"{sep}{self.sql(expression.this, 'alias')}" 1481 else: 1482 this = self.sql(expression, "this") 1483 alias = "" 1484 1485 method = self.sql(expression, "method") 1486 method = f"{method.upper()} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1487 numerator = self.sql(expression, "bucket_numerator") 1488 denominator = self.sql(expression, "bucket_denominator") 1489 field = self.sql(expression, "bucket_field") 1490 field = f" ON {field}" if field else "" 1491 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1492 percent = self.sql(expression, "percent") 1493 percent = f"{percent} PERCENT" if percent else "" 1494 rows = self.sql(expression, "rows") 1495 rows = f"{rows} ROWS" if rows else "" 1496 1497 size = self.sql(expression, "size") 1498 if size and self.TABLESAMPLE_SIZE_IS_PERCENT: 1499 size = f"{size} PERCENT" 1500 1501 seed = self.sql(expression, "seed") 1502 seed = f" {seed_prefix} ({seed})" if seed else "" 1503 kind = expression.args.get("kind", "TABLESAMPLE") 1504 1505 expr = f"{bucket}{percent}{rows}{size}" 1506 if self.TABLESAMPLE_REQUIRES_PARENS: 1507 expr = f"({expr})" 1508 1509 return f"{this} {kind} {method}{expr}{seed}{alias}" 1510 1511 def pivot_sql(self, expression: exp.Pivot) -> str: 1512 expressions = self.expressions(expression, flat=True) 1513 1514 if expression.this: 1515 this = self.sql(expression, "this") 1516 if not expressions: 1517 return f"UNPIVOT {this}" 1518 1519 on = f"{self.seg('ON')} {expressions}" 1520 using = self.expressions(expression, key="using", flat=True) 1521 using = f"{self.seg('USING')} {using}" if using else "" 1522 group = self.sql(expression, "group") 1523 return f"PIVOT {this}{on}{using}{group}" 1524 1525 alias = self.sql(expression, "alias") 1526 alias = f" AS {alias}" if alias else "" 1527 unpivot = expression.args.get("unpivot") 1528 direction = "UNPIVOT" if unpivot else "PIVOT" 1529 field = self.sql(expression, "field") 1530 include_nulls = expression.args.get("include_nulls") 1531 if include_nulls is not None: 1532 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1533 else: 1534 nulls = "" 1535 return f"{direction}{nulls}({expressions} FOR {field}){alias}" 1536 1537 def version_sql(self, expression: exp.Version) -> str: 1538 this = f"FOR {expression.name}" 1539 kind = expression.text("kind") 1540 expr = self.sql(expression, "expression") 1541 return f"{this} {kind} {expr}" 1542 1543 def tuple_sql(self, expression: exp.Tuple) -> str: 1544 return f"({self.expressions(expression, flat=True)})" 1545 1546 def update_sql(self, expression: exp.Update) -> str: 1547 this = self.sql(expression, "this") 1548 set_sql = self.expressions(expression, flat=True) 1549 from_sql = self.sql(expression, "from") 1550 where_sql = self.sql(expression, "where") 1551 returning = self.sql(expression, "returning") 1552 order = self.sql(expression, "order") 1553 limit = self.sql(expression, "limit") 1554 if self.RETURNING_END: 1555 expression_sql = f"{from_sql}{where_sql}{returning}" 1556 else: 1557 expression_sql = f"{returning}{from_sql}{where_sql}" 1558 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 1559 return self.prepend_ctes(expression, sql) 1560 1561 def values_sql(self, expression: exp.Values) -> str: 1562 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 1563 if self.VALUES_AS_TABLE or not expression.find_ancestor(exp.From, exp.Join): 1564 args = self.expressions(expression) 1565 alias = self.sql(expression, "alias") 1566 values = f"VALUES{self.seg('')}{args}" 1567 values = ( 1568 f"({values})" 1569 if self.WRAP_DERIVED_VALUES and (alias or isinstance(expression.parent, exp.From)) 1570 else values 1571 ) 1572 return f"{values} AS {alias}" if alias else values 1573 1574 # Converts `VALUES...` expression into a series of select unions. 1575 alias_node = expression.args.get("alias") 1576 column_names = alias_node and alias_node.columns 1577 1578 selects: t.List[exp.Subqueryable] = [] 1579 1580 for i, tup in enumerate(expression.expressions): 1581 row = tup.expressions 1582 1583 if i == 0 and column_names: 1584 row = [ 1585 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 1586 ] 1587 1588 selects.append(exp.Select(expressions=row)) 1589 1590 if self.pretty: 1591 # This may result in poor performance for large-cardinality `VALUES` tables, due to 1592 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 1593 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 1594 subqueryable = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 1595 return self.subquery_sql( 1596 subqueryable.subquery(alias_node and alias_node.this, copy=False) 1597 ) 1598 1599 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 1600 unions = " UNION ALL ".join(self.sql(select) for select in selects) 1601 return f"({unions}){alias}" 1602 1603 def var_sql(self, expression: exp.Var) -> str: 1604 return self.sql(expression, "this") 1605 1606 def into_sql(self, expression: exp.Into) -> str: 1607 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1608 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 1609 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 1610 1611 def from_sql(self, expression: exp.From) -> str: 1612 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 1613 1614 def group_sql(self, expression: exp.Group) -> str: 1615 group_by = self.op_expressions("GROUP BY", expression) 1616 1617 if expression.args.get("all"): 1618 return f"{group_by} ALL" 1619 1620 grouping_sets = self.expressions(expression, key="grouping_sets", indent=False) 1621 grouping_sets = ( 1622 f"{self.seg('GROUPING SETS')} {self.wrap(grouping_sets)}" if grouping_sets else "" 1623 ) 1624 1625 cube = expression.args.get("cube", []) 1626 if seq_get(cube, 0) is True: 1627 return f"{group_by}{self.seg('WITH CUBE')}" 1628 else: 1629 cube_sql = self.expressions(expression, key="cube", indent=False) 1630 cube_sql = f"{self.seg('CUBE')} {self.wrap(cube_sql)}" if cube_sql else "" 1631 1632 rollup = expression.args.get("rollup", []) 1633 if seq_get(rollup, 0) is True: 1634 return f"{group_by}{self.seg('WITH ROLLUP')}" 1635 else: 1636 rollup_sql = self.expressions(expression, key="rollup", indent=False) 1637 rollup_sql = f"{self.seg('ROLLUP')} {self.wrap(rollup_sql)}" if rollup_sql else "" 1638 1639 groupings = csv( 1640 grouping_sets, 1641 cube_sql, 1642 rollup_sql, 1643 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 1644 sep=self.GROUPINGS_SEP, 1645 ) 1646 1647 if expression.args.get("expressions") and groupings: 1648 group_by = f"{group_by}{self.GROUPINGS_SEP}" 1649 1650 return f"{group_by}{groupings}" 1651 1652 def having_sql(self, expression: exp.Having) -> str: 1653 this = self.indent(self.sql(expression, "this")) 1654 return f"{self.seg('HAVING')}{self.sep()}{this}" 1655 1656 def connect_sql(self, expression: exp.Connect) -> str: 1657 start = self.sql(expression, "start") 1658 start = self.seg(f"START WITH {start}") if start else "" 1659 connect = self.sql(expression, "connect") 1660 connect = self.seg(f"CONNECT BY {connect}") 1661 return start + connect 1662 1663 def prior_sql(self, expression: exp.Prior) -> str: 1664 return f"PRIOR {self.sql(expression, 'this')}" 1665 1666 def join_sql(self, expression: exp.Join) -> str: 1667 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 1668 side = None 1669 else: 1670 side = expression.side 1671 1672 op_sql = " ".join( 1673 op 1674 for op in ( 1675 expression.method, 1676 "GLOBAL" if expression.args.get("global") else None, 1677 side, 1678 expression.kind, 1679 expression.hint if self.JOIN_HINTS else None, 1680 ) 1681 if op 1682 ) 1683 on_sql = self.sql(expression, "on") 1684 using = expression.args.get("using") 1685 1686 if not on_sql and using: 1687 on_sql = csv(*(self.sql(column) for column in using)) 1688 1689 this_sql = self.sql(expression, "this") 1690 1691 if on_sql: 1692 on_sql = self.indent(on_sql, skip_first=True) 1693 space = self.seg(" " * self.pad) if self.pretty else " " 1694 if using: 1695 on_sql = f"{space}USING ({on_sql})" 1696 else: 1697 on_sql = f"{space}ON {on_sql}" 1698 elif not op_sql: 1699 return f", {this_sql}" 1700 1701 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 1702 return f"{self.seg(op_sql)} {this_sql}{on_sql}" 1703 1704 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 1705 args = self.expressions(expression, flat=True) 1706 args = f"({args})" if len(args.split(",")) > 1 else args 1707 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 1708 1709 def lateral_sql(self, expression: exp.Lateral) -> str: 1710 this = self.sql(expression, "this") 1711 1712 if expression.args.get("view"): 1713 alias = expression.args["alias"] 1714 columns = self.expressions(alias, key="columns", flat=True) 1715 table = f" {alias.name}" if alias.name else "" 1716 columns = f" AS {columns}" if columns else "" 1717 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 1718 return f"{op_sql}{self.sep()}{this}{table}{columns}" 1719 1720 alias = self.sql(expression, "alias") 1721 alias = f" AS {alias}" if alias else "" 1722 return f"LATERAL {this}{alias}" 1723 1724 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 1725 this = self.sql(expression, "this") 1726 1727 args = [ 1728 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 1729 for e in (expression.args.get(k) for k in ("offset", "expression")) 1730 if e 1731 ] 1732 1733 args_sql = ", ".join(self.sql(e) for e in args) 1734 args_sql = f"({args_sql})" if any(top and not e.is_number for e in args) else args_sql 1735 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}" 1736 1737 def offset_sql(self, expression: exp.Offset) -> str: 1738 this = self.sql(expression, "this") 1739 expression = expression.expression 1740 expression = ( 1741 self._simplify_unless_literal(expression) if self.LIMIT_ONLY_LITERALS else expression 1742 ) 1743 return f"{this}{self.seg('OFFSET')} {self.sql(expression)}" 1744 1745 def setitem_sql(self, expression: exp.SetItem) -> str: 1746 kind = self.sql(expression, "kind") 1747 kind = f"{kind} " if kind else "" 1748 this = self.sql(expression, "this") 1749 expressions = self.expressions(expression) 1750 collate = self.sql(expression, "collate") 1751 collate = f" COLLATE {collate}" if collate else "" 1752 global_ = "GLOBAL " if expression.args.get("global") else "" 1753 return f"{global_}{kind}{this}{expressions}{collate}" 1754 1755 def set_sql(self, expression: exp.Set) -> str: 1756 expressions = ( 1757 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 1758 ) 1759 tag = " TAG" if expression.args.get("tag") else "" 1760 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 1761 1762 def pragma_sql(self, expression: exp.Pragma) -> str: 1763 return f"PRAGMA {self.sql(expression, 'this')}" 1764 1765 def lock_sql(self, expression: exp.Lock) -> str: 1766 if not self.LOCKING_READS_SUPPORTED: 1767 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 1768 return "" 1769 1770 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 1771 expressions = self.expressions(expression, flat=True) 1772 expressions = f" OF {expressions}" if expressions else "" 1773 wait = expression.args.get("wait") 1774 1775 if wait is not None: 1776 if isinstance(wait, exp.Literal): 1777 wait = f" WAIT {self.sql(wait)}" 1778 else: 1779 wait = " NOWAIT" if wait else " SKIP LOCKED" 1780 1781 return f"{lock_type}{expressions}{wait or ''}" 1782 1783 def literal_sql(self, expression: exp.Literal) -> str: 1784 text = expression.this or "" 1785 if expression.is_string: 1786 text = f"{self.QUOTE_START}{self.escape_str(text)}{self.QUOTE_END}" 1787 return text 1788 1789 def escape_str(self, text: str) -> str: 1790 text = text.replace(self.QUOTE_END, self._escaped_quote_end) 1791 if self.INVERSE_ESCAPE_SEQUENCES: 1792 text = "".join(self.INVERSE_ESCAPE_SEQUENCES.get(ch, ch) for ch in text) 1793 elif self.pretty: 1794 text = text.replace("\n", self.SENTINEL_LINE_BREAK) 1795 return text 1796 1797 def loaddata_sql(self, expression: exp.LoadData) -> str: 1798 local = " LOCAL" if expression.args.get("local") else "" 1799 inpath = f" INPATH {self.sql(expression, 'inpath')}" 1800 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 1801 this = f" INTO TABLE {self.sql(expression, 'this')}" 1802 partition = self.sql(expression, "partition") 1803 partition = f" {partition}" if partition else "" 1804 input_format = self.sql(expression, "input_format") 1805 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 1806 serde = self.sql(expression, "serde") 1807 serde = f" SERDE {serde}" if serde else "" 1808 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 1809 1810 def null_sql(self, *_) -> str: 1811 return "NULL" 1812 1813 def boolean_sql(self, expression: exp.Boolean) -> str: 1814 return "TRUE" if expression.this else "FALSE" 1815 1816 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 1817 this = self.sql(expression, "this") 1818 this = f"{this} " if this else this 1819 return self.op_expressions(f"{this}ORDER BY", expression, flat=this or flat) # type: ignore 1820 1821 def cluster_sql(self, expression: exp.Cluster) -> str: 1822 return self.op_expressions("CLUSTER BY", expression) 1823 1824 def distribute_sql(self, expression: exp.Distribute) -> str: 1825 return self.op_expressions("DISTRIBUTE BY", expression) 1826 1827 def sort_sql(self, expression: exp.Sort) -> str: 1828 return self.op_expressions("SORT BY", expression) 1829 1830 def ordered_sql(self, expression: exp.Ordered) -> str: 1831 desc = expression.args.get("desc") 1832 asc = not desc 1833 1834 nulls_first = expression.args.get("nulls_first") 1835 nulls_last = not nulls_first 1836 nulls_are_large = self.NULL_ORDERING == "nulls_are_large" 1837 nulls_are_small = self.NULL_ORDERING == "nulls_are_small" 1838 nulls_are_last = self.NULL_ORDERING == "nulls_are_last" 1839 1840 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 1841 nulls_sort_change = "" 1842 if nulls_first and ( 1843 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 1844 ): 1845 nulls_sort_change = " NULLS FIRST" 1846 elif ( 1847 nulls_last 1848 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 1849 and not nulls_are_last 1850 ): 1851 nulls_sort_change = " NULLS LAST" 1852 1853 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 1854 self.unsupported( 1855 "Sorting in an ORDER BY on NULLS FIRST/NULLS LAST is not supported by this dialect" 1856 ) 1857 nulls_sort_change = "" 1858 1859 return f"{self.sql(expression, 'this')}{sort_order}{nulls_sort_change}" 1860 1861 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 1862 partition = self.partition_by_sql(expression) 1863 order = self.sql(expression, "order") 1864 measures = self.expressions(expression, key="measures") 1865 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 1866 rows = self.sql(expression, "rows") 1867 rows = self.seg(rows) if rows else "" 1868 after = self.sql(expression, "after") 1869 after = self.seg(after) if after else "" 1870 pattern = self.sql(expression, "pattern") 1871 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 1872 definition_sqls = [ 1873 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 1874 for definition in expression.args.get("define", []) 1875 ] 1876 definitions = self.expressions(sqls=definition_sqls) 1877 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 1878 body = "".join( 1879 ( 1880 partition, 1881 order, 1882 measures, 1883 rows, 1884 after, 1885 pattern, 1886 define, 1887 ) 1888 ) 1889 alias = self.sql(expression, "alias") 1890 alias = f" {alias}" if alias else "" 1891 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 1892 1893 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 1894 limit: t.Optional[exp.Fetch | exp.Limit] = expression.args.get("limit") 1895 1896 # If the limit is generated as TOP, we need to ensure it's not generated twice 1897 with_offset_limit_modifiers = not isinstance(limit, exp.Limit) or not self.LIMIT_IS_TOP 1898 1899 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 1900 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 1901 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 1902 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 1903 1904 fetch = isinstance(limit, exp.Fetch) 1905 1906 offset_limit_modifiers = ( 1907 self.offset_limit_modifiers(expression, fetch, limit) 1908 if with_offset_limit_modifiers 1909 else [] 1910 ) 1911 1912 return csv( 1913 *sqls, 1914 *[self.sql(join) for join in expression.args.get("joins") or []], 1915 self.sql(expression, "connect"), 1916 self.sql(expression, "match"), 1917 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 1918 self.sql(expression, "where"), 1919 self.sql(expression, "group"), 1920 self.sql(expression, "having"), 1921 *self.after_having_modifiers(expression), 1922 self.sql(expression, "order"), 1923 *offset_limit_modifiers, 1924 *self.after_limit_modifiers(expression), 1925 sep="", 1926 ) 1927 1928 def offset_limit_modifiers( 1929 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 1930 ) -> t.List[str]: 1931 return [ 1932 self.sql(expression, "offset") if fetch else self.sql(limit), 1933 self.sql(limit) if fetch else self.sql(expression, "offset"), 1934 ] 1935 1936 def after_having_modifiers(self, expression: exp.Expression) -> t.List[str]: 1937 return [ 1938 self.sql(expression, "qualify"), 1939 self.seg("WINDOW ") + self.expressions(expression, key="windows", flat=True) 1940 if expression.args.get("windows") 1941 else "", 1942 self.sql(expression, "distribute"), 1943 self.sql(expression, "sort"), 1944 self.sql(expression, "cluster"), 1945 ] 1946 1947 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 1948 locks = self.expressions(expression, key="locks", sep=" ") 1949 locks = f" {locks}" if locks else "" 1950 return [locks, self.sql(expression, "sample")] 1951 1952 def select_sql(self, expression: exp.Select) -> str: 1953 hint = self.sql(expression, "hint") 1954 distinct = self.sql(expression, "distinct") 1955 distinct = f" {distinct}" if distinct else "" 1956 kind = self.sql(expression, "kind").upper() 1957 limit = expression.args.get("limit") 1958 top = ( 1959 self.limit_sql(limit, top=True) 1960 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP 1961 else "" 1962 ) 1963 1964 expressions = self.expressions(expression) 1965 1966 if kind: 1967 if kind in self.SELECT_KINDS: 1968 kind = f" AS {kind}" 1969 else: 1970 if kind == "STRUCT": 1971 expressions = self.expressions( 1972 sqls=[ 1973 self.sql( 1974 exp.Struct( 1975 expressions=[ 1976 exp.column(e.output_name).eq( 1977 e.this if isinstance(e, exp.Alias) else e 1978 ) 1979 for e in expression.expressions 1980 ] 1981 ) 1982 ) 1983 ] 1984 ) 1985 kind = "" 1986 1987 expressions = f"{self.sep()}{expressions}" if expressions else expressions 1988 sql = self.query_modifiers( 1989 expression, 1990 f"SELECT{top}{hint}{distinct}{kind}{expressions}", 1991 self.sql(expression, "into", comment=False), 1992 self.sql(expression, "from", comment=False), 1993 ) 1994 return self.prepend_ctes(expression, sql) 1995 1996 def schema_sql(self, expression: exp.Schema) -> str: 1997 this = self.sql(expression, "this") 1998 sql = self.schema_columns_sql(expression) 1999 return f"{this} {sql}" if this and sql else this or sql 2000 2001 def schema_columns_sql(self, expression: exp.Schema) -> str: 2002 if expression.expressions: 2003 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2004 return "" 2005 2006 def star_sql(self, expression: exp.Star) -> str: 2007 except_ = self.expressions(expression, key="except", flat=True) 2008 except_ = f"{self.seg(self.STAR_MAPPING['except'])} ({except_})" if except_ else "" 2009 replace = self.expressions(expression, key="replace", flat=True) 2010 replace = f"{self.seg(self.STAR_MAPPING['replace'])} ({replace})" if replace else "" 2011 return f"*{except_}{replace}" 2012 2013 def parameter_sql(self, expression: exp.Parameter) -> str: 2014 this = self.sql(expression, "this") 2015 return f"{self.PARAMETER_TOKEN}{this}" if self.SUPPORTS_PARAMETERS else this 2016 2017 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2018 this = self.sql(expression, "this") 2019 kind = expression.text("kind") 2020 if kind: 2021 kind = f"{kind}." 2022 return f"@@{kind}{this}" 2023 2024 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2025 return f":{expression.name}" if expression.name else "?" 2026 2027 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2028 alias = self.sql(expression, "alias") 2029 alias = f"{sep}{alias}" if alias else "" 2030 2031 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 2032 pivots = f" {pivots}" if pivots else "" 2033 2034 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2035 return self.prepend_ctes(expression, sql) 2036 2037 def qualify_sql(self, expression: exp.Qualify) -> str: 2038 this = self.indent(self.sql(expression, "this")) 2039 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2040 2041 def union_sql(self, expression: exp.Union) -> str: 2042 return self.prepend_ctes( 2043 expression, 2044 self.set_operation(expression, self.union_op(expression)), 2045 ) 2046 2047 def union_op(self, expression: exp.Union) -> str: 2048 kind = " DISTINCT" if self.EXPLICIT_UNION else "" 2049 kind = kind if expression.args.get("distinct") else " ALL" 2050 by_name = " BY NAME" if expression.args.get("by_name") else "" 2051 return f"UNION{kind}{by_name}" 2052 2053 def unnest_sql(self, expression: exp.Unnest) -> str: 2054 args = self.expressions(expression, flat=True) 2055 2056 alias = expression.args.get("alias") 2057 offset = expression.args.get("offset") 2058 2059 if self.UNNEST_WITH_ORDINALITY: 2060 if alias and isinstance(offset, exp.Expression): 2061 alias.append("columns", offset) 2062 2063 if alias and self.UNNEST_COLUMN_ONLY: 2064 columns = alias.columns 2065 alias = self.sql(columns[0]) if columns else "" 2066 else: 2067 alias = self.sql(alias) 2068 2069 alias = f" AS {alias}" if alias else alias 2070 if self.UNNEST_WITH_ORDINALITY: 2071 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2072 else: 2073 if isinstance(offset, exp.Expression): 2074 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2075 elif offset: 2076 suffix = f"{alias} WITH OFFSET" 2077 else: 2078 suffix = alias 2079 2080 return f"UNNEST({args}){suffix}" 2081 2082 def where_sql(self, expression: exp.Where) -> str: 2083 this = self.indent(self.sql(expression, "this")) 2084 return f"{self.seg('WHERE')}{self.sep()}{this}" 2085 2086 def window_sql(self, expression: exp.Window) -> str: 2087 this = self.sql(expression, "this") 2088 partition = self.partition_by_sql(expression) 2089 order = expression.args.get("order") 2090 order = self.order_sql(order, flat=True) if order else "" 2091 spec = self.sql(expression, "spec") 2092 alias = self.sql(expression, "alias") 2093 over = self.sql(expression, "over") or "OVER" 2094 2095 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2096 2097 first = expression.args.get("first") 2098 if first is None: 2099 first = "" 2100 else: 2101 first = "FIRST" if first else "LAST" 2102 2103 if not partition and not order and not spec and alias: 2104 return f"{this} {alias}" 2105 2106 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2107 return f"{this} ({args})" 2108 2109 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2110 partition = self.expressions(expression, key="partition_by", flat=True) 2111 return f"PARTITION BY {partition}" if partition else "" 2112 2113 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2114 kind = self.sql(expression, "kind") 2115 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2116 end = ( 2117 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2118 or "CURRENT ROW" 2119 ) 2120 return f"{kind} BETWEEN {start} AND {end}" 2121 2122 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2123 this = self.sql(expression, "this") 2124 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2125 return f"{this} WITHIN GROUP ({expression_sql})" 2126 2127 def between_sql(self, expression: exp.Between) -> str: 2128 this = self.sql(expression, "this") 2129 low = self.sql(expression, "low") 2130 high = self.sql(expression, "high") 2131 return f"{this} BETWEEN {low} AND {high}" 2132 2133 def bracket_sql(self, expression: exp.Bracket) -> str: 2134 expressions = apply_index_offset(expression.this, expression.expressions, self.INDEX_OFFSET) 2135 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2136 2137 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2138 2139 def safebracket_sql(self, expression: exp.SafeBracket) -> str: 2140 return self.bracket_sql(expression) 2141 2142 def all_sql(self, expression: exp.All) -> str: 2143 return f"ALL {self.wrap(expression)}" 2144 2145 def any_sql(self, expression: exp.Any) -> str: 2146 this = self.sql(expression, "this") 2147 if isinstance(expression.this, exp.Subqueryable): 2148 this = self.wrap(this) 2149 return f"ANY {this}" 2150 2151 def exists_sql(self, expression: exp.Exists) -> str: 2152 return f"EXISTS{self.wrap(expression)}" 2153 2154 def case_sql(self, expression: exp.Case) -> str: 2155 this = self.sql(expression, "this") 2156 statements = [f"CASE {this}" if this else "CASE"] 2157 2158 for e in expression.args["ifs"]: 2159 statements.append(f"WHEN {self.sql(e, 'this')}") 2160 statements.append(f"THEN {self.sql(e, 'true')}") 2161 2162 default = self.sql(expression, "default") 2163 2164 if default: 2165 statements.append(f"ELSE {default}") 2166 2167 statements.append("END") 2168 2169 if self.pretty and self.text_width(statements) > self.max_text_width: 2170 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2171 2172 return " ".join(statements) 2173 2174 def constraint_sql(self, expression: exp.Constraint) -> str: 2175 this = self.sql(expression, "this") 2176 expressions = self.expressions(expression, flat=True) 2177 return f"CONSTRAINT {this} {expressions}" 2178 2179 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2180 order = expression.args.get("order") 2181 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2182 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2183 2184 def extract_sql(self, expression: exp.Extract) -> str: 2185 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2186 expression_sql = self.sql(expression, "expression") 2187 return f"EXTRACT({this} FROM {expression_sql})" 2188 2189 def trim_sql(self, expression: exp.Trim) -> str: 2190 trim_type = self.sql(expression, "position") 2191 2192 if trim_type == "LEADING": 2193 return self.func("LTRIM", expression.this) 2194 elif trim_type == "TRAILING": 2195 return self.func("RTRIM", expression.this) 2196 else: 2197 return self.func("TRIM", expression.this, expression.expression) 2198 2199 def safeconcat_sql(self, expression: exp.SafeConcat) -> str: 2200 expressions = expression.expressions 2201 if self.STRICT_STRING_CONCAT: 2202 expressions = [exp.cast(e, "text") for e in expressions] 2203 return self.func("CONCAT", *expressions) 2204 2205 def check_sql(self, expression: exp.Check) -> str: 2206 this = self.sql(expression, key="this") 2207 return f"CHECK ({this})" 2208 2209 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2210 expressions = self.expressions(expression, flat=True) 2211 reference = self.sql(expression, "reference") 2212 reference = f" {reference}" if reference else "" 2213 delete = self.sql(expression, "delete") 2214 delete = f" ON DELETE {delete}" if delete else "" 2215 update = self.sql(expression, "update") 2216 update = f" ON UPDATE {update}" if update else "" 2217 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}" 2218 2219 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2220 expressions = self.expressions(expression, flat=True) 2221 options = self.expressions(expression, key="options", flat=True, sep=" ") 2222 options = f" {options}" if options else "" 2223 return f"PRIMARY KEY ({expressions}){options}" 2224 2225 def if_sql(self, expression: exp.If) -> str: 2226 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2227 2228 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2229 modifier = expression.args.get("modifier") 2230 modifier = f" {modifier}" if modifier else "" 2231 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2232 2233 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2234 return f"{self.sql(expression, 'this')}: {self.sql(expression, 'expression')}" 2235 2236 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2237 return f"{self.sql(expression, 'this')} FORMAT JSON" 2238 2239 def jsonobject_sql(self, expression: exp.JSONObject) -> str: 2240 null_handling = expression.args.get("null_handling") 2241 null_handling = f" {null_handling}" if null_handling else "" 2242 unique_keys = expression.args.get("unique_keys") 2243 if unique_keys is not None: 2244 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2245 else: 2246 unique_keys = "" 2247 return_type = self.sql(expression, "return_type") 2248 return_type = f" RETURNING {return_type}" if return_type else "" 2249 encoding = self.sql(expression, "encoding") 2250 encoding = f" ENCODING {encoding}" if encoding else "" 2251 return self.func( 2252 "JSON_OBJECT", 2253 *expression.expressions, 2254 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2255 ) 2256 2257 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2258 null_handling = expression.args.get("null_handling") 2259 null_handling = f" {null_handling}" if null_handling else "" 2260 return_type = self.sql(expression, "return_type") 2261 return_type = f" RETURNING {return_type}" if return_type else "" 2262 strict = " STRICT" if expression.args.get("strict") else "" 2263 return self.func( 2264 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2265 ) 2266 2267 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2268 this = self.sql(expression, "this") 2269 order = self.sql(expression, "order") 2270 null_handling = expression.args.get("null_handling") 2271 null_handling = f" {null_handling}" if null_handling else "" 2272 return_type = self.sql(expression, "return_type") 2273 return_type = f" RETURNING {return_type}" if return_type else "" 2274 strict = " STRICT" if expression.args.get("strict") else "" 2275 return self.func( 2276 "JSON_ARRAYAGG", 2277 this, 2278 suffix=f"{order}{null_handling}{return_type}{strict})", 2279 ) 2280 2281 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2282 path = self.sql(expression, "path") 2283 path = f" PATH {path}" if path else "" 2284 nested_schema = self.sql(expression, "nested_schema") 2285 2286 if nested_schema: 2287 return f"NESTED{path} {nested_schema}" 2288 2289 this = self.sql(expression, "this") 2290 kind = self.sql(expression, "kind") 2291 kind = f" {kind}" if kind else "" 2292 return f"{this}{kind}{path}" 2293 2294 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2295 return self.func("COLUMNS", *expression.expressions) 2296 2297 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2298 this = self.sql(expression, "this") 2299 path = self.sql(expression, "path") 2300 path = f", {path}" if path else "" 2301 error_handling = expression.args.get("error_handling") 2302 error_handling = f" {error_handling}" if error_handling else "" 2303 empty_handling = expression.args.get("empty_handling") 2304 empty_handling = f" {empty_handling}" if empty_handling else "" 2305 schema = self.sql(expression, "schema") 2306 return self.func( 2307 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2308 ) 2309 2310 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2311 this = self.sql(expression, "this") 2312 kind = self.sql(expression, "kind") 2313 path = self.sql(expression, "path") 2314 path = f" {path}" if path else "" 2315 as_json = " AS JSON" if expression.args.get("as_json") else "" 2316 return f"{this} {kind}{path}{as_json}" 2317 2318 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2319 this = self.sql(expression, "this") 2320 path = self.sql(expression, "path") 2321 path = f", {path}" if path else "" 2322 expressions = self.expressions(expression) 2323 with_ = ( 2324 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2325 if expressions 2326 else "" 2327 ) 2328 return f"OPENJSON({this}{path}){with_}" 2329 2330 def in_sql(self, expression: exp.In) -> str: 2331 query = expression.args.get("query") 2332 unnest = expression.args.get("unnest") 2333 field = expression.args.get("field") 2334 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2335 2336 if query: 2337 in_sql = self.wrap(query) 2338 elif unnest: 2339 in_sql = self.in_unnest_op(unnest) 2340 elif field: 2341 in_sql = self.sql(field) 2342 else: 2343 in_sql = f"({self.expressions(expression, flat=True)})" 2344 2345 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 2346 2347 def in_unnest_op(self, unnest: exp.Unnest) -> str: 2348 return f"(SELECT {self.sql(unnest)})" 2349 2350 def interval_sql(self, expression: exp.Interval) -> str: 2351 unit = self.sql(expression, "unit") 2352 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2353 unit = self.TIME_PART_SINGULARS.get(unit.lower(), unit) 2354 unit = f" {unit}" if unit else "" 2355 2356 if self.SINGLE_STRING_INTERVAL: 2357 this = expression.this.name if expression.this else "" 2358 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2359 2360 this = self.sql(expression, "this") 2361 if this: 2362 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2363 this = f" {this}" if unwrapped else f" ({this})" 2364 2365 return f"INTERVAL{this}{unit}" 2366 2367 def return_sql(self, expression: exp.Return) -> str: 2368 return f"RETURN {self.sql(expression, 'this')}" 2369 2370 def reference_sql(self, expression: exp.Reference) -> str: 2371 this = self.sql(expression, "this") 2372 expressions = self.expressions(expression, flat=True) 2373 expressions = f"({expressions})" if expressions else "" 2374 options = self.expressions(expression, key="options", flat=True, sep=" ") 2375 options = f" {options}" if options else "" 2376 return f"REFERENCES {this}{expressions}{options}" 2377 2378 def anonymous_sql(self, expression: exp.Anonymous) -> str: 2379 return self.func(expression.name, *expression.expressions) 2380 2381 def paren_sql(self, expression: exp.Paren) -> str: 2382 if isinstance(expression.unnest(), exp.Select): 2383 sql = self.wrap(expression) 2384 else: 2385 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 2386 sql = f"({sql}{self.seg(')', sep='')}" 2387 2388 return self.prepend_ctes(expression, sql) 2389 2390 def neg_sql(self, expression: exp.Neg) -> str: 2391 # This makes sure we don't convert "- - 5" to "--5", which is a comment 2392 this_sql = self.sql(expression, "this") 2393 sep = " " if this_sql[0] == "-" else "" 2394 return f"-{sep}{this_sql}" 2395 2396 def not_sql(self, expression: exp.Not) -> str: 2397 return f"NOT {self.sql(expression, 'this')}" 2398 2399 def alias_sql(self, expression: exp.Alias) -> str: 2400 alias = self.sql(expression, "alias") 2401 alias = f" AS {alias}" if alias else "" 2402 return f"{self.sql(expression, 'this')}{alias}" 2403 2404 def aliases_sql(self, expression: exp.Aliases) -> str: 2405 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 2406 2407 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 2408 this = self.sql(expression, "this") 2409 zone = self.sql(expression, "zone") 2410 return f"{this} AT TIME ZONE {zone}" 2411 2412 def add_sql(self, expression: exp.Add) -> str: 2413 return self.binary(expression, "+") 2414 2415 def and_sql(self, expression: exp.And) -> str: 2416 return self.connector_sql(expression, "AND") 2417 2418 def xor_sql(self, expression: exp.Xor) -> str: 2419 return self.connector_sql(expression, "XOR") 2420 2421 def connector_sql(self, expression: exp.Connector, op: str) -> str: 2422 if not self.pretty: 2423 return self.binary(expression, op) 2424 2425 sqls = tuple( 2426 self.maybe_comment(self.sql(e), e, e.parent.comments or []) if i != 1 else self.sql(e) 2427 for i, e in enumerate(expression.flatten(unnest=False)) 2428 ) 2429 2430 sep = "\n" if self.text_width(sqls) > self.max_text_width else " " 2431 return f"{sep}{op} ".join(sqls) 2432 2433 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 2434 return self.binary(expression, "&") 2435 2436 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 2437 return self.binary(expression, "<<") 2438 2439 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 2440 return f"~{self.sql(expression, 'this')}" 2441 2442 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 2443 return self.binary(expression, "|") 2444 2445 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 2446 return self.binary(expression, ">>") 2447 2448 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 2449 return self.binary(expression, "^") 2450 2451 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 2452 format_sql = self.sql(expression, "format") 2453 format_sql = f" FORMAT {format_sql}" if format_sql else "" 2454 to_sql = self.sql(expression, "to") 2455 to_sql = f" {to_sql}" if to_sql else "" 2456 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql})" 2457 2458 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 2459 zone = self.sql(expression, "this") 2460 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 2461 2462 def collate_sql(self, expression: exp.Collate) -> str: 2463 if self.COLLATE_IS_FUNC: 2464 return self.function_fallback_sql(expression) 2465 return self.binary(expression, "COLLATE") 2466 2467 def command_sql(self, expression: exp.Command) -> str: 2468 return f"{self.sql(expression, 'this').upper()} {expression.text('expression').strip()}" 2469 2470 def comment_sql(self, expression: exp.Comment) -> str: 2471 this = self.sql(expression, "this") 2472 kind = expression.args["kind"] 2473 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 2474 expression_sql = self.sql(expression, "expression") 2475 return f"COMMENT{exists_sql}ON {kind} {this} IS {expression_sql}" 2476 2477 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 2478 this = self.sql(expression, "this") 2479 delete = " DELETE" if expression.args.get("delete") else "" 2480 recompress = self.sql(expression, "recompress") 2481 recompress = f" RECOMPRESS {recompress}" if recompress else "" 2482 to_disk = self.sql(expression, "to_disk") 2483 to_disk = f" TO DISK {to_disk}" if to_disk else "" 2484 to_volume = self.sql(expression, "to_volume") 2485 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 2486 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 2487 2488 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 2489 where = self.sql(expression, "where") 2490 group = self.sql(expression, "group") 2491 aggregates = self.expressions(expression, key="aggregates") 2492 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 2493 2494 if not (where or group or aggregates) and len(expression.expressions) == 1: 2495 return f"TTL {self.expressions(expression, flat=True)}" 2496 2497 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 2498 2499 def transaction_sql(self, expression: exp.Transaction) -> str: 2500 return "BEGIN" 2501 2502 def commit_sql(self, expression: exp.Commit) -> str: 2503 chain = expression.args.get("chain") 2504 if chain is not None: 2505 chain = " AND CHAIN" if chain else " AND NO CHAIN" 2506 2507 return f"COMMIT{chain or ''}" 2508 2509 def rollback_sql(self, expression: exp.Rollback) -> str: 2510 savepoint = expression.args.get("savepoint") 2511 savepoint = f" TO {savepoint}" if savepoint else "" 2512 return f"ROLLBACK{savepoint}" 2513 2514 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 2515 this = self.sql(expression, "this") 2516 2517 dtype = self.sql(expression, "dtype") 2518 if dtype: 2519 collate = self.sql(expression, "collate") 2520 collate = f" COLLATE {collate}" if collate else "" 2521 using = self.sql(expression, "using") 2522 using = f" USING {using}" if using else "" 2523 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 2524 2525 default = self.sql(expression, "default") 2526 if default: 2527 return f"ALTER COLUMN {this} SET DEFAULT {default}" 2528 2529 if not expression.args.get("drop"): 2530 self.unsupported("Unsupported ALTER COLUMN syntax") 2531 2532 return f"ALTER COLUMN {this} DROP DEFAULT" 2533 2534 def renametable_sql(self, expression: exp.RenameTable) -> str: 2535 if not self.RENAME_TABLE_WITH_DB: 2536 # Remove db from tables 2537 expression = expression.transform( 2538 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 2539 ) 2540 this = self.sql(expression, "this") 2541 return f"RENAME TO {this}" 2542 2543 def altertable_sql(self, expression: exp.AlterTable) -> str: 2544 actions = expression.args["actions"] 2545 2546 if isinstance(actions[0], exp.ColumnDef): 2547 actions = self.add_column_sql(expression) 2548 elif isinstance(actions[0], exp.Schema): 2549 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 2550 elif isinstance(actions[0], exp.Delete): 2551 actions = self.expressions(expression, key="actions", flat=True) 2552 else: 2553 actions = self.expressions(expression, key="actions", flat=True) 2554 2555 exists = " IF EXISTS" if expression.args.get("exists") else "" 2556 only = " ONLY" if expression.args.get("only") else "" 2557 return f"ALTER TABLE{exists}{only} {self.sql(expression, 'this')} {actions}" 2558 2559 def add_column_sql(self, expression: exp.AlterTable) -> str: 2560 if self.ALTER_TABLE_ADD_COLUMN_KEYWORD: 2561 return self.expressions( 2562 expression, 2563 key="actions", 2564 prefix="ADD COLUMN ", 2565 ) 2566 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 2567 2568 def droppartition_sql(self, expression: exp.DropPartition) -> str: 2569 expressions = self.expressions(expression) 2570 exists = " IF EXISTS " if expression.args.get("exists") else " " 2571 return f"DROP{exists}{expressions}" 2572 2573 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 2574 this = self.sql(expression, "this") 2575 expression_ = self.sql(expression, "expression") 2576 add_constraint = f"ADD CONSTRAINT {this}" if this else "ADD" 2577 2578 enforced = expression.args.get("enforced") 2579 if enforced is not None: 2580 return f"{add_constraint} CHECK ({expression_}){' ENFORCED' if enforced else ''}" 2581 2582 return f"{add_constraint} {expression_}" 2583 2584 def distinct_sql(self, expression: exp.Distinct) -> str: 2585 this = self.expressions(expression, flat=True) 2586 this = f" {this}" if this else "" 2587 2588 on = self.sql(expression, "on") 2589 on = f" ON {on}" if on else "" 2590 return f"DISTINCT{this}{on}" 2591 2592 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 2593 return f"{self.sql(expression, 'this')} IGNORE NULLS" 2594 2595 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 2596 return f"{self.sql(expression, 'this')} RESPECT NULLS" 2597 2598 def intdiv_sql(self, expression: exp.IntDiv) -> str: 2599 return self.sql( 2600 exp.Cast( 2601 this=exp.Div(this=expression.this, expression=expression.expression), 2602 to=exp.DataType(this=exp.DataType.Type.INT), 2603 ) 2604 ) 2605 2606 def dpipe_sql(self, expression: exp.DPipe) -> str: 2607 return self.binary(expression, "||") 2608 2609 def safedpipe_sql(self, expression: exp.SafeDPipe) -> str: 2610 if self.STRICT_STRING_CONCAT: 2611 return self.func("CONCAT", *(exp.cast(e, "text") for e in expression.flatten())) 2612 return self.dpipe_sql(expression) 2613 2614 def div_sql(self, expression: exp.Div) -> str: 2615 l, r = expression.left, expression.right 2616 2617 if not self.SAFE_DIVISION and expression.args.get("safe"): 2618 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 2619 2620 if self.TYPED_DIVISION and not expression.args.get("typed"): 2621 if not l.is_type(*exp.DataType.FLOAT_TYPES) and not r.is_type( 2622 *exp.DataType.FLOAT_TYPES 2623 ): 2624 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 2625 2626 elif not self.TYPED_DIVISION and expression.args.get("typed"): 2627 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 2628 return self.sql( 2629 exp.cast( 2630 l / r, 2631 to=exp.DataType.Type.BIGINT, 2632 ) 2633 ) 2634 2635 return self.binary(expression, "/") 2636 2637 def overlaps_sql(self, expression: exp.Overlaps) -> str: 2638 return self.binary(expression, "OVERLAPS") 2639 2640 def distance_sql(self, expression: exp.Distance) -> str: 2641 return self.binary(expression, "<->") 2642 2643 def dot_sql(self, expression: exp.Dot) -> str: 2644 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 2645 2646 def eq_sql(self, expression: exp.EQ) -> str: 2647 return self.binary(expression, "=") 2648 2649 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 2650 return self.binary(expression, "=") 2651 2652 def escape_sql(self, expression: exp.Escape) -> str: 2653 return self.binary(expression, "ESCAPE") 2654 2655 def glob_sql(self, expression: exp.Glob) -> str: 2656 return self.binary(expression, "GLOB") 2657 2658 def gt_sql(self, expression: exp.GT) -> str: 2659 return self.binary(expression, ">") 2660 2661 def gte_sql(self, expression: exp.GTE) -> str: 2662 return self.binary(expression, ">=") 2663 2664 def ilike_sql(self, expression: exp.ILike) -> str: 2665 return self.binary(expression, "ILIKE") 2666 2667 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 2668 return self.binary(expression, "ILIKE ANY") 2669 2670 def is_sql(self, expression: exp.Is) -> str: 2671 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 2672 return self.sql( 2673 expression.this if expression.expression.this else exp.not_(expression.this) 2674 ) 2675 return self.binary(expression, "IS") 2676 2677 def like_sql(self, expression: exp.Like) -> str: 2678 return self.binary(expression, "LIKE") 2679 2680 def likeany_sql(self, expression: exp.LikeAny) -> str: 2681 return self.binary(expression, "LIKE ANY") 2682 2683 def similarto_sql(self, expression: exp.SimilarTo) -> str: 2684 return self.binary(expression, "SIMILAR TO") 2685 2686 def lt_sql(self, expression: exp.LT) -> str: 2687 return self.binary(expression, "<") 2688 2689 def lte_sql(self, expression: exp.LTE) -> str: 2690 return self.binary(expression, "<=") 2691 2692 def mod_sql(self, expression: exp.Mod) -> str: 2693 return self.binary(expression, "%") 2694 2695 def mul_sql(self, expression: exp.Mul) -> str: 2696 return self.binary(expression, "*") 2697 2698 def neq_sql(self, expression: exp.NEQ) -> str: 2699 return self.binary(expression, "<>") 2700 2701 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 2702 return self.binary(expression, "IS NOT DISTINCT FROM") 2703 2704 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 2705 return self.binary(expression, "IS DISTINCT FROM") 2706 2707 def or_sql(self, expression: exp.Or) -> str: 2708 return self.connector_sql(expression, "OR") 2709 2710 def slice_sql(self, expression: exp.Slice) -> str: 2711 return self.binary(expression, ":") 2712 2713 def sub_sql(self, expression: exp.Sub) -> str: 2714 return self.binary(expression, "-") 2715 2716 def trycast_sql(self, expression: exp.TryCast) -> str: 2717 return self.cast_sql(expression, safe_prefix="TRY_") 2718 2719 def log_sql(self, expression: exp.Log) -> str: 2720 args = list(expression.args.values()) 2721 if not self.LOG_BASE_FIRST: 2722 args.reverse() 2723 return self.func("LOG", *args) 2724 2725 def use_sql(self, expression: exp.Use) -> str: 2726 kind = self.sql(expression, "kind") 2727 kind = f" {kind}" if kind else "" 2728 this = self.sql(expression, "this") 2729 this = f" {this}" if this else "" 2730 return f"USE{kind}{this}" 2731 2732 def binary(self, expression: exp.Binary, op: str) -> str: 2733 op = self.maybe_comment(op, comments=expression.comments) 2734 return f"{self.sql(expression, 'this')} {op} {self.sql(expression, 'expression')}" 2735 2736 def function_fallback_sql(self, expression: exp.Func) -> str: 2737 args = [] 2738 2739 for key in expression.arg_types: 2740 arg_value = expression.args.get(key) 2741 2742 if isinstance(arg_value, list): 2743 for value in arg_value: 2744 args.append(value) 2745 elif arg_value is not None: 2746 args.append(arg_value) 2747 2748 if self.normalize_functions: 2749 name = expression.sql_name() 2750 else: 2751 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 2752 2753 return self.func(name, *args) 2754 2755 def func( 2756 self, 2757 name: str, 2758 *args: t.Optional[exp.Expression | str], 2759 prefix: str = "(", 2760 suffix: str = ")", 2761 ) -> str: 2762 return f"{self.normalize_func(name)}{prefix}{self.format_args(*args)}{suffix}" 2763 2764 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 2765 arg_sqls = tuple(self.sql(arg) for arg in args if arg is not None) 2766 if self.pretty and self.text_width(arg_sqls) > self.max_text_width: 2767 return self.indent("\n" + f",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 2768 return ", ".join(arg_sqls) 2769 2770 def text_width(self, args: t.Iterable) -> int: 2771 return sum(len(arg) for arg in args) 2772 2773 def format_time(self, expression: exp.Expression) -> t.Optional[str]: 2774 return format_time( 2775 self.sql(expression, "format"), self.INVERSE_TIME_MAPPING, self.INVERSE_TIME_TRIE 2776 ) 2777 2778 def expressions( 2779 self, 2780 expression: t.Optional[exp.Expression] = None, 2781 key: t.Optional[str] = None, 2782 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 2783 flat: bool = False, 2784 indent: bool = True, 2785 skip_first: bool = False, 2786 sep: str = ", ", 2787 prefix: str = "", 2788 ) -> str: 2789 expressions = expression.args.get(key or "expressions") if expression else sqls 2790 2791 if not expressions: 2792 return "" 2793 2794 if flat: 2795 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 2796 2797 num_sqls = len(expressions) 2798 2799 # These are calculated once in case we have the leading_comma / pretty option set, correspondingly 2800 pad = " " * self.pad 2801 stripped_sep = sep.strip() 2802 2803 result_sqls = [] 2804 for i, e in enumerate(expressions): 2805 sql = self.sql(e, comment=False) 2806 if not sql: 2807 continue 2808 2809 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 2810 2811 if self.pretty: 2812 if self.leading_comma: 2813 result_sqls.append(f"{sep if i > 0 else pad}{prefix}{sql}{comments}") 2814 else: 2815 result_sqls.append( 2816 f"{prefix}{sql}{stripped_sep if i + 1 < num_sqls else ''}{comments}" 2817 ) 2818 else: 2819 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 2820 2821 result_sql = "\n".join(result_sqls) if self.pretty else "".join(result_sqls) 2822 return self.indent(result_sql, skip_first=skip_first) if indent else result_sql 2823 2824 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 2825 flat = flat or isinstance(expression.parent, exp.Properties) 2826 expressions_sql = self.expressions(expression, flat=flat) 2827 if flat: 2828 return f"{op} {expressions_sql}" 2829 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 2830 2831 def naked_property(self, expression: exp.Property) -> str: 2832 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 2833 if not property_name: 2834 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 2835 return f"{property_name} {self.sql(expression, 'this')}" 2836 2837 def set_operation(self, expression: exp.Union, op: str) -> str: 2838 this = self.maybe_comment(self.sql(expression, "this"), comments=expression.comments) 2839 op = self.seg(op) 2840 return self.query_modifiers( 2841 expression, f"{this}{op}{self.sep()}{self.sql(expression, 'expression')}" 2842 ) 2843 2844 def tag_sql(self, expression: exp.Tag) -> str: 2845 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 2846 2847 def token_sql(self, token_type: TokenType) -> str: 2848 return self.TOKEN_MAPPING.get(token_type, token_type.name) 2849 2850 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 2851 this = self.sql(expression, "this") 2852 expressions = self.no_identify(self.expressions, expression) 2853 expressions = ( 2854 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 2855 ) 2856 return f"{this}{expressions}" 2857 2858 def joinhint_sql(self, expression: exp.JoinHint) -> str: 2859 this = self.sql(expression, "this") 2860 expressions = self.expressions(expression, flat=True) 2861 return f"{this}({expressions})" 2862 2863 def kwarg_sql(self, expression: exp.Kwarg) -> str: 2864 return self.binary(expression, "=>") 2865 2866 def when_sql(self, expression: exp.When) -> str: 2867 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 2868 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 2869 condition = self.sql(expression, "condition") 2870 condition = f" AND {condition}" if condition else "" 2871 2872 then_expression = expression.args.get("then") 2873 if isinstance(then_expression, exp.Insert): 2874 then = f"INSERT {self.sql(then_expression, 'this')}" 2875 if "expression" in then_expression.args: 2876 then += f" VALUES {self.sql(then_expression, 'expression')}" 2877 elif isinstance(then_expression, exp.Update): 2878 if isinstance(then_expression.args.get("expressions"), exp.Star): 2879 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 2880 else: 2881 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 2882 else: 2883 then = self.sql(then_expression) 2884 return f"WHEN {matched}{source}{condition} THEN {then}" 2885 2886 def merge_sql(self, expression: exp.Merge) -> str: 2887 table = expression.this 2888 table_alias = "" 2889 2890 hints = table.args.get("hints") 2891 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 2892 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 2893 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 2894 2895 this = self.sql(table) 2896 using = f"USING {self.sql(expression, 'using')}" 2897 on = f"ON {self.sql(expression, 'on')}" 2898 expressions = self.expressions(expression, sep=" ") 2899 2900 return self.prepend_ctes( 2901 expression, f"MERGE INTO {this}{table_alias} {using} {on} {expressions}" 2902 ) 2903 2904 def tochar_sql(self, expression: exp.ToChar) -> str: 2905 if expression.args.get("format"): 2906 self.unsupported("Format argument unsupported for TO_CHAR/TO_VARCHAR function") 2907 2908 return self.sql(exp.cast(expression.this, "text")) 2909 2910 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 2911 this = self.sql(expression, "this") 2912 kind = self.sql(expression, "kind") 2913 settings_sql = self.expressions(expression, key="settings", sep=" ") 2914 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 2915 return f"{this}({kind}{args})" 2916 2917 def dictrange_sql(self, expression: exp.DictRange) -> str: 2918 this = self.sql(expression, "this") 2919 max = self.sql(expression, "max") 2920 min = self.sql(expression, "min") 2921 return f"{this}(MIN {min} MAX {max})" 2922 2923 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 2924 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 2925 2926 def oncluster_sql(self, expression: exp.OnCluster) -> str: 2927 return "" 2928 2929 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 2930 expressions = self.expressions(expression, key="expressions", flat=True) 2931 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 2932 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 2933 buckets = self.sql(expression, "buckets") 2934 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 2935 2936 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 2937 this = self.sql(expression, "this") 2938 having = self.sql(expression, "having") 2939 2940 if having: 2941 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 2942 2943 return self.func("ANY_VALUE", this) 2944 2945 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 2946 transform = self.func("TRANSFORM", *expression.expressions) 2947 row_format_before = self.sql(expression, "row_format_before") 2948 row_format_before = f" {row_format_before}" if row_format_before else "" 2949 record_writer = self.sql(expression, "record_writer") 2950 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 2951 using = f" USING {self.sql(expression, 'command_script')}" 2952 schema = self.sql(expression, "schema") 2953 schema = f" AS {schema}" if schema else "" 2954 row_format_after = self.sql(expression, "row_format_after") 2955 row_format_after = f" {row_format_after}" if row_format_after else "" 2956 record_reader = self.sql(expression, "record_reader") 2957 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 2958 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 2959 2960 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 2961 key_block_size = self.sql(expression, "key_block_size") 2962 if key_block_size: 2963 return f"KEY_BLOCK_SIZE = {key_block_size}" 2964 2965 using = self.sql(expression, "using") 2966 if using: 2967 return f"USING {using}" 2968 2969 parser = self.sql(expression, "parser") 2970 if parser: 2971 return f"WITH PARSER {parser}" 2972 2973 comment = self.sql(expression, "comment") 2974 if comment: 2975 return f"COMMENT {comment}" 2976 2977 visible = expression.args.get("visible") 2978 if visible is not None: 2979 return "VISIBLE" if visible else "INVISIBLE" 2980 2981 engine_attr = self.sql(expression, "engine_attr") 2982 if engine_attr: 2983 return f"ENGINE_ATTRIBUTE = {engine_attr}" 2984 2985 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 2986 if secondary_engine_attr: 2987 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 2988 2989 self.unsupported("Unsupported index constraint option.") 2990 return "" 2991 2992 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 2993 kind = self.sql(expression, "kind") 2994 kind = f"{kind} INDEX" if kind else "INDEX" 2995 this = self.sql(expression, "this") 2996 this = f" {this}" if this else "" 2997 index_type = self.sql(expression, "index_type") 2998 index_type = f" USING {index_type}" if index_type else "" 2999 schema = self.sql(expression, "schema") 3000 schema = f" {schema}" if schema else "" 3001 options = self.expressions(expression, key="options", sep=" ") 3002 options = f" {options}" if options else "" 3003 return f"{kind}{this}{index_type}{schema}{options}" 3004 3005 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3006 if self.NVL2_SUPPORTED: 3007 return self.function_fallback_sql(expression) 3008 3009 case = exp.Case().when( 3010 expression.this.is_(exp.null()).not_(copy=False), 3011 expression.args["true"], 3012 copy=False, 3013 ) 3014 else_cond = expression.args.get("false") 3015 if else_cond: 3016 case.else_(else_cond, copy=False) 3017 3018 return self.sql(case) 3019 3020 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3021 this = self.sql(expression, "this") 3022 expr = self.sql(expression, "expression") 3023 iterator = self.sql(expression, "iterator") 3024 condition = self.sql(expression, "condition") 3025 condition = f" IF {condition}" if condition else "" 3026 return f"{this} FOR {expr} IN {iterator}{condition}" 3027 3028 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3029 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3030 3031 def opclass_sql(self, expression: exp.Opclass) -> str: 3032 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3033 3034 def predict_sql(self, expression: exp.Predict) -> str: 3035 model = self.sql(expression, "this") 3036 model = f"MODEL {model}" 3037 table = self.sql(expression, "expression") 3038 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3039 parameters = self.sql(expression, "params_struct") 3040 return self.func("PREDICT", model, table, parameters or None) 3041 3042 def forin_sql(self, expression: exp.ForIn) -> str: 3043 this = self.sql(expression, "this") 3044 expression_sql = self.sql(expression, "expression") 3045 return f"FOR {this} DO {expression_sql}" 3046 3047 def refresh_sql(self, expression: exp.Refresh) -> str: 3048 this = self.sql(expression, "this") 3049 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3050 return f"REFRESH {table}{this}" 3051 3052 def _simplify_unless_literal(self, expression: E) -> E: 3053 if not isinstance(expression, exp.Literal): 3054 from sqlglot.optimizer.simplify import simplify 3055 3056 expression = simplify(expression) 3057 3058 return expression
Generator converts a given syntax tree to the corresponding SQL string.
Arguments:
- pretty: Whether or not to format the produced SQL string. Default: False.
- identify: Determines when an identifier should be quoted. Possible values are: False (default): Never quote, except in cases where it's mandatory by the dialect. True or 'always': Always quote. 'safe': Only quote identifiers that are case insensitive.
- normalize: Whether or not to normalize identifiers to lowercase. Default: False.
- pad: Determines the pad size in a formatted string. Default: 2.
- indent: Determines the indentation size in a formatted string. Default: 2.
- normalize_functions: Whether or not to normalize all function names. Possible values are: "upper" or True (default): Convert names to uppercase. "lower": Convert names to lowercase. False: Disables function name normalization.
- unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. Default ErrorLevel.WARN.
- max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. This is only relevant if unsupported_level is ErrorLevel.RAISE. Default: 3
- leading_comma: Determines whether or not the comma is leading or trailing in select expressions. This is only relevant when generating in pretty mode. Default: False
- max_text_width: The max number of characters in a segment before creating new lines in pretty mode. The default is on the smaller end because the length only represents a segment and not the true line length. Default: 80
- comments: Whether or not to preserve comments in the output SQL code. Default: True
Generator( pretty: Optional[bool] = None, identify: str | bool = False, normalize: bool = False, pad: int = 2, indent: int = 2, normalize_functions: Union[str, bool, NoneType] = None, unsupported_level: sqlglot.errors.ErrorLevel = <ErrorLevel.WARN: 'WARN'>, max_unsupported: int = 3, leading_comma: bool = False, max_text_width: int = 80, comments: bool = True)
435 def __init__( 436 self, 437 pretty: t.Optional[bool] = None, 438 identify: str | bool = False, 439 normalize: bool = False, 440 pad: int = 2, 441 indent: int = 2, 442 normalize_functions: t.Optional[str | bool] = None, 443 unsupported_level: ErrorLevel = ErrorLevel.WARN, 444 max_unsupported: int = 3, 445 leading_comma: bool = False, 446 max_text_width: int = 80, 447 comments: bool = True, 448 ): 449 import sqlglot 450 451 self.pretty = pretty if pretty is not None else sqlglot.pretty 452 self.identify = identify 453 self.normalize = normalize 454 self.pad = pad 455 self._indent = indent 456 self.unsupported_level = unsupported_level 457 self.max_unsupported = max_unsupported 458 self.leading_comma = leading_comma 459 self.max_text_width = max_text_width 460 self.comments = comments 461 462 # This is both a Dialect property and a Generator argument, so we prioritize the latter 463 self.normalize_functions = ( 464 self.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 465 ) 466 467 self.unsupported_messages: t.List[str] = [] 468 self._escaped_quote_end: str = self.TOKENIZER_CLASS.STRING_ESCAPES[0] + self.QUOTE_END 469 self._escaped_identifier_end: str = ( 470 self.TOKENIZER_CLASS.IDENTIFIER_ESCAPES[0] + self.IDENTIFIER_END 471 )
TRANSFORMS =
{<class 'sqlglot.expressions.DateAdd'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TsOrDsAdd'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CaseSpecificColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CharacterSetColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CharacterSetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CheckColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CollateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CopyGrantsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CommentColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DateFormatColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DefaultColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.EncodeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExecuteAsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExternalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.HeapProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InlineLengthColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.IntervalSpan'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LanguageProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LocationProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LogProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.MaterializedProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NoPrimaryIndexProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NonClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NotForReplicationColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnCommitProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnUpdateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OutputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.PathColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.RemoteWithConnectionModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ReturnsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SampleProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SettingsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SqlSecurityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.StabilityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TemporaryProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ToTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TransientProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TransformModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TitleColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.UppercaseColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.VarMap'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.VolatileProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithJournalTableProperty'>: <function Generator.<lambda>>}
TYPE_MAPPING =
{<Type.NCHAR: 'NCHAR'>: 'CHAR', <Type.NVARCHAR: 'NVARCHAR'>: 'VARCHAR', <Type.MEDIUMTEXT: 'MEDIUMTEXT'>: 'TEXT', <Type.LONGTEXT: 'LONGTEXT'>: 'TEXT', <Type.TINYTEXT: 'TINYTEXT'>: 'TEXT', <Type.MEDIUMBLOB: 'MEDIUMBLOB'>: 'BLOB', <Type.LONGBLOB: 'LONGBLOB'>: 'BLOB', <Type.TINYBLOB: 'TINYBLOB'>: 'BLOB', <Type.INET: 'INET'>: 'INET'}
TIME_PART_SINGULARS =
{'microseconds': 'microsecond', 'seconds': 'second', 'minutes': 'minute', 'hours': 'hour', 'days': 'day', 'weeks': 'week', 'months': 'month', 'quarters': 'quarter', 'years': 'year'}
PROPERTIES_LOCATION =
{<class 'sqlglot.expressions.AlgorithmProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.AutoIncrementProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.BlockCompressionProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.CharacterSetProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ChecksumProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.CollateProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.CopyGrantsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Cluster'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ClusteredByProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DataBlocksizeProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.DefinerProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.DictRange'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DictProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DistKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DistStyleProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.EngineProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ExecuteAsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ExternalProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.FallbackProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.FileFormatProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.FreespaceProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.HeapProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.InputModelProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.IsolatedLoadingProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.JournalProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.LanguageProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LikeProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LocationProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LockingProperty'>: <Location.POST_ALIAS: 'POST_ALIAS'>, <class 'sqlglot.expressions.LogProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.MaterializedProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.MergeBlockRatioProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.NoPrimaryIndexProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.OnProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.OnCommitProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.Order'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.OutputModelProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.PartitionedByProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.PartitionedOfProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.PrimaryKey'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Property'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.RemoteWithConnectionModelProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ReturnsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatDelimitedProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatSerdeProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SampleProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SchemaCommentProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SerdeProperties'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Set'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SettingsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SetProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.SortKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SqlSecurityProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.StabilityProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.TemporaryProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.ToTableProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.TransientProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.TransformModelProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.MergeTreeTTL'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.VolatileProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.WithDataProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.WithJournalTableProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.WithSystemVersioningProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>}
WITH_SEPARATED_COMMENTS: Tuple[Type[sqlglot.expressions.Expression], ...] =
(<class 'sqlglot.expressions.Create'>, <class 'sqlglot.expressions.Delete'>, <class 'sqlglot.expressions.Drop'>, <class 'sqlglot.expressions.From'>, <class 'sqlglot.expressions.Insert'>, <class 'sqlglot.expressions.Join'>, <class 'sqlglot.expressions.Select'>, <class 'sqlglot.expressions.Update'>, <class 'sqlglot.expressions.Where'>, <class 'sqlglot.expressions.With'>)
EXCLUDE_COMMENTS: Tuple[Type[sqlglot.expressions.Expression], ...] =
(<class 'sqlglot.expressions.Binary'>, <class 'sqlglot.expressions.Union'>)
UNWRAPPED_INTERVAL_VALUES: Tuple[Type[sqlglot.expressions.Expression], ...] =
(<class 'sqlglot.expressions.Column'>, <class 'sqlglot.expressions.Literal'>, <class 'sqlglot.expressions.Neg'>, <class 'sqlglot.expressions.Paren'>)
KEY_VALUE_DEFINITONS =
(<class 'sqlglot.expressions.Bracket'>, <class 'sqlglot.expressions.EQ'>, <class 'sqlglot.expressions.PropertyEQ'>, <class 'sqlglot.expressions.Slice'>)
@classmethod
def
can_identify(text: str, identify: str | bool = 'safe') -> bool:
288 @classmethod 289 def can_identify(cls, text: str, identify: str | bool = "safe") -> bool: 290 """Checks if text can be identified given an identify option. 291 292 Args: 293 text: The text to check. 294 identify: 295 "always" or `True`: Always returns true. 296 "safe": True if the identifier is case-insensitive. 297 298 Returns: 299 Whether or not the given text can be identified. 300 """ 301 if identify is True or identify == "always": 302 return True 303 304 if identify == "safe": 305 return not cls.case_sensitive(text) 306 307 return False
Checks if text can be identified given an identify option.
Arguments:
- text: The text to check.
- identify: "always" or
True
: Always returns true. "safe": True if the identifier is case-insensitive.
Returns:
Whether or not the given text can be identified.
TOKENIZER_CLASS =
<class 'sqlglot.tokens.Tokenizer'>
473 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 474 """ 475 Generates the SQL string corresponding to the given syntax tree. 476 477 Args: 478 expression: The syntax tree. 479 copy: Whether or not to copy the expression. The generator performs mutations so 480 it is safer to copy. 481 482 Returns: 483 The SQL string corresponding to `expression`. 484 """ 485 if copy: 486 expression = expression.copy() 487 488 # Some dialects only support CTEs at the top level expression for certain expression 489 # types, so we need to bubble up nested CTEs to that level in order to produce a 490 # syntactically valid expression. This transformation happens here to minimize code 491 # duplication, since many expressions support CTEs. 492 if ( 493 not expression.parent 494 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 495 and any(node.parent is not expression for node in expression.find_all(exp.With)) 496 ): 497 from sqlglot.transforms import move_ctes_to_top_level 498 499 expression = move_ctes_to_top_level(expression) 500 501 if self.ENSURE_BOOLS: 502 from sqlglot.transforms import ensure_bools 503 504 expression = ensure_bools(expression) 505 506 self.unsupported_messages = [] 507 sql = self.sql(expression).strip() 508 509 if self.unsupported_level == ErrorLevel.IGNORE: 510 return sql 511 512 if self.unsupported_level == ErrorLevel.WARN: 513 for msg in self.unsupported_messages: 514 logger.warning(msg) 515 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 516 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 517 518 if self.pretty: 519 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 520 return sql
Generates the SQL string corresponding to the given syntax tree.
Arguments:
- expression: The syntax tree.
- copy: Whether or not to copy the expression. The generator performs mutations so it is safer to copy.
Returns:
The SQL string corresponding to
expression
.
def
maybe_comment( self, sql: str, expression: Optional[sqlglot.expressions.Expression] = None, comments: Optional[List[str]] = None) -> str:
538 def maybe_comment( 539 self, 540 sql: str, 541 expression: t.Optional[exp.Expression] = None, 542 comments: t.Optional[t.List[str]] = None, 543 ) -> str: 544 comments = ( 545 ((expression and expression.comments) if comments is None else comments) # type: ignore 546 if self.comments 547 else None 548 ) 549 550 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 551 return sql 552 553 comments_sql = " ".join( 554 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 555 ) 556 557 if not comments_sql: 558 return sql 559 560 if isinstance(expression, self.WITH_SEPARATED_COMMENTS): 561 return ( 562 f"{self.sep()}{comments_sql}{sql}" 563 if sql[0].isspace() 564 else f"{comments_sql}{self.sep()}{sql}" 565 ) 566 567 return f"{sql} {comments_sql}"
569 def wrap(self, expression: exp.Expression | str) -> str: 570 this_sql = self.indent( 571 self.sql(expression) 572 if isinstance(expression, (exp.Select, exp.Union)) 573 else self.sql(expression, "this"), 574 level=1, 575 pad=0, 576 ) 577 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}"
def
indent( self, sql: str, level: int = 0, pad: Optional[int] = None, skip_first: bool = False, skip_last: bool = False) -> str:
593 def indent( 594 self, 595 sql: str, 596 level: int = 0, 597 pad: t.Optional[int] = None, 598 skip_first: bool = False, 599 skip_last: bool = False, 600 ) -> str: 601 if not self.pretty: 602 return sql 603 604 pad = self.pad if pad is None else pad 605 lines = sql.split("\n") 606 607 return "\n".join( 608 line 609 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 610 else f"{' ' * (level * self._indent + pad)}{line}" 611 for i, line in enumerate(lines) 612 )
def
sql( self, expression: Union[str, sqlglot.expressions.Expression, NoneType], key: Optional[str] = None, comment: bool = True) -> str:
614 def sql( 615 self, 616 expression: t.Optional[str | exp.Expression], 617 key: t.Optional[str] = None, 618 comment: bool = True, 619 ) -> str: 620 if not expression: 621 return "" 622 623 if isinstance(expression, str): 624 return expression 625 626 if key: 627 value = expression.args.get(key) 628 if value: 629 return self.sql(value) 630 return "" 631 632 transform = self.TRANSFORMS.get(expression.__class__) 633 634 if callable(transform): 635 sql = transform(self, expression) 636 elif transform: 637 sql = transform 638 elif isinstance(expression, exp.Expression): 639 exp_handler_name = f"{expression.key}_sql" 640 641 if hasattr(self, exp_handler_name): 642 sql = getattr(self, exp_handler_name)(expression) 643 elif isinstance(expression, exp.Func): 644 sql = self.function_fallback_sql(expression) 645 elif isinstance(expression, exp.Property): 646 sql = self.property_sql(expression) 647 else: 648 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 649 else: 650 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 651 652 return self.maybe_comment(sql, expression) if self.comments and comment else sql
659 def cache_sql(self, expression: exp.Cache) -> str: 660 lazy = " LAZY" if expression.args.get("lazy") else "" 661 table = self.sql(expression, "this") 662 options = expression.args.get("options") 663 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 664 sql = self.sql(expression, "expression") 665 sql = f" AS{self.sep()}{sql}" if sql else "" 666 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 667 return self.prepend_ctes(expression, sql)
669 def characterset_sql(self, expression: exp.CharacterSet) -> str: 670 if isinstance(expression.parent, exp.Cast): 671 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 672 default = "DEFAULT " if expression.args.get("default") else "" 673 return f"{default}CHARACTER SET={self.sql(expression, 'this')}"
675 def column_sql(self, expression: exp.Column) -> str: 676 join_mark = " (+)" if expression.args.get("join_mark") else "" 677 678 if join_mark and not self.COLUMN_JOIN_MARKS_SUPPORTED: 679 join_mark = "" 680 self.unsupported("Outer join syntax using the (+) operator is not supported.") 681 682 column = ".".join( 683 self.sql(part) 684 for part in ( 685 expression.args.get("catalog"), 686 expression.args.get("db"), 687 expression.args.get("table"), 688 expression.args.get("this"), 689 ) 690 if part 691 ) 692 693 return f"{column}{join_mark}"
701 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 702 column = self.sql(expression, "this") 703 kind = self.sql(expression, "kind") 704 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 705 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 706 kind = f"{sep}{kind}" if kind else "" 707 constraints = f" {constraints}" if constraints else "" 708 position = self.sql(expression, "position") 709 position = f" {position}" if position else "" 710 711 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 712 kind = "" 713 714 return f"{exists}{column}{kind}{constraints}{position}"
def
computedcolumnconstraint_sql(self, expression: sqlglot.expressions.ComputedColumnConstraint) -> str:
721 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 722 this = self.sql(expression, "this") 723 if expression.args.get("not_null"): 724 persisted = " PERSISTED NOT NULL" 725 elif expression.args.get("persisted"): 726 persisted = " PERSISTED" 727 else: 728 persisted = "" 729 return f"AS {this}{persisted}"
def
compresscolumnconstraint_sql(self, expression: sqlglot.expressions.CompressColumnConstraint) -> str:
def
generatedasidentitycolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsIdentityColumnConstraint) -> str:
742 def generatedasidentitycolumnconstraint_sql( 743 self, expression: exp.GeneratedAsIdentityColumnConstraint 744 ) -> str: 745 this = "" 746 if expression.this is not None: 747 on_null = " ON NULL" if expression.args.get("on_null") else "" 748 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 749 750 start = expression.args.get("start") 751 start = f"START WITH {start}" if start else "" 752 increment = expression.args.get("increment") 753 increment = f" INCREMENT BY {increment}" if increment else "" 754 minvalue = expression.args.get("minvalue") 755 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 756 maxvalue = expression.args.get("maxvalue") 757 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 758 cycle = expression.args.get("cycle") 759 cycle_sql = "" 760 761 if cycle is not None: 762 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 763 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 764 765 sequence_opts = "" 766 if start or increment or cycle_sql: 767 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 768 sequence_opts = f" ({sequence_opts.strip()})" 769 770 expr = self.sql(expression, "expression") 771 expr = f"({expr})" if expr else "IDENTITY" 772 773 return f"GENERATED{this} AS {expr}{sequence_opts}"
def
generatedasrowcolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsRowColumnConstraint) -> str:
def
periodforsystemtimeconstraint_sql( self, expression: sqlglot.expressions.PeriodForSystemTimeConstraint) -> str:
def
notnullcolumnconstraint_sql(self, expression: sqlglot.expressions.NotNullColumnConstraint) -> str:
def
primarykeycolumnconstraint_sql(self, expression: sqlglot.expressions.PrimaryKeyColumnConstraint) -> str:
def
uniquecolumnconstraint_sql(self, expression: sqlglot.expressions.UniqueColumnConstraint) -> str:
796 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 797 this = self.sql(expression, "this") 798 this = f" {this}" if this else "" 799 index_type = expression.args.get("index_type") 800 index_type = f" USING {index_type}" if index_type else "" 801 return f"UNIQUE{this}{index_type}"
806 def create_sql(self, expression: exp.Create) -> str: 807 kind = self.sql(expression, "kind").upper() 808 properties = expression.args.get("properties") 809 properties_locs = self.locate_properties(properties) if properties else defaultdict() 810 811 this = self.createable_sql(expression, properties_locs) 812 813 properties_sql = "" 814 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 815 exp.Properties.Location.POST_WITH 816 ): 817 properties_sql = self.sql( 818 exp.Properties( 819 expressions=[ 820 *properties_locs[exp.Properties.Location.POST_SCHEMA], 821 *properties_locs[exp.Properties.Location.POST_WITH], 822 ] 823 ) 824 ) 825 826 begin = " BEGIN" if expression.args.get("begin") else "" 827 end = " END" if expression.args.get("end") else "" 828 829 expression_sql = self.sql(expression, "expression") 830 if expression_sql: 831 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 832 833 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 834 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 835 postalias_props_sql = self.properties( 836 exp.Properties( 837 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 838 ), 839 wrapped=False, 840 ) 841 expression_sql = f" AS {postalias_props_sql}{expression_sql}" 842 else: 843 expression_sql = f" AS{expression_sql}" 844 845 postindex_props_sql = "" 846 if properties_locs.get(exp.Properties.Location.POST_INDEX): 847 postindex_props_sql = self.properties( 848 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 849 wrapped=False, 850 prefix=" ", 851 ) 852 853 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 854 indexes = f" {indexes}" if indexes else "" 855 index_sql = indexes + postindex_props_sql 856 857 replace = " OR REPLACE" if expression.args.get("replace") else "" 858 unique = " UNIQUE" if expression.args.get("unique") else "" 859 860 postcreate_props_sql = "" 861 if properties_locs.get(exp.Properties.Location.POST_CREATE): 862 postcreate_props_sql = self.properties( 863 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 864 sep=" ", 865 prefix=" ", 866 wrapped=False, 867 ) 868 869 modifiers = "".join((replace, unique, postcreate_props_sql)) 870 871 postexpression_props_sql = "" 872 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 873 postexpression_props_sql = self.properties( 874 exp.Properties( 875 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 876 ), 877 sep=" ", 878 prefix=" ", 879 wrapped=False, 880 ) 881 882 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 883 no_schema_binding = ( 884 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 885 ) 886 887 clone = self.sql(expression, "clone") 888 clone = f" {clone}" if clone else "" 889 890 expression_sql = f"CREATE{modifiers} {kind}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 891 return self.prepend_ctes(expression, expression_sql)
893 def clone_sql(self, expression: exp.Clone) -> str: 894 this = self.sql(expression, "this") 895 shallow = "SHALLOW " if expression.args.get("shallow") else "" 896 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 897 this = f"{shallow}{keyword} {this}" 898 when = self.sql(expression, "when") 899 900 if when: 901 kind = self.sql(expression, "kind") 902 expr = self.sql(expression, "expression") 903 return f"{this} {when} ({kind} => {expr})" 904 905 return this
930 def tablealias_sql(self, expression: exp.TableAlias) -> str: 931 alias = self.sql(expression, "this") 932 columns = self.expressions(expression, key="columns", flat=True) 933 columns = f"({columns})" if columns else "" 934 935 if not alias and not self.UNNEST_COLUMN_ONLY: 936 alias = "_t" 937 938 return f"{alias}{columns}"
968 def datatype_sql(self, expression: exp.DataType) -> str: 969 type_value = expression.this 970 971 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 972 type_sql = self.sql(expression, "kind") 973 else: 974 type_sql = ( 975 self.TYPE_MAPPING.get(type_value, type_value.value) 976 if isinstance(type_value, exp.DataType.Type) 977 else type_value 978 ) 979 980 nested = "" 981 interior = self.expressions(expression, flat=True) 982 values = "" 983 984 if interior: 985 if expression.args.get("nested"): 986 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 987 if expression.args.get("values") is not None: 988 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 989 values = self.expressions(expression, key="values", flat=True) 990 values = f"{delimiters[0]}{values}{delimiters[1]}" 991 elif type_value == exp.DataType.Type.INTERVAL: 992 nested = f" {interior}" 993 else: 994 nested = f"({interior})" 995 996 type_sql = f"{type_sql}{nested}{values}" 997 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 998 exp.DataType.Type.TIMETZ, 999 exp.DataType.Type.TIMESTAMPTZ, 1000 ): 1001 type_sql = f"{type_sql} WITH TIME ZONE" 1002 1003 return type_sql
1005 def directory_sql(self, expression: exp.Directory) -> str: 1006 local = "LOCAL " if expression.args.get("local") else "" 1007 row_format = self.sql(expression, "row_format") 1008 row_format = f" {row_format}" if row_format else "" 1009 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}"
1011 def delete_sql(self, expression: exp.Delete) -> str: 1012 this = self.sql(expression, "this") 1013 this = f" FROM {this}" if this else "" 1014 using = self.sql(expression, "using") 1015 using = f" USING {using}" if using else "" 1016 where = self.sql(expression, "where") 1017 returning = self.sql(expression, "returning") 1018 limit = self.sql(expression, "limit") 1019 tables = self.expressions(expression, key="tables") 1020 tables = f" {tables}" if tables else "" 1021 if self.RETURNING_END: 1022 expression_sql = f"{this}{using}{where}{returning}{limit}" 1023 else: 1024 expression_sql = f"{returning}{this}{using}{where}{limit}" 1025 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}")
1027 def drop_sql(self, expression: exp.Drop) -> str: 1028 this = self.sql(expression, "this") 1029 kind = expression.args["kind"] 1030 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1031 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1032 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1033 cascade = " CASCADE" if expression.args.get("cascade") else "" 1034 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1035 purge = " PURGE" if expression.args.get("purge") else "" 1036 return ( 1037 f"DROP{temporary}{materialized} {kind}{exists_sql}{this}{cascade}{constraints}{purge}" 1038 )
1049 def fetch_sql(self, expression: exp.Fetch) -> str: 1050 direction = expression.args.get("direction") 1051 direction = f" {direction.upper()}" if direction else "" 1052 count = expression.args.get("count") 1053 count = f" {count}" if count else "" 1054 if expression.args.get("percent"): 1055 count = f"{count} PERCENT" 1056 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1057 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}"
1059 def filter_sql(self, expression: exp.Filter) -> str: 1060 if self.AGGREGATE_FILTER_SUPPORTED: 1061 this = self.sql(expression, "this") 1062 where = self.sql(expression, "expression").strip() 1063 return f"{this} FILTER({where})" 1064 1065 agg = expression.this 1066 agg_arg = agg.this 1067 cond = expression.expression.this 1068 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1069 return self.sql(agg)
1078 def index_sql(self, expression: exp.Index) -> str: 1079 unique = "UNIQUE " if expression.args.get("unique") else "" 1080 primary = "PRIMARY " if expression.args.get("primary") else "" 1081 amp = "AMP " if expression.args.get("amp") else "" 1082 name = self.sql(expression, "this") 1083 name = f"{name} " if name else "" 1084 table = self.sql(expression, "table") 1085 table = f"{self.INDEX_ON} {table}" if table else "" 1086 using = self.sql(expression, "using") 1087 using = f" USING {using}" if using else "" 1088 index = "INDEX " if not table else "" 1089 columns = self.expressions(expression, key="columns", flat=True) 1090 columns = f"({columns})" if columns else "" 1091 partition_by = self.expressions(expression, key="partition_by", flat=True) 1092 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1093 where = self.sql(expression, "where") 1094 return f"{unique}{primary}{amp}{index}{name}{table}{using}{columns}{partition_by}{where}"
1096 def identifier_sql(self, expression: exp.Identifier) -> str: 1097 text = expression.name 1098 lower = text.lower() 1099 text = lower if self.normalize and not expression.quoted else text 1100 text = text.replace(self.IDENTIFIER_END, self._escaped_identifier_end) 1101 if ( 1102 expression.quoted 1103 or self.can_identify(text, self.identify) 1104 or lower in self.RESERVED_KEYWORDS 1105 or (not self.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1106 ): 1107 text = f"{self.IDENTIFIER_START}{text}{self.IDENTIFIER_END}" 1108 return text
1110 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1111 input_format = self.sql(expression, "input_format") 1112 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1113 output_format = self.sql(expression, "output_format") 1114 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1115 return self.sep().join((input_format, output_format))
1124 def properties_sql(self, expression: exp.Properties) -> str: 1125 root_properties = [] 1126 with_properties = [] 1127 1128 for p in expression.expressions: 1129 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1130 if p_loc == exp.Properties.Location.POST_WITH: 1131 with_properties.append(p) 1132 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1133 root_properties.append(p) 1134 1135 return self.root_properties( 1136 exp.Properties(expressions=root_properties) 1137 ) + self.with_properties(exp.Properties(expressions=with_properties))
def
properties( self, properties: sqlglot.expressions.Properties, prefix: str = '', sep: str = ', ', suffix: str = '', wrapped: bool = True) -> str:
1144 def properties( 1145 self, 1146 properties: exp.Properties, 1147 prefix: str = "", 1148 sep: str = ", ", 1149 suffix: str = "", 1150 wrapped: bool = True, 1151 ) -> str: 1152 if properties.expressions: 1153 expressions = self.expressions(properties, sep=sep, indent=False) 1154 if expressions: 1155 expressions = self.wrap(expressions) if wrapped else expressions 1156 return f"{prefix}{' ' if prefix and prefix != ' ' else ''}{expressions}{suffix}" 1157 return ""
1162 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1163 properties_locs = defaultdict(list) 1164 for p in properties.expressions: 1165 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1166 if p_loc != exp.Properties.Location.UNSUPPORTED: 1167 properties_locs[p_loc].append(p) 1168 else: 1169 self.unsupported(f"Unsupported property {p.key}") 1170 1171 return properties_locs
def
property_name( self, expression: sqlglot.expressions.Property, string_key: bool = False) -> str:
1178 def property_sql(self, expression: exp.Property) -> str: 1179 property_cls = expression.__class__ 1180 if property_cls == exp.Property: 1181 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1182 1183 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1184 if not property_name: 1185 self.unsupported(f"Unsupported property {expression.key}") 1186 1187 return f"{property_name}={self.sql(expression, 'this')}"
1199 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1200 no = "NO " if expression.args.get("no") else "" 1201 local = expression.args.get("local") 1202 local = f"{local} " if local else "" 1203 dual = "DUAL " if expression.args.get("dual") else "" 1204 before = "BEFORE " if expression.args.get("before") else "" 1205 after = "AFTER " if expression.args.get("after") else "" 1206 return f"{no}{local}{dual}{before}{after}JOURNAL"
def
mergeblockratioproperty_sql(self, expression: sqlglot.expressions.MergeBlockRatioProperty) -> str:
1222 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1223 if expression.args.get("no"): 1224 return "NO MERGEBLOCKRATIO" 1225 if expression.args.get("default"): 1226 return "DEFAULT MERGEBLOCKRATIO" 1227 1228 percent = " PERCENT" if expression.args.get("percent") else "" 1229 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}"
1231 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1232 default = expression.args.get("default") 1233 minimum = expression.args.get("minimum") 1234 maximum = expression.args.get("maximum") 1235 if default or minimum or maximum: 1236 if default: 1237 prop = "DEFAULT" 1238 elif minimum: 1239 prop = "MINIMUM" 1240 else: 1241 prop = "MAXIMUM" 1242 return f"{prop} DATABLOCKSIZE" 1243 units = expression.args.get("units") 1244 units = f" {units}" if units else "" 1245 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}"
def
blockcompressionproperty_sql(self, expression: sqlglot.expressions.BlockCompressionProperty) -> str:
1247 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1248 autotemp = expression.args.get("autotemp") 1249 always = expression.args.get("always") 1250 default = expression.args.get("default") 1251 manual = expression.args.get("manual") 1252 never = expression.args.get("never") 1253 1254 if autotemp is not None: 1255 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1256 elif always: 1257 prop = "ALWAYS" 1258 elif default: 1259 prop = "DEFAULT" 1260 elif manual: 1261 prop = "MANUAL" 1262 elif never: 1263 prop = "NEVER" 1264 return f"BLOCKCOMPRESSION={prop}"
def
isolatedloadingproperty_sql(self, expression: sqlglot.expressions.IsolatedLoadingProperty) -> str:
1266 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1267 no = expression.args.get("no") 1268 no = " NO" if no else "" 1269 concurrent = expression.args.get("concurrent") 1270 concurrent = " CONCURRENT" if concurrent else "" 1271 1272 for_ = "" 1273 if expression.args.get("for_all"): 1274 for_ = " FOR ALL" 1275 elif expression.args.get("for_insert"): 1276 for_ = " FOR INSERT" 1277 elif expression.args.get("for_none"): 1278 for_ = " FOR NONE" 1279 return f"WITH{no}{concurrent} ISOLATED LOADING{for_}"
1281 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1282 if isinstance(expression.this, list): 1283 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1284 if expression.this: 1285 modulus = self.sql(expression, "this") 1286 remainder = self.sql(expression, "expression") 1287 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1288 1289 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1290 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1291 return f"FROM ({from_expressions}) TO ({to_expressions})"
1293 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1294 this = self.sql(expression, "this") 1295 1296 for_values_or_default = expression.expression 1297 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1298 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1299 else: 1300 for_values_or_default = " DEFAULT" 1301 1302 return f"PARTITION OF {this}{for_values_or_default}"
1304 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1305 kind = expression.args.get("kind") 1306 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1307 for_or_in = expression.args.get("for_or_in") 1308 for_or_in = f" {for_or_in}" if for_or_in else "" 1309 lock_type = expression.args.get("lock_type") 1310 override = " OVERRIDE" if expression.args.get("override") else "" 1311 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}"
1313 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1314 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1315 statistics = expression.args.get("statistics") 1316 statistics_sql = "" 1317 if statistics is not None: 1318 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1319 return f"{data_sql}{statistics_sql}"
def
withsystemversioningproperty_sql( self, expression: sqlglot.expressions.WithSystemVersioningProperty) -> str:
1321 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1322 sql = "WITH(SYSTEM_VERSIONING=ON" 1323 1324 if expression.this: 1325 history_table = self.sql(expression, "this") 1326 sql = f"{sql}(HISTORY_TABLE={history_table}" 1327 1328 if expression.expression: 1329 data_consistency_check = self.sql(expression, "expression") 1330 sql = f"{sql}, DATA_CONSISTENCY_CHECK={data_consistency_check}" 1331 1332 sql = f"{sql})" 1333 1334 return f"{sql})"
1336 def insert_sql(self, expression: exp.Insert) -> str: 1337 overwrite = expression.args.get("overwrite") 1338 1339 if isinstance(expression.this, exp.Directory): 1340 this = " OVERWRITE" if overwrite else " INTO" 1341 else: 1342 this = " OVERWRITE TABLE" if overwrite else " INTO" 1343 1344 alternative = expression.args.get("alternative") 1345 alternative = f" OR {alternative}" if alternative else "" 1346 ignore = " IGNORE" if expression.args.get("ignore") else "" 1347 1348 this = f"{this} {self.sql(expression, 'this')}" 1349 1350 exists = " IF EXISTS" if expression.args.get("exists") else "" 1351 partition_sql = ( 1352 f" {self.sql(expression, 'partition')}" if expression.args.get("partition") else "" 1353 ) 1354 where = self.sql(expression, "where") 1355 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1356 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1357 conflict = self.sql(expression, "conflict") 1358 by_name = " BY NAME" if expression.args.get("by_name") else "" 1359 returning = self.sql(expression, "returning") 1360 1361 if self.RETURNING_END: 1362 expression_sql = f"{expression_sql}{conflict}{returning}" 1363 else: 1364 expression_sql = f"{returning}{expression_sql}{conflict}" 1365 1366 sql = f"INSERT{alternative}{ignore}{this}{by_name}{exists}{partition_sql}{where}{expression_sql}" 1367 return self.prepend_ctes(expression, sql)
1394 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1395 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1396 constraint = self.sql(expression, "constraint") 1397 if constraint: 1398 constraint = f"ON CONSTRAINT {constraint}" 1399 key = self.expressions(expression, key="key", flat=True) 1400 do = "" if expression.args.get("duplicate") else " DO " 1401 nothing = "NOTHING" if expression.args.get("nothing") else "" 1402 expressions = self.expressions(expression, flat=True) 1403 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1404 if expressions: 1405 expressions = f"UPDATE {set_keyword}{expressions}" 1406 return f"{self.seg(conflict)} {constraint}{key}{do}{nothing}{expressions}"
def
rowformatdelimitedproperty_sql(self, expression: sqlglot.expressions.RowFormatDelimitedProperty) -> str:
1411 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1412 fields = expression.args.get("fields") 1413 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1414 escaped = expression.args.get("escaped") 1415 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1416 items = expression.args.get("collection_items") 1417 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1418 keys = expression.args.get("map_keys") 1419 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1420 lines = expression.args.get("lines") 1421 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1422 null = expression.args.get("null") 1423 null = f" NULL DEFINED AS {null}" if null else "" 1424 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}"
1435 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1436 table = ".".join( 1437 part 1438 for part in [ 1439 self.sql(expression, "catalog"), 1440 self.sql(expression, "db"), 1441 self.sql(expression, "this"), 1442 ] 1443 if part 1444 ) 1445 1446 version = self.sql(expression, "version") 1447 version = f" {version}" if version else "" 1448 alias = self.sql(expression, "alias") 1449 alias = f"{sep}{alias}" if alias else "" 1450 hints = self.expressions(expression, key="hints", sep=" ") 1451 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1452 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 1453 pivots = f" {pivots}" if pivots else "" 1454 joins = self.expressions(expression, key="joins", sep="", skip_first=True) 1455 laterals = self.expressions(expression, key="laterals", sep="") 1456 1457 file_format = self.sql(expression, "format") 1458 if file_format: 1459 pattern = self.sql(expression, "pattern") 1460 pattern = f", PATTERN => {pattern}" if pattern else "" 1461 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1462 1463 index = self.sql(expression, "index") 1464 index = f" AT {index}" if index else "" 1465 1466 ordinality = expression.args.get("ordinality") or "" 1467 if ordinality: 1468 ordinality = f" WITH ORDINALITY{alias}" 1469 alias = "" 1470 1471 return f"{table}{version}{file_format}{alias}{index}{hints}{pivots}{joins}{laterals}{ordinality}"
def
tablesample_sql( self, expression: sqlglot.expressions.TableSample, seed_prefix: str = 'SEED', sep=' AS ') -> str:
1473 def tablesample_sql( 1474 self, expression: exp.TableSample, seed_prefix: str = "SEED", sep=" AS " 1475 ) -> str: 1476 if self.ALIAS_POST_TABLESAMPLE and expression.this and expression.this.alias: 1477 table = expression.this.copy() 1478 table.set("alias", None) 1479 this = self.sql(table) 1480 alias = f"{sep}{self.sql(expression.this, 'alias')}" 1481 else: 1482 this = self.sql(expression, "this") 1483 alias = "" 1484 1485 method = self.sql(expression, "method") 1486 method = f"{method.upper()} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1487 numerator = self.sql(expression, "bucket_numerator") 1488 denominator = self.sql(expression, "bucket_denominator") 1489 field = self.sql(expression, "bucket_field") 1490 field = f" ON {field}" if field else "" 1491 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1492 percent = self.sql(expression, "percent") 1493 percent = f"{percent} PERCENT" if percent else "" 1494 rows = self.sql(expression, "rows") 1495 rows = f"{rows} ROWS" if rows else "" 1496 1497 size = self.sql(expression, "size") 1498 if size and self.TABLESAMPLE_SIZE_IS_PERCENT: 1499 size = f"{size} PERCENT" 1500 1501 seed = self.sql(expression, "seed") 1502 seed = f" {seed_prefix} ({seed})" if seed else "" 1503 kind = expression.args.get("kind", "TABLESAMPLE") 1504 1505 expr = f"{bucket}{percent}{rows}{size}" 1506 if self.TABLESAMPLE_REQUIRES_PARENS: 1507 expr = f"({expr})" 1508 1509 return f"{this} {kind} {method}{expr}{seed}{alias}"
1511 def pivot_sql(self, expression: exp.Pivot) -> str: 1512 expressions = self.expressions(expression, flat=True) 1513 1514 if expression.this: 1515 this = self.sql(expression, "this") 1516 if not expressions: 1517 return f"UNPIVOT {this}" 1518 1519 on = f"{self.seg('ON')} {expressions}" 1520 using = self.expressions(expression, key="using", flat=True) 1521 using = f"{self.seg('USING')} {using}" if using else "" 1522 group = self.sql(expression, "group") 1523 return f"PIVOT {this}{on}{using}{group}" 1524 1525 alias = self.sql(expression, "alias") 1526 alias = f" AS {alias}" if alias else "" 1527 unpivot = expression.args.get("unpivot") 1528 direction = "UNPIVOT" if unpivot else "PIVOT" 1529 field = self.sql(expression, "field") 1530 include_nulls = expression.args.get("include_nulls") 1531 if include_nulls is not None: 1532 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1533 else: 1534 nulls = "" 1535 return f"{direction}{nulls}({expressions} FOR {field}){alias}"
1546 def update_sql(self, expression: exp.Update) -> str: 1547 this = self.sql(expression, "this") 1548 set_sql = self.expressions(expression, flat=True) 1549 from_sql = self.sql(expression, "from") 1550 where_sql = self.sql(expression, "where") 1551 returning = self.sql(expression, "returning") 1552 order = self.sql(expression, "order") 1553 limit = self.sql(expression, "limit") 1554 if self.RETURNING_END: 1555 expression_sql = f"{from_sql}{where_sql}{returning}" 1556 else: 1557 expression_sql = f"{returning}{from_sql}{where_sql}" 1558 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 1559 return self.prepend_ctes(expression, sql)
1561 def values_sql(self, expression: exp.Values) -> str: 1562 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 1563 if self.VALUES_AS_TABLE or not expression.find_ancestor(exp.From, exp.Join): 1564 args = self.expressions(expression) 1565 alias = self.sql(expression, "alias") 1566 values = f"VALUES{self.seg('')}{args}" 1567 values = ( 1568 f"({values})" 1569 if self.WRAP_DERIVED_VALUES and (alias or isinstance(expression.parent, exp.From)) 1570 else values 1571 ) 1572 return f"{values} AS {alias}" if alias else values 1573 1574 # Converts `VALUES...` expression into a series of select unions. 1575 alias_node = expression.args.get("alias") 1576 column_names = alias_node and alias_node.columns 1577 1578 selects: t.List[exp.Subqueryable] = [] 1579 1580 for i, tup in enumerate(expression.expressions): 1581 row = tup.expressions 1582 1583 if i == 0 and column_names: 1584 row = [ 1585 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 1586 ] 1587 1588 selects.append(exp.Select(expressions=row)) 1589 1590 if self.pretty: 1591 # This may result in poor performance for large-cardinality `VALUES` tables, due to 1592 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 1593 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 1594 subqueryable = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 1595 return self.subquery_sql( 1596 subqueryable.subquery(alias_node and alias_node.this, copy=False) 1597 ) 1598 1599 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 1600 unions = " UNION ALL ".join(self.sql(select) for select in selects) 1601 return f"({unions}){alias}"
1614 def group_sql(self, expression: exp.Group) -> str: 1615 group_by = self.op_expressions("GROUP BY", expression) 1616 1617 if expression.args.get("all"): 1618 return f"{group_by} ALL" 1619 1620 grouping_sets = self.expressions(expression, key="grouping_sets", indent=False) 1621 grouping_sets = ( 1622 f"{self.seg('GROUPING SETS')} {self.wrap(grouping_sets)}" if grouping_sets else "" 1623 ) 1624 1625 cube = expression.args.get("cube", []) 1626 if seq_get(cube, 0) is True: 1627 return f"{group_by}{self.seg('WITH CUBE')}" 1628 else: 1629 cube_sql = self.expressions(expression, key="cube", indent=False) 1630 cube_sql = f"{self.seg('CUBE')} {self.wrap(cube_sql)}" if cube_sql else "" 1631 1632 rollup = expression.args.get("rollup", []) 1633 if seq_get(rollup, 0) is True: 1634 return f"{group_by}{self.seg('WITH ROLLUP')}" 1635 else: 1636 rollup_sql = self.expressions(expression, key="rollup", indent=False) 1637 rollup_sql = f"{self.seg('ROLLUP')} {self.wrap(rollup_sql)}" if rollup_sql else "" 1638 1639 groupings = csv( 1640 grouping_sets, 1641 cube_sql, 1642 rollup_sql, 1643 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 1644 sep=self.GROUPINGS_SEP, 1645 ) 1646 1647 if expression.args.get("expressions") and groupings: 1648 group_by = f"{group_by}{self.GROUPINGS_SEP}" 1649 1650 return f"{group_by}{groupings}"
1666 def join_sql(self, expression: exp.Join) -> str: 1667 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 1668 side = None 1669 else: 1670 side = expression.side 1671 1672 op_sql = " ".join( 1673 op 1674 for op in ( 1675 expression.method, 1676 "GLOBAL" if expression.args.get("global") else None, 1677 side, 1678 expression.kind, 1679 expression.hint if self.JOIN_HINTS else None, 1680 ) 1681 if op 1682 ) 1683 on_sql = self.sql(expression, "on") 1684 using = expression.args.get("using") 1685 1686 if not on_sql and using: 1687 on_sql = csv(*(self.sql(column) for column in using)) 1688 1689 this_sql = self.sql(expression, "this") 1690 1691 if on_sql: 1692 on_sql = self.indent(on_sql, skip_first=True) 1693 space = self.seg(" " * self.pad) if self.pretty else " " 1694 if using: 1695 on_sql = f"{space}USING ({on_sql})" 1696 else: 1697 on_sql = f"{space}ON {on_sql}" 1698 elif not op_sql: 1699 return f", {this_sql}" 1700 1701 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 1702 return f"{self.seg(op_sql)} {this_sql}{on_sql}"
1709 def lateral_sql(self, expression: exp.Lateral) -> str: 1710 this = self.sql(expression, "this") 1711 1712 if expression.args.get("view"): 1713 alias = expression.args["alias"] 1714 columns = self.expressions(alias, key="columns", flat=True) 1715 table = f" {alias.name}" if alias.name else "" 1716 columns = f" AS {columns}" if columns else "" 1717 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 1718 return f"{op_sql}{self.sep()}{this}{table}{columns}" 1719 1720 alias = self.sql(expression, "alias") 1721 alias = f" AS {alias}" if alias else "" 1722 return f"LATERAL {this}{alias}"
1724 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 1725 this = self.sql(expression, "this") 1726 1727 args = [ 1728 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 1729 for e in (expression.args.get(k) for k in ("offset", "expression")) 1730 if e 1731 ] 1732 1733 args_sql = ", ".join(self.sql(e) for e in args) 1734 args_sql = f"({args_sql})" if any(top and not e.is_number for e in args) else args_sql 1735 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}"
1737 def offset_sql(self, expression: exp.Offset) -> str: 1738 this = self.sql(expression, "this") 1739 expression = expression.expression 1740 expression = ( 1741 self._simplify_unless_literal(expression) if self.LIMIT_ONLY_LITERALS else expression 1742 ) 1743 return f"{this}{self.seg('OFFSET')} {self.sql(expression)}"
1745 def setitem_sql(self, expression: exp.SetItem) -> str: 1746 kind = self.sql(expression, "kind") 1747 kind = f"{kind} " if kind else "" 1748 this = self.sql(expression, "this") 1749 expressions = self.expressions(expression) 1750 collate = self.sql(expression, "collate") 1751 collate = f" COLLATE {collate}" if collate else "" 1752 global_ = "GLOBAL " if expression.args.get("global") else "" 1753 return f"{global_}{kind}{this}{expressions}{collate}"
1755 def set_sql(self, expression: exp.Set) -> str: 1756 expressions = ( 1757 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 1758 ) 1759 tag = " TAG" if expression.args.get("tag") else "" 1760 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}"
1765 def lock_sql(self, expression: exp.Lock) -> str: 1766 if not self.LOCKING_READS_SUPPORTED: 1767 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 1768 return "" 1769 1770 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 1771 expressions = self.expressions(expression, flat=True) 1772 expressions = f" OF {expressions}" if expressions else "" 1773 wait = expression.args.get("wait") 1774 1775 if wait is not None: 1776 if isinstance(wait, exp.Literal): 1777 wait = f" WAIT {self.sql(wait)}" 1778 else: 1779 wait = " NOWAIT" if wait else " SKIP LOCKED" 1780 1781 return f"{lock_type}{expressions}{wait or ''}"
def
escape_str(self, text: str) -> str:
1789 def escape_str(self, text: str) -> str: 1790 text = text.replace(self.QUOTE_END, self._escaped_quote_end) 1791 if self.INVERSE_ESCAPE_SEQUENCES: 1792 text = "".join(self.INVERSE_ESCAPE_SEQUENCES.get(ch, ch) for ch in text) 1793 elif self.pretty: 1794 text = text.replace("\n", self.SENTINEL_LINE_BREAK) 1795 return text
1797 def loaddata_sql(self, expression: exp.LoadData) -> str: 1798 local = " LOCAL" if expression.args.get("local") else "" 1799 inpath = f" INPATH {self.sql(expression, 'inpath')}" 1800 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 1801 this = f" INTO TABLE {self.sql(expression, 'this')}" 1802 partition = self.sql(expression, "partition") 1803 partition = f" {partition}" if partition else "" 1804 input_format = self.sql(expression, "input_format") 1805 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 1806 serde = self.sql(expression, "serde") 1807 serde = f" SERDE {serde}" if serde else "" 1808 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}"
1830 def ordered_sql(self, expression: exp.Ordered) -> str: 1831 desc = expression.args.get("desc") 1832 asc = not desc 1833 1834 nulls_first = expression.args.get("nulls_first") 1835 nulls_last = not nulls_first 1836 nulls_are_large = self.NULL_ORDERING == "nulls_are_large" 1837 nulls_are_small = self.NULL_ORDERING == "nulls_are_small" 1838 nulls_are_last = self.NULL_ORDERING == "nulls_are_last" 1839 1840 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 1841 nulls_sort_change = "" 1842 if nulls_first and ( 1843 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 1844 ): 1845 nulls_sort_change = " NULLS FIRST" 1846 elif ( 1847 nulls_last 1848 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 1849 and not nulls_are_last 1850 ): 1851 nulls_sort_change = " NULLS LAST" 1852 1853 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 1854 self.unsupported( 1855 "Sorting in an ORDER BY on NULLS FIRST/NULLS LAST is not supported by this dialect" 1856 ) 1857 nulls_sort_change = "" 1858 1859 return f"{self.sql(expression, 'this')}{sort_order}{nulls_sort_change}"
1861 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 1862 partition = self.partition_by_sql(expression) 1863 order = self.sql(expression, "order") 1864 measures = self.expressions(expression, key="measures") 1865 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 1866 rows = self.sql(expression, "rows") 1867 rows = self.seg(rows) if rows else "" 1868 after = self.sql(expression, "after") 1869 after = self.seg(after) if after else "" 1870 pattern = self.sql(expression, "pattern") 1871 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 1872 definition_sqls = [ 1873 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 1874 for definition in expression.args.get("define", []) 1875 ] 1876 definitions = self.expressions(sqls=definition_sqls) 1877 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 1878 body = "".join( 1879 ( 1880 partition, 1881 order, 1882 measures, 1883 rows, 1884 after, 1885 pattern, 1886 define, 1887 ) 1888 ) 1889 alias = self.sql(expression, "alias") 1890 alias = f" {alias}" if alias else "" 1891 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}"
1893 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 1894 limit: t.Optional[exp.Fetch | exp.Limit] = expression.args.get("limit") 1895 1896 # If the limit is generated as TOP, we need to ensure it's not generated twice 1897 with_offset_limit_modifiers = not isinstance(limit, exp.Limit) or not self.LIMIT_IS_TOP 1898 1899 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 1900 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 1901 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 1902 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 1903 1904 fetch = isinstance(limit, exp.Fetch) 1905 1906 offset_limit_modifiers = ( 1907 self.offset_limit_modifiers(expression, fetch, limit) 1908 if with_offset_limit_modifiers 1909 else [] 1910 ) 1911 1912 return csv( 1913 *sqls, 1914 *[self.sql(join) for join in expression.args.get("joins") or []], 1915 self.sql(expression, "connect"), 1916 self.sql(expression, "match"), 1917 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 1918 self.sql(expression, "where"), 1919 self.sql(expression, "group"), 1920 self.sql(expression, "having"), 1921 *self.after_having_modifiers(expression), 1922 self.sql(expression, "order"), 1923 *offset_limit_modifiers, 1924 *self.after_limit_modifiers(expression), 1925 sep="", 1926 )
def
offset_limit_modifiers( self, expression: sqlglot.expressions.Expression, fetch: bool, limit: Union[sqlglot.expressions.Fetch, sqlglot.expressions.Limit, NoneType]) -> List[str]:
1928 def offset_limit_modifiers( 1929 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 1930 ) -> t.List[str]: 1931 return [ 1932 self.sql(expression, "offset") if fetch else self.sql(limit), 1933 self.sql(limit) if fetch else self.sql(expression, "offset"), 1934 ]
1936 def after_having_modifiers(self, expression: exp.Expression) -> t.List[str]: 1937 return [ 1938 self.sql(expression, "qualify"), 1939 self.seg("WINDOW ") + self.expressions(expression, key="windows", flat=True) 1940 if expression.args.get("windows") 1941 else "", 1942 self.sql(expression, "distribute"), 1943 self.sql(expression, "sort"), 1944 self.sql(expression, "cluster"), 1945 ]
1952 def select_sql(self, expression: exp.Select) -> str: 1953 hint = self.sql(expression, "hint") 1954 distinct = self.sql(expression, "distinct") 1955 distinct = f" {distinct}" if distinct else "" 1956 kind = self.sql(expression, "kind").upper() 1957 limit = expression.args.get("limit") 1958 top = ( 1959 self.limit_sql(limit, top=True) 1960 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP 1961 else "" 1962 ) 1963 1964 expressions = self.expressions(expression) 1965 1966 if kind: 1967 if kind in self.SELECT_KINDS: 1968 kind = f" AS {kind}" 1969 else: 1970 if kind == "STRUCT": 1971 expressions = self.expressions( 1972 sqls=[ 1973 self.sql( 1974 exp.Struct( 1975 expressions=[ 1976 exp.column(e.output_name).eq( 1977 e.this if isinstance(e, exp.Alias) else e 1978 ) 1979 for e in expression.expressions 1980 ] 1981 ) 1982 ) 1983 ] 1984 ) 1985 kind = "" 1986 1987 expressions = f"{self.sep()}{expressions}" if expressions else expressions 1988 sql = self.query_modifiers( 1989 expression, 1990 f"SELECT{top}{hint}{distinct}{kind}{expressions}", 1991 self.sql(expression, "into", comment=False), 1992 self.sql(expression, "from", comment=False), 1993 ) 1994 return self.prepend_ctes(expression, sql)
2006 def star_sql(self, expression: exp.Star) -> str: 2007 except_ = self.expressions(expression, key="except", flat=True) 2008 except_ = f"{self.seg(self.STAR_MAPPING['except'])} ({except_})" if except_ else "" 2009 replace = self.expressions(expression, key="replace", flat=True) 2010 replace = f"{self.seg(self.STAR_MAPPING['replace'])} ({replace})" if replace else "" 2011 return f"*{except_}{replace}"
2027 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2028 alias = self.sql(expression, "alias") 2029 alias = f"{sep}{alias}" if alias else "" 2030 2031 pivots = self.expressions(expression, key="pivots", sep=" ", flat=True) 2032 pivots = f" {pivots}" if pivots else "" 2033 2034 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2035 return self.prepend_ctes(expression, sql)
2053 def unnest_sql(self, expression: exp.Unnest) -> str: 2054 args = self.expressions(expression, flat=True) 2055 2056 alias = expression.args.get("alias") 2057 offset = expression.args.get("offset") 2058 2059 if self.UNNEST_WITH_ORDINALITY: 2060 if alias and isinstance(offset, exp.Expression): 2061 alias.append("columns", offset) 2062 2063 if alias and self.UNNEST_COLUMN_ONLY: 2064 columns = alias.columns 2065 alias = self.sql(columns[0]) if columns else "" 2066 else: 2067 alias = self.sql(alias) 2068 2069 alias = f" AS {alias}" if alias else alias 2070 if self.UNNEST_WITH_ORDINALITY: 2071 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2072 else: 2073 if isinstance(offset, exp.Expression): 2074 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2075 elif offset: 2076 suffix = f"{alias} WITH OFFSET" 2077 else: 2078 suffix = alias 2079 2080 return f"UNNEST({args}){suffix}"
2086 def window_sql(self, expression: exp.Window) -> str: 2087 this = self.sql(expression, "this") 2088 partition = self.partition_by_sql(expression) 2089 order = expression.args.get("order") 2090 order = self.order_sql(order, flat=True) if order else "" 2091 spec = self.sql(expression, "spec") 2092 alias = self.sql(expression, "alias") 2093 over = self.sql(expression, "over") or "OVER" 2094 2095 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2096 2097 first = expression.args.get("first") 2098 if first is None: 2099 first = "" 2100 else: 2101 first = "FIRST" if first else "LAST" 2102 2103 if not partition and not order and not spec and alias: 2104 return f"{this} {alias}" 2105 2106 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2107 return f"{this} ({args})"
def
partition_by_sql( self, expression: sqlglot.expressions.Window | sqlglot.expressions.MatchRecognize) -> str:
2113 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2114 kind = self.sql(expression, "kind") 2115 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2116 end = ( 2117 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2118 or "CURRENT ROW" 2119 ) 2120 return f"{kind} BETWEEN {start} AND {end}"
2154 def case_sql(self, expression: exp.Case) -> str: 2155 this = self.sql(expression, "this") 2156 statements = [f"CASE {this}" if this else "CASE"] 2157 2158 for e in expression.args["ifs"]: 2159 statements.append(f"WHEN {self.sql(e, 'this')}") 2160 statements.append(f"THEN {self.sql(e, 'true')}") 2161 2162 default = self.sql(expression, "default") 2163 2164 if default: 2165 statements.append(f"ELSE {default}") 2166 2167 statements.append("END") 2168 2169 if self.pretty and self.text_width(statements) > self.max_text_width: 2170 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2171 2172 return " ".join(statements)
2189 def trim_sql(self, expression: exp.Trim) -> str: 2190 trim_type = self.sql(expression, "position") 2191 2192 if trim_type == "LEADING": 2193 return self.func("LTRIM", expression.this) 2194 elif trim_type == "TRAILING": 2195 return self.func("RTRIM", expression.this) 2196 else: 2197 return self.func("TRIM", expression.this, expression.expression)
2209 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2210 expressions = self.expressions(expression, flat=True) 2211 reference = self.sql(expression, "reference") 2212 reference = f" {reference}" if reference else "" 2213 delete = self.sql(expression, "delete") 2214 delete = f" ON DELETE {delete}" if delete else "" 2215 update = self.sql(expression, "update") 2216 update = f" ON UPDATE {update}" if update else "" 2217 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}"
2219 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2220 expressions = self.expressions(expression, flat=True) 2221 options = self.expressions(expression, key="options", flat=True, sep=" ") 2222 options = f" {options}" if options else "" 2223 return f"PRIMARY KEY ({expressions}){options}"
2239 def jsonobject_sql(self, expression: exp.JSONObject) -> str: 2240 null_handling = expression.args.get("null_handling") 2241 null_handling = f" {null_handling}" if null_handling else "" 2242 unique_keys = expression.args.get("unique_keys") 2243 if unique_keys is not None: 2244 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2245 else: 2246 unique_keys = "" 2247 return_type = self.sql(expression, "return_type") 2248 return_type = f" RETURNING {return_type}" if return_type else "" 2249 encoding = self.sql(expression, "encoding") 2250 encoding = f" ENCODING {encoding}" if encoding else "" 2251 return self.func( 2252 "JSON_OBJECT", 2253 *expression.expressions, 2254 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2255 )
2257 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2258 null_handling = expression.args.get("null_handling") 2259 null_handling = f" {null_handling}" if null_handling else "" 2260 return_type = self.sql(expression, "return_type") 2261 return_type = f" RETURNING {return_type}" if return_type else "" 2262 strict = " STRICT" if expression.args.get("strict") else "" 2263 return self.func( 2264 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2265 )
2267 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2268 this = self.sql(expression, "this") 2269 order = self.sql(expression, "order") 2270 null_handling = expression.args.get("null_handling") 2271 null_handling = f" {null_handling}" if null_handling else "" 2272 return_type = self.sql(expression, "return_type") 2273 return_type = f" RETURNING {return_type}" if return_type else "" 2274 strict = " STRICT" if expression.args.get("strict") else "" 2275 return self.func( 2276 "JSON_ARRAYAGG", 2277 this, 2278 suffix=f"{order}{null_handling}{return_type}{strict})", 2279 )
2281 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2282 path = self.sql(expression, "path") 2283 path = f" PATH {path}" if path else "" 2284 nested_schema = self.sql(expression, "nested_schema") 2285 2286 if nested_schema: 2287 return f"NESTED{path} {nested_schema}" 2288 2289 this = self.sql(expression, "this") 2290 kind = self.sql(expression, "kind") 2291 kind = f" {kind}" if kind else "" 2292 return f"{this}{kind}{path}"
2297 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2298 this = self.sql(expression, "this") 2299 path = self.sql(expression, "path") 2300 path = f", {path}" if path else "" 2301 error_handling = expression.args.get("error_handling") 2302 error_handling = f" {error_handling}" if error_handling else "" 2303 empty_handling = expression.args.get("empty_handling") 2304 empty_handling = f" {empty_handling}" if empty_handling else "" 2305 schema = self.sql(expression, "schema") 2306 return self.func( 2307 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2308 )
2310 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2311 this = self.sql(expression, "this") 2312 kind = self.sql(expression, "kind") 2313 path = self.sql(expression, "path") 2314 path = f" {path}" if path else "" 2315 as_json = " AS JSON" if expression.args.get("as_json") else "" 2316 return f"{this} {kind}{path}{as_json}"
2318 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2319 this = self.sql(expression, "this") 2320 path = self.sql(expression, "path") 2321 path = f", {path}" if path else "" 2322 expressions = self.expressions(expression) 2323 with_ = ( 2324 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2325 if expressions 2326 else "" 2327 ) 2328 return f"OPENJSON({this}{path}){with_}"
2330 def in_sql(self, expression: exp.In) -> str: 2331 query = expression.args.get("query") 2332 unnest = expression.args.get("unnest") 2333 field = expression.args.get("field") 2334 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2335 2336 if query: 2337 in_sql = self.wrap(query) 2338 elif unnest: 2339 in_sql = self.in_unnest_op(unnest) 2340 elif field: 2341 in_sql = self.sql(field) 2342 else: 2343 in_sql = f"({self.expressions(expression, flat=True)})" 2344 2345 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}"
2350 def interval_sql(self, expression: exp.Interval) -> str: 2351 unit = self.sql(expression, "unit") 2352 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2353 unit = self.TIME_PART_SINGULARS.get(unit.lower(), unit) 2354 unit = f" {unit}" if unit else "" 2355 2356 if self.SINGLE_STRING_INTERVAL: 2357 this = expression.this.name if expression.this else "" 2358 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2359 2360 this = self.sql(expression, "this") 2361 if this: 2362 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2363 this = f" {this}" if unwrapped else f" ({this})" 2364 2365 return f"INTERVAL{this}{unit}"
2370 def reference_sql(self, expression: exp.Reference) -> str: 2371 this = self.sql(expression, "this") 2372 expressions = self.expressions(expression, flat=True) 2373 expressions = f"({expressions})" if expressions else "" 2374 options = self.expressions(expression, key="options", flat=True, sep=" ") 2375 options = f" {options}" if options else "" 2376 return f"REFERENCES {this}{expressions}{options}"
2381 def paren_sql(self, expression: exp.Paren) -> str: 2382 if isinstance(expression.unnest(), exp.Select): 2383 sql = self.wrap(expression) 2384 else: 2385 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 2386 sql = f"({sql}{self.seg(')', sep='')}" 2387 2388 return self.prepend_ctes(expression, sql)
2421 def connector_sql(self, expression: exp.Connector, op: str) -> str: 2422 if not self.pretty: 2423 return self.binary(expression, op) 2424 2425 sqls = tuple( 2426 self.maybe_comment(self.sql(e), e, e.parent.comments or []) if i != 1 else self.sql(e) 2427 for i, e in enumerate(expression.flatten(unnest=False)) 2428 ) 2429 2430 sep = "\n" if self.text_width(sqls) > self.max_text_width else " " 2431 return f"{sep}{op} ".join(sqls)
def
cast_sql( self, expression: sqlglot.expressions.Cast, safe_prefix: Optional[str] = None) -> str:
2451 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 2452 format_sql = self.sql(expression, "format") 2453 format_sql = f" FORMAT {format_sql}" if format_sql else "" 2454 to_sql = self.sql(expression, "to") 2455 to_sql = f" {to_sql}" if to_sql else "" 2456 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql})"
2470 def comment_sql(self, expression: exp.Comment) -> str: 2471 this = self.sql(expression, "this") 2472 kind = expression.args["kind"] 2473 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 2474 expression_sql = self.sql(expression, "expression") 2475 return f"COMMENT{exists_sql}ON {kind} {this} IS {expression_sql}"
2477 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 2478 this = self.sql(expression, "this") 2479 delete = " DELETE" if expression.args.get("delete") else "" 2480 recompress = self.sql(expression, "recompress") 2481 recompress = f" RECOMPRESS {recompress}" if recompress else "" 2482 to_disk = self.sql(expression, "to_disk") 2483 to_disk = f" TO DISK {to_disk}" if to_disk else "" 2484 to_volume = self.sql(expression, "to_volume") 2485 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 2486 return f"{this}{delete}{recompress}{to_disk}{to_volume}"
2488 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 2489 where = self.sql(expression, "where") 2490 group = self.sql(expression, "group") 2491 aggregates = self.expressions(expression, key="aggregates") 2492 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 2493 2494 if not (where or group or aggregates) and len(expression.expressions) == 1: 2495 return f"TTL {self.expressions(expression, flat=True)}" 2496 2497 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}"
2514 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 2515 this = self.sql(expression, "this") 2516 2517 dtype = self.sql(expression, "dtype") 2518 if dtype: 2519 collate = self.sql(expression, "collate") 2520 collate = f" COLLATE {collate}" if collate else "" 2521 using = self.sql(expression, "using") 2522 using = f" USING {using}" if using else "" 2523 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 2524 2525 default = self.sql(expression, "default") 2526 if default: 2527 return f"ALTER COLUMN {this} SET DEFAULT {default}" 2528 2529 if not expression.args.get("drop"): 2530 self.unsupported("Unsupported ALTER COLUMN syntax") 2531 2532 return f"ALTER COLUMN {this} DROP DEFAULT"
2534 def renametable_sql(self, expression: exp.RenameTable) -> str: 2535 if not self.RENAME_TABLE_WITH_DB: 2536 # Remove db from tables 2537 expression = expression.transform( 2538 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 2539 ) 2540 this = self.sql(expression, "this") 2541 return f"RENAME TO {this}"
2543 def altertable_sql(self, expression: exp.AlterTable) -> str: 2544 actions = expression.args["actions"] 2545 2546 if isinstance(actions[0], exp.ColumnDef): 2547 actions = self.add_column_sql(expression) 2548 elif isinstance(actions[0], exp.Schema): 2549 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 2550 elif isinstance(actions[0], exp.Delete): 2551 actions = self.expressions(expression, key="actions", flat=True) 2552 else: 2553 actions = self.expressions(expression, key="actions", flat=True) 2554 2555 exists = " IF EXISTS" if expression.args.get("exists") else "" 2556 only = " ONLY" if expression.args.get("only") else "" 2557 return f"ALTER TABLE{exists}{only} {self.sql(expression, 'this')} {actions}"
2573 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 2574 this = self.sql(expression, "this") 2575 expression_ = self.sql(expression, "expression") 2576 add_constraint = f"ADD CONSTRAINT {this}" if this else "ADD" 2577 2578 enforced = expression.args.get("enforced") 2579 if enforced is not None: 2580 return f"{add_constraint} CHECK ({expression_}){' ENFORCED' if enforced else ''}" 2581 2582 return f"{add_constraint} {expression_}"
2614 def div_sql(self, expression: exp.Div) -> str: 2615 l, r = expression.left, expression.right 2616 2617 if not self.SAFE_DIVISION and expression.args.get("safe"): 2618 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 2619 2620 if self.TYPED_DIVISION and not expression.args.get("typed"): 2621 if not l.is_type(*exp.DataType.FLOAT_TYPES) and not r.is_type( 2622 *exp.DataType.FLOAT_TYPES 2623 ): 2624 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 2625 2626 elif not self.TYPED_DIVISION and expression.args.get("typed"): 2627 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 2628 return self.sql( 2629 exp.cast( 2630 l / r, 2631 to=exp.DataType.Type.BIGINT, 2632 ) 2633 ) 2634 2635 return self.binary(expression, "/")
2736 def function_fallback_sql(self, expression: exp.Func) -> str: 2737 args = [] 2738 2739 for key in expression.arg_types: 2740 arg_value = expression.args.get(key) 2741 2742 if isinstance(arg_value, list): 2743 for value in arg_value: 2744 args.append(value) 2745 elif arg_value is not None: 2746 args.append(arg_value) 2747 2748 if self.normalize_functions: 2749 name = expression.sql_name() 2750 else: 2751 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 2752 2753 return self.func(name, *args)
def
func( self, name: str, *args: Union[str, sqlglot.expressions.Expression, NoneType], prefix: str = '(', suffix: str = ')') -> str:
2764 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 2765 arg_sqls = tuple(self.sql(arg) for arg in args if arg is not None) 2766 if self.pretty and self.text_width(arg_sqls) > self.max_text_width: 2767 return self.indent("\n" + f",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 2768 return ", ".join(arg_sqls)
def
expressions( self, expression: Optional[sqlglot.expressions.Expression] = None, key: Optional[str] = None, sqls: Optional[Collection[Union[str, sqlglot.expressions.Expression]]] = None, flat: bool = False, indent: bool = True, skip_first: bool = False, sep: str = ', ', prefix: str = '') -> str:
2778 def expressions( 2779 self, 2780 expression: t.Optional[exp.Expression] = None, 2781 key: t.Optional[str] = None, 2782 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 2783 flat: bool = False, 2784 indent: bool = True, 2785 skip_first: bool = False, 2786 sep: str = ", ", 2787 prefix: str = "", 2788 ) -> str: 2789 expressions = expression.args.get(key or "expressions") if expression else sqls 2790 2791 if not expressions: 2792 return "" 2793 2794 if flat: 2795 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 2796 2797 num_sqls = len(expressions) 2798 2799 # These are calculated once in case we have the leading_comma / pretty option set, correspondingly 2800 pad = " " * self.pad 2801 stripped_sep = sep.strip() 2802 2803 result_sqls = [] 2804 for i, e in enumerate(expressions): 2805 sql = self.sql(e, comment=False) 2806 if not sql: 2807 continue 2808 2809 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 2810 2811 if self.pretty: 2812 if self.leading_comma: 2813 result_sqls.append(f"{sep if i > 0 else pad}{prefix}{sql}{comments}") 2814 else: 2815 result_sqls.append( 2816 f"{prefix}{sql}{stripped_sep if i + 1 < num_sqls else ''}{comments}" 2817 ) 2818 else: 2819 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 2820 2821 result_sql = "\n".join(result_sqls) if self.pretty else "".join(result_sqls) 2822 return self.indent(result_sql, skip_first=skip_first) if indent else result_sql
def
op_expressions( self, op: str, expression: sqlglot.expressions.Expression, flat: bool = False) -> str:
2824 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 2825 flat = flat or isinstance(expression.parent, exp.Properties) 2826 expressions_sql = self.expressions(expression, flat=flat) 2827 if flat: 2828 return f"{op} {expressions_sql}" 2829 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}"
2831 def naked_property(self, expression: exp.Property) -> str: 2832 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 2833 if not property_name: 2834 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 2835 return f"{property_name} {self.sql(expression, 'this')}"
2837 def set_operation(self, expression: exp.Union, op: str) -> str: 2838 this = self.maybe_comment(self.sql(expression, "this"), comments=expression.comments) 2839 op = self.seg(op) 2840 return self.query_modifiers( 2841 expression, f"{this}{op}{self.sep()}{self.sql(expression, 'expression')}" 2842 )
2850 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 2851 this = self.sql(expression, "this") 2852 expressions = self.no_identify(self.expressions, expression) 2853 expressions = ( 2854 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 2855 ) 2856 return f"{this}{expressions}"
2866 def when_sql(self, expression: exp.When) -> str: 2867 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 2868 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 2869 condition = self.sql(expression, "condition") 2870 condition = f" AND {condition}" if condition else "" 2871 2872 then_expression = expression.args.get("then") 2873 if isinstance(then_expression, exp.Insert): 2874 then = f"INSERT {self.sql(then_expression, 'this')}" 2875 if "expression" in then_expression.args: 2876 then += f" VALUES {self.sql(then_expression, 'expression')}" 2877 elif isinstance(then_expression, exp.Update): 2878 if isinstance(then_expression.args.get("expressions"), exp.Star): 2879 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 2880 else: 2881 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 2882 else: 2883 then = self.sql(then_expression) 2884 return f"WHEN {matched}{source}{condition} THEN {then}"
2886 def merge_sql(self, expression: exp.Merge) -> str: 2887 table = expression.this 2888 table_alias = "" 2889 2890 hints = table.args.get("hints") 2891 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 2892 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 2893 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 2894 2895 this = self.sql(table) 2896 using = f"USING {self.sql(expression, 'using')}" 2897 on = f"ON {self.sql(expression, 'on')}" 2898 expressions = self.expressions(expression, sep=" ") 2899 2900 return self.prepend_ctes( 2901 expression, f"MERGE INTO {this}{table_alias} {using} {on} {expressions}" 2902 )
2910 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 2911 this = self.sql(expression, "this") 2912 kind = self.sql(expression, "kind") 2913 settings_sql = self.expressions(expression, key="settings", sep=" ") 2914 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 2915 return f"{this}({kind}{args})"
2929 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 2930 expressions = self.expressions(expression, key="expressions", flat=True) 2931 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 2932 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 2933 buckets = self.sql(expression, "buckets") 2934 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS"
2936 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 2937 this = self.sql(expression, "this") 2938 having = self.sql(expression, "having") 2939 2940 if having: 2941 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 2942 2943 return self.func("ANY_VALUE", this)
2945 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 2946 transform = self.func("TRANSFORM", *expression.expressions) 2947 row_format_before = self.sql(expression, "row_format_before") 2948 row_format_before = f" {row_format_before}" if row_format_before else "" 2949 record_writer = self.sql(expression, "record_writer") 2950 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 2951 using = f" USING {self.sql(expression, 'command_script')}" 2952 schema = self.sql(expression, "schema") 2953 schema = f" AS {schema}" if schema else "" 2954 row_format_after = self.sql(expression, "row_format_after") 2955 row_format_after = f" {row_format_after}" if row_format_after else "" 2956 record_reader = self.sql(expression, "record_reader") 2957 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 2958 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}"
2960 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 2961 key_block_size = self.sql(expression, "key_block_size") 2962 if key_block_size: 2963 return f"KEY_BLOCK_SIZE = {key_block_size}" 2964 2965 using = self.sql(expression, "using") 2966 if using: 2967 return f"USING {using}" 2968 2969 parser = self.sql(expression, "parser") 2970 if parser: 2971 return f"WITH PARSER {parser}" 2972 2973 comment = self.sql(expression, "comment") 2974 if comment: 2975 return f"COMMENT {comment}" 2976 2977 visible = expression.args.get("visible") 2978 if visible is not None: 2979 return "VISIBLE" if visible else "INVISIBLE" 2980 2981 engine_attr = self.sql(expression, "engine_attr") 2982 if engine_attr: 2983 return f"ENGINE_ATTRIBUTE = {engine_attr}" 2984 2985 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 2986 if secondary_engine_attr: 2987 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 2988 2989 self.unsupported("Unsupported index constraint option.") 2990 return ""
2992 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 2993 kind = self.sql(expression, "kind") 2994 kind = f"{kind} INDEX" if kind else "INDEX" 2995 this = self.sql(expression, "this") 2996 this = f" {this}" if this else "" 2997 index_type = self.sql(expression, "index_type") 2998 index_type = f" USING {index_type}" if index_type else "" 2999 schema = self.sql(expression, "schema") 3000 schema = f" {schema}" if schema else "" 3001 options = self.expressions(expression, key="options", sep=" ") 3002 options = f" {options}" if options else "" 3003 return f"{kind}{this}{index_type}{schema}{options}"
3005 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3006 if self.NVL2_SUPPORTED: 3007 return self.function_fallback_sql(expression) 3008 3009 case = exp.Case().when( 3010 expression.this.is_(exp.null()).not_(copy=False), 3011 expression.args["true"], 3012 copy=False, 3013 ) 3014 else_cond = expression.args.get("false") 3015 if else_cond: 3016 case.else_(else_cond, copy=False) 3017 3018 return self.sql(case)
3020 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3021 this = self.sql(expression, "this") 3022 expr = self.sql(expression, "expression") 3023 iterator = self.sql(expression, "iterator") 3024 condition = self.sql(expression, "condition") 3025 condition = f" IF {condition}" if condition else "" 3026 return f"{this} FOR {expr} IN {iterator}{condition}"
3034 def predict_sql(self, expression: exp.Predict) -> str: 3035 model = self.sql(expression, "this") 3036 model = f"MODEL {model}" 3037 table = self.sql(expression, "expression") 3038 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3039 parameters = self.sql(expression, "params_struct") 3040 return self.func("PREDICT", model, table, parameters or None)