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