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