sqlglot.generator
1from __future__ import annotations 2 3import logging 4import re 5import typing as t 6from collections import defaultdict 7from functools import reduce, wraps 8 9from sqlglot import exp 10from sqlglot.errors import ErrorLevel, UnsupportedError, concat_messages 11from sqlglot.helper import apply_index_offset, csv, name_sequence, seq_get 12from sqlglot.jsonpath import ALL_JSON_PATH_PARTS, JSON_PATH_PART_TRANSFORMS 13from sqlglot.time import format_time 14from sqlglot.tokens import TokenType 15 16if t.TYPE_CHECKING: 17 from sqlglot._typing import E 18 from sqlglot.dialects.dialect import DialectType 19 20 G = t.TypeVar("G", bound="Generator") 21 GeneratorMethod = t.Callable[[G, E], str] 22 23logger = logging.getLogger("sqlglot") 24 25ESCAPED_UNICODE_RE = re.compile(r"\\(\d+)") 26UNSUPPORTED_TEMPLATE = "Argument '{}' is not supported for expression '{}' when targeting {}." 27 28 29def unsupported_args( 30 *args: t.Union[str, t.Tuple[str, str]], 31) -> t.Callable[[GeneratorMethod], GeneratorMethod]: 32 """ 33 Decorator that can be used to mark certain args of an `Expression` subclass as unsupported. 34 It expects a sequence of argument names or pairs of the form (argument_name, diagnostic_msg). 35 """ 36 diagnostic_by_arg: t.Dict[str, t.Optional[str]] = {} 37 for arg in args: 38 if isinstance(arg, str): 39 diagnostic_by_arg[arg] = None 40 else: 41 diagnostic_by_arg[arg[0]] = arg[1] 42 43 def decorator(func: GeneratorMethod) -> GeneratorMethod: 44 @wraps(func) 45 def _func(generator: G, expression: E) -> str: 46 expression_name = expression.__class__.__name__ 47 dialect_name = generator.dialect.__class__.__name__ 48 49 for arg_name, diagnostic in diagnostic_by_arg.items(): 50 if expression.args.get(arg_name): 51 diagnostic = diagnostic or UNSUPPORTED_TEMPLATE.format( 52 arg_name, expression_name, dialect_name 53 ) 54 generator.unsupported(diagnostic) 55 56 return func(generator, expression) 57 58 return _func 59 60 return decorator 61 62 63class _Generator(type): 64 def __new__(cls, clsname, bases, attrs): 65 klass = super().__new__(cls, clsname, bases, attrs) 66 67 # Remove transforms that correspond to unsupported JSONPathPart expressions 68 for part in ALL_JSON_PATH_PARTS - klass.SUPPORTED_JSON_PATH_PARTS: 69 klass.TRANSFORMS.pop(part, None) 70 71 return klass 72 73 74class Generator(metaclass=_Generator): 75 """ 76 Generator converts a given syntax tree to the corresponding SQL string. 77 78 Args: 79 pretty: Whether to format the produced SQL string. 80 Default: False. 81 identify: Determines when an identifier should be quoted. Possible values are: 82 False (default): Never quote, except in cases where it's mandatory by the dialect. 83 True or 'always': Always quote. 84 'safe': Only quote identifiers that are case insensitive. 85 normalize: Whether to normalize identifiers to lowercase. 86 Default: False. 87 pad: The pad size in a formatted string. For example, this affects the indentation of 88 a projection in a query, relative to its nesting level. 89 Default: 2. 90 indent: The indentation size in a formatted string. For example, this affects the 91 indentation of subqueries and filters under a `WHERE` clause. 92 Default: 2. 93 normalize_functions: How to normalize function names. Possible values are: 94 "upper" or True (default): Convert names to uppercase. 95 "lower": Convert names to lowercase. 96 False: Disables function name normalization. 97 unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. 98 Default ErrorLevel.WARN. 99 max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. 100 This is only relevant if unsupported_level is ErrorLevel.RAISE. 101 Default: 3 102 leading_comma: Whether the comma is leading or trailing in select expressions. 103 This is only relevant when generating in pretty mode. 104 Default: False 105 max_text_width: The max number of characters in a segment before creating new lines in pretty mode. 106 The default is on the smaller end because the length only represents a segment and not the true 107 line length. 108 Default: 80 109 comments: Whether to preserve comments in the output SQL code. 110 Default: True 111 """ 112 113 TRANSFORMS: t.Dict[t.Type[exp.Expression], t.Callable[..., str]] = { 114 **JSON_PATH_PART_TRANSFORMS, 115 exp.AllowedValuesProperty: lambda self, 116 e: f"ALLOWED_VALUES {self.expressions(e, flat=True)}", 117 exp.ArrayContainsAll: lambda self, e: self.binary(e, "@>"), 118 exp.ArrayOverlaps: lambda self, e: self.binary(e, "&&"), 119 exp.AutoRefreshProperty: lambda self, e: f"AUTO REFRESH {self.sql(e, 'this')}", 120 exp.BackupProperty: lambda self, e: f"BACKUP {self.sql(e, 'this')}", 121 exp.CaseSpecificColumnConstraint: lambda _, 122 e: f"{'NOT ' if e.args.get('not_') else ''}CASESPECIFIC", 123 exp.CharacterSetColumnConstraint: lambda self, e: f"CHARACTER SET {self.sql(e, 'this')}", 124 exp.CharacterSetProperty: lambda self, 125 e: f"{'DEFAULT ' if e.args.get('default') else ''}CHARACTER SET={self.sql(e, 'this')}", 126 exp.ClusteredColumnConstraint: lambda self, 127 e: f"CLUSTERED ({self.expressions(e, 'this', indent=False)})", 128 exp.CollateColumnConstraint: lambda self, e: f"COLLATE {self.sql(e, 'this')}", 129 exp.CommentColumnConstraint: lambda self, e: f"COMMENT {self.sql(e, 'this')}", 130 exp.ConnectByRoot: lambda self, e: f"CONNECT_BY_ROOT {self.sql(e, 'this')}", 131 exp.CopyGrantsProperty: lambda *_: "COPY GRANTS", 132 exp.DateFormatColumnConstraint: lambda self, e: f"FORMAT {self.sql(e, 'this')}", 133 exp.DefaultColumnConstraint: lambda self, e: f"DEFAULT {self.sql(e, 'this')}", 134 exp.DynamicProperty: lambda *_: "DYNAMIC", 135 exp.EmptyProperty: lambda *_: "EMPTY", 136 exp.EncodeColumnConstraint: lambda self, e: f"ENCODE {self.sql(e, 'this')}", 137 exp.EphemeralColumnConstraint: lambda self, 138 e: f"EPHEMERAL{(' ' + self.sql(e, 'this')) if e.this else ''}", 139 exp.ExcludeColumnConstraint: lambda self, e: f"EXCLUDE {self.sql(e, 'this').lstrip()}", 140 exp.ExecuteAsProperty: lambda self, e: self.naked_property(e), 141 exp.Except: lambda self, e: self.set_operations(e), 142 exp.ExternalProperty: lambda *_: "EXTERNAL", 143 exp.GlobalProperty: lambda *_: "GLOBAL", 144 exp.HeapProperty: lambda *_: "HEAP", 145 exp.IcebergProperty: lambda *_: "ICEBERG", 146 exp.InheritsProperty: lambda self, e: f"INHERITS ({self.expressions(e, flat=True)})", 147 exp.InlineLengthColumnConstraint: lambda self, e: f"INLINE LENGTH {self.sql(e, 'this')}", 148 exp.InputModelProperty: lambda self, e: f"INPUT{self.sql(e, 'this')}", 149 exp.Intersect: lambda self, e: self.set_operations(e), 150 exp.IntervalSpan: lambda self, e: f"{self.sql(e, 'this')} TO {self.sql(e, 'expression')}", 151 exp.LanguageProperty: lambda self, e: self.naked_property(e), 152 exp.LocationProperty: lambda self, e: self.naked_property(e), 153 exp.LogProperty: lambda _, e: f"{'NO ' if e.args.get('no') else ''}LOG", 154 exp.MaterializedProperty: lambda *_: "MATERIALIZED", 155 exp.NonClusteredColumnConstraint: lambda self, 156 e: f"NONCLUSTERED ({self.expressions(e, 'this', indent=False)})", 157 exp.NoPrimaryIndexProperty: lambda *_: "NO PRIMARY INDEX", 158 exp.NotForReplicationColumnConstraint: lambda *_: "NOT FOR REPLICATION", 159 exp.OnCommitProperty: lambda _, 160 e: f"ON COMMIT {'DELETE' if e.args.get('delete') else 'PRESERVE'} ROWS", 161 exp.OnProperty: lambda self, e: f"ON {self.sql(e, 'this')}", 162 exp.OnUpdateColumnConstraint: lambda self, e: f"ON UPDATE {self.sql(e, 'this')}", 163 exp.Operator: lambda self, e: self.binary(e, ""), # The operator is produced in `binary` 164 exp.OutputModelProperty: lambda self, e: f"OUTPUT{self.sql(e, 'this')}", 165 exp.PathColumnConstraint: lambda self, e: f"PATH {self.sql(e, 'this')}", 166 exp.PivotAny: lambda self, e: f"ANY{self.sql(e, 'this')}", 167 exp.ProjectionPolicyColumnConstraint: lambda self, 168 e: f"PROJECTION POLICY {self.sql(e, 'this')}", 169 exp.RemoteWithConnectionModelProperty: lambda self, 170 e: f"REMOTE WITH CONNECTION {self.sql(e, 'this')}", 171 exp.ReturnsProperty: lambda self, e: ( 172 "RETURNS NULL ON NULL INPUT" if e.args.get("null") else self.naked_property(e) 173 ), 174 exp.SampleProperty: lambda self, e: f"SAMPLE BY {self.sql(e, 'this')}", 175 exp.SecureProperty: lambda *_: "SECURE", 176 exp.SecurityProperty: lambda self, e: f"SECURITY {self.sql(e, 'this')}", 177 exp.SetConfigProperty: lambda self, e: self.sql(e, "this"), 178 exp.SetProperty: lambda _, e: f"{'MULTI' if e.args.get('multi') else ''}SET", 179 exp.SettingsProperty: lambda self, e: f"SETTINGS{self.seg('')}{(self.expressions(e))}", 180 exp.SharingProperty: lambda self, e: f"SHARING={self.sql(e, 'this')}", 181 exp.SqlReadWriteProperty: lambda _, e: e.name, 182 exp.SqlSecurityProperty: lambda _, 183 e: f"SQL SECURITY {'DEFINER' if e.args.get('definer') else 'INVOKER'}", 184 exp.StabilityProperty: lambda _, e: e.name, 185 exp.Stream: lambda self, e: f"STREAM {self.sql(e, 'this')}", 186 exp.StreamingTableProperty: lambda *_: "STREAMING", 187 exp.StrictProperty: lambda *_: "STRICT", 188 exp.TemporaryProperty: lambda *_: "TEMPORARY", 189 exp.TagColumnConstraint: lambda self, e: f"TAG ({self.expressions(e, flat=True)})", 190 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 191 exp.ToMap: lambda self, e: f"MAP {self.sql(e, 'this')}", 192 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 193 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 194 exp.TransientProperty: lambda *_: "TRANSIENT", 195 exp.Union: lambda self, e: self.set_operations(e), 196 exp.UnloggedProperty: lambda *_: "UNLOGGED", 197 exp.Uuid: lambda *_: "UUID()", 198 exp.UppercaseColumnConstraint: lambda *_: "UPPERCASE", 199 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 200 exp.ViewAttributeProperty: lambda self, e: f"WITH {self.sql(e, 'this')}", 201 exp.VolatileProperty: lambda *_: "VOLATILE", 202 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 203 exp.WithSchemaBindingProperty: lambda self, e: f"WITH SCHEMA {self.sql(e, 'this')}", 204 exp.WithOperator: lambda self, e: f"{self.sql(e, 'this')} WITH {self.sql(e, 'op')}", 205 } 206 207 # Whether null ordering is supported in order by 208 # True: Full Support, None: No support, False: No support for certain cases 209 # such as window specifications, aggregate functions etc 210 NULL_ORDERING_SUPPORTED: t.Optional[bool] = True 211 212 # Whether ignore nulls is inside the agg or outside. 213 # FIRST(x IGNORE NULLS) OVER vs FIRST (x) IGNORE NULLS OVER 214 IGNORE_NULLS_IN_FUNC = False 215 216 # Whether locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 217 LOCKING_READS_SUPPORTED = False 218 219 # Whether the EXCEPT and INTERSECT operations can return duplicates 220 EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = True 221 222 # Wrap derived values in parens, usually standard but spark doesn't support it 223 WRAP_DERIVED_VALUES = True 224 225 # Whether create function uses an AS before the RETURN 226 CREATE_FUNCTION_RETURN_AS = True 227 228 # Whether MERGE ... WHEN MATCHED BY SOURCE is allowed 229 MATCHED_BY_SOURCE = True 230 231 # Whether the INTERVAL expression works only with values like '1 day' 232 SINGLE_STRING_INTERVAL = False 233 234 # Whether the plural form of date parts like day (i.e. "days") is supported in INTERVALs 235 INTERVAL_ALLOWS_PLURAL_FORM = True 236 237 # Whether limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 238 LIMIT_FETCH = "ALL" 239 240 # Whether limit and fetch allows expresions or just limits 241 LIMIT_ONLY_LITERALS = False 242 243 # Whether a table is allowed to be renamed with a db 244 RENAME_TABLE_WITH_DB = True 245 246 # The separator for grouping sets and rollups 247 GROUPINGS_SEP = "," 248 249 # The string used for creating an index on a table 250 INDEX_ON = "ON" 251 252 # Whether join hints should be generated 253 JOIN_HINTS = True 254 255 # Whether table hints should be generated 256 TABLE_HINTS = True 257 258 # Whether query hints should be generated 259 QUERY_HINTS = True 260 261 # What kind of separator to use for query hints 262 QUERY_HINT_SEP = ", " 263 264 # Whether comparing against booleans (e.g. x IS TRUE) is supported 265 IS_BOOL_ALLOWED = True 266 267 # Whether to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 268 DUPLICATE_KEY_UPDATE_WITH_SET = True 269 270 # Whether to generate the limit as TOP <value> instead of LIMIT <value> 271 LIMIT_IS_TOP = False 272 273 # Whether to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 274 RETURNING_END = True 275 276 # Whether to generate an unquoted value for EXTRACT's date part argument 277 EXTRACT_ALLOWS_QUOTES = True 278 279 # Whether TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 280 TZ_TO_WITH_TIME_ZONE = False 281 282 # Whether the NVL2 function is supported 283 NVL2_SUPPORTED = True 284 285 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 286 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 287 288 # Whether VALUES statements can be used as derived tables. 289 # MySQL 5 and Redshift do not allow this, so when False, it will convert 290 # SELECT * VALUES into SELECT UNION 291 VALUES_AS_TABLE = True 292 293 # Whether the word COLUMN is included when adding a column with ALTER TABLE 294 ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = True 295 296 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 297 UNNEST_WITH_ORDINALITY = True 298 299 # Whether FILTER (WHERE cond) can be used for conditional aggregation 300 AGGREGATE_FILTER_SUPPORTED = True 301 302 # Whether JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 303 SEMI_ANTI_JOIN_WITH_SIDE = True 304 305 # Whether to include the type of a computed column in the CREATE DDL 306 COMPUTED_COLUMN_WITH_TYPE = True 307 308 # Whether CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 309 SUPPORTS_TABLE_COPY = True 310 311 # Whether parentheses are required around the table sample's expression 312 TABLESAMPLE_REQUIRES_PARENS = True 313 314 # Whether a table sample clause's size needs to be followed by the ROWS keyword 315 TABLESAMPLE_SIZE_IS_ROWS = True 316 317 # The keyword(s) to use when generating a sample clause 318 TABLESAMPLE_KEYWORDS = "TABLESAMPLE" 319 320 # Whether the TABLESAMPLE clause supports a method name, like BERNOULLI 321 TABLESAMPLE_WITH_METHOD = True 322 323 # The keyword to use when specifying the seed of a sample clause 324 TABLESAMPLE_SEED_KEYWORD = "SEED" 325 326 # Whether COLLATE is a function instead of a binary operator 327 COLLATE_IS_FUNC = False 328 329 # Whether data types support additional specifiers like e.g. CHAR or BYTE (oracle) 330 DATA_TYPE_SPECIFIERS_ALLOWED = False 331 332 # Whether conditions require booleans WHERE x = 0 vs WHERE x 333 ENSURE_BOOLS = False 334 335 # Whether the "RECURSIVE" keyword is required when defining recursive CTEs 336 CTE_RECURSIVE_KEYWORD_REQUIRED = True 337 338 # Whether CONCAT requires >1 arguments 339 SUPPORTS_SINGLE_ARG_CONCAT = True 340 341 # Whether LAST_DAY function supports a date part argument 342 LAST_DAY_SUPPORTS_DATE_PART = True 343 344 # Whether named columns are allowed in table aliases 345 SUPPORTS_TABLE_ALIAS_COLUMNS = True 346 347 # Whether UNPIVOT aliases are Identifiers (False means they're Literals) 348 UNPIVOT_ALIASES_ARE_IDENTIFIERS = True 349 350 # What delimiter to use for separating JSON key/value pairs 351 JSON_KEY_VALUE_PAIR_SEP = ":" 352 353 # INSERT OVERWRITE TABLE x override 354 INSERT_OVERWRITE = " OVERWRITE TABLE" 355 356 # Whether the SELECT .. INTO syntax is used instead of CTAS 357 SUPPORTS_SELECT_INTO = False 358 359 # Whether UNLOGGED tables can be created 360 SUPPORTS_UNLOGGED_TABLES = False 361 362 # Whether the CREATE TABLE LIKE statement is supported 363 SUPPORTS_CREATE_TABLE_LIKE = True 364 365 # Whether the LikeProperty needs to be specified inside of the schema clause 366 LIKE_PROPERTY_INSIDE_SCHEMA = False 367 368 # Whether DISTINCT can be followed by multiple args in an AggFunc. If not, it will be 369 # transpiled into a series of CASE-WHEN-ELSE, ultimately using a tuple conseisting of the args 370 MULTI_ARG_DISTINCT = True 371 372 # Whether the JSON extraction operators expect a value of type JSON 373 JSON_TYPE_REQUIRED_FOR_EXTRACTION = False 374 375 # Whether bracketed keys like ["foo"] are supported in JSON paths 376 JSON_PATH_BRACKETED_KEY_SUPPORTED = True 377 378 # Whether to escape keys using single quotes in JSON paths 379 JSON_PATH_SINGLE_QUOTE_ESCAPE = False 380 381 # The JSONPathPart expressions supported by this dialect 382 SUPPORTED_JSON_PATH_PARTS = ALL_JSON_PATH_PARTS.copy() 383 384 # Whether any(f(x) for x in array) can be implemented by this dialect 385 CAN_IMPLEMENT_ARRAY_ANY = False 386 387 # Whether the function TO_NUMBER is supported 388 SUPPORTS_TO_NUMBER = True 389 390 # Whether or not set op modifiers apply to the outer set op or select. 391 # SELECT * FROM x UNION SELECT * FROM y LIMIT 1 392 # True means limit 1 happens after the set op, False means it it happens on y. 393 SET_OP_MODIFIERS = True 394 395 # Whether parameters from COPY statement are wrapped in parentheses 396 COPY_PARAMS_ARE_WRAPPED = True 397 398 # Whether values of params are set with "=" token or empty space 399 COPY_PARAMS_EQ_REQUIRED = False 400 401 # Whether COPY statement has INTO keyword 402 COPY_HAS_INTO_KEYWORD = True 403 404 # Whether the conditional TRY(expression) function is supported 405 TRY_SUPPORTED = True 406 407 # Whether the UESCAPE syntax in unicode strings is supported 408 SUPPORTS_UESCAPE = True 409 410 # The keyword to use when generating a star projection with excluded columns 411 STAR_EXCEPT = "EXCEPT" 412 413 # The HEX function name 414 HEX_FUNC = "HEX" 415 416 # The keywords to use when prefixing & separating WITH based properties 417 WITH_PROPERTIES_PREFIX = "WITH" 418 419 # Whether to quote the generated expression of exp.JsonPath 420 QUOTE_JSON_PATH = True 421 422 # Whether the text pattern/fill (3rd) parameter of RPAD()/LPAD() is optional (defaults to space) 423 PAD_FILL_PATTERN_IS_REQUIRED = False 424 425 # Whether a projection can explode into multiple rows, e.g. by unnesting an array. 426 SUPPORTS_EXPLODING_PROJECTIONS = True 427 428 # Whether ARRAY_CONCAT can be generated with varlen args or if it should be reduced to 2-arg version 429 ARRAY_CONCAT_IS_VAR_LEN = True 430 431 # Whether CONVERT_TIMEZONE() is supported; if not, it will be generated as exp.AtTimeZone 432 SUPPORTS_CONVERT_TIMEZONE = False 433 434 # The name to generate for the JSONPath expression. If `None`, only `this` will be generated 435 PARSE_JSON_NAME: t.Optional[str] = "PARSE_JSON" 436 437 TYPE_MAPPING = { 438 exp.DataType.Type.NCHAR: "CHAR", 439 exp.DataType.Type.NVARCHAR: "VARCHAR", 440 exp.DataType.Type.MEDIUMTEXT: "TEXT", 441 exp.DataType.Type.LONGTEXT: "TEXT", 442 exp.DataType.Type.TINYTEXT: "TEXT", 443 exp.DataType.Type.MEDIUMBLOB: "BLOB", 444 exp.DataType.Type.LONGBLOB: "BLOB", 445 exp.DataType.Type.TINYBLOB: "BLOB", 446 exp.DataType.Type.INET: "INET", 447 exp.DataType.Type.ROWVERSION: "VARBINARY", 448 } 449 450 TIME_PART_SINGULARS = { 451 "MICROSECONDS": "MICROSECOND", 452 "SECONDS": "SECOND", 453 "MINUTES": "MINUTE", 454 "HOURS": "HOUR", 455 "DAYS": "DAY", 456 "WEEKS": "WEEK", 457 "MONTHS": "MONTH", 458 "QUARTERS": "QUARTER", 459 "YEARS": "YEAR", 460 } 461 462 AFTER_HAVING_MODIFIER_TRANSFORMS = { 463 "cluster": lambda self, e: self.sql(e, "cluster"), 464 "distribute": lambda self, e: self.sql(e, "distribute"), 465 "sort": lambda self, e: self.sql(e, "sort"), 466 "windows": lambda self, e: ( 467 self.seg("WINDOW ") + self.expressions(e, key="windows", flat=True) 468 if e.args.get("windows") 469 else "" 470 ), 471 "qualify": lambda self, e: self.sql(e, "qualify"), 472 } 473 474 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 475 476 STRUCT_DELIMITER = ("<", ">") 477 478 PARAMETER_TOKEN = "@" 479 NAMED_PLACEHOLDER_TOKEN = ":" 480 481 PROPERTIES_LOCATION = { 482 exp.AllowedValuesProperty: exp.Properties.Location.POST_SCHEMA, 483 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 484 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 485 exp.AutoRefreshProperty: exp.Properties.Location.POST_SCHEMA, 486 exp.BackupProperty: exp.Properties.Location.POST_SCHEMA, 487 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 488 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 489 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 490 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 491 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 492 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 493 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 494 exp.DistributedByProperty: exp.Properties.Location.POST_SCHEMA, 495 exp.DuplicateKeyProperty: exp.Properties.Location.POST_SCHEMA, 496 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 497 exp.DataDeletionProperty: exp.Properties.Location.POST_SCHEMA, 498 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 499 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 500 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 501 exp.DynamicProperty: exp.Properties.Location.POST_CREATE, 502 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 503 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 504 exp.EmptyProperty: exp.Properties.Location.POST_SCHEMA, 505 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 506 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 507 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 508 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 509 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 510 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 511 exp.GlobalProperty: exp.Properties.Location.POST_CREATE, 512 exp.HeapProperty: exp.Properties.Location.POST_WITH, 513 exp.InheritsProperty: exp.Properties.Location.POST_SCHEMA, 514 exp.IcebergProperty: exp.Properties.Location.POST_CREATE, 515 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 516 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 517 exp.JournalProperty: exp.Properties.Location.POST_NAME, 518 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 519 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 520 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 521 exp.LockProperty: exp.Properties.Location.POST_SCHEMA, 522 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 523 exp.LogProperty: exp.Properties.Location.POST_NAME, 524 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 525 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 526 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 527 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 528 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 529 exp.Order: exp.Properties.Location.POST_SCHEMA, 530 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 531 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 532 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 533 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 534 exp.Property: exp.Properties.Location.POST_WITH, 535 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 536 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 537 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 538 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 539 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 540 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 541 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 542 exp.SecureProperty: exp.Properties.Location.POST_CREATE, 543 exp.SecurityProperty: exp.Properties.Location.POST_SCHEMA, 544 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 545 exp.Set: exp.Properties.Location.POST_SCHEMA, 546 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 547 exp.SetProperty: exp.Properties.Location.POST_CREATE, 548 exp.SetConfigProperty: exp.Properties.Location.POST_SCHEMA, 549 exp.SharingProperty: exp.Properties.Location.POST_EXPRESSION, 550 exp.SequenceProperties: exp.Properties.Location.POST_EXPRESSION, 551 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 552 exp.SqlReadWriteProperty: exp.Properties.Location.POST_SCHEMA, 553 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 554 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 555 exp.StreamingTableProperty: exp.Properties.Location.POST_CREATE, 556 exp.StrictProperty: exp.Properties.Location.POST_SCHEMA, 557 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 558 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 559 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 560 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 561 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 562 exp.UnloggedProperty: exp.Properties.Location.POST_CREATE, 563 exp.ViewAttributeProperty: exp.Properties.Location.POST_SCHEMA, 564 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 565 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 566 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 567 exp.WithSchemaBindingProperty: exp.Properties.Location.POST_SCHEMA, 568 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 569 } 570 571 # Keywords that can't be used as unquoted identifier names 572 RESERVED_KEYWORDS: t.Set[str] = set() 573 574 # Expressions whose comments are separated from them for better formatting 575 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 576 exp.Command, 577 exp.Create, 578 exp.Delete, 579 exp.Drop, 580 exp.From, 581 exp.Insert, 582 exp.Join, 583 exp.MultitableInserts, 584 exp.Select, 585 exp.SetOperation, 586 exp.Update, 587 exp.Where, 588 exp.With, 589 ) 590 591 # Expressions that should not have their comments generated in maybe_comment 592 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 593 exp.Binary, 594 exp.SetOperation, 595 ) 596 597 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 598 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 599 exp.Column, 600 exp.Literal, 601 exp.Neg, 602 exp.Paren, 603 ) 604 605 PARAMETERIZABLE_TEXT_TYPES = { 606 exp.DataType.Type.NVARCHAR, 607 exp.DataType.Type.VARCHAR, 608 exp.DataType.Type.CHAR, 609 exp.DataType.Type.NCHAR, 610 } 611 612 # Expressions that need to have all CTEs under them bubbled up to them 613 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 614 615 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 616 617 __slots__ = ( 618 "pretty", 619 "identify", 620 "normalize", 621 "pad", 622 "_indent", 623 "normalize_functions", 624 "unsupported_level", 625 "max_unsupported", 626 "leading_comma", 627 "max_text_width", 628 "comments", 629 "dialect", 630 "unsupported_messages", 631 "_escaped_quote_end", 632 "_escaped_identifier_end", 633 "_next_name", 634 "_identifier_start", 635 "_identifier_end", 636 ) 637 638 def __init__( 639 self, 640 pretty: t.Optional[bool] = None, 641 identify: str | bool = False, 642 normalize: bool = False, 643 pad: int = 2, 644 indent: int = 2, 645 normalize_functions: t.Optional[str | bool] = None, 646 unsupported_level: ErrorLevel = ErrorLevel.WARN, 647 max_unsupported: int = 3, 648 leading_comma: bool = False, 649 max_text_width: int = 80, 650 comments: bool = True, 651 dialect: DialectType = None, 652 ): 653 import sqlglot 654 from sqlglot.dialects import Dialect 655 656 self.pretty = pretty if pretty is not None else sqlglot.pretty 657 self.identify = identify 658 self.normalize = normalize 659 self.pad = pad 660 self._indent = indent 661 self.unsupported_level = unsupported_level 662 self.max_unsupported = max_unsupported 663 self.leading_comma = leading_comma 664 self.max_text_width = max_text_width 665 self.comments = comments 666 self.dialect = Dialect.get_or_raise(dialect) 667 668 # This is both a Dialect property and a Generator argument, so we prioritize the latter 669 self.normalize_functions = ( 670 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 671 ) 672 673 self.unsupported_messages: t.List[str] = [] 674 self._escaped_quote_end: str = ( 675 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 676 ) 677 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 678 679 self._next_name = name_sequence("_t") 680 681 self._identifier_start = self.dialect.IDENTIFIER_START 682 self._identifier_end = self.dialect.IDENTIFIER_END 683 684 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 685 """ 686 Generates the SQL string corresponding to the given syntax tree. 687 688 Args: 689 expression: The syntax tree. 690 copy: Whether to copy the expression. The generator performs mutations so 691 it is safer to copy. 692 693 Returns: 694 The SQL string corresponding to `expression`. 695 """ 696 if copy: 697 expression = expression.copy() 698 699 expression = self.preprocess(expression) 700 701 self.unsupported_messages = [] 702 sql = self.sql(expression).strip() 703 704 if self.pretty: 705 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 706 707 if self.unsupported_level == ErrorLevel.IGNORE: 708 return sql 709 710 if self.unsupported_level == ErrorLevel.WARN: 711 for msg in self.unsupported_messages: 712 logger.warning(msg) 713 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 714 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 715 716 return sql 717 718 def preprocess(self, expression: exp.Expression) -> exp.Expression: 719 """Apply generic preprocessing transformations to a given expression.""" 720 expression = self._move_ctes_to_top_level(expression) 721 722 if self.ENSURE_BOOLS: 723 from sqlglot.transforms import ensure_bools 724 725 expression = ensure_bools(expression) 726 727 return expression 728 729 def _move_ctes_to_top_level(self, expression: E) -> E: 730 if ( 731 not expression.parent 732 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 733 and any(node.parent is not expression for node in expression.find_all(exp.With)) 734 ): 735 from sqlglot.transforms import move_ctes_to_top_level 736 737 expression = move_ctes_to_top_level(expression) 738 return expression 739 740 def unsupported(self, message: str) -> None: 741 if self.unsupported_level == ErrorLevel.IMMEDIATE: 742 raise UnsupportedError(message) 743 self.unsupported_messages.append(message) 744 745 def sep(self, sep: str = " ") -> str: 746 return f"{sep.strip()}\n" if self.pretty else sep 747 748 def seg(self, sql: str, sep: str = " ") -> str: 749 return f"{self.sep(sep)}{sql}" 750 751 def pad_comment(self, comment: str) -> str: 752 comment = " " + comment if comment[0].strip() else comment 753 comment = comment + " " if comment[-1].strip() else comment 754 return comment 755 756 def maybe_comment( 757 self, 758 sql: str, 759 expression: t.Optional[exp.Expression] = None, 760 comments: t.Optional[t.List[str]] = None, 761 separated: bool = False, 762 ) -> str: 763 comments = ( 764 ((expression and expression.comments) if comments is None else comments) # type: ignore 765 if self.comments 766 else None 767 ) 768 769 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 770 return sql 771 772 comments_sql = " ".join( 773 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 774 ) 775 776 if not comments_sql: 777 return sql 778 779 comments_sql = self._replace_line_breaks(comments_sql) 780 781 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 782 return ( 783 f"{self.sep()}{comments_sql}{sql}" 784 if not sql or sql[0].isspace() 785 else f"{comments_sql}{self.sep()}{sql}" 786 ) 787 788 return f"{sql} {comments_sql}" 789 790 def wrap(self, expression: exp.Expression | str) -> str: 791 this_sql = ( 792 self.sql(expression) 793 if isinstance(expression, exp.UNWRAPPED_QUERIES) 794 else self.sql(expression, "this") 795 ) 796 if not this_sql: 797 return "()" 798 799 this_sql = self.indent(this_sql, level=1, pad=0) 800 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 801 802 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 803 original = self.identify 804 self.identify = False 805 result = func(*args, **kwargs) 806 self.identify = original 807 return result 808 809 def normalize_func(self, name: str) -> str: 810 if self.normalize_functions == "upper" or self.normalize_functions is True: 811 return name.upper() 812 if self.normalize_functions == "lower": 813 return name.lower() 814 return name 815 816 def indent( 817 self, 818 sql: str, 819 level: int = 0, 820 pad: t.Optional[int] = None, 821 skip_first: bool = False, 822 skip_last: bool = False, 823 ) -> str: 824 if not self.pretty or not sql: 825 return sql 826 827 pad = self.pad if pad is None else pad 828 lines = sql.split("\n") 829 830 return "\n".join( 831 ( 832 line 833 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 834 else f"{' ' * (level * self._indent + pad)}{line}" 835 ) 836 for i, line in enumerate(lines) 837 ) 838 839 def sql( 840 self, 841 expression: t.Optional[str | exp.Expression], 842 key: t.Optional[str] = None, 843 comment: bool = True, 844 ) -> str: 845 if not expression: 846 return "" 847 848 if isinstance(expression, str): 849 return expression 850 851 if key: 852 value = expression.args.get(key) 853 if value: 854 return self.sql(value) 855 return "" 856 857 transform = self.TRANSFORMS.get(expression.__class__) 858 859 if callable(transform): 860 sql = transform(self, expression) 861 elif isinstance(expression, exp.Expression): 862 exp_handler_name = f"{expression.key}_sql" 863 864 if hasattr(self, exp_handler_name): 865 sql = getattr(self, exp_handler_name)(expression) 866 elif isinstance(expression, exp.Func): 867 sql = self.function_fallback_sql(expression) 868 elif isinstance(expression, exp.Property): 869 sql = self.property_sql(expression) 870 else: 871 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 872 else: 873 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 874 875 return self.maybe_comment(sql, expression) if self.comments and comment else sql 876 877 def uncache_sql(self, expression: exp.Uncache) -> str: 878 table = self.sql(expression, "this") 879 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 880 return f"UNCACHE TABLE{exists_sql} {table}" 881 882 def cache_sql(self, expression: exp.Cache) -> str: 883 lazy = " LAZY" if expression.args.get("lazy") else "" 884 table = self.sql(expression, "this") 885 options = expression.args.get("options") 886 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 887 sql = self.sql(expression, "expression") 888 sql = f" AS{self.sep()}{sql}" if sql else "" 889 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 890 return self.prepend_ctes(expression, sql) 891 892 def characterset_sql(self, expression: exp.CharacterSet) -> str: 893 if isinstance(expression.parent, exp.Cast): 894 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 895 default = "DEFAULT " if expression.args.get("default") else "" 896 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 897 898 def column_parts(self, expression: exp.Column) -> str: 899 return ".".join( 900 self.sql(part) 901 for part in ( 902 expression.args.get("catalog"), 903 expression.args.get("db"), 904 expression.args.get("table"), 905 expression.args.get("this"), 906 ) 907 if part 908 ) 909 910 def column_sql(self, expression: exp.Column) -> str: 911 join_mark = " (+)" if expression.args.get("join_mark") else "" 912 913 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 914 join_mark = "" 915 self.unsupported("Outer join syntax using the (+) operator is not supported.") 916 917 return f"{self.column_parts(expression)}{join_mark}" 918 919 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 920 this = self.sql(expression, "this") 921 this = f" {this}" if this else "" 922 position = self.sql(expression, "position") 923 return f"{position}{this}" 924 925 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 926 column = self.sql(expression, "this") 927 kind = self.sql(expression, "kind") 928 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 929 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 930 kind = f"{sep}{kind}" if kind else "" 931 constraints = f" {constraints}" if constraints else "" 932 position = self.sql(expression, "position") 933 position = f" {position}" if position else "" 934 935 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 936 kind = "" 937 938 return f"{exists}{column}{kind}{constraints}{position}" 939 940 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 941 this = self.sql(expression, "this") 942 kind_sql = self.sql(expression, "kind").strip() 943 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 944 945 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 946 this = self.sql(expression, "this") 947 if expression.args.get("not_null"): 948 persisted = " PERSISTED NOT NULL" 949 elif expression.args.get("persisted"): 950 persisted = " PERSISTED" 951 else: 952 persisted = "" 953 return f"AS {this}{persisted}" 954 955 def autoincrementcolumnconstraint_sql(self, _) -> str: 956 return self.token_sql(TokenType.AUTO_INCREMENT) 957 958 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 959 if isinstance(expression.this, list): 960 this = self.wrap(self.expressions(expression, key="this", flat=True)) 961 else: 962 this = self.sql(expression, "this") 963 964 return f"COMPRESS {this}" 965 966 def generatedasidentitycolumnconstraint_sql( 967 self, expression: exp.GeneratedAsIdentityColumnConstraint 968 ) -> str: 969 this = "" 970 if expression.this is not None: 971 on_null = " ON NULL" if expression.args.get("on_null") else "" 972 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 973 974 start = expression.args.get("start") 975 start = f"START WITH {start}" if start else "" 976 increment = expression.args.get("increment") 977 increment = f" INCREMENT BY {increment}" if increment else "" 978 minvalue = expression.args.get("minvalue") 979 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 980 maxvalue = expression.args.get("maxvalue") 981 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 982 cycle = expression.args.get("cycle") 983 cycle_sql = "" 984 985 if cycle is not None: 986 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 987 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 988 989 sequence_opts = "" 990 if start or increment or cycle_sql: 991 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 992 sequence_opts = f" ({sequence_opts.strip()})" 993 994 expr = self.sql(expression, "expression") 995 expr = f"({expr})" if expr else "IDENTITY" 996 997 return f"GENERATED{this} AS {expr}{sequence_opts}" 998 999 def generatedasrowcolumnconstraint_sql( 1000 self, expression: exp.GeneratedAsRowColumnConstraint 1001 ) -> str: 1002 start = "START" if expression.args.get("start") else "END" 1003 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1004 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 1005 1006 def periodforsystemtimeconstraint_sql( 1007 self, expression: exp.PeriodForSystemTimeConstraint 1008 ) -> str: 1009 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 1010 1011 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 1012 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 1013 1014 def transformcolumnconstraint_sql(self, expression: exp.TransformColumnConstraint) -> str: 1015 return f"AS {self.sql(expression, 'this')}" 1016 1017 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 1018 desc = expression.args.get("desc") 1019 if desc is not None: 1020 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 1021 return "PRIMARY KEY" 1022 1023 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1024 this = self.sql(expression, "this") 1025 this = f" {this}" if this else "" 1026 index_type = expression.args.get("index_type") 1027 index_type = f" USING {index_type}" if index_type else "" 1028 on_conflict = self.sql(expression, "on_conflict") 1029 on_conflict = f" {on_conflict}" if on_conflict else "" 1030 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1031 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}" 1032 1033 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 1034 return self.sql(expression, "this") 1035 1036 def create_sql(self, expression: exp.Create) -> str: 1037 kind = self.sql(expression, "kind") 1038 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1039 properties = expression.args.get("properties") 1040 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1041 1042 this = self.createable_sql(expression, properties_locs) 1043 1044 properties_sql = "" 1045 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1046 exp.Properties.Location.POST_WITH 1047 ): 1048 properties_sql = self.sql( 1049 exp.Properties( 1050 expressions=[ 1051 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1052 *properties_locs[exp.Properties.Location.POST_WITH], 1053 ] 1054 ) 1055 ) 1056 1057 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1058 properties_sql = self.sep() + properties_sql 1059 elif not self.pretty: 1060 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1061 properties_sql = f" {properties_sql}" 1062 1063 begin = " BEGIN" if expression.args.get("begin") else "" 1064 end = " END" if expression.args.get("end") else "" 1065 1066 expression_sql = self.sql(expression, "expression") 1067 if expression_sql: 1068 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1069 1070 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1071 postalias_props_sql = "" 1072 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1073 postalias_props_sql = self.properties( 1074 exp.Properties( 1075 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1076 ), 1077 wrapped=False, 1078 ) 1079 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1080 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1081 1082 postindex_props_sql = "" 1083 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1084 postindex_props_sql = self.properties( 1085 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1086 wrapped=False, 1087 prefix=" ", 1088 ) 1089 1090 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1091 indexes = f" {indexes}" if indexes else "" 1092 index_sql = indexes + postindex_props_sql 1093 1094 replace = " OR REPLACE" if expression.args.get("replace") else "" 1095 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1096 unique = " UNIQUE" if expression.args.get("unique") else "" 1097 1098 clustered = expression.args.get("clustered") 1099 if clustered is None: 1100 clustered_sql = "" 1101 elif clustered: 1102 clustered_sql = " CLUSTERED COLUMNSTORE" 1103 else: 1104 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1105 1106 postcreate_props_sql = "" 1107 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1108 postcreate_props_sql = self.properties( 1109 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1110 sep=" ", 1111 prefix=" ", 1112 wrapped=False, 1113 ) 1114 1115 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1116 1117 postexpression_props_sql = "" 1118 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1119 postexpression_props_sql = self.properties( 1120 exp.Properties( 1121 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1122 ), 1123 sep=" ", 1124 prefix=" ", 1125 wrapped=False, 1126 ) 1127 1128 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1129 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1130 no_schema_binding = ( 1131 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1132 ) 1133 1134 clone = self.sql(expression, "clone") 1135 clone = f" {clone}" if clone else "" 1136 1137 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1138 return self.prepend_ctes(expression, expression_sql) 1139 1140 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1141 start = self.sql(expression, "start") 1142 start = f"START WITH {start}" if start else "" 1143 increment = self.sql(expression, "increment") 1144 increment = f" INCREMENT BY {increment}" if increment else "" 1145 minvalue = self.sql(expression, "minvalue") 1146 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1147 maxvalue = self.sql(expression, "maxvalue") 1148 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1149 owned = self.sql(expression, "owned") 1150 owned = f" OWNED BY {owned}" if owned else "" 1151 1152 cache = expression.args.get("cache") 1153 if cache is None: 1154 cache_str = "" 1155 elif cache is True: 1156 cache_str = " CACHE" 1157 else: 1158 cache_str = f" CACHE {cache}" 1159 1160 options = self.expressions(expression, key="options", flat=True, sep=" ") 1161 options = f" {options}" if options else "" 1162 1163 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip() 1164 1165 def clone_sql(self, expression: exp.Clone) -> str: 1166 this = self.sql(expression, "this") 1167 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1168 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1169 return f"{shallow}{keyword} {this}" 1170 1171 def describe_sql(self, expression: exp.Describe) -> str: 1172 style = expression.args.get("style") 1173 style = f" {style}" if style else "" 1174 partition = self.sql(expression, "partition") 1175 partition = f" {partition}" if partition else "" 1176 return f"DESCRIBE{style} {self.sql(expression, 'this')}{partition}" 1177 1178 def heredoc_sql(self, expression: exp.Heredoc) -> str: 1179 tag = self.sql(expression, "tag") 1180 return f"${tag}${self.sql(expression, 'this')}${tag}$" 1181 1182 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 1183 with_ = self.sql(expression, "with") 1184 if with_: 1185 sql = f"{with_}{self.sep()}{sql}" 1186 return sql 1187 1188 def with_sql(self, expression: exp.With) -> str: 1189 sql = self.expressions(expression, flat=True) 1190 recursive = ( 1191 "RECURSIVE " 1192 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 1193 else "" 1194 ) 1195 1196 return f"WITH {recursive}{sql}" 1197 1198 def cte_sql(self, expression: exp.CTE) -> str: 1199 alias = expression.args.get("alias") 1200 if alias: 1201 alias.add_comments(expression.pop_comments()) 1202 1203 alias_sql = self.sql(expression, "alias") 1204 1205 materialized = expression.args.get("materialized") 1206 if materialized is False: 1207 materialized = "NOT MATERIALIZED " 1208 elif materialized: 1209 materialized = "MATERIALIZED " 1210 1211 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}" 1212 1213 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1214 alias = self.sql(expression, "this") 1215 columns = self.expressions(expression, key="columns", flat=True) 1216 columns = f"({columns})" if columns else "" 1217 1218 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1219 columns = "" 1220 self.unsupported("Named columns are not supported in table alias.") 1221 1222 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1223 alias = self._next_name() 1224 1225 return f"{alias}{columns}" 1226 1227 def bitstring_sql(self, expression: exp.BitString) -> str: 1228 this = self.sql(expression, "this") 1229 if self.dialect.BIT_START: 1230 return f"{self.dialect.BIT_START}{this}{self.dialect.BIT_END}" 1231 return f"{int(this, 2)}" 1232 1233 def hexstring_sql(self, expression: exp.HexString) -> str: 1234 this = self.sql(expression, "this") 1235 if self.dialect.HEX_START: 1236 return f"{self.dialect.HEX_START}{this}{self.dialect.HEX_END}" 1237 return f"{int(this, 16)}" 1238 1239 def bytestring_sql(self, expression: exp.ByteString) -> str: 1240 this = self.sql(expression, "this") 1241 if self.dialect.BYTE_START: 1242 return f"{self.dialect.BYTE_START}{this}{self.dialect.BYTE_END}" 1243 return this 1244 1245 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1246 this = self.sql(expression, "this") 1247 escape = expression.args.get("escape") 1248 1249 if self.dialect.UNICODE_START: 1250 escape_substitute = r"\\\1" 1251 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1252 else: 1253 escape_substitute = r"\\u\1" 1254 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1255 1256 if escape: 1257 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1258 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1259 else: 1260 escape_pattern = ESCAPED_UNICODE_RE 1261 escape_sql = "" 1262 1263 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1264 this = escape_pattern.sub(escape_substitute, this) 1265 1266 return f"{left_quote}{this}{right_quote}{escape_sql}" 1267 1268 def rawstring_sql(self, expression: exp.RawString) -> str: 1269 string = self.escape_str(expression.this.replace("\\", "\\\\"), escape_backslash=False) 1270 return f"{self.dialect.QUOTE_START}{string}{self.dialect.QUOTE_END}" 1271 1272 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 1273 this = self.sql(expression, "this") 1274 specifier = self.sql(expression, "expression") 1275 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 1276 return f"{this}{specifier}" 1277 1278 def datatype_sql(self, expression: exp.DataType) -> str: 1279 nested = "" 1280 values = "" 1281 interior = self.expressions(expression, flat=True) 1282 1283 type_value = expression.this 1284 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1285 type_sql = self.sql(expression, "kind") 1286 else: 1287 type_sql = ( 1288 self.TYPE_MAPPING.get(type_value, type_value.value) 1289 if isinstance(type_value, exp.DataType.Type) 1290 else type_value 1291 ) 1292 1293 if interior: 1294 if expression.args.get("nested"): 1295 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1296 if expression.args.get("values") is not None: 1297 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1298 values = self.expressions(expression, key="values", flat=True) 1299 values = f"{delimiters[0]}{values}{delimiters[1]}" 1300 elif type_value == exp.DataType.Type.INTERVAL: 1301 nested = f" {interior}" 1302 else: 1303 nested = f"({interior})" 1304 1305 type_sql = f"{type_sql}{nested}{values}" 1306 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1307 exp.DataType.Type.TIMETZ, 1308 exp.DataType.Type.TIMESTAMPTZ, 1309 ): 1310 type_sql = f"{type_sql} WITH TIME ZONE" 1311 1312 return type_sql 1313 1314 def directory_sql(self, expression: exp.Directory) -> str: 1315 local = "LOCAL " if expression.args.get("local") else "" 1316 row_format = self.sql(expression, "row_format") 1317 row_format = f" {row_format}" if row_format else "" 1318 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1319 1320 def delete_sql(self, expression: exp.Delete) -> str: 1321 this = self.sql(expression, "this") 1322 this = f" FROM {this}" if this else "" 1323 using = self.sql(expression, "using") 1324 using = f" USING {using}" if using else "" 1325 cluster = self.sql(expression, "cluster") 1326 cluster = f" {cluster}" if cluster else "" 1327 where = self.sql(expression, "where") 1328 returning = self.sql(expression, "returning") 1329 limit = self.sql(expression, "limit") 1330 tables = self.expressions(expression, key="tables") 1331 tables = f" {tables}" if tables else "" 1332 if self.RETURNING_END: 1333 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1334 else: 1335 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1336 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1337 1338 def drop_sql(self, expression: exp.Drop) -> str: 1339 this = self.sql(expression, "this") 1340 expressions = self.expressions(expression, flat=True) 1341 expressions = f" ({expressions})" if expressions else "" 1342 kind = expression.args["kind"] 1343 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1344 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1345 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1346 on_cluster = self.sql(expression, "cluster") 1347 on_cluster = f" {on_cluster}" if on_cluster else "" 1348 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1349 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1350 cascade = " CASCADE" if expression.args.get("cascade") else "" 1351 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1352 purge = " PURGE" if expression.args.get("purge") else "" 1353 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}" 1354 1355 def set_operation(self, expression: exp.SetOperation) -> str: 1356 op_type = type(expression) 1357 op_name = op_type.key.upper() 1358 1359 distinct = expression.args.get("distinct") 1360 if ( 1361 distinct is False 1362 and op_type in (exp.Except, exp.Intersect) 1363 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1364 ): 1365 self.unsupported(f"{op_name} ALL is not supported") 1366 1367 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1368 1369 if distinct is None: 1370 distinct = default_distinct 1371 if distinct is None: 1372 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1373 1374 if distinct is default_distinct: 1375 kind = "" 1376 else: 1377 kind = " DISTINCT" if distinct else " ALL" 1378 1379 by_name = " BY NAME" if expression.args.get("by_name") else "" 1380 return f"{op_name}{kind}{by_name}" 1381 1382 def set_operations(self, expression: exp.SetOperation) -> str: 1383 if not self.SET_OP_MODIFIERS: 1384 limit = expression.args.get("limit") 1385 order = expression.args.get("order") 1386 1387 if limit or order: 1388 select = self._move_ctes_to_top_level( 1389 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1390 ) 1391 1392 if limit: 1393 select = select.limit(limit.pop(), copy=False) 1394 if order: 1395 select = select.order_by(order.pop(), copy=False) 1396 return self.sql(select) 1397 1398 sqls: t.List[str] = [] 1399 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1400 1401 while stack: 1402 node = stack.pop() 1403 1404 if isinstance(node, exp.SetOperation): 1405 stack.append(node.expression) 1406 stack.append( 1407 self.maybe_comment( 1408 self.set_operation(node), comments=node.comments, separated=True 1409 ) 1410 ) 1411 stack.append(node.this) 1412 else: 1413 sqls.append(self.sql(node)) 1414 1415 this = self.sep().join(sqls) 1416 this = self.query_modifiers(expression, this) 1417 return self.prepend_ctes(expression, this) 1418 1419 def fetch_sql(self, expression: exp.Fetch) -> str: 1420 direction = expression.args.get("direction") 1421 direction = f" {direction}" if direction else "" 1422 count = self.sql(expression, "count") 1423 count = f" {count}" if count else "" 1424 if expression.args.get("percent"): 1425 count = f"{count} PERCENT" 1426 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1427 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1428 1429 def filter_sql(self, expression: exp.Filter) -> str: 1430 if self.AGGREGATE_FILTER_SUPPORTED: 1431 this = self.sql(expression, "this") 1432 where = self.sql(expression, "expression").strip() 1433 return f"{this} FILTER({where})" 1434 1435 agg = expression.this 1436 agg_arg = agg.this 1437 cond = expression.expression.this 1438 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1439 return self.sql(agg) 1440 1441 def hint_sql(self, expression: exp.Hint) -> str: 1442 if not self.QUERY_HINTS: 1443 self.unsupported("Hints are not supported") 1444 return "" 1445 1446 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1447 1448 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1449 using = self.sql(expression, "using") 1450 using = f" USING {using}" if using else "" 1451 columns = self.expressions(expression, key="columns", flat=True) 1452 columns = f"({columns})" if columns else "" 1453 partition_by = self.expressions(expression, key="partition_by", flat=True) 1454 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1455 where = self.sql(expression, "where") 1456 include = self.expressions(expression, key="include", flat=True) 1457 if include: 1458 include = f" INCLUDE ({include})" 1459 with_storage = self.expressions(expression, key="with_storage", flat=True) 1460 with_storage = f" WITH ({with_storage})" if with_storage else "" 1461 tablespace = self.sql(expression, "tablespace") 1462 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1463 on = self.sql(expression, "on") 1464 on = f" ON {on}" if on else "" 1465 1466 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}" 1467 1468 def index_sql(self, expression: exp.Index) -> str: 1469 unique = "UNIQUE " if expression.args.get("unique") else "" 1470 primary = "PRIMARY " if expression.args.get("primary") else "" 1471 amp = "AMP " if expression.args.get("amp") else "" 1472 name = self.sql(expression, "this") 1473 name = f"{name} " if name else "" 1474 table = self.sql(expression, "table") 1475 table = f"{self.INDEX_ON} {table}" if table else "" 1476 1477 index = "INDEX " if not table else "" 1478 1479 params = self.sql(expression, "params") 1480 return f"{unique}{primary}{amp}{index}{name}{table}{params}" 1481 1482 def identifier_sql(self, expression: exp.Identifier) -> str: 1483 text = expression.name 1484 lower = text.lower() 1485 text = lower if self.normalize and not expression.quoted else text 1486 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1487 if ( 1488 expression.quoted 1489 or self.dialect.can_identify(text, self.identify) 1490 or lower in self.RESERVED_KEYWORDS 1491 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1492 ): 1493 text = f"{self._identifier_start}{text}{self._identifier_end}" 1494 return text 1495 1496 def hex_sql(self, expression: exp.Hex) -> str: 1497 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1498 if self.dialect.HEX_LOWERCASE: 1499 text = self.func("LOWER", text) 1500 1501 return text 1502 1503 def lowerhex_sql(self, expression: exp.LowerHex) -> str: 1504 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1505 if not self.dialect.HEX_LOWERCASE: 1506 text = self.func("LOWER", text) 1507 return text 1508 1509 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1510 input_format = self.sql(expression, "input_format") 1511 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1512 output_format = self.sql(expression, "output_format") 1513 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1514 return self.sep().join((input_format, output_format)) 1515 1516 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1517 string = self.sql(exp.Literal.string(expression.name)) 1518 return f"{prefix}{string}" 1519 1520 def partition_sql(self, expression: exp.Partition) -> str: 1521 return f"PARTITION({self.expressions(expression, flat=True)})" 1522 1523 def properties_sql(self, expression: exp.Properties) -> str: 1524 root_properties = [] 1525 with_properties = [] 1526 1527 for p in expression.expressions: 1528 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1529 if p_loc == exp.Properties.Location.POST_WITH: 1530 with_properties.append(p) 1531 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1532 root_properties.append(p) 1533 1534 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1535 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1536 1537 if root_props and with_props and not self.pretty: 1538 with_props = " " + with_props 1539 1540 return root_props + with_props 1541 1542 def root_properties(self, properties: exp.Properties) -> str: 1543 if properties.expressions: 1544 return self.expressions(properties, indent=False, sep=" ") 1545 return "" 1546 1547 def properties( 1548 self, 1549 properties: exp.Properties, 1550 prefix: str = "", 1551 sep: str = ", ", 1552 suffix: str = "", 1553 wrapped: bool = True, 1554 ) -> str: 1555 if properties.expressions: 1556 expressions = self.expressions(properties, sep=sep, indent=False) 1557 if expressions: 1558 expressions = self.wrap(expressions) if wrapped else expressions 1559 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1560 return "" 1561 1562 def with_properties(self, properties: exp.Properties) -> str: 1563 return self.properties(properties, prefix=self.seg(self.WITH_PROPERTIES_PREFIX, sep="")) 1564 1565 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1566 properties_locs = defaultdict(list) 1567 for p in properties.expressions: 1568 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1569 if p_loc != exp.Properties.Location.UNSUPPORTED: 1570 properties_locs[p_loc].append(p) 1571 else: 1572 self.unsupported(f"Unsupported property {p.key}") 1573 1574 return properties_locs 1575 1576 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1577 if isinstance(expression.this, exp.Dot): 1578 return self.sql(expression, "this") 1579 return f"'{expression.name}'" if string_key else expression.name 1580 1581 def property_sql(self, expression: exp.Property) -> str: 1582 property_cls = expression.__class__ 1583 if property_cls == exp.Property: 1584 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1585 1586 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1587 if not property_name: 1588 self.unsupported(f"Unsupported property {expression.key}") 1589 1590 return f"{property_name}={self.sql(expression, 'this')}" 1591 1592 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1593 if self.SUPPORTS_CREATE_TABLE_LIKE: 1594 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1595 options = f" {options}" if options else "" 1596 1597 like = f"LIKE {self.sql(expression, 'this')}{options}" 1598 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1599 like = f"({like})" 1600 1601 return like 1602 1603 if expression.expressions: 1604 self.unsupported("Transpilation of LIKE property options is unsupported") 1605 1606 select = exp.select("*").from_(expression.this).limit(0) 1607 return f"AS {self.sql(select)}" 1608 1609 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1610 no = "NO " if expression.args.get("no") else "" 1611 protection = " PROTECTION" if expression.args.get("protection") else "" 1612 return f"{no}FALLBACK{protection}" 1613 1614 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1615 no = "NO " if expression.args.get("no") else "" 1616 local = expression.args.get("local") 1617 local = f"{local} " if local else "" 1618 dual = "DUAL " if expression.args.get("dual") else "" 1619 before = "BEFORE " if expression.args.get("before") else "" 1620 after = "AFTER " if expression.args.get("after") else "" 1621 return f"{no}{local}{dual}{before}{after}JOURNAL" 1622 1623 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1624 freespace = self.sql(expression, "this") 1625 percent = " PERCENT" if expression.args.get("percent") else "" 1626 return f"FREESPACE={freespace}{percent}" 1627 1628 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1629 if expression.args.get("default"): 1630 property = "DEFAULT" 1631 elif expression.args.get("on"): 1632 property = "ON" 1633 else: 1634 property = "OFF" 1635 return f"CHECKSUM={property}" 1636 1637 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1638 if expression.args.get("no"): 1639 return "NO MERGEBLOCKRATIO" 1640 if expression.args.get("default"): 1641 return "DEFAULT MERGEBLOCKRATIO" 1642 1643 percent = " PERCENT" if expression.args.get("percent") else "" 1644 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1645 1646 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1647 default = expression.args.get("default") 1648 minimum = expression.args.get("minimum") 1649 maximum = expression.args.get("maximum") 1650 if default or minimum or maximum: 1651 if default: 1652 prop = "DEFAULT" 1653 elif minimum: 1654 prop = "MINIMUM" 1655 else: 1656 prop = "MAXIMUM" 1657 return f"{prop} DATABLOCKSIZE" 1658 units = expression.args.get("units") 1659 units = f" {units}" if units else "" 1660 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1661 1662 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1663 autotemp = expression.args.get("autotemp") 1664 always = expression.args.get("always") 1665 default = expression.args.get("default") 1666 manual = expression.args.get("manual") 1667 never = expression.args.get("never") 1668 1669 if autotemp is not None: 1670 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1671 elif always: 1672 prop = "ALWAYS" 1673 elif default: 1674 prop = "DEFAULT" 1675 elif manual: 1676 prop = "MANUAL" 1677 elif never: 1678 prop = "NEVER" 1679 return f"BLOCKCOMPRESSION={prop}" 1680 1681 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1682 no = expression.args.get("no") 1683 no = " NO" if no else "" 1684 concurrent = expression.args.get("concurrent") 1685 concurrent = " CONCURRENT" if concurrent else "" 1686 target = self.sql(expression, "target") 1687 target = f" {target}" if target else "" 1688 return f"WITH{no}{concurrent} ISOLATED LOADING{target}" 1689 1690 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1691 if isinstance(expression.this, list): 1692 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1693 if expression.this: 1694 modulus = self.sql(expression, "this") 1695 remainder = self.sql(expression, "expression") 1696 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1697 1698 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1699 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1700 return f"FROM ({from_expressions}) TO ({to_expressions})" 1701 1702 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1703 this = self.sql(expression, "this") 1704 1705 for_values_or_default = expression.expression 1706 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1707 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1708 else: 1709 for_values_or_default = " DEFAULT" 1710 1711 return f"PARTITION OF {this}{for_values_or_default}" 1712 1713 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1714 kind = expression.args.get("kind") 1715 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1716 for_or_in = expression.args.get("for_or_in") 1717 for_or_in = f" {for_or_in}" if for_or_in else "" 1718 lock_type = expression.args.get("lock_type") 1719 override = " OVERRIDE" if expression.args.get("override") else "" 1720 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1721 1722 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1723 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1724 statistics = expression.args.get("statistics") 1725 statistics_sql = "" 1726 if statistics is not None: 1727 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1728 return f"{data_sql}{statistics_sql}" 1729 1730 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1731 this = self.sql(expression, "this") 1732 this = f"HISTORY_TABLE={this}" if this else "" 1733 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1734 data_consistency = ( 1735 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1736 ) 1737 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1738 retention_period = ( 1739 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1740 ) 1741 1742 if this: 1743 on_sql = self.func("ON", this, data_consistency, retention_period) 1744 else: 1745 on_sql = "ON" if expression.args.get("on") else "OFF" 1746 1747 sql = f"SYSTEM_VERSIONING={on_sql}" 1748 1749 return f"WITH({sql})" if expression.args.get("with") else sql 1750 1751 def insert_sql(self, expression: exp.Insert) -> str: 1752 hint = self.sql(expression, "hint") 1753 overwrite = expression.args.get("overwrite") 1754 1755 if isinstance(expression.this, exp.Directory): 1756 this = " OVERWRITE" if overwrite else " INTO" 1757 else: 1758 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1759 1760 stored = self.sql(expression, "stored") 1761 stored = f" {stored}" if stored else "" 1762 alternative = expression.args.get("alternative") 1763 alternative = f" OR {alternative}" if alternative else "" 1764 ignore = " IGNORE" if expression.args.get("ignore") else "" 1765 is_function = expression.args.get("is_function") 1766 if is_function: 1767 this = f"{this} FUNCTION" 1768 this = f"{this} {self.sql(expression, 'this')}" 1769 1770 exists = " IF EXISTS" if expression.args.get("exists") else "" 1771 where = self.sql(expression, "where") 1772 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1773 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1774 on_conflict = self.sql(expression, "conflict") 1775 on_conflict = f" {on_conflict}" if on_conflict else "" 1776 by_name = " BY NAME" if expression.args.get("by_name") else "" 1777 returning = self.sql(expression, "returning") 1778 1779 if self.RETURNING_END: 1780 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1781 else: 1782 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1783 1784 partition_by = self.sql(expression, "partition") 1785 partition_by = f" {partition_by}" if partition_by else "" 1786 settings = self.sql(expression, "settings") 1787 settings = f" {settings}" if settings else "" 1788 1789 source = self.sql(expression, "source") 1790 source = f"TABLE {source}" if source else "" 1791 1792 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1793 return self.prepend_ctes(expression, sql) 1794 1795 def introducer_sql(self, expression: exp.Introducer) -> str: 1796 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1797 1798 def kill_sql(self, expression: exp.Kill) -> str: 1799 kind = self.sql(expression, "kind") 1800 kind = f" {kind}" if kind else "" 1801 this = self.sql(expression, "this") 1802 this = f" {this}" if this else "" 1803 return f"KILL{kind}{this}" 1804 1805 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1806 return expression.name 1807 1808 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1809 return expression.name 1810 1811 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1812 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1813 1814 constraint = self.sql(expression, "constraint") 1815 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1816 1817 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1818 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1819 action = self.sql(expression, "action") 1820 1821 expressions = self.expressions(expression, flat=True) 1822 if expressions: 1823 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1824 expressions = f" {set_keyword}{expressions}" 1825 1826 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}" 1827 1828 def returning_sql(self, expression: exp.Returning) -> str: 1829 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1830 1831 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1832 fields = self.sql(expression, "fields") 1833 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1834 escaped = self.sql(expression, "escaped") 1835 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1836 items = self.sql(expression, "collection_items") 1837 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1838 keys = self.sql(expression, "map_keys") 1839 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1840 lines = self.sql(expression, "lines") 1841 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1842 null = self.sql(expression, "null") 1843 null = f" NULL DEFINED AS {null}" if null else "" 1844 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1845 1846 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1847 return f"WITH ({self.expressions(expression, flat=True)})" 1848 1849 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1850 this = f"{self.sql(expression, 'this')} INDEX" 1851 target = self.sql(expression, "target") 1852 target = f" FOR {target}" if target else "" 1853 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1854 1855 def historicaldata_sql(self, expression: exp.HistoricalData) -> str: 1856 this = self.sql(expression, "this") 1857 kind = self.sql(expression, "kind") 1858 expr = self.sql(expression, "expression") 1859 return f"{this} ({kind} => {expr})" 1860 1861 def table_parts(self, expression: exp.Table) -> str: 1862 return ".".join( 1863 self.sql(part) 1864 for part in ( 1865 expression.args.get("catalog"), 1866 expression.args.get("db"), 1867 expression.args.get("this"), 1868 ) 1869 if part is not None 1870 ) 1871 1872 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1873 table = self.table_parts(expression) 1874 only = "ONLY " if expression.args.get("only") else "" 1875 partition = self.sql(expression, "partition") 1876 partition = f" {partition}" if partition else "" 1877 version = self.sql(expression, "version") 1878 version = f" {version}" if version else "" 1879 alias = self.sql(expression, "alias") 1880 alias = f"{sep}{alias}" if alias else "" 1881 1882 sample = self.sql(expression, "sample") 1883 if self.dialect.ALIAS_POST_TABLESAMPLE: 1884 sample_pre_alias = sample 1885 sample_post_alias = "" 1886 else: 1887 sample_pre_alias = "" 1888 sample_post_alias = sample 1889 1890 hints = self.expressions(expression, key="hints", sep=" ") 1891 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1892 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1893 joins = self.indent( 1894 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1895 ) 1896 laterals = self.expressions(expression, key="laterals", sep="") 1897 1898 file_format = self.sql(expression, "format") 1899 if file_format: 1900 pattern = self.sql(expression, "pattern") 1901 pattern = f", PATTERN => {pattern}" if pattern else "" 1902 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1903 1904 ordinality = expression.args.get("ordinality") or "" 1905 if ordinality: 1906 ordinality = f" WITH ORDINALITY{alias}" 1907 alias = "" 1908 1909 when = self.sql(expression, "when") 1910 if when: 1911 table = f"{table} {when}" 1912 1913 changes = self.sql(expression, "changes") 1914 changes = f" {changes}" if changes else "" 1915 1916 rows_from = self.expressions(expression, key="rows_from") 1917 if rows_from: 1918 table = f"ROWS FROM {self.wrap(rows_from)}" 1919 1920 return f"{only}{table}{changes}{partition}{version}{file_format}{sample_pre_alias}{alias}{hints}{pivots}{sample_post_alias}{joins}{laterals}{ordinality}" 1921 1922 def tablesample_sql( 1923 self, 1924 expression: exp.TableSample, 1925 tablesample_keyword: t.Optional[str] = None, 1926 ) -> str: 1927 method = self.sql(expression, "method") 1928 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1929 numerator = self.sql(expression, "bucket_numerator") 1930 denominator = self.sql(expression, "bucket_denominator") 1931 field = self.sql(expression, "bucket_field") 1932 field = f" ON {field}" if field else "" 1933 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1934 seed = self.sql(expression, "seed") 1935 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1936 1937 size = self.sql(expression, "size") 1938 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1939 size = f"{size} ROWS" 1940 1941 percent = self.sql(expression, "percent") 1942 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1943 percent = f"{percent} PERCENT" 1944 1945 expr = f"{bucket}{percent}{size}" 1946 if self.TABLESAMPLE_REQUIRES_PARENS: 1947 expr = f"({expr})" 1948 1949 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}" 1950 1951 def pivot_sql(self, expression: exp.Pivot) -> str: 1952 expressions = self.expressions(expression, flat=True) 1953 1954 if expression.this: 1955 this = self.sql(expression, "this") 1956 if not expressions: 1957 return f"UNPIVOT {this}" 1958 1959 on = f"{self.seg('ON')} {expressions}" 1960 using = self.expressions(expression, key="using", flat=True) 1961 using = f"{self.seg('USING')} {using}" if using else "" 1962 group = self.sql(expression, "group") 1963 return f"PIVOT {this}{on}{using}{group}" 1964 1965 alias = self.sql(expression, "alias") 1966 alias = f" AS {alias}" if alias else "" 1967 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 1968 1969 field = self.sql(expression, "field") 1970 1971 include_nulls = expression.args.get("include_nulls") 1972 if include_nulls is not None: 1973 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1974 else: 1975 nulls = "" 1976 1977 default_on_null = self.sql(expression, "default_on_null") 1978 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 1979 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}" 1980 1981 def version_sql(self, expression: exp.Version) -> str: 1982 this = f"FOR {expression.name}" 1983 kind = expression.text("kind") 1984 expr = self.sql(expression, "expression") 1985 return f"{this} {kind} {expr}" 1986 1987 def tuple_sql(self, expression: exp.Tuple) -> str: 1988 return f"({self.expressions(expression, dynamic=True, new_line=True, skip_first=True, skip_last=True)})" 1989 1990 def update_sql(self, expression: exp.Update) -> str: 1991 this = self.sql(expression, "this") 1992 set_sql = self.expressions(expression, flat=True) 1993 from_sql = self.sql(expression, "from") 1994 where_sql = self.sql(expression, "where") 1995 returning = self.sql(expression, "returning") 1996 order = self.sql(expression, "order") 1997 limit = self.sql(expression, "limit") 1998 if self.RETURNING_END: 1999 expression_sql = f"{from_sql}{where_sql}{returning}" 2000 else: 2001 expression_sql = f"{returning}{from_sql}{where_sql}" 2002 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2003 return self.prepend_ctes(expression, sql) 2004 2005 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2006 values_as_table = values_as_table and self.VALUES_AS_TABLE 2007 2008 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2009 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2010 args = self.expressions(expression) 2011 alias = self.sql(expression, "alias") 2012 values = f"VALUES{self.seg('')}{args}" 2013 values = ( 2014 f"({values})" 2015 if self.WRAP_DERIVED_VALUES 2016 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2017 else values 2018 ) 2019 return f"{values} AS {alias}" if alias else values 2020 2021 # Converts `VALUES...` expression into a series of select unions. 2022 alias_node = expression.args.get("alias") 2023 column_names = alias_node and alias_node.columns 2024 2025 selects: t.List[exp.Query] = [] 2026 2027 for i, tup in enumerate(expression.expressions): 2028 row = tup.expressions 2029 2030 if i == 0 and column_names: 2031 row = [ 2032 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2033 ] 2034 2035 selects.append(exp.Select(expressions=row)) 2036 2037 if self.pretty: 2038 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2039 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2040 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2041 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2042 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2043 2044 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2045 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2046 return f"({unions}){alias}" 2047 2048 def var_sql(self, expression: exp.Var) -> str: 2049 return self.sql(expression, "this") 2050 2051 @unsupported_args("expressions") 2052 def into_sql(self, expression: exp.Into) -> str: 2053 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2054 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2055 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 2056 2057 def from_sql(self, expression: exp.From) -> str: 2058 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 2059 2060 def groupingsets_sql(self, expression: exp.GroupingSets) -> str: 2061 grouping_sets = self.expressions(expression, indent=False) 2062 return f"GROUPING SETS {self.wrap(grouping_sets)}" 2063 2064 def rollup_sql(self, expression: exp.Rollup) -> str: 2065 expressions = self.expressions(expression, indent=False) 2066 return f"ROLLUP {self.wrap(expressions)}" if expressions else "WITH ROLLUP" 2067 2068 def cube_sql(self, expression: exp.Cube) -> str: 2069 expressions = self.expressions(expression, indent=False) 2070 return f"CUBE {self.wrap(expressions)}" if expressions else "WITH CUBE" 2071 2072 def group_sql(self, expression: exp.Group) -> str: 2073 group_by_all = expression.args.get("all") 2074 if group_by_all is True: 2075 modifier = " ALL" 2076 elif group_by_all is False: 2077 modifier = " DISTINCT" 2078 else: 2079 modifier = "" 2080 2081 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2082 2083 grouping_sets = self.expressions(expression, key="grouping_sets") 2084 cube = self.expressions(expression, key="cube") 2085 rollup = self.expressions(expression, key="rollup") 2086 2087 groupings = csv( 2088 self.seg(grouping_sets) if grouping_sets else "", 2089 self.seg(cube) if cube else "", 2090 self.seg(rollup) if rollup else "", 2091 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2092 sep=self.GROUPINGS_SEP, 2093 ) 2094 2095 if ( 2096 expression.expressions 2097 and groupings 2098 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2099 ): 2100 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2101 2102 return f"{group_by}{groupings}" 2103 2104 def having_sql(self, expression: exp.Having) -> str: 2105 this = self.indent(self.sql(expression, "this")) 2106 return f"{self.seg('HAVING')}{self.sep()}{this}" 2107 2108 def connect_sql(self, expression: exp.Connect) -> str: 2109 start = self.sql(expression, "start") 2110 start = self.seg(f"START WITH {start}") if start else "" 2111 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2112 connect = self.sql(expression, "connect") 2113 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2114 return start + connect 2115 2116 def prior_sql(self, expression: exp.Prior) -> str: 2117 return f"PRIOR {self.sql(expression, 'this')}" 2118 2119 def join_sql(self, expression: exp.Join) -> str: 2120 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2121 side = None 2122 else: 2123 side = expression.side 2124 2125 op_sql = " ".join( 2126 op 2127 for op in ( 2128 expression.method, 2129 "GLOBAL" if expression.args.get("global") else None, 2130 side, 2131 expression.kind, 2132 expression.hint if self.JOIN_HINTS else None, 2133 ) 2134 if op 2135 ) 2136 match_cond = self.sql(expression, "match_condition") 2137 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2138 on_sql = self.sql(expression, "on") 2139 using = expression.args.get("using") 2140 2141 if not on_sql and using: 2142 on_sql = csv(*(self.sql(column) for column in using)) 2143 2144 this = expression.this 2145 this_sql = self.sql(this) 2146 2147 if on_sql: 2148 on_sql = self.indent(on_sql, skip_first=True) 2149 space = self.seg(" " * self.pad) if self.pretty else " " 2150 if using: 2151 on_sql = f"{space}USING ({on_sql})" 2152 else: 2153 on_sql = f"{space}ON {on_sql}" 2154 elif not op_sql: 2155 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2156 return f" {this_sql}" 2157 2158 return f", {this_sql}" 2159 2160 if op_sql != "STRAIGHT_JOIN": 2161 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2162 2163 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}" 2164 2165 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 2166 args = self.expressions(expression, flat=True) 2167 args = f"({args})" if len(args.split(",")) > 1 else args 2168 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 2169 2170 def lateral_op(self, expression: exp.Lateral) -> str: 2171 cross_apply = expression.args.get("cross_apply") 2172 2173 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2174 if cross_apply is True: 2175 op = "INNER JOIN " 2176 elif cross_apply is False: 2177 op = "LEFT JOIN " 2178 else: 2179 op = "" 2180 2181 return f"{op}LATERAL" 2182 2183 def lateral_sql(self, expression: exp.Lateral) -> str: 2184 this = self.sql(expression, "this") 2185 2186 if expression.args.get("view"): 2187 alias = expression.args["alias"] 2188 columns = self.expressions(alias, key="columns", flat=True) 2189 table = f" {alias.name}" if alias.name else "" 2190 columns = f" AS {columns}" if columns else "" 2191 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2192 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2193 2194 alias = self.sql(expression, "alias") 2195 alias = f" AS {alias}" if alias else "" 2196 return f"{self.lateral_op(expression)} {this}{alias}" 2197 2198 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2199 this = self.sql(expression, "this") 2200 2201 args = [ 2202 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2203 for e in (expression.args.get(k) for k in ("offset", "expression")) 2204 if e 2205 ] 2206 2207 args_sql = ", ".join(self.sql(e) for e in args) 2208 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2209 expressions = self.expressions(expression, flat=True) 2210 expressions = f" BY {expressions}" if expressions else "" 2211 2212 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}" 2213 2214 def offset_sql(self, expression: exp.Offset) -> str: 2215 this = self.sql(expression, "this") 2216 value = expression.expression 2217 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2218 expressions = self.expressions(expression, flat=True) 2219 expressions = f" BY {expressions}" if expressions else "" 2220 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}" 2221 2222 def setitem_sql(self, expression: exp.SetItem) -> str: 2223 kind = self.sql(expression, "kind") 2224 kind = f"{kind} " if kind else "" 2225 this = self.sql(expression, "this") 2226 expressions = self.expressions(expression) 2227 collate = self.sql(expression, "collate") 2228 collate = f" COLLATE {collate}" if collate else "" 2229 global_ = "GLOBAL " if expression.args.get("global") else "" 2230 return f"{global_}{kind}{this}{expressions}{collate}" 2231 2232 def set_sql(self, expression: exp.Set) -> str: 2233 expressions = ( 2234 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2235 ) 2236 tag = " TAG" if expression.args.get("tag") else "" 2237 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 2238 2239 def pragma_sql(self, expression: exp.Pragma) -> str: 2240 return f"PRAGMA {self.sql(expression, 'this')}" 2241 2242 def lock_sql(self, expression: exp.Lock) -> str: 2243 if not self.LOCKING_READS_SUPPORTED: 2244 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2245 return "" 2246 2247 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2248 expressions = self.expressions(expression, flat=True) 2249 expressions = f" OF {expressions}" if expressions else "" 2250 wait = expression.args.get("wait") 2251 2252 if wait is not None: 2253 if isinstance(wait, exp.Literal): 2254 wait = f" WAIT {self.sql(wait)}" 2255 else: 2256 wait = " NOWAIT" if wait else " SKIP LOCKED" 2257 2258 return f"{lock_type}{expressions}{wait or ''}" 2259 2260 def literal_sql(self, expression: exp.Literal) -> str: 2261 text = expression.this or "" 2262 if expression.is_string: 2263 text = f"{self.dialect.QUOTE_START}{self.escape_str(text)}{self.dialect.QUOTE_END}" 2264 return text 2265 2266 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2267 if self.dialect.ESCAPED_SEQUENCES: 2268 to_escaped = self.dialect.ESCAPED_SEQUENCES 2269 text = "".join( 2270 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2271 ) 2272 2273 return self._replace_line_breaks(text).replace( 2274 self.dialect.QUOTE_END, self._escaped_quote_end 2275 ) 2276 2277 def loaddata_sql(self, expression: exp.LoadData) -> str: 2278 local = " LOCAL" if expression.args.get("local") else "" 2279 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2280 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2281 this = f" INTO TABLE {self.sql(expression, 'this')}" 2282 partition = self.sql(expression, "partition") 2283 partition = f" {partition}" if partition else "" 2284 input_format = self.sql(expression, "input_format") 2285 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2286 serde = self.sql(expression, "serde") 2287 serde = f" SERDE {serde}" if serde else "" 2288 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 2289 2290 def null_sql(self, *_) -> str: 2291 return "NULL" 2292 2293 def boolean_sql(self, expression: exp.Boolean) -> str: 2294 return "TRUE" if expression.this else "FALSE" 2295 2296 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2297 this = self.sql(expression, "this") 2298 this = f"{this} " if this else this 2299 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2300 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore 2301 2302 def withfill_sql(self, expression: exp.WithFill) -> str: 2303 from_sql = self.sql(expression, "from") 2304 from_sql = f" FROM {from_sql}" if from_sql else "" 2305 to_sql = self.sql(expression, "to") 2306 to_sql = f" TO {to_sql}" if to_sql else "" 2307 step_sql = self.sql(expression, "step") 2308 step_sql = f" STEP {step_sql}" if step_sql else "" 2309 interpolated_values = [ 2310 f"{self.sql(named_expression, 'alias')} AS {self.sql(named_expression, 'this')}" 2311 for named_expression in expression.args.get("interpolate") or [] 2312 ] 2313 interpolate = ( 2314 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2315 ) 2316 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}" 2317 2318 def cluster_sql(self, expression: exp.Cluster) -> str: 2319 return self.op_expressions("CLUSTER BY", expression) 2320 2321 def distribute_sql(self, expression: exp.Distribute) -> str: 2322 return self.op_expressions("DISTRIBUTE BY", expression) 2323 2324 def sort_sql(self, expression: exp.Sort) -> str: 2325 return self.op_expressions("SORT BY", expression) 2326 2327 def ordered_sql(self, expression: exp.Ordered) -> str: 2328 desc = expression.args.get("desc") 2329 asc = not desc 2330 2331 nulls_first = expression.args.get("nulls_first") 2332 nulls_last = not nulls_first 2333 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2334 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2335 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2336 2337 this = self.sql(expression, "this") 2338 2339 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2340 nulls_sort_change = "" 2341 if nulls_first and ( 2342 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2343 ): 2344 nulls_sort_change = " NULLS FIRST" 2345 elif ( 2346 nulls_last 2347 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2348 and not nulls_are_last 2349 ): 2350 nulls_sort_change = " NULLS LAST" 2351 2352 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2353 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2354 window = expression.find_ancestor(exp.Window, exp.Select) 2355 if isinstance(window, exp.Window) and window.args.get("spec"): 2356 self.unsupported( 2357 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2358 ) 2359 nulls_sort_change = "" 2360 elif ( 2361 self.NULL_ORDERING_SUPPORTED is False 2362 and (isinstance(expression.find_ancestor(exp.AggFunc, exp.Select), exp.AggFunc)) 2363 and ( 2364 (asc and nulls_sort_change == " NULLS LAST") 2365 or (desc and nulls_sort_change == " NULLS FIRST") 2366 ) 2367 ): 2368 self.unsupported( 2369 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2370 ) 2371 nulls_sort_change = "" 2372 elif self.NULL_ORDERING_SUPPORTED is None: 2373 if expression.this.is_int: 2374 self.unsupported( 2375 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2376 ) 2377 elif not isinstance(expression.this, exp.Rand): 2378 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2379 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2380 nulls_sort_change = "" 2381 2382 with_fill = self.sql(expression, "with_fill") 2383 with_fill = f" {with_fill}" if with_fill else "" 2384 2385 return f"{this}{sort_order}{nulls_sort_change}{with_fill}" 2386 2387 def matchrecognizemeasure_sql(self, expression: exp.MatchRecognizeMeasure) -> str: 2388 window_frame = self.sql(expression, "window_frame") 2389 window_frame = f"{window_frame} " if window_frame else "" 2390 2391 this = self.sql(expression, "this") 2392 2393 return f"{window_frame}{this}" 2394 2395 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2396 partition = self.partition_by_sql(expression) 2397 order = self.sql(expression, "order") 2398 measures = self.expressions(expression, key="measures") 2399 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2400 rows = self.sql(expression, "rows") 2401 rows = self.seg(rows) if rows else "" 2402 after = self.sql(expression, "after") 2403 after = self.seg(after) if after else "" 2404 pattern = self.sql(expression, "pattern") 2405 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2406 definition_sqls = [ 2407 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2408 for definition in expression.args.get("define", []) 2409 ] 2410 definitions = self.expressions(sqls=definition_sqls) 2411 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2412 body = "".join( 2413 ( 2414 partition, 2415 order, 2416 measures, 2417 rows, 2418 after, 2419 pattern, 2420 define, 2421 ) 2422 ) 2423 alias = self.sql(expression, "alias") 2424 alias = f" {alias}" if alias else "" 2425 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 2426 2427 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2428 limit = expression.args.get("limit") 2429 2430 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2431 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2432 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2433 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2434 2435 return csv( 2436 *sqls, 2437 *[self.sql(join) for join in expression.args.get("joins") or []], 2438 self.sql(expression, "connect"), 2439 self.sql(expression, "match"), 2440 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2441 self.sql(expression, "prewhere"), 2442 self.sql(expression, "where"), 2443 self.sql(expression, "group"), 2444 self.sql(expression, "having"), 2445 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2446 self.sql(expression, "order"), 2447 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2448 *self.after_limit_modifiers(expression), 2449 self.options_modifier(expression), 2450 sep="", 2451 ) 2452 2453 def options_modifier(self, expression: exp.Expression) -> str: 2454 options = self.expressions(expression, key="options") 2455 return f" {options}" if options else "" 2456 2457 def queryoption_sql(self, expression: exp.QueryOption) -> str: 2458 return "" 2459 2460 def offset_limit_modifiers( 2461 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2462 ) -> t.List[str]: 2463 return [ 2464 self.sql(expression, "offset") if fetch else self.sql(limit), 2465 self.sql(limit) if fetch else self.sql(expression, "offset"), 2466 ] 2467 2468 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 2469 locks = self.expressions(expression, key="locks", sep=" ") 2470 locks = f" {locks}" if locks else "" 2471 return [locks, self.sql(expression, "sample")] 2472 2473 def select_sql(self, expression: exp.Select) -> str: 2474 into = expression.args.get("into") 2475 if not self.SUPPORTS_SELECT_INTO and into: 2476 into.pop() 2477 2478 hint = self.sql(expression, "hint") 2479 distinct = self.sql(expression, "distinct") 2480 distinct = f" {distinct}" if distinct else "" 2481 kind = self.sql(expression, "kind") 2482 2483 limit = expression.args.get("limit") 2484 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2485 top = self.limit_sql(limit, top=True) 2486 limit.pop() 2487 else: 2488 top = "" 2489 2490 expressions = self.expressions(expression) 2491 2492 if kind: 2493 if kind in self.SELECT_KINDS: 2494 kind = f" AS {kind}" 2495 else: 2496 if kind == "STRUCT": 2497 expressions = self.expressions( 2498 sqls=[ 2499 self.sql( 2500 exp.Struct( 2501 expressions=[ 2502 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2503 if isinstance(e, exp.Alias) 2504 else e 2505 for e in expression.expressions 2506 ] 2507 ) 2508 ) 2509 ] 2510 ) 2511 kind = "" 2512 2513 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2514 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2515 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2516 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2517 sql = self.query_modifiers( 2518 expression, 2519 f"SELECT{top_distinct}{kind}{expressions}", 2520 self.sql(expression, "into", comment=False), 2521 self.sql(expression, "from", comment=False), 2522 ) 2523 2524 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2525 if expression.args.get("with"): 2526 sql = self.maybe_comment(sql, expression) 2527 expression.pop_comments() 2528 2529 sql = self.prepend_ctes(expression, sql) 2530 2531 if not self.SUPPORTS_SELECT_INTO and into: 2532 if into.args.get("temporary"): 2533 table_kind = " TEMPORARY" 2534 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2535 table_kind = " UNLOGGED" 2536 else: 2537 table_kind = "" 2538 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2539 2540 return sql 2541 2542 def schema_sql(self, expression: exp.Schema) -> str: 2543 this = self.sql(expression, "this") 2544 sql = self.schema_columns_sql(expression) 2545 return f"{this} {sql}" if this and sql else this or sql 2546 2547 def schema_columns_sql(self, expression: exp.Schema) -> str: 2548 if expression.expressions: 2549 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2550 return "" 2551 2552 def star_sql(self, expression: exp.Star) -> str: 2553 except_ = self.expressions(expression, key="except", flat=True) 2554 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2555 replace = self.expressions(expression, key="replace", flat=True) 2556 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2557 rename = self.expressions(expression, key="rename", flat=True) 2558 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2559 return f"*{except_}{replace}{rename}" 2560 2561 def parameter_sql(self, expression: exp.Parameter) -> str: 2562 this = self.sql(expression, "this") 2563 return f"{self.PARAMETER_TOKEN}{this}" 2564 2565 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2566 this = self.sql(expression, "this") 2567 kind = expression.text("kind") 2568 if kind: 2569 kind = f"{kind}." 2570 return f"@@{kind}{this}" 2571 2572 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2573 return f"{self.NAMED_PLACEHOLDER_TOKEN}{expression.name}" if expression.this else "?" 2574 2575 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2576 alias = self.sql(expression, "alias") 2577 alias = f"{sep}{alias}" if alias else "" 2578 sample = self.sql(expression, "sample") 2579 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2580 alias = f"{sample}{alias}" 2581 2582 # Set to None so it's not generated again by self.query_modifiers() 2583 expression.set("sample", None) 2584 2585 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2586 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2587 return self.prepend_ctes(expression, sql) 2588 2589 def qualify_sql(self, expression: exp.Qualify) -> str: 2590 this = self.indent(self.sql(expression, "this")) 2591 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2592 2593 def unnest_sql(self, expression: exp.Unnest) -> str: 2594 args = self.expressions(expression, flat=True) 2595 2596 alias = expression.args.get("alias") 2597 offset = expression.args.get("offset") 2598 2599 if self.UNNEST_WITH_ORDINALITY: 2600 if alias and isinstance(offset, exp.Expression): 2601 alias.append("columns", offset) 2602 2603 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2604 columns = alias.columns 2605 alias = self.sql(columns[0]) if columns else "" 2606 else: 2607 alias = self.sql(alias) 2608 2609 alias = f" AS {alias}" if alias else alias 2610 if self.UNNEST_WITH_ORDINALITY: 2611 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2612 else: 2613 if isinstance(offset, exp.Expression): 2614 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2615 elif offset: 2616 suffix = f"{alias} WITH OFFSET" 2617 else: 2618 suffix = alias 2619 2620 return f"UNNEST({args}){suffix}" 2621 2622 def prewhere_sql(self, expression: exp.PreWhere) -> str: 2623 return "" 2624 2625 def where_sql(self, expression: exp.Where) -> str: 2626 this = self.indent(self.sql(expression, "this")) 2627 return f"{self.seg('WHERE')}{self.sep()}{this}" 2628 2629 def window_sql(self, expression: exp.Window) -> str: 2630 this = self.sql(expression, "this") 2631 partition = self.partition_by_sql(expression) 2632 order = expression.args.get("order") 2633 order = self.order_sql(order, flat=True) if order else "" 2634 spec = self.sql(expression, "spec") 2635 alias = self.sql(expression, "alias") 2636 over = self.sql(expression, "over") or "OVER" 2637 2638 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2639 2640 first = expression.args.get("first") 2641 if first is None: 2642 first = "" 2643 else: 2644 first = "FIRST" if first else "LAST" 2645 2646 if not partition and not order and not spec and alias: 2647 return f"{this} {alias}" 2648 2649 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2650 return f"{this} ({args})" 2651 2652 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2653 partition = self.expressions(expression, key="partition_by", flat=True) 2654 return f"PARTITION BY {partition}" if partition else "" 2655 2656 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2657 kind = self.sql(expression, "kind") 2658 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2659 end = ( 2660 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2661 or "CURRENT ROW" 2662 ) 2663 return f"{kind} BETWEEN {start} AND {end}" 2664 2665 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2666 this = self.sql(expression, "this") 2667 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2668 return f"{this} WITHIN GROUP ({expression_sql})" 2669 2670 def between_sql(self, expression: exp.Between) -> str: 2671 this = self.sql(expression, "this") 2672 low = self.sql(expression, "low") 2673 high = self.sql(expression, "high") 2674 return f"{this} BETWEEN {low} AND {high}" 2675 2676 def bracket_offset_expressions( 2677 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2678 ) -> t.List[exp.Expression]: 2679 return apply_index_offset( 2680 expression.this, 2681 expression.expressions, 2682 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2683 ) 2684 2685 def bracket_sql(self, expression: exp.Bracket) -> str: 2686 expressions = self.bracket_offset_expressions(expression) 2687 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2688 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2689 2690 def all_sql(self, expression: exp.All) -> str: 2691 return f"ALL {self.wrap(expression)}" 2692 2693 def any_sql(self, expression: exp.Any) -> str: 2694 this = self.sql(expression, "this") 2695 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2696 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2697 this = self.wrap(this) 2698 return f"ANY{this}" 2699 return f"ANY {this}" 2700 2701 def exists_sql(self, expression: exp.Exists) -> str: 2702 return f"EXISTS{self.wrap(expression)}" 2703 2704 def case_sql(self, expression: exp.Case) -> str: 2705 this = self.sql(expression, "this") 2706 statements = [f"CASE {this}" if this else "CASE"] 2707 2708 for e in expression.args["ifs"]: 2709 statements.append(f"WHEN {self.sql(e, 'this')}") 2710 statements.append(f"THEN {self.sql(e, 'true')}") 2711 2712 default = self.sql(expression, "default") 2713 2714 if default: 2715 statements.append(f"ELSE {default}") 2716 2717 statements.append("END") 2718 2719 if self.pretty and self.too_wide(statements): 2720 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2721 2722 return " ".join(statements) 2723 2724 def constraint_sql(self, expression: exp.Constraint) -> str: 2725 this = self.sql(expression, "this") 2726 expressions = self.expressions(expression, flat=True) 2727 return f"CONSTRAINT {this} {expressions}" 2728 2729 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2730 order = expression.args.get("order") 2731 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2732 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2733 2734 def extract_sql(self, expression: exp.Extract) -> str: 2735 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2736 expression_sql = self.sql(expression, "expression") 2737 return f"EXTRACT({this} FROM {expression_sql})" 2738 2739 def trim_sql(self, expression: exp.Trim) -> str: 2740 trim_type = self.sql(expression, "position") 2741 2742 if trim_type == "LEADING": 2743 func_name = "LTRIM" 2744 elif trim_type == "TRAILING": 2745 func_name = "RTRIM" 2746 else: 2747 func_name = "TRIM" 2748 2749 return self.func(func_name, expression.this, expression.expression) 2750 2751 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2752 args = expression.expressions 2753 if isinstance(expression, exp.ConcatWs): 2754 args = args[1:] # Skip the delimiter 2755 2756 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2757 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2758 2759 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2760 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2761 2762 return args 2763 2764 def concat_sql(self, expression: exp.Concat) -> str: 2765 expressions = self.convert_concat_args(expression) 2766 2767 # Some dialects don't allow a single-argument CONCAT call 2768 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2769 return self.sql(expressions[0]) 2770 2771 return self.func("CONCAT", *expressions) 2772 2773 def concatws_sql(self, expression: exp.ConcatWs) -> str: 2774 return self.func( 2775 "CONCAT_WS", seq_get(expression.expressions, 0), *self.convert_concat_args(expression) 2776 ) 2777 2778 def check_sql(self, expression: exp.Check) -> str: 2779 this = self.sql(expression, key="this") 2780 return f"CHECK ({this})" 2781 2782 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2783 expressions = self.expressions(expression, flat=True) 2784 reference = self.sql(expression, "reference") 2785 reference = f" {reference}" if reference else "" 2786 delete = self.sql(expression, "delete") 2787 delete = f" ON DELETE {delete}" if delete else "" 2788 update = self.sql(expression, "update") 2789 update = f" ON UPDATE {update}" if update else "" 2790 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}" 2791 2792 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2793 expressions = self.expressions(expression, flat=True) 2794 options = self.expressions(expression, key="options", flat=True, sep=" ") 2795 options = f" {options}" if options else "" 2796 return f"PRIMARY KEY ({expressions}){options}" 2797 2798 def if_sql(self, expression: exp.If) -> str: 2799 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2800 2801 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2802 modifier = expression.args.get("modifier") 2803 modifier = f" {modifier}" if modifier else "" 2804 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2805 2806 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2807 return f"{self.sql(expression, 'this')}{self.JSON_KEY_VALUE_PAIR_SEP} {self.sql(expression, 'expression')}" 2808 2809 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2810 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2811 2812 if expression.args.get("escape"): 2813 path = self.escape_str(path) 2814 2815 if self.QUOTE_JSON_PATH: 2816 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2817 2818 return path 2819 2820 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2821 if isinstance(expression, exp.JSONPathPart): 2822 transform = self.TRANSFORMS.get(expression.__class__) 2823 if not callable(transform): 2824 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2825 return "" 2826 2827 return transform(self, expression) 2828 2829 if isinstance(expression, int): 2830 return str(expression) 2831 2832 if self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2833 escaped = expression.replace("'", "\\'") 2834 escaped = f"\\'{expression}\\'" 2835 else: 2836 escaped = expression.replace('"', '\\"') 2837 escaped = f'"{escaped}"' 2838 2839 return escaped 2840 2841 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2842 return f"{self.sql(expression, 'this')} FORMAT JSON" 2843 2844 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2845 null_handling = expression.args.get("null_handling") 2846 null_handling = f" {null_handling}" if null_handling else "" 2847 2848 unique_keys = expression.args.get("unique_keys") 2849 if unique_keys is not None: 2850 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2851 else: 2852 unique_keys = "" 2853 2854 return_type = self.sql(expression, "return_type") 2855 return_type = f" RETURNING {return_type}" if return_type else "" 2856 encoding = self.sql(expression, "encoding") 2857 encoding = f" ENCODING {encoding}" if encoding else "" 2858 2859 return self.func( 2860 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2861 *expression.expressions, 2862 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2863 ) 2864 2865 def jsonobjectagg_sql(self, expression: exp.JSONObjectAgg) -> str: 2866 return self.jsonobject_sql(expression) 2867 2868 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2869 null_handling = expression.args.get("null_handling") 2870 null_handling = f" {null_handling}" if null_handling else "" 2871 return_type = self.sql(expression, "return_type") 2872 return_type = f" RETURNING {return_type}" if return_type else "" 2873 strict = " STRICT" if expression.args.get("strict") else "" 2874 return self.func( 2875 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2876 ) 2877 2878 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2879 this = self.sql(expression, "this") 2880 order = self.sql(expression, "order") 2881 null_handling = expression.args.get("null_handling") 2882 null_handling = f" {null_handling}" if null_handling else "" 2883 return_type = self.sql(expression, "return_type") 2884 return_type = f" RETURNING {return_type}" if return_type else "" 2885 strict = " STRICT" if expression.args.get("strict") else "" 2886 return self.func( 2887 "JSON_ARRAYAGG", 2888 this, 2889 suffix=f"{order}{null_handling}{return_type}{strict})", 2890 ) 2891 2892 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2893 path = self.sql(expression, "path") 2894 path = f" PATH {path}" if path else "" 2895 nested_schema = self.sql(expression, "nested_schema") 2896 2897 if nested_schema: 2898 return f"NESTED{path} {nested_schema}" 2899 2900 this = self.sql(expression, "this") 2901 kind = self.sql(expression, "kind") 2902 kind = f" {kind}" if kind else "" 2903 return f"{this}{kind}{path}" 2904 2905 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2906 return self.func("COLUMNS", *expression.expressions) 2907 2908 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2909 this = self.sql(expression, "this") 2910 path = self.sql(expression, "path") 2911 path = f", {path}" if path else "" 2912 error_handling = expression.args.get("error_handling") 2913 error_handling = f" {error_handling}" if error_handling else "" 2914 empty_handling = expression.args.get("empty_handling") 2915 empty_handling = f" {empty_handling}" if empty_handling else "" 2916 schema = self.sql(expression, "schema") 2917 return self.func( 2918 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2919 ) 2920 2921 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2922 this = self.sql(expression, "this") 2923 kind = self.sql(expression, "kind") 2924 path = self.sql(expression, "path") 2925 path = f" {path}" if path else "" 2926 as_json = " AS JSON" if expression.args.get("as_json") else "" 2927 return f"{this} {kind}{path}{as_json}" 2928 2929 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2930 this = self.sql(expression, "this") 2931 path = self.sql(expression, "path") 2932 path = f", {path}" if path else "" 2933 expressions = self.expressions(expression) 2934 with_ = ( 2935 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2936 if expressions 2937 else "" 2938 ) 2939 return f"OPENJSON({this}{path}){with_}" 2940 2941 def in_sql(self, expression: exp.In) -> str: 2942 query = expression.args.get("query") 2943 unnest = expression.args.get("unnest") 2944 field = expression.args.get("field") 2945 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2946 2947 if query: 2948 in_sql = self.sql(query) 2949 elif unnest: 2950 in_sql = self.in_unnest_op(unnest) 2951 elif field: 2952 in_sql = self.sql(field) 2953 else: 2954 in_sql = f"({self.expressions(expression, flat=True)})" 2955 2956 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 2957 2958 def in_unnest_op(self, unnest: exp.Unnest) -> str: 2959 return f"(SELECT {self.sql(unnest)})" 2960 2961 def interval_sql(self, expression: exp.Interval) -> str: 2962 unit = self.sql(expression, "unit") 2963 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2964 unit = self.TIME_PART_SINGULARS.get(unit, unit) 2965 unit = f" {unit}" if unit else "" 2966 2967 if self.SINGLE_STRING_INTERVAL: 2968 this = expression.this.name if expression.this else "" 2969 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2970 2971 this = self.sql(expression, "this") 2972 if this: 2973 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2974 this = f" {this}" if unwrapped else f" ({this})" 2975 2976 return f"INTERVAL{this}{unit}" 2977 2978 def return_sql(self, expression: exp.Return) -> str: 2979 return f"RETURN {self.sql(expression, 'this')}" 2980 2981 def reference_sql(self, expression: exp.Reference) -> str: 2982 this = self.sql(expression, "this") 2983 expressions = self.expressions(expression, flat=True) 2984 expressions = f"({expressions})" if expressions else "" 2985 options = self.expressions(expression, key="options", flat=True, sep=" ") 2986 options = f" {options}" if options else "" 2987 return f"REFERENCES {this}{expressions}{options}" 2988 2989 def anonymous_sql(self, expression: exp.Anonymous) -> str: 2990 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 2991 parent = expression.parent 2992 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 2993 return self.func( 2994 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 2995 ) 2996 2997 def paren_sql(self, expression: exp.Paren) -> str: 2998 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 2999 return f"({sql}{self.seg(')', sep='')}" 3000 3001 def neg_sql(self, expression: exp.Neg) -> str: 3002 # This makes sure we don't convert "- - 5" to "--5", which is a comment 3003 this_sql = self.sql(expression, "this") 3004 sep = " " if this_sql[0] == "-" else "" 3005 return f"-{sep}{this_sql}" 3006 3007 def not_sql(self, expression: exp.Not) -> str: 3008 return f"NOT {self.sql(expression, 'this')}" 3009 3010 def alias_sql(self, expression: exp.Alias) -> str: 3011 alias = self.sql(expression, "alias") 3012 alias = f" AS {alias}" if alias else "" 3013 return f"{self.sql(expression, 'this')}{alias}" 3014 3015 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3016 alias = expression.args["alias"] 3017 3018 identifier_alias = isinstance(alias, exp.Identifier) 3019 literal_alias = isinstance(alias, exp.Literal) 3020 3021 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3022 alias.replace(exp.Literal.string(alias.output_name)) 3023 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3024 alias.replace(exp.to_identifier(alias.output_name)) 3025 3026 return self.alias_sql(expression) 3027 3028 def aliases_sql(self, expression: exp.Aliases) -> str: 3029 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 3030 3031 def atindex_sql(self, expression: exp.AtTimeZone) -> str: 3032 this = self.sql(expression, "this") 3033 index = self.sql(expression, "expression") 3034 return f"{this} AT {index}" 3035 3036 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 3037 this = self.sql(expression, "this") 3038 zone = self.sql(expression, "zone") 3039 return f"{this} AT TIME ZONE {zone}" 3040 3041 def fromtimezone_sql(self, expression: exp.FromTimeZone) -> str: 3042 this = self.sql(expression, "this") 3043 zone = self.sql(expression, "zone") 3044 return f"{this} AT TIME ZONE {zone} AT TIME ZONE 'UTC'" 3045 3046 def add_sql(self, expression: exp.Add) -> str: 3047 return self.binary(expression, "+") 3048 3049 def and_sql( 3050 self, expression: exp.And, stack: t.Optional[t.List[str | exp.Expression]] = None 3051 ) -> str: 3052 return self.connector_sql(expression, "AND", stack) 3053 3054 def or_sql( 3055 self, expression: exp.Or, stack: t.Optional[t.List[str | exp.Expression]] = None 3056 ) -> str: 3057 return self.connector_sql(expression, "OR", stack) 3058 3059 def xor_sql( 3060 self, expression: exp.Xor, stack: t.Optional[t.List[str | exp.Expression]] = None 3061 ) -> str: 3062 return self.connector_sql(expression, "XOR", stack) 3063 3064 def connector_sql( 3065 self, 3066 expression: exp.Connector, 3067 op: str, 3068 stack: t.Optional[t.List[str | exp.Expression]] = None, 3069 ) -> str: 3070 if stack is not None: 3071 if expression.expressions: 3072 stack.append(self.expressions(expression, sep=f" {op} ")) 3073 else: 3074 stack.append(expression.right) 3075 if expression.comments and self.comments: 3076 for comment in expression.comments: 3077 if comment: 3078 op += f" /*{self.pad_comment(comment)}*/" 3079 stack.extend((op, expression.left)) 3080 return op 3081 3082 stack = [expression] 3083 sqls: t.List[str] = [] 3084 ops = set() 3085 3086 while stack: 3087 node = stack.pop() 3088 if isinstance(node, exp.Connector): 3089 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3090 else: 3091 sql = self.sql(node) 3092 if sqls and sqls[-1] in ops: 3093 sqls[-1] += f" {sql}" 3094 else: 3095 sqls.append(sql) 3096 3097 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3098 return sep.join(sqls) 3099 3100 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 3101 return self.binary(expression, "&") 3102 3103 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 3104 return self.binary(expression, "<<") 3105 3106 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 3107 return f"~{self.sql(expression, 'this')}" 3108 3109 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 3110 return self.binary(expression, "|") 3111 3112 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 3113 return self.binary(expression, ">>") 3114 3115 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 3116 return self.binary(expression, "^") 3117 3118 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3119 format_sql = self.sql(expression, "format") 3120 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3121 to_sql = self.sql(expression, "to") 3122 to_sql = f" {to_sql}" if to_sql else "" 3123 action = self.sql(expression, "action") 3124 action = f" {action}" if action else "" 3125 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})" 3126 3127 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 3128 zone = self.sql(expression, "this") 3129 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 3130 3131 def collate_sql(self, expression: exp.Collate) -> str: 3132 if self.COLLATE_IS_FUNC: 3133 return self.function_fallback_sql(expression) 3134 return self.binary(expression, "COLLATE") 3135 3136 def command_sql(self, expression: exp.Command) -> str: 3137 return f"{self.sql(expression, 'this')} {expression.text('expression').strip()}" 3138 3139 def comment_sql(self, expression: exp.Comment) -> str: 3140 this = self.sql(expression, "this") 3141 kind = expression.args["kind"] 3142 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3143 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3144 expression_sql = self.sql(expression, "expression") 3145 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}" 3146 3147 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3148 this = self.sql(expression, "this") 3149 delete = " DELETE" if expression.args.get("delete") else "" 3150 recompress = self.sql(expression, "recompress") 3151 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3152 to_disk = self.sql(expression, "to_disk") 3153 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3154 to_volume = self.sql(expression, "to_volume") 3155 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3156 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 3157 3158 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3159 where = self.sql(expression, "where") 3160 group = self.sql(expression, "group") 3161 aggregates = self.expressions(expression, key="aggregates") 3162 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3163 3164 if not (where or group or aggregates) and len(expression.expressions) == 1: 3165 return f"TTL {self.expressions(expression, flat=True)}" 3166 3167 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 3168 3169 def transaction_sql(self, expression: exp.Transaction) -> str: 3170 return "BEGIN" 3171 3172 def commit_sql(self, expression: exp.Commit) -> str: 3173 chain = expression.args.get("chain") 3174 if chain is not None: 3175 chain = " AND CHAIN" if chain else " AND NO CHAIN" 3176 3177 return f"COMMIT{chain or ''}" 3178 3179 def rollback_sql(self, expression: exp.Rollback) -> str: 3180 savepoint = expression.args.get("savepoint") 3181 savepoint = f" TO {savepoint}" if savepoint else "" 3182 return f"ROLLBACK{savepoint}" 3183 3184 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3185 this = self.sql(expression, "this") 3186 3187 dtype = self.sql(expression, "dtype") 3188 if dtype: 3189 collate = self.sql(expression, "collate") 3190 collate = f" COLLATE {collate}" if collate else "" 3191 using = self.sql(expression, "using") 3192 using = f" USING {using}" if using else "" 3193 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3194 3195 default = self.sql(expression, "default") 3196 if default: 3197 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3198 3199 comment = self.sql(expression, "comment") 3200 if comment: 3201 return f"ALTER COLUMN {this} COMMENT {comment}" 3202 3203 allow_null = expression.args.get("allow_null") 3204 drop = expression.args.get("drop") 3205 3206 if not drop and not allow_null: 3207 self.unsupported("Unsupported ALTER COLUMN syntax") 3208 3209 if allow_null is not None: 3210 keyword = "DROP" if drop else "SET" 3211 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3212 3213 return f"ALTER COLUMN {this} DROP DEFAULT" 3214 3215 def alterdiststyle_sql(self, expression: exp.AlterDistStyle) -> str: 3216 this = self.sql(expression, "this") 3217 if not isinstance(expression.this, exp.Var): 3218 this = f"KEY DISTKEY {this}" 3219 return f"ALTER DISTSTYLE {this}" 3220 3221 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3222 compound = " COMPOUND" if expression.args.get("compound") else "" 3223 this = self.sql(expression, "this") 3224 expressions = self.expressions(expression, flat=True) 3225 expressions = f"({expressions})" if expressions else "" 3226 return f"ALTER{compound} SORTKEY {this or expressions}" 3227 3228 def renametable_sql(self, expression: exp.RenameTable) -> str: 3229 if not self.RENAME_TABLE_WITH_DB: 3230 # Remove db from tables 3231 expression = expression.transform( 3232 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3233 ).assert_is(exp.RenameTable) 3234 this = self.sql(expression, "this") 3235 return f"RENAME TO {this}" 3236 3237 def renamecolumn_sql(self, expression: exp.RenameColumn) -> str: 3238 exists = " IF EXISTS" if expression.args.get("exists") else "" 3239 old_column = self.sql(expression, "this") 3240 new_column = self.sql(expression, "to") 3241 return f"RENAME COLUMN{exists} {old_column} TO {new_column}" 3242 3243 def alterset_sql(self, expression: exp.AlterSet) -> str: 3244 exprs = self.expressions(expression, flat=True) 3245 return f"SET {exprs}" 3246 3247 def alter_sql(self, expression: exp.Alter) -> str: 3248 actions = expression.args["actions"] 3249 3250 if isinstance(actions[0], exp.ColumnDef): 3251 actions = self.add_column_sql(expression) 3252 elif isinstance(actions[0], exp.Schema): 3253 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3254 elif isinstance(actions[0], exp.Delete): 3255 actions = self.expressions(expression, key="actions", flat=True) 3256 elif isinstance(actions[0], exp.Query): 3257 actions = "AS " + self.expressions(expression, key="actions") 3258 else: 3259 actions = self.expressions(expression, key="actions", flat=True) 3260 3261 exists = " IF EXISTS" if expression.args.get("exists") else "" 3262 on_cluster = self.sql(expression, "cluster") 3263 on_cluster = f" {on_cluster}" if on_cluster else "" 3264 only = " ONLY" if expression.args.get("only") else "" 3265 options = self.expressions(expression, key="options") 3266 options = f", {options}" if options else "" 3267 kind = self.sql(expression, "kind") 3268 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3269 3270 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}" 3271 3272 def add_column_sql(self, expression: exp.Alter) -> str: 3273 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3274 return self.expressions( 3275 expression, 3276 key="actions", 3277 prefix="ADD COLUMN ", 3278 skip_first=True, 3279 ) 3280 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 3281 3282 def droppartition_sql(self, expression: exp.DropPartition) -> str: 3283 expressions = self.expressions(expression) 3284 exists = " IF EXISTS " if expression.args.get("exists") else " " 3285 return f"DROP{exists}{expressions}" 3286 3287 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 3288 return f"ADD {self.expressions(expression)}" 3289 3290 def distinct_sql(self, expression: exp.Distinct) -> str: 3291 this = self.expressions(expression, flat=True) 3292 3293 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3294 case = exp.case() 3295 for arg in expression.expressions: 3296 case = case.when(arg.is_(exp.null()), exp.null()) 3297 this = self.sql(case.else_(f"({this})")) 3298 3299 this = f" {this}" if this else "" 3300 3301 on = self.sql(expression, "on") 3302 on = f" ON {on}" if on else "" 3303 return f"DISTINCT{this}{on}" 3304 3305 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 3306 return self._embed_ignore_nulls(expression, "IGNORE NULLS") 3307 3308 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 3309 return self._embed_ignore_nulls(expression, "RESPECT NULLS") 3310 3311 def havingmax_sql(self, expression: exp.HavingMax) -> str: 3312 this_sql = self.sql(expression, "this") 3313 expression_sql = self.sql(expression, "expression") 3314 kind = "MAX" if expression.args.get("max") else "MIN" 3315 return f"{this_sql} HAVING {kind} {expression_sql}" 3316 3317 def intdiv_sql(self, expression: exp.IntDiv) -> str: 3318 return self.sql( 3319 exp.Cast( 3320 this=exp.Div(this=expression.this, expression=expression.expression), 3321 to=exp.DataType(this=exp.DataType.Type.INT), 3322 ) 3323 ) 3324 3325 def dpipe_sql(self, expression: exp.DPipe) -> str: 3326 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 3327 return self.func( 3328 "CONCAT", *(exp.cast(e, exp.DataType.Type.TEXT) for e in expression.flatten()) 3329 ) 3330 return self.binary(expression, "||") 3331 3332 def div_sql(self, expression: exp.Div) -> str: 3333 l, r = expression.left, expression.right 3334 3335 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3336 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3337 3338 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3339 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3340 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3341 3342 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3343 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3344 return self.sql( 3345 exp.cast( 3346 l / r, 3347 to=exp.DataType.Type.BIGINT, 3348 ) 3349 ) 3350 3351 return self.binary(expression, "/") 3352 3353 def overlaps_sql(self, expression: exp.Overlaps) -> str: 3354 return self.binary(expression, "OVERLAPS") 3355 3356 def distance_sql(self, expression: exp.Distance) -> str: 3357 return self.binary(expression, "<->") 3358 3359 def dot_sql(self, expression: exp.Dot) -> str: 3360 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 3361 3362 def eq_sql(self, expression: exp.EQ) -> str: 3363 return self.binary(expression, "=") 3364 3365 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 3366 return self.binary(expression, ":=") 3367 3368 def escape_sql(self, expression: exp.Escape) -> str: 3369 return self.binary(expression, "ESCAPE") 3370 3371 def glob_sql(self, expression: exp.Glob) -> str: 3372 return self.binary(expression, "GLOB") 3373 3374 def gt_sql(self, expression: exp.GT) -> str: 3375 return self.binary(expression, ">") 3376 3377 def gte_sql(self, expression: exp.GTE) -> str: 3378 return self.binary(expression, ">=") 3379 3380 def ilike_sql(self, expression: exp.ILike) -> str: 3381 return self.binary(expression, "ILIKE") 3382 3383 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 3384 return self.binary(expression, "ILIKE ANY") 3385 3386 def is_sql(self, expression: exp.Is) -> str: 3387 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 3388 return self.sql( 3389 expression.this if expression.expression.this else exp.not_(expression.this) 3390 ) 3391 return self.binary(expression, "IS") 3392 3393 def like_sql(self, expression: exp.Like) -> str: 3394 return self.binary(expression, "LIKE") 3395 3396 def likeany_sql(self, expression: exp.LikeAny) -> str: 3397 return self.binary(expression, "LIKE ANY") 3398 3399 def similarto_sql(self, expression: exp.SimilarTo) -> str: 3400 return self.binary(expression, "SIMILAR TO") 3401 3402 def lt_sql(self, expression: exp.LT) -> str: 3403 return self.binary(expression, "<") 3404 3405 def lte_sql(self, expression: exp.LTE) -> str: 3406 return self.binary(expression, "<=") 3407 3408 def mod_sql(self, expression: exp.Mod) -> str: 3409 return self.binary(expression, "%") 3410 3411 def mul_sql(self, expression: exp.Mul) -> str: 3412 return self.binary(expression, "*") 3413 3414 def neq_sql(self, expression: exp.NEQ) -> str: 3415 return self.binary(expression, "<>") 3416 3417 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 3418 return self.binary(expression, "IS NOT DISTINCT FROM") 3419 3420 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 3421 return self.binary(expression, "IS DISTINCT FROM") 3422 3423 def slice_sql(self, expression: exp.Slice) -> str: 3424 return self.binary(expression, ":") 3425 3426 def sub_sql(self, expression: exp.Sub) -> str: 3427 return self.binary(expression, "-") 3428 3429 def trycast_sql(self, expression: exp.TryCast) -> str: 3430 return self.cast_sql(expression, safe_prefix="TRY_") 3431 3432 def try_sql(self, expression: exp.Try) -> str: 3433 if not self.TRY_SUPPORTED: 3434 self.unsupported("Unsupported TRY function") 3435 return self.sql(expression, "this") 3436 3437 return self.func("TRY", expression.this) 3438 3439 def log_sql(self, expression: exp.Log) -> str: 3440 this = expression.this 3441 expr = expression.expression 3442 3443 if self.dialect.LOG_BASE_FIRST is False: 3444 this, expr = expr, this 3445 elif self.dialect.LOG_BASE_FIRST is None and expr: 3446 if this.name in ("2", "10"): 3447 return self.func(f"LOG{this.name}", expr) 3448 3449 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3450 3451 return self.func("LOG", this, expr) 3452 3453 def use_sql(self, expression: exp.Use) -> str: 3454 kind = self.sql(expression, "kind") 3455 kind = f" {kind}" if kind else "" 3456 this = self.sql(expression, "this") 3457 this = f" {this}" if this else "" 3458 return f"USE{kind}{this}" 3459 3460 def binary(self, expression: exp.Binary, op: str) -> str: 3461 sqls: t.List[str] = [] 3462 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3463 binary_type = type(expression) 3464 3465 while stack: 3466 node = stack.pop() 3467 3468 if type(node) is binary_type: 3469 op_func = node.args.get("operator") 3470 if op_func: 3471 op = f"OPERATOR({self.sql(op_func)})" 3472 3473 stack.append(node.right) 3474 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3475 stack.append(node.left) 3476 else: 3477 sqls.append(self.sql(node)) 3478 3479 return "".join(sqls) 3480 3481 def function_fallback_sql(self, expression: exp.Func) -> str: 3482 args = [] 3483 3484 for key in expression.arg_types: 3485 arg_value = expression.args.get(key) 3486 3487 if isinstance(arg_value, list): 3488 for value in arg_value: 3489 args.append(value) 3490 elif arg_value is not None: 3491 args.append(arg_value) 3492 3493 if self.normalize_functions: 3494 name = expression.sql_name() 3495 else: 3496 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3497 3498 return self.func(name, *args) 3499 3500 def func( 3501 self, 3502 name: str, 3503 *args: t.Optional[exp.Expression | str], 3504 prefix: str = "(", 3505 suffix: str = ")", 3506 normalize: bool = True, 3507 ) -> str: 3508 name = self.normalize_func(name) if normalize else name 3509 return f"{name}{prefix}{self.format_args(*args)}{suffix}" 3510 3511 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 3512 arg_sqls = tuple( 3513 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3514 ) 3515 if self.pretty and self.too_wide(arg_sqls): 3516 return self.indent("\n" + ",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 3517 return ", ".join(arg_sqls) 3518 3519 def too_wide(self, args: t.Iterable) -> bool: 3520 return sum(len(arg) for arg in args) > self.max_text_width 3521 3522 def format_time( 3523 self, 3524 expression: exp.Expression, 3525 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3526 inverse_time_trie: t.Optional[t.Dict] = None, 3527 ) -> t.Optional[str]: 3528 return format_time( 3529 self.sql(expression, "format"), 3530 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3531 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3532 ) 3533 3534 def expressions( 3535 self, 3536 expression: t.Optional[exp.Expression] = None, 3537 key: t.Optional[str] = None, 3538 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3539 flat: bool = False, 3540 indent: bool = True, 3541 skip_first: bool = False, 3542 skip_last: bool = False, 3543 sep: str = ", ", 3544 prefix: str = "", 3545 dynamic: bool = False, 3546 new_line: bool = False, 3547 ) -> str: 3548 expressions = expression.args.get(key or "expressions") if expression else sqls 3549 3550 if not expressions: 3551 return "" 3552 3553 if flat: 3554 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3555 3556 num_sqls = len(expressions) 3557 result_sqls = [] 3558 3559 for i, e in enumerate(expressions): 3560 sql = self.sql(e, comment=False) 3561 if not sql: 3562 continue 3563 3564 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3565 3566 if self.pretty: 3567 if self.leading_comma: 3568 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3569 else: 3570 result_sqls.append( 3571 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3572 ) 3573 else: 3574 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3575 3576 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3577 if new_line: 3578 result_sqls.insert(0, "") 3579 result_sqls.append("") 3580 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3581 else: 3582 result_sql = "".join(result_sqls) 3583 3584 return ( 3585 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3586 if indent 3587 else result_sql 3588 ) 3589 3590 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3591 flat = flat or isinstance(expression.parent, exp.Properties) 3592 expressions_sql = self.expressions(expression, flat=flat) 3593 if flat: 3594 return f"{op} {expressions_sql}" 3595 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 3596 3597 def naked_property(self, expression: exp.Property) -> str: 3598 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3599 if not property_name: 3600 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3601 return f"{property_name} {self.sql(expression, 'this')}" 3602 3603 def tag_sql(self, expression: exp.Tag) -> str: 3604 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 3605 3606 def token_sql(self, token_type: TokenType) -> str: 3607 return self.TOKEN_MAPPING.get(token_type, token_type.name) 3608 3609 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3610 this = self.sql(expression, "this") 3611 expressions = self.no_identify(self.expressions, expression) 3612 expressions = ( 3613 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3614 ) 3615 return f"{this}{expressions}" 3616 3617 def joinhint_sql(self, expression: exp.JoinHint) -> str: 3618 this = self.sql(expression, "this") 3619 expressions = self.expressions(expression, flat=True) 3620 return f"{this}({expressions})" 3621 3622 def kwarg_sql(self, expression: exp.Kwarg) -> str: 3623 return self.binary(expression, "=>") 3624 3625 def when_sql(self, expression: exp.When) -> str: 3626 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3627 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3628 condition = self.sql(expression, "condition") 3629 condition = f" AND {condition}" if condition else "" 3630 3631 then_expression = expression.args.get("then") 3632 if isinstance(then_expression, exp.Insert): 3633 this = self.sql(then_expression, "this") 3634 this = f"INSERT {this}" if this else "INSERT" 3635 then = self.sql(then_expression, "expression") 3636 then = f"{this} VALUES {then}" if then else this 3637 elif isinstance(then_expression, exp.Update): 3638 if isinstance(then_expression.args.get("expressions"), exp.Star): 3639 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3640 else: 3641 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3642 else: 3643 then = self.sql(then_expression) 3644 return f"WHEN {matched}{source}{condition} THEN {then}" 3645 3646 def merge_sql(self, expression: exp.Merge) -> str: 3647 table = expression.this 3648 table_alias = "" 3649 3650 hints = table.args.get("hints") 3651 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3652 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3653 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3654 3655 this = self.sql(table) 3656 using = f"USING {self.sql(expression, 'using')}" 3657 on = f"ON {self.sql(expression, 'on')}" 3658 expressions = self.expressions(expression, sep=" ", indent=False) 3659 returning = self.sql(expression, "returning") 3660 if returning: 3661 expressions = f"{expressions}{returning}" 3662 3663 sep = self.sep() 3664 3665 return self.prepend_ctes( 3666 expression, 3667 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{expressions}", 3668 ) 3669 3670 @unsupported_args("format") 3671 def tochar_sql(self, expression: exp.ToChar) -> str: 3672 return self.sql(exp.cast(expression.this, exp.DataType.Type.TEXT)) 3673 3674 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3675 if not self.SUPPORTS_TO_NUMBER: 3676 self.unsupported("Unsupported TO_NUMBER function") 3677 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3678 3679 fmt = expression.args.get("format") 3680 if not fmt: 3681 self.unsupported("Conversion format is required for TO_NUMBER") 3682 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3683 3684 return self.func("TO_NUMBER", expression.this, fmt) 3685 3686 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3687 this = self.sql(expression, "this") 3688 kind = self.sql(expression, "kind") 3689 settings_sql = self.expressions(expression, key="settings", sep=" ") 3690 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3691 return f"{this}({kind}{args})" 3692 3693 def dictrange_sql(self, expression: exp.DictRange) -> str: 3694 this = self.sql(expression, "this") 3695 max = self.sql(expression, "max") 3696 min = self.sql(expression, "min") 3697 return f"{this}(MIN {min} MAX {max})" 3698 3699 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 3700 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 3701 3702 def duplicatekeyproperty_sql(self, expression: exp.DuplicateKeyProperty) -> str: 3703 return f"DUPLICATE KEY ({self.expressions(expression, flat=True)})" 3704 3705 # https://docs.starrocks.io/docs/sql-reference/sql-statements/data-definition/CREATE_TABLE/#distribution_desc 3706 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3707 expressions = self.expressions(expression, flat=True) 3708 expressions = f" {self.wrap(expressions)}" if expressions else "" 3709 buckets = self.sql(expression, "buckets") 3710 kind = self.sql(expression, "kind") 3711 buckets = f" BUCKETS {buckets}" if buckets else "" 3712 order = self.sql(expression, "order") 3713 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}" 3714 3715 def oncluster_sql(self, expression: exp.OnCluster) -> str: 3716 return "" 3717 3718 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3719 expressions = self.expressions(expression, key="expressions", flat=True) 3720 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3721 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3722 buckets = self.sql(expression, "buckets") 3723 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 3724 3725 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3726 this = self.sql(expression, "this") 3727 having = self.sql(expression, "having") 3728 3729 if having: 3730 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3731 3732 return self.func("ANY_VALUE", this) 3733 3734 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3735 transform = self.func("TRANSFORM", *expression.expressions) 3736 row_format_before = self.sql(expression, "row_format_before") 3737 row_format_before = f" {row_format_before}" if row_format_before else "" 3738 record_writer = self.sql(expression, "record_writer") 3739 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3740 using = f" USING {self.sql(expression, 'command_script')}" 3741 schema = self.sql(expression, "schema") 3742 schema = f" AS {schema}" if schema else "" 3743 row_format_after = self.sql(expression, "row_format_after") 3744 row_format_after = f" {row_format_after}" if row_format_after else "" 3745 record_reader = self.sql(expression, "record_reader") 3746 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3747 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 3748 3749 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3750 key_block_size = self.sql(expression, "key_block_size") 3751 if key_block_size: 3752 return f"KEY_BLOCK_SIZE = {key_block_size}" 3753 3754 using = self.sql(expression, "using") 3755 if using: 3756 return f"USING {using}" 3757 3758 parser = self.sql(expression, "parser") 3759 if parser: 3760 return f"WITH PARSER {parser}" 3761 3762 comment = self.sql(expression, "comment") 3763 if comment: 3764 return f"COMMENT {comment}" 3765 3766 visible = expression.args.get("visible") 3767 if visible is not None: 3768 return "VISIBLE" if visible else "INVISIBLE" 3769 3770 engine_attr = self.sql(expression, "engine_attr") 3771 if engine_attr: 3772 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3773 3774 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3775 if secondary_engine_attr: 3776 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3777 3778 self.unsupported("Unsupported index constraint option.") 3779 return "" 3780 3781 def checkcolumnconstraint_sql(self, expression: exp.CheckColumnConstraint) -> str: 3782 enforced = " ENFORCED" if expression.args.get("enforced") else "" 3783 return f"CHECK ({self.sql(expression, 'this')}){enforced}" 3784 3785 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3786 kind = self.sql(expression, "kind") 3787 kind = f"{kind} INDEX" if kind else "INDEX" 3788 this = self.sql(expression, "this") 3789 this = f" {this}" if this else "" 3790 index_type = self.sql(expression, "index_type") 3791 index_type = f" USING {index_type}" if index_type else "" 3792 expressions = self.expressions(expression, flat=True) 3793 expressions = f" ({expressions})" if expressions else "" 3794 options = self.expressions(expression, key="options", sep=" ") 3795 options = f" {options}" if options else "" 3796 return f"{kind}{this}{index_type}{expressions}{options}" 3797 3798 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3799 if self.NVL2_SUPPORTED: 3800 return self.function_fallback_sql(expression) 3801 3802 case = exp.Case().when( 3803 expression.this.is_(exp.null()).not_(copy=False), 3804 expression.args["true"], 3805 copy=False, 3806 ) 3807 else_cond = expression.args.get("false") 3808 if else_cond: 3809 case.else_(else_cond, copy=False) 3810 3811 return self.sql(case) 3812 3813 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3814 this = self.sql(expression, "this") 3815 expr = self.sql(expression, "expression") 3816 iterator = self.sql(expression, "iterator") 3817 condition = self.sql(expression, "condition") 3818 condition = f" IF {condition}" if condition else "" 3819 return f"{this} FOR {expr} IN {iterator}{condition}" 3820 3821 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3822 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3823 3824 def opclass_sql(self, expression: exp.Opclass) -> str: 3825 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3826 3827 def predict_sql(self, expression: exp.Predict) -> str: 3828 model = self.sql(expression, "this") 3829 model = f"MODEL {model}" 3830 table = self.sql(expression, "expression") 3831 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3832 parameters = self.sql(expression, "params_struct") 3833 return self.func("PREDICT", model, table, parameters or None) 3834 3835 def forin_sql(self, expression: exp.ForIn) -> str: 3836 this = self.sql(expression, "this") 3837 expression_sql = self.sql(expression, "expression") 3838 return f"FOR {this} DO {expression_sql}" 3839 3840 def refresh_sql(self, expression: exp.Refresh) -> str: 3841 this = self.sql(expression, "this") 3842 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3843 return f"REFRESH {table}{this}" 3844 3845 def toarray_sql(self, expression: exp.ToArray) -> str: 3846 arg = expression.this 3847 if not arg.type: 3848 from sqlglot.optimizer.annotate_types import annotate_types 3849 3850 arg = annotate_types(arg) 3851 3852 if arg.is_type(exp.DataType.Type.ARRAY): 3853 return self.sql(arg) 3854 3855 cond_for_null = arg.is_(exp.null()) 3856 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False))) 3857 3858 def tsordstotime_sql(self, expression: exp.TsOrDsToTime) -> str: 3859 this = expression.this 3860 if isinstance(this, exp.TsOrDsToTime) or this.is_type(exp.DataType.Type.TIME): 3861 return self.sql(this) 3862 3863 return self.sql(exp.cast(this, exp.DataType.Type.TIME)) 3864 3865 def tsordstotimestamp_sql(self, expression: exp.TsOrDsToTimestamp) -> str: 3866 this = expression.this 3867 if isinstance(this, exp.TsOrDsToTimestamp) or this.is_type(exp.DataType.Type.TIMESTAMP): 3868 return self.sql(this) 3869 3870 return self.sql(exp.cast(this, exp.DataType.Type.TIMESTAMP)) 3871 3872 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3873 this = expression.this 3874 time_format = self.format_time(expression) 3875 3876 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3877 return self.sql( 3878 exp.cast( 3879 exp.StrToTime(this=this, format=expression.args["format"]), 3880 exp.DataType.Type.DATE, 3881 ) 3882 ) 3883 3884 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3885 return self.sql(this) 3886 3887 return self.sql(exp.cast(this, exp.DataType.Type.DATE)) 3888 3889 def unixdate_sql(self, expression: exp.UnixDate) -> str: 3890 return self.sql( 3891 exp.func( 3892 "DATEDIFF", 3893 expression.this, 3894 exp.cast(exp.Literal.string("1970-01-01"), exp.DataType.Type.DATE), 3895 "day", 3896 ) 3897 ) 3898 3899 def lastday_sql(self, expression: exp.LastDay) -> str: 3900 if self.LAST_DAY_SUPPORTS_DATE_PART: 3901 return self.function_fallback_sql(expression) 3902 3903 unit = expression.text("unit") 3904 if unit and unit != "MONTH": 3905 self.unsupported("Date parts are not supported in LAST_DAY.") 3906 3907 return self.func("LAST_DAY", expression.this) 3908 3909 def dateadd_sql(self, expression: exp.DateAdd) -> str: 3910 from sqlglot.dialects.dialect import unit_to_str 3911 3912 return self.func( 3913 "DATE_ADD", expression.this, expression.expression, unit_to_str(expression) 3914 ) 3915 3916 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3917 if self.CAN_IMPLEMENT_ARRAY_ANY: 3918 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3919 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3920 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3921 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3922 3923 from sqlglot.dialects import Dialect 3924 3925 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3926 if self.dialect.__class__ != Dialect: 3927 self.unsupported("ARRAY_ANY is unsupported") 3928 3929 return self.function_fallback_sql(expression) 3930 3931 def struct_sql(self, expression: exp.Struct) -> str: 3932 expression.set( 3933 "expressions", 3934 [ 3935 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 3936 if isinstance(e, exp.PropertyEQ) 3937 else e 3938 for e in expression.expressions 3939 ], 3940 ) 3941 3942 return self.function_fallback_sql(expression) 3943 3944 def partitionrange_sql(self, expression: exp.PartitionRange) -> str: 3945 low = self.sql(expression, "this") 3946 high = self.sql(expression, "expression") 3947 3948 return f"{low} TO {high}" 3949 3950 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 3951 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 3952 tables = f" {self.expressions(expression)}" 3953 3954 exists = " IF EXISTS" if expression.args.get("exists") else "" 3955 3956 on_cluster = self.sql(expression, "cluster") 3957 on_cluster = f" {on_cluster}" if on_cluster else "" 3958 3959 identity = self.sql(expression, "identity") 3960 identity = f" {identity} IDENTITY" if identity else "" 3961 3962 option = self.sql(expression, "option") 3963 option = f" {option}" if option else "" 3964 3965 partition = self.sql(expression, "partition") 3966 partition = f" {partition}" if partition else "" 3967 3968 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}" 3969 3970 # This transpiles T-SQL's CONVERT function 3971 # https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16 3972 def convert_sql(self, expression: exp.Convert) -> str: 3973 to = expression.this 3974 value = expression.expression 3975 style = expression.args.get("style") 3976 safe = expression.args.get("safe") 3977 strict = expression.args.get("strict") 3978 3979 if not to or not value: 3980 return "" 3981 3982 # Retrieve length of datatype and override to default if not specified 3983 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 3984 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 3985 3986 transformed: t.Optional[exp.Expression] = None 3987 cast = exp.Cast if strict else exp.TryCast 3988 3989 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 3990 if isinstance(style, exp.Literal) and style.is_int: 3991 from sqlglot.dialects.tsql import TSQL 3992 3993 style_value = style.name 3994 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 3995 if not converted_style: 3996 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 3997 3998 fmt = exp.Literal.string(converted_style) 3999 4000 if to.this == exp.DataType.Type.DATE: 4001 transformed = exp.StrToDate(this=value, format=fmt) 4002 elif to.this == exp.DataType.Type.DATETIME: 4003 transformed = exp.StrToTime(this=value, format=fmt) 4004 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4005 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4006 elif to.this == exp.DataType.Type.TEXT: 4007 transformed = exp.TimeToStr(this=value, format=fmt) 4008 4009 if not transformed: 4010 transformed = cast(this=value, to=to, safe=safe) 4011 4012 return self.sql(transformed) 4013 4014 def _jsonpathkey_sql(self, expression: exp.JSONPathKey) -> str: 4015 this = expression.this 4016 if isinstance(this, exp.JSONPathWildcard): 4017 this = self.json_path_part(this) 4018 return f".{this}" if this else "" 4019 4020 if exp.SAFE_IDENTIFIER_RE.match(this): 4021 return f".{this}" 4022 4023 this = self.json_path_part(this) 4024 return f"[{this}]" if self.JSON_PATH_BRACKETED_KEY_SUPPORTED else f".{this}" 4025 4026 def _jsonpathsubscript_sql(self, expression: exp.JSONPathSubscript) -> str: 4027 this = self.json_path_part(expression.this) 4028 return f"[{this}]" if this else "" 4029 4030 def _simplify_unless_literal(self, expression: E) -> E: 4031 if not isinstance(expression, exp.Literal): 4032 from sqlglot.optimizer.simplify import simplify 4033 4034 expression = simplify(expression, dialect=self.dialect) 4035 4036 return expression 4037 4038 def _embed_ignore_nulls(self, expression: exp.IgnoreNulls | exp.RespectNulls, text: str) -> str: 4039 if self.IGNORE_NULLS_IN_FUNC and not expression.meta.get("inline"): 4040 # The first modifier here will be the one closest to the AggFunc's arg 4041 mods = sorted( 4042 expression.find_all(exp.HavingMax, exp.Order, exp.Limit), 4043 key=lambda x: 0 4044 if isinstance(x, exp.HavingMax) 4045 else (1 if isinstance(x, exp.Order) else 2), 4046 ) 4047 4048 if mods: 4049 mod = mods[0] 4050 this = expression.__class__(this=mod.this.copy()) 4051 this.meta["inline"] = True 4052 mod.this.replace(this) 4053 return self.sql(expression.this) 4054 4055 agg_func = expression.find(exp.AggFunc) 4056 4057 if agg_func: 4058 return self.sql(agg_func)[:-1] + f" {text})" 4059 4060 return f"{self.sql(expression, 'this')} {text}" 4061 4062 def _replace_line_breaks(self, string: str) -> str: 4063 """We don't want to extra indent line breaks so we temporarily replace them with sentinels.""" 4064 if self.pretty: 4065 return string.replace("\n", self.SENTINEL_LINE_BREAK) 4066 return string 4067 4068 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4069 option = self.sql(expression, "this") 4070 4071 if expression.expressions: 4072 upper = option.upper() 4073 4074 # Snowflake FILE_FORMAT options are separated by whitespace 4075 sep = " " if upper == "FILE_FORMAT" else ", " 4076 4077 # Databricks copy/format options do not set their list of values with EQ 4078 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4079 values = self.expressions(expression, flat=True, sep=sep) 4080 return f"{option}{op}({values})" 4081 4082 value = self.sql(expression, "expression") 4083 4084 if not value: 4085 return option 4086 4087 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4088 4089 return f"{option}{op}{value}" 4090 4091 def credentials_sql(self, expression: exp.Credentials) -> str: 4092 cred_expr = expression.args.get("credentials") 4093 if isinstance(cred_expr, exp.Literal): 4094 # Redshift case: CREDENTIALS <string> 4095 credentials = self.sql(expression, "credentials") 4096 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4097 else: 4098 # Snowflake case: CREDENTIALS = (...) 4099 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4100 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4101 4102 storage = self.sql(expression, "storage") 4103 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4104 4105 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4106 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4107 4108 iam_role = self.sql(expression, "iam_role") 4109 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4110 4111 region = self.sql(expression, "region") 4112 region = f" REGION {region}" if region else "" 4113 4114 return f"{credentials}{storage}{encryption}{iam_role}{region}" 4115 4116 def copy_sql(self, expression: exp.Copy) -> str: 4117 this = self.sql(expression, "this") 4118 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4119 4120 credentials = self.sql(expression, "credentials") 4121 credentials = self.seg(credentials) if credentials else "" 4122 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4123 files = self.expressions(expression, key="files", flat=True) 4124 4125 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4126 params = self.expressions( 4127 expression, 4128 key="params", 4129 sep=sep, 4130 new_line=True, 4131 skip_last=True, 4132 skip_first=True, 4133 indent=self.COPY_PARAMS_ARE_WRAPPED, 4134 ) 4135 4136 if params: 4137 if self.COPY_PARAMS_ARE_WRAPPED: 4138 params = f" WITH ({params})" 4139 elif not self.pretty: 4140 params = f" {params}" 4141 4142 return f"COPY{this}{kind} {files}{credentials}{params}" 4143 4144 def semicolon_sql(self, expression: exp.Semicolon) -> str: 4145 return "" 4146 4147 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4148 on_sql = "ON" if expression.args.get("on") else "OFF" 4149 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4150 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4151 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4152 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4153 4154 if filter_col or retention_period: 4155 on_sql = self.func("ON", filter_col, retention_period) 4156 4157 return f"DATA_DELETION={on_sql}" 4158 4159 def maskingpolicycolumnconstraint_sql( 4160 self, expression: exp.MaskingPolicyColumnConstraint 4161 ) -> str: 4162 this = self.sql(expression, "this") 4163 expressions = self.expressions(expression, flat=True) 4164 expressions = f" USING ({expressions})" if expressions else "" 4165 return f"MASKING POLICY {this}{expressions}" 4166 4167 def gapfill_sql(self, expression: exp.GapFill) -> str: 4168 this = self.sql(expression, "this") 4169 this = f"TABLE {this}" 4170 return self.func("GAP_FILL", this, *[v for k, v in expression.args.items() if k != "this"]) 4171 4172 def scope_resolution(self, rhs: str, scope_name: str) -> str: 4173 return self.func("SCOPE_RESOLUTION", scope_name or None, rhs) 4174 4175 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4176 this = self.sql(expression, "this") 4177 expr = expression.expression 4178 4179 if isinstance(expr, exp.Func): 4180 # T-SQL's CLR functions are case sensitive 4181 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4182 else: 4183 expr = self.sql(expression, "expression") 4184 4185 return self.scope_resolution(expr, this) 4186 4187 def parsejson_sql(self, expression: exp.ParseJSON) -> str: 4188 if self.PARSE_JSON_NAME is None: 4189 return self.sql(expression.this) 4190 4191 return self.func(self.PARSE_JSON_NAME, expression.this, expression.expression) 4192 4193 def rand_sql(self, expression: exp.Rand) -> str: 4194 lower = self.sql(expression, "lower") 4195 upper = self.sql(expression, "upper") 4196 4197 if lower and upper: 4198 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4199 return self.func("RAND", expression.this) 4200 4201 def changes_sql(self, expression: exp.Changes) -> str: 4202 information = self.sql(expression, "information") 4203 information = f"INFORMATION => {information}" 4204 at_before = self.sql(expression, "at_before") 4205 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4206 end = self.sql(expression, "end") 4207 end = f"{self.seg('')}{end}" if end else "" 4208 4209 return f"CHANGES ({information}){at_before}{end}" 4210 4211 def pad_sql(self, expression: exp.Pad) -> str: 4212 prefix = "L" if expression.args.get("is_left") else "R" 4213 4214 fill_pattern = self.sql(expression, "fill_pattern") or None 4215 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4216 fill_pattern = "' '" 4217 4218 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern) 4219 4220 def summarize_sql(self, expression: exp.Summarize) -> str: 4221 table = " TABLE" if expression.args.get("table") else "" 4222 return f"SUMMARIZE{table} {self.sql(expression.this)}" 4223 4224 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4225 generate_series = exp.GenerateSeries(**expression.args) 4226 4227 parent = expression.parent 4228 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4229 parent = parent.parent 4230 4231 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4232 return self.sql(exp.Unnest(expressions=[generate_series])) 4233 4234 if isinstance(parent, exp.Select): 4235 self.unsupported("GenerateSeries projection unnesting is not supported.") 4236 4237 return self.sql(generate_series) 4238 4239 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4240 exprs = expression.expressions 4241 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4242 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4243 else: 4244 rhs = self.expressions(expression) 4245 4246 return self.func(name, expression.this, rhs) 4247 4248 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4249 if self.SUPPORTS_CONVERT_TIMEZONE: 4250 return self.function_fallback_sql(expression) 4251 4252 source_tz = expression.args.get("source_tz") 4253 target_tz = expression.args.get("target_tz") 4254 timestamp = expression.args.get("timestamp") 4255 4256 if source_tz and timestamp: 4257 timestamp = exp.AtTimeZone( 4258 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4259 ) 4260 4261 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4262 4263 return self.sql(expr) 4264 4265 def json_sql(self, expression: exp.JSON) -> str: 4266 this = self.sql(expression, "this") 4267 this = f" {this}" if this else "" 4268 4269 _with = expression.args.get("with") 4270 4271 if _with is None: 4272 with_sql = "" 4273 elif not _with: 4274 with_sql = " WITHOUT" 4275 else: 4276 with_sql = " WITH" 4277 4278 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4279 4280 return f"JSON{this}{with_sql}{unique_sql}" 4281 4282 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4283 def _generate_on_options(arg: t.Any) -> str: 4284 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4285 4286 path = self.sql(expression, "path") 4287 returning = self.sql(expression, "returning") 4288 returning = f" RETURNING {returning}" if returning else "" 4289 4290 on_condition = self.sql(expression, "on_condition") 4291 on_condition = f" {on_condition}" if on_condition else "" 4292 4293 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}") 4294 4295 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4296 else_ = "ELSE " if expression.args.get("else_") else "" 4297 condition = self.sql(expression, "expression") 4298 condition = f"WHEN {condition} THEN " if condition else else_ 4299 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4300 return f"{condition}{insert}" 4301 4302 def multitableinserts_sql(self, expression: exp.MultitableInserts) -> str: 4303 kind = self.sql(expression, "kind") 4304 expressions = self.seg(self.expressions(expression, sep=" ")) 4305 res = f"INSERT {kind}{expressions}{self.seg(self.sql(expression, 'source'))}" 4306 return res 4307 4308 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4309 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4310 empty = expression.args.get("empty") 4311 empty = ( 4312 f"DEFAULT {empty} ON EMPTY" 4313 if isinstance(empty, exp.Expression) 4314 else self.sql(expression, "empty") 4315 ) 4316 4317 error = expression.args.get("error") 4318 error = ( 4319 f"DEFAULT {error} ON ERROR" 4320 if isinstance(error, exp.Expression) 4321 else self.sql(expression, "error") 4322 ) 4323 4324 if error and empty: 4325 error = ( 4326 f"{empty} {error}" 4327 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4328 else f"{error} {empty}" 4329 ) 4330 empty = "" 4331 4332 null = self.sql(expression, "null") 4333 4334 return f"{empty}{error}{null}" 4335 4336 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4337 this = self.sql(expression, "this") 4338 path = self.sql(expression, "path") 4339 4340 passing = self.expressions(expression, "passing") 4341 passing = f" PASSING {passing}" if passing else "" 4342 4343 on_condition = self.sql(expression, "on_condition") 4344 on_condition = f" {on_condition}" if on_condition else "" 4345 4346 path = f"{path}{passing}{on_condition}" 4347 4348 return self.func("JSON_EXISTS", this, path) 4349 4350 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4351 array_agg = self.function_fallback_sql(expression) 4352 4353 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4354 parent = expression.parent 4355 if isinstance(parent, exp.Filter): 4356 parent_cond = parent.expression.this 4357 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4358 else: 4359 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4360 this = expression.this 4361 this_sql = ( 4362 self.expressions(this) 4363 if isinstance(this, exp.Distinct) 4364 else self.sql(expression, "this") 4365 ) 4366 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4367 4368 return array_agg 4369 4370 def apply_sql(self, expression: exp.Apply) -> str: 4371 this = self.sql(expression, "this") 4372 expr = self.sql(expression, "expression") 4373 4374 return f"{this} APPLY({expr})" 4375 4376 def grant_sql(self, expression: exp.Grant) -> str: 4377 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4378 4379 kind = self.sql(expression, "kind") 4380 kind = f" {kind}" if kind else "" 4381 4382 securable = self.sql(expression, "securable") 4383 securable = f" {securable}" if securable else "" 4384 4385 principals = self.expressions(expression, key="principals", flat=True) 4386 4387 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4388 4389 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}" 4390 4391 def grantprivilege_sql(self, expression: exp.GrantPrivilege): 4392 this = self.sql(expression, "this") 4393 columns = self.expressions(expression, flat=True) 4394 columns = f"({columns})" if columns else "" 4395 4396 return f"{this}{columns}" 4397 4398 def grantprincipal_sql(self, expression: exp.GrantPrincipal): 4399 this = self.sql(expression, "this") 4400 4401 kind = self.sql(expression, "kind") 4402 kind = f"{kind} " if kind else "" 4403 4404 return f"{kind}{this}" 4405 4406 def columns_sql(self, expression: exp.Columns): 4407 func = self.function_fallback_sql(expression) 4408 if expression.args.get("unpack"): 4409 func = f"*{func}" 4410 4411 return func 4412 4413 def overlay_sql(self, expression: exp.Overlay): 4414 this = self.sql(expression, "this") 4415 expr = self.sql(expression, "expression") 4416 from_sql = self.sql(expression, "from") 4417 for_sql = self.sql(expression, "for") 4418 for_sql = f" FOR {for_sql}" if for_sql else "" 4419 4420 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})"
logger =
<Logger sqlglot (WARNING)>
ESCAPED_UNICODE_RE =
re.compile('\\\\(\\d+)')
UNSUPPORTED_TEMPLATE =
"Argument '{}' is not supported for expression '{}' when targeting {}."
def
unsupported_args( *args: Union[str, Tuple[str, str]]) -> Callable[[Callable[[~G, ~E], str]], Callable[[~G, ~E], str]]:
30def unsupported_args( 31 *args: t.Union[str, t.Tuple[str, str]], 32) -> t.Callable[[GeneratorMethod], GeneratorMethod]: 33 """ 34 Decorator that can be used to mark certain args of an `Expression` subclass as unsupported. 35 It expects a sequence of argument names or pairs of the form (argument_name, diagnostic_msg). 36 """ 37 diagnostic_by_arg: t.Dict[str, t.Optional[str]] = {} 38 for arg in args: 39 if isinstance(arg, str): 40 diagnostic_by_arg[arg] = None 41 else: 42 diagnostic_by_arg[arg[0]] = arg[1] 43 44 def decorator(func: GeneratorMethod) -> GeneratorMethod: 45 @wraps(func) 46 def _func(generator: G, expression: E) -> str: 47 expression_name = expression.__class__.__name__ 48 dialect_name = generator.dialect.__class__.__name__ 49 50 for arg_name, diagnostic in diagnostic_by_arg.items(): 51 if expression.args.get(arg_name): 52 diagnostic = diagnostic or UNSUPPORTED_TEMPLATE.format( 53 arg_name, expression_name, dialect_name 54 ) 55 generator.unsupported(diagnostic) 56 57 return func(generator, expression) 58 59 return _func 60 61 return decorator
Decorator that can be used to mark certain args of an Expression
subclass as unsupported.
It expects a sequence of argument names or pairs of the form (argument_name, diagnostic_msg).
class
Generator:
75class Generator(metaclass=_Generator): 76 """ 77 Generator converts a given syntax tree to the corresponding SQL string. 78 79 Args: 80 pretty: Whether to format the produced SQL string. 81 Default: False. 82 identify: Determines when an identifier should be quoted. Possible values are: 83 False (default): Never quote, except in cases where it's mandatory by the dialect. 84 True or 'always': Always quote. 85 'safe': Only quote identifiers that are case insensitive. 86 normalize: Whether to normalize identifiers to lowercase. 87 Default: False. 88 pad: The pad size in a formatted string. For example, this affects the indentation of 89 a projection in a query, relative to its nesting level. 90 Default: 2. 91 indent: The indentation size in a formatted string. For example, this affects the 92 indentation of subqueries and filters under a `WHERE` clause. 93 Default: 2. 94 normalize_functions: How to normalize function names. Possible values are: 95 "upper" or True (default): Convert names to uppercase. 96 "lower": Convert names to lowercase. 97 False: Disables function name normalization. 98 unsupported_level: Determines the generator's behavior when it encounters unsupported expressions. 99 Default ErrorLevel.WARN. 100 max_unsupported: Maximum number of unsupported messages to include in a raised UnsupportedError. 101 This is only relevant if unsupported_level is ErrorLevel.RAISE. 102 Default: 3 103 leading_comma: Whether the comma is leading or trailing in select expressions. 104 This is only relevant when generating in pretty mode. 105 Default: False 106 max_text_width: The max number of characters in a segment before creating new lines in pretty mode. 107 The default is on the smaller end because the length only represents a segment and not the true 108 line length. 109 Default: 80 110 comments: Whether to preserve comments in the output SQL code. 111 Default: True 112 """ 113 114 TRANSFORMS: t.Dict[t.Type[exp.Expression], t.Callable[..., str]] = { 115 **JSON_PATH_PART_TRANSFORMS, 116 exp.AllowedValuesProperty: lambda self, 117 e: f"ALLOWED_VALUES {self.expressions(e, flat=True)}", 118 exp.ArrayContainsAll: lambda self, e: self.binary(e, "@>"), 119 exp.ArrayOverlaps: lambda self, e: self.binary(e, "&&"), 120 exp.AutoRefreshProperty: lambda self, e: f"AUTO REFRESH {self.sql(e, 'this')}", 121 exp.BackupProperty: lambda self, e: f"BACKUP {self.sql(e, 'this')}", 122 exp.CaseSpecificColumnConstraint: lambda _, 123 e: f"{'NOT ' if e.args.get('not_') else ''}CASESPECIFIC", 124 exp.CharacterSetColumnConstraint: lambda self, e: f"CHARACTER SET {self.sql(e, 'this')}", 125 exp.CharacterSetProperty: lambda self, 126 e: f"{'DEFAULT ' if e.args.get('default') else ''}CHARACTER SET={self.sql(e, 'this')}", 127 exp.ClusteredColumnConstraint: lambda self, 128 e: f"CLUSTERED ({self.expressions(e, 'this', indent=False)})", 129 exp.CollateColumnConstraint: lambda self, e: f"COLLATE {self.sql(e, 'this')}", 130 exp.CommentColumnConstraint: lambda self, e: f"COMMENT {self.sql(e, 'this')}", 131 exp.ConnectByRoot: lambda self, e: f"CONNECT_BY_ROOT {self.sql(e, 'this')}", 132 exp.CopyGrantsProperty: lambda *_: "COPY GRANTS", 133 exp.DateFormatColumnConstraint: lambda self, e: f"FORMAT {self.sql(e, 'this')}", 134 exp.DefaultColumnConstraint: lambda self, e: f"DEFAULT {self.sql(e, 'this')}", 135 exp.DynamicProperty: lambda *_: "DYNAMIC", 136 exp.EmptyProperty: lambda *_: "EMPTY", 137 exp.EncodeColumnConstraint: lambda self, e: f"ENCODE {self.sql(e, 'this')}", 138 exp.EphemeralColumnConstraint: lambda self, 139 e: f"EPHEMERAL{(' ' + self.sql(e, 'this')) if e.this else ''}", 140 exp.ExcludeColumnConstraint: lambda self, e: f"EXCLUDE {self.sql(e, 'this').lstrip()}", 141 exp.ExecuteAsProperty: lambda self, e: self.naked_property(e), 142 exp.Except: lambda self, e: self.set_operations(e), 143 exp.ExternalProperty: lambda *_: "EXTERNAL", 144 exp.GlobalProperty: lambda *_: "GLOBAL", 145 exp.HeapProperty: lambda *_: "HEAP", 146 exp.IcebergProperty: lambda *_: "ICEBERG", 147 exp.InheritsProperty: lambda self, e: f"INHERITS ({self.expressions(e, flat=True)})", 148 exp.InlineLengthColumnConstraint: lambda self, e: f"INLINE LENGTH {self.sql(e, 'this')}", 149 exp.InputModelProperty: lambda self, e: f"INPUT{self.sql(e, 'this')}", 150 exp.Intersect: lambda self, e: self.set_operations(e), 151 exp.IntervalSpan: lambda self, e: f"{self.sql(e, 'this')} TO {self.sql(e, 'expression')}", 152 exp.LanguageProperty: lambda self, e: self.naked_property(e), 153 exp.LocationProperty: lambda self, e: self.naked_property(e), 154 exp.LogProperty: lambda _, e: f"{'NO ' if e.args.get('no') else ''}LOG", 155 exp.MaterializedProperty: lambda *_: "MATERIALIZED", 156 exp.NonClusteredColumnConstraint: lambda self, 157 e: f"NONCLUSTERED ({self.expressions(e, 'this', indent=False)})", 158 exp.NoPrimaryIndexProperty: lambda *_: "NO PRIMARY INDEX", 159 exp.NotForReplicationColumnConstraint: lambda *_: "NOT FOR REPLICATION", 160 exp.OnCommitProperty: lambda _, 161 e: f"ON COMMIT {'DELETE' if e.args.get('delete') else 'PRESERVE'} ROWS", 162 exp.OnProperty: lambda self, e: f"ON {self.sql(e, 'this')}", 163 exp.OnUpdateColumnConstraint: lambda self, e: f"ON UPDATE {self.sql(e, 'this')}", 164 exp.Operator: lambda self, e: self.binary(e, ""), # The operator is produced in `binary` 165 exp.OutputModelProperty: lambda self, e: f"OUTPUT{self.sql(e, 'this')}", 166 exp.PathColumnConstraint: lambda self, e: f"PATH {self.sql(e, 'this')}", 167 exp.PivotAny: lambda self, e: f"ANY{self.sql(e, 'this')}", 168 exp.ProjectionPolicyColumnConstraint: lambda self, 169 e: f"PROJECTION POLICY {self.sql(e, 'this')}", 170 exp.RemoteWithConnectionModelProperty: lambda self, 171 e: f"REMOTE WITH CONNECTION {self.sql(e, 'this')}", 172 exp.ReturnsProperty: lambda self, e: ( 173 "RETURNS NULL ON NULL INPUT" if e.args.get("null") else self.naked_property(e) 174 ), 175 exp.SampleProperty: lambda self, e: f"SAMPLE BY {self.sql(e, 'this')}", 176 exp.SecureProperty: lambda *_: "SECURE", 177 exp.SecurityProperty: lambda self, e: f"SECURITY {self.sql(e, 'this')}", 178 exp.SetConfigProperty: lambda self, e: self.sql(e, "this"), 179 exp.SetProperty: lambda _, e: f"{'MULTI' if e.args.get('multi') else ''}SET", 180 exp.SettingsProperty: lambda self, e: f"SETTINGS{self.seg('')}{(self.expressions(e))}", 181 exp.SharingProperty: lambda self, e: f"SHARING={self.sql(e, 'this')}", 182 exp.SqlReadWriteProperty: lambda _, e: e.name, 183 exp.SqlSecurityProperty: lambda _, 184 e: f"SQL SECURITY {'DEFINER' if e.args.get('definer') else 'INVOKER'}", 185 exp.StabilityProperty: lambda _, e: e.name, 186 exp.Stream: lambda self, e: f"STREAM {self.sql(e, 'this')}", 187 exp.StreamingTableProperty: lambda *_: "STREAMING", 188 exp.StrictProperty: lambda *_: "STRICT", 189 exp.TemporaryProperty: lambda *_: "TEMPORARY", 190 exp.TagColumnConstraint: lambda self, e: f"TAG ({self.expressions(e, flat=True)})", 191 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 192 exp.ToMap: lambda self, e: f"MAP {self.sql(e, 'this')}", 193 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 194 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 195 exp.TransientProperty: lambda *_: "TRANSIENT", 196 exp.Union: lambda self, e: self.set_operations(e), 197 exp.UnloggedProperty: lambda *_: "UNLOGGED", 198 exp.Uuid: lambda *_: "UUID()", 199 exp.UppercaseColumnConstraint: lambda *_: "UPPERCASE", 200 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 201 exp.ViewAttributeProperty: lambda self, e: f"WITH {self.sql(e, 'this')}", 202 exp.VolatileProperty: lambda *_: "VOLATILE", 203 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 204 exp.WithSchemaBindingProperty: lambda self, e: f"WITH SCHEMA {self.sql(e, 'this')}", 205 exp.WithOperator: lambda self, e: f"{self.sql(e, 'this')} WITH {self.sql(e, 'op')}", 206 } 207 208 # Whether null ordering is supported in order by 209 # True: Full Support, None: No support, False: No support for certain cases 210 # such as window specifications, aggregate functions etc 211 NULL_ORDERING_SUPPORTED: t.Optional[bool] = True 212 213 # Whether ignore nulls is inside the agg or outside. 214 # FIRST(x IGNORE NULLS) OVER vs FIRST (x) IGNORE NULLS OVER 215 IGNORE_NULLS_IN_FUNC = False 216 217 # Whether locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 218 LOCKING_READS_SUPPORTED = False 219 220 # Whether the EXCEPT and INTERSECT operations can return duplicates 221 EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = True 222 223 # Wrap derived values in parens, usually standard but spark doesn't support it 224 WRAP_DERIVED_VALUES = True 225 226 # Whether create function uses an AS before the RETURN 227 CREATE_FUNCTION_RETURN_AS = True 228 229 # Whether MERGE ... WHEN MATCHED BY SOURCE is allowed 230 MATCHED_BY_SOURCE = True 231 232 # Whether the INTERVAL expression works only with values like '1 day' 233 SINGLE_STRING_INTERVAL = False 234 235 # Whether the plural form of date parts like day (i.e. "days") is supported in INTERVALs 236 INTERVAL_ALLOWS_PLURAL_FORM = True 237 238 # Whether limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 239 LIMIT_FETCH = "ALL" 240 241 # Whether limit and fetch allows expresions or just limits 242 LIMIT_ONLY_LITERALS = False 243 244 # Whether a table is allowed to be renamed with a db 245 RENAME_TABLE_WITH_DB = True 246 247 # The separator for grouping sets and rollups 248 GROUPINGS_SEP = "," 249 250 # The string used for creating an index on a table 251 INDEX_ON = "ON" 252 253 # Whether join hints should be generated 254 JOIN_HINTS = True 255 256 # Whether table hints should be generated 257 TABLE_HINTS = True 258 259 # Whether query hints should be generated 260 QUERY_HINTS = True 261 262 # What kind of separator to use for query hints 263 QUERY_HINT_SEP = ", " 264 265 # Whether comparing against booleans (e.g. x IS TRUE) is supported 266 IS_BOOL_ALLOWED = True 267 268 # Whether to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 269 DUPLICATE_KEY_UPDATE_WITH_SET = True 270 271 # Whether to generate the limit as TOP <value> instead of LIMIT <value> 272 LIMIT_IS_TOP = False 273 274 # Whether to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 275 RETURNING_END = True 276 277 # Whether to generate an unquoted value for EXTRACT's date part argument 278 EXTRACT_ALLOWS_QUOTES = True 279 280 # Whether TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 281 TZ_TO_WITH_TIME_ZONE = False 282 283 # Whether the NVL2 function is supported 284 NVL2_SUPPORTED = True 285 286 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 287 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 288 289 # Whether VALUES statements can be used as derived tables. 290 # MySQL 5 and Redshift do not allow this, so when False, it will convert 291 # SELECT * VALUES into SELECT UNION 292 VALUES_AS_TABLE = True 293 294 # Whether the word COLUMN is included when adding a column with ALTER TABLE 295 ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = True 296 297 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 298 UNNEST_WITH_ORDINALITY = True 299 300 # Whether FILTER (WHERE cond) can be used for conditional aggregation 301 AGGREGATE_FILTER_SUPPORTED = True 302 303 # Whether JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 304 SEMI_ANTI_JOIN_WITH_SIDE = True 305 306 # Whether to include the type of a computed column in the CREATE DDL 307 COMPUTED_COLUMN_WITH_TYPE = True 308 309 # Whether CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 310 SUPPORTS_TABLE_COPY = True 311 312 # Whether parentheses are required around the table sample's expression 313 TABLESAMPLE_REQUIRES_PARENS = True 314 315 # Whether a table sample clause's size needs to be followed by the ROWS keyword 316 TABLESAMPLE_SIZE_IS_ROWS = True 317 318 # The keyword(s) to use when generating a sample clause 319 TABLESAMPLE_KEYWORDS = "TABLESAMPLE" 320 321 # Whether the TABLESAMPLE clause supports a method name, like BERNOULLI 322 TABLESAMPLE_WITH_METHOD = True 323 324 # The keyword to use when specifying the seed of a sample clause 325 TABLESAMPLE_SEED_KEYWORD = "SEED" 326 327 # Whether COLLATE is a function instead of a binary operator 328 COLLATE_IS_FUNC = False 329 330 # Whether data types support additional specifiers like e.g. CHAR or BYTE (oracle) 331 DATA_TYPE_SPECIFIERS_ALLOWED = False 332 333 # Whether conditions require booleans WHERE x = 0 vs WHERE x 334 ENSURE_BOOLS = False 335 336 # Whether the "RECURSIVE" keyword is required when defining recursive CTEs 337 CTE_RECURSIVE_KEYWORD_REQUIRED = True 338 339 # Whether CONCAT requires >1 arguments 340 SUPPORTS_SINGLE_ARG_CONCAT = True 341 342 # Whether LAST_DAY function supports a date part argument 343 LAST_DAY_SUPPORTS_DATE_PART = True 344 345 # Whether named columns are allowed in table aliases 346 SUPPORTS_TABLE_ALIAS_COLUMNS = True 347 348 # Whether UNPIVOT aliases are Identifiers (False means they're Literals) 349 UNPIVOT_ALIASES_ARE_IDENTIFIERS = True 350 351 # What delimiter to use for separating JSON key/value pairs 352 JSON_KEY_VALUE_PAIR_SEP = ":" 353 354 # INSERT OVERWRITE TABLE x override 355 INSERT_OVERWRITE = " OVERWRITE TABLE" 356 357 # Whether the SELECT .. INTO syntax is used instead of CTAS 358 SUPPORTS_SELECT_INTO = False 359 360 # Whether UNLOGGED tables can be created 361 SUPPORTS_UNLOGGED_TABLES = False 362 363 # Whether the CREATE TABLE LIKE statement is supported 364 SUPPORTS_CREATE_TABLE_LIKE = True 365 366 # Whether the LikeProperty needs to be specified inside of the schema clause 367 LIKE_PROPERTY_INSIDE_SCHEMA = False 368 369 # Whether DISTINCT can be followed by multiple args in an AggFunc. If not, it will be 370 # transpiled into a series of CASE-WHEN-ELSE, ultimately using a tuple conseisting of the args 371 MULTI_ARG_DISTINCT = True 372 373 # Whether the JSON extraction operators expect a value of type JSON 374 JSON_TYPE_REQUIRED_FOR_EXTRACTION = False 375 376 # Whether bracketed keys like ["foo"] are supported in JSON paths 377 JSON_PATH_BRACKETED_KEY_SUPPORTED = True 378 379 # Whether to escape keys using single quotes in JSON paths 380 JSON_PATH_SINGLE_QUOTE_ESCAPE = False 381 382 # The JSONPathPart expressions supported by this dialect 383 SUPPORTED_JSON_PATH_PARTS = ALL_JSON_PATH_PARTS.copy() 384 385 # Whether any(f(x) for x in array) can be implemented by this dialect 386 CAN_IMPLEMENT_ARRAY_ANY = False 387 388 # Whether the function TO_NUMBER is supported 389 SUPPORTS_TO_NUMBER = True 390 391 # Whether or not set op modifiers apply to the outer set op or select. 392 # SELECT * FROM x UNION SELECT * FROM y LIMIT 1 393 # True means limit 1 happens after the set op, False means it it happens on y. 394 SET_OP_MODIFIERS = True 395 396 # Whether parameters from COPY statement are wrapped in parentheses 397 COPY_PARAMS_ARE_WRAPPED = True 398 399 # Whether values of params are set with "=" token or empty space 400 COPY_PARAMS_EQ_REQUIRED = False 401 402 # Whether COPY statement has INTO keyword 403 COPY_HAS_INTO_KEYWORD = True 404 405 # Whether the conditional TRY(expression) function is supported 406 TRY_SUPPORTED = True 407 408 # Whether the UESCAPE syntax in unicode strings is supported 409 SUPPORTS_UESCAPE = True 410 411 # The keyword to use when generating a star projection with excluded columns 412 STAR_EXCEPT = "EXCEPT" 413 414 # The HEX function name 415 HEX_FUNC = "HEX" 416 417 # The keywords to use when prefixing & separating WITH based properties 418 WITH_PROPERTIES_PREFIX = "WITH" 419 420 # Whether to quote the generated expression of exp.JsonPath 421 QUOTE_JSON_PATH = True 422 423 # Whether the text pattern/fill (3rd) parameter of RPAD()/LPAD() is optional (defaults to space) 424 PAD_FILL_PATTERN_IS_REQUIRED = False 425 426 # Whether a projection can explode into multiple rows, e.g. by unnesting an array. 427 SUPPORTS_EXPLODING_PROJECTIONS = True 428 429 # Whether ARRAY_CONCAT can be generated with varlen args or if it should be reduced to 2-arg version 430 ARRAY_CONCAT_IS_VAR_LEN = True 431 432 # Whether CONVERT_TIMEZONE() is supported; if not, it will be generated as exp.AtTimeZone 433 SUPPORTS_CONVERT_TIMEZONE = False 434 435 # The name to generate for the JSONPath expression. If `None`, only `this` will be generated 436 PARSE_JSON_NAME: t.Optional[str] = "PARSE_JSON" 437 438 TYPE_MAPPING = { 439 exp.DataType.Type.NCHAR: "CHAR", 440 exp.DataType.Type.NVARCHAR: "VARCHAR", 441 exp.DataType.Type.MEDIUMTEXT: "TEXT", 442 exp.DataType.Type.LONGTEXT: "TEXT", 443 exp.DataType.Type.TINYTEXT: "TEXT", 444 exp.DataType.Type.MEDIUMBLOB: "BLOB", 445 exp.DataType.Type.LONGBLOB: "BLOB", 446 exp.DataType.Type.TINYBLOB: "BLOB", 447 exp.DataType.Type.INET: "INET", 448 exp.DataType.Type.ROWVERSION: "VARBINARY", 449 } 450 451 TIME_PART_SINGULARS = { 452 "MICROSECONDS": "MICROSECOND", 453 "SECONDS": "SECOND", 454 "MINUTES": "MINUTE", 455 "HOURS": "HOUR", 456 "DAYS": "DAY", 457 "WEEKS": "WEEK", 458 "MONTHS": "MONTH", 459 "QUARTERS": "QUARTER", 460 "YEARS": "YEAR", 461 } 462 463 AFTER_HAVING_MODIFIER_TRANSFORMS = { 464 "cluster": lambda self, e: self.sql(e, "cluster"), 465 "distribute": lambda self, e: self.sql(e, "distribute"), 466 "sort": lambda self, e: self.sql(e, "sort"), 467 "windows": lambda self, e: ( 468 self.seg("WINDOW ") + self.expressions(e, key="windows", flat=True) 469 if e.args.get("windows") 470 else "" 471 ), 472 "qualify": lambda self, e: self.sql(e, "qualify"), 473 } 474 475 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 476 477 STRUCT_DELIMITER = ("<", ">") 478 479 PARAMETER_TOKEN = "@" 480 NAMED_PLACEHOLDER_TOKEN = ":" 481 482 PROPERTIES_LOCATION = { 483 exp.AllowedValuesProperty: exp.Properties.Location.POST_SCHEMA, 484 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 485 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 486 exp.AutoRefreshProperty: exp.Properties.Location.POST_SCHEMA, 487 exp.BackupProperty: exp.Properties.Location.POST_SCHEMA, 488 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 489 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 490 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 491 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 492 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 493 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 494 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 495 exp.DistributedByProperty: exp.Properties.Location.POST_SCHEMA, 496 exp.DuplicateKeyProperty: exp.Properties.Location.POST_SCHEMA, 497 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 498 exp.DataDeletionProperty: exp.Properties.Location.POST_SCHEMA, 499 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 500 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 501 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 502 exp.DynamicProperty: exp.Properties.Location.POST_CREATE, 503 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 504 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 505 exp.EmptyProperty: exp.Properties.Location.POST_SCHEMA, 506 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 507 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 508 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 509 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 510 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 511 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 512 exp.GlobalProperty: exp.Properties.Location.POST_CREATE, 513 exp.HeapProperty: exp.Properties.Location.POST_WITH, 514 exp.InheritsProperty: exp.Properties.Location.POST_SCHEMA, 515 exp.IcebergProperty: exp.Properties.Location.POST_CREATE, 516 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 517 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 518 exp.JournalProperty: exp.Properties.Location.POST_NAME, 519 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 520 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 521 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 522 exp.LockProperty: exp.Properties.Location.POST_SCHEMA, 523 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 524 exp.LogProperty: exp.Properties.Location.POST_NAME, 525 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 526 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 527 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 528 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 529 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 530 exp.Order: exp.Properties.Location.POST_SCHEMA, 531 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 532 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 533 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 534 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 535 exp.Property: exp.Properties.Location.POST_WITH, 536 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 537 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 538 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 539 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 540 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 541 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 542 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 543 exp.SecureProperty: exp.Properties.Location.POST_CREATE, 544 exp.SecurityProperty: exp.Properties.Location.POST_SCHEMA, 545 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 546 exp.Set: exp.Properties.Location.POST_SCHEMA, 547 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 548 exp.SetProperty: exp.Properties.Location.POST_CREATE, 549 exp.SetConfigProperty: exp.Properties.Location.POST_SCHEMA, 550 exp.SharingProperty: exp.Properties.Location.POST_EXPRESSION, 551 exp.SequenceProperties: exp.Properties.Location.POST_EXPRESSION, 552 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 553 exp.SqlReadWriteProperty: exp.Properties.Location.POST_SCHEMA, 554 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 555 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 556 exp.StreamingTableProperty: exp.Properties.Location.POST_CREATE, 557 exp.StrictProperty: exp.Properties.Location.POST_SCHEMA, 558 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 559 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 560 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 561 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 562 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 563 exp.UnloggedProperty: exp.Properties.Location.POST_CREATE, 564 exp.ViewAttributeProperty: exp.Properties.Location.POST_SCHEMA, 565 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 566 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 567 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 568 exp.WithSchemaBindingProperty: exp.Properties.Location.POST_SCHEMA, 569 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 570 } 571 572 # Keywords that can't be used as unquoted identifier names 573 RESERVED_KEYWORDS: t.Set[str] = set() 574 575 # Expressions whose comments are separated from them for better formatting 576 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 577 exp.Command, 578 exp.Create, 579 exp.Delete, 580 exp.Drop, 581 exp.From, 582 exp.Insert, 583 exp.Join, 584 exp.MultitableInserts, 585 exp.Select, 586 exp.SetOperation, 587 exp.Update, 588 exp.Where, 589 exp.With, 590 ) 591 592 # Expressions that should not have their comments generated in maybe_comment 593 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 594 exp.Binary, 595 exp.SetOperation, 596 ) 597 598 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 599 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 600 exp.Column, 601 exp.Literal, 602 exp.Neg, 603 exp.Paren, 604 ) 605 606 PARAMETERIZABLE_TEXT_TYPES = { 607 exp.DataType.Type.NVARCHAR, 608 exp.DataType.Type.VARCHAR, 609 exp.DataType.Type.CHAR, 610 exp.DataType.Type.NCHAR, 611 } 612 613 # Expressions that need to have all CTEs under them bubbled up to them 614 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 615 616 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 617 618 __slots__ = ( 619 "pretty", 620 "identify", 621 "normalize", 622 "pad", 623 "_indent", 624 "normalize_functions", 625 "unsupported_level", 626 "max_unsupported", 627 "leading_comma", 628 "max_text_width", 629 "comments", 630 "dialect", 631 "unsupported_messages", 632 "_escaped_quote_end", 633 "_escaped_identifier_end", 634 "_next_name", 635 "_identifier_start", 636 "_identifier_end", 637 ) 638 639 def __init__( 640 self, 641 pretty: t.Optional[bool] = None, 642 identify: str | bool = False, 643 normalize: bool = False, 644 pad: int = 2, 645 indent: int = 2, 646 normalize_functions: t.Optional[str | bool] = None, 647 unsupported_level: ErrorLevel = ErrorLevel.WARN, 648 max_unsupported: int = 3, 649 leading_comma: bool = False, 650 max_text_width: int = 80, 651 comments: bool = True, 652 dialect: DialectType = None, 653 ): 654 import sqlglot 655 from sqlglot.dialects import Dialect 656 657 self.pretty = pretty if pretty is not None else sqlglot.pretty 658 self.identify = identify 659 self.normalize = normalize 660 self.pad = pad 661 self._indent = indent 662 self.unsupported_level = unsupported_level 663 self.max_unsupported = max_unsupported 664 self.leading_comma = leading_comma 665 self.max_text_width = max_text_width 666 self.comments = comments 667 self.dialect = Dialect.get_or_raise(dialect) 668 669 # This is both a Dialect property and a Generator argument, so we prioritize the latter 670 self.normalize_functions = ( 671 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 672 ) 673 674 self.unsupported_messages: t.List[str] = [] 675 self._escaped_quote_end: str = ( 676 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 677 ) 678 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 679 680 self._next_name = name_sequence("_t") 681 682 self._identifier_start = self.dialect.IDENTIFIER_START 683 self._identifier_end = self.dialect.IDENTIFIER_END 684 685 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 686 """ 687 Generates the SQL string corresponding to the given syntax tree. 688 689 Args: 690 expression: The syntax tree. 691 copy: Whether to copy the expression. The generator performs mutations so 692 it is safer to copy. 693 694 Returns: 695 The SQL string corresponding to `expression`. 696 """ 697 if copy: 698 expression = expression.copy() 699 700 expression = self.preprocess(expression) 701 702 self.unsupported_messages = [] 703 sql = self.sql(expression).strip() 704 705 if self.pretty: 706 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 707 708 if self.unsupported_level == ErrorLevel.IGNORE: 709 return sql 710 711 if self.unsupported_level == ErrorLevel.WARN: 712 for msg in self.unsupported_messages: 713 logger.warning(msg) 714 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 715 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 716 717 return sql 718 719 def preprocess(self, expression: exp.Expression) -> exp.Expression: 720 """Apply generic preprocessing transformations to a given expression.""" 721 expression = self._move_ctes_to_top_level(expression) 722 723 if self.ENSURE_BOOLS: 724 from sqlglot.transforms import ensure_bools 725 726 expression = ensure_bools(expression) 727 728 return expression 729 730 def _move_ctes_to_top_level(self, expression: E) -> E: 731 if ( 732 not expression.parent 733 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 734 and any(node.parent is not expression for node in expression.find_all(exp.With)) 735 ): 736 from sqlglot.transforms import move_ctes_to_top_level 737 738 expression = move_ctes_to_top_level(expression) 739 return expression 740 741 def unsupported(self, message: str) -> None: 742 if self.unsupported_level == ErrorLevel.IMMEDIATE: 743 raise UnsupportedError(message) 744 self.unsupported_messages.append(message) 745 746 def sep(self, sep: str = " ") -> str: 747 return f"{sep.strip()}\n" if self.pretty else sep 748 749 def seg(self, sql: str, sep: str = " ") -> str: 750 return f"{self.sep(sep)}{sql}" 751 752 def pad_comment(self, comment: str) -> str: 753 comment = " " + comment if comment[0].strip() else comment 754 comment = comment + " " if comment[-1].strip() else comment 755 return comment 756 757 def maybe_comment( 758 self, 759 sql: str, 760 expression: t.Optional[exp.Expression] = None, 761 comments: t.Optional[t.List[str]] = None, 762 separated: bool = False, 763 ) -> str: 764 comments = ( 765 ((expression and expression.comments) if comments is None else comments) # type: ignore 766 if self.comments 767 else None 768 ) 769 770 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 771 return sql 772 773 comments_sql = " ".join( 774 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 775 ) 776 777 if not comments_sql: 778 return sql 779 780 comments_sql = self._replace_line_breaks(comments_sql) 781 782 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 783 return ( 784 f"{self.sep()}{comments_sql}{sql}" 785 if not sql or sql[0].isspace() 786 else f"{comments_sql}{self.sep()}{sql}" 787 ) 788 789 return f"{sql} {comments_sql}" 790 791 def wrap(self, expression: exp.Expression | str) -> str: 792 this_sql = ( 793 self.sql(expression) 794 if isinstance(expression, exp.UNWRAPPED_QUERIES) 795 else self.sql(expression, "this") 796 ) 797 if not this_sql: 798 return "()" 799 800 this_sql = self.indent(this_sql, level=1, pad=0) 801 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 802 803 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 804 original = self.identify 805 self.identify = False 806 result = func(*args, **kwargs) 807 self.identify = original 808 return result 809 810 def normalize_func(self, name: str) -> str: 811 if self.normalize_functions == "upper" or self.normalize_functions is True: 812 return name.upper() 813 if self.normalize_functions == "lower": 814 return name.lower() 815 return name 816 817 def indent( 818 self, 819 sql: str, 820 level: int = 0, 821 pad: t.Optional[int] = None, 822 skip_first: bool = False, 823 skip_last: bool = False, 824 ) -> str: 825 if not self.pretty or not sql: 826 return sql 827 828 pad = self.pad if pad is None else pad 829 lines = sql.split("\n") 830 831 return "\n".join( 832 ( 833 line 834 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 835 else f"{' ' * (level * self._indent + pad)}{line}" 836 ) 837 for i, line in enumerate(lines) 838 ) 839 840 def sql( 841 self, 842 expression: t.Optional[str | exp.Expression], 843 key: t.Optional[str] = None, 844 comment: bool = True, 845 ) -> str: 846 if not expression: 847 return "" 848 849 if isinstance(expression, str): 850 return expression 851 852 if key: 853 value = expression.args.get(key) 854 if value: 855 return self.sql(value) 856 return "" 857 858 transform = self.TRANSFORMS.get(expression.__class__) 859 860 if callable(transform): 861 sql = transform(self, expression) 862 elif isinstance(expression, exp.Expression): 863 exp_handler_name = f"{expression.key}_sql" 864 865 if hasattr(self, exp_handler_name): 866 sql = getattr(self, exp_handler_name)(expression) 867 elif isinstance(expression, exp.Func): 868 sql = self.function_fallback_sql(expression) 869 elif isinstance(expression, exp.Property): 870 sql = self.property_sql(expression) 871 else: 872 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 873 else: 874 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 875 876 return self.maybe_comment(sql, expression) if self.comments and comment else sql 877 878 def uncache_sql(self, expression: exp.Uncache) -> str: 879 table = self.sql(expression, "this") 880 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 881 return f"UNCACHE TABLE{exists_sql} {table}" 882 883 def cache_sql(self, expression: exp.Cache) -> str: 884 lazy = " LAZY" if expression.args.get("lazy") else "" 885 table = self.sql(expression, "this") 886 options = expression.args.get("options") 887 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 888 sql = self.sql(expression, "expression") 889 sql = f" AS{self.sep()}{sql}" if sql else "" 890 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 891 return self.prepend_ctes(expression, sql) 892 893 def characterset_sql(self, expression: exp.CharacterSet) -> str: 894 if isinstance(expression.parent, exp.Cast): 895 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 896 default = "DEFAULT " if expression.args.get("default") else "" 897 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 898 899 def column_parts(self, expression: exp.Column) -> str: 900 return ".".join( 901 self.sql(part) 902 for part in ( 903 expression.args.get("catalog"), 904 expression.args.get("db"), 905 expression.args.get("table"), 906 expression.args.get("this"), 907 ) 908 if part 909 ) 910 911 def column_sql(self, expression: exp.Column) -> str: 912 join_mark = " (+)" if expression.args.get("join_mark") else "" 913 914 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 915 join_mark = "" 916 self.unsupported("Outer join syntax using the (+) operator is not supported.") 917 918 return f"{self.column_parts(expression)}{join_mark}" 919 920 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 921 this = self.sql(expression, "this") 922 this = f" {this}" if this else "" 923 position = self.sql(expression, "position") 924 return f"{position}{this}" 925 926 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 927 column = self.sql(expression, "this") 928 kind = self.sql(expression, "kind") 929 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 930 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 931 kind = f"{sep}{kind}" if kind else "" 932 constraints = f" {constraints}" if constraints else "" 933 position = self.sql(expression, "position") 934 position = f" {position}" if position else "" 935 936 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 937 kind = "" 938 939 return f"{exists}{column}{kind}{constraints}{position}" 940 941 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 942 this = self.sql(expression, "this") 943 kind_sql = self.sql(expression, "kind").strip() 944 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 945 946 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 947 this = self.sql(expression, "this") 948 if expression.args.get("not_null"): 949 persisted = " PERSISTED NOT NULL" 950 elif expression.args.get("persisted"): 951 persisted = " PERSISTED" 952 else: 953 persisted = "" 954 return f"AS {this}{persisted}" 955 956 def autoincrementcolumnconstraint_sql(self, _) -> str: 957 return self.token_sql(TokenType.AUTO_INCREMENT) 958 959 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 960 if isinstance(expression.this, list): 961 this = self.wrap(self.expressions(expression, key="this", flat=True)) 962 else: 963 this = self.sql(expression, "this") 964 965 return f"COMPRESS {this}" 966 967 def generatedasidentitycolumnconstraint_sql( 968 self, expression: exp.GeneratedAsIdentityColumnConstraint 969 ) -> str: 970 this = "" 971 if expression.this is not None: 972 on_null = " ON NULL" if expression.args.get("on_null") else "" 973 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 974 975 start = expression.args.get("start") 976 start = f"START WITH {start}" if start else "" 977 increment = expression.args.get("increment") 978 increment = f" INCREMENT BY {increment}" if increment else "" 979 minvalue = expression.args.get("minvalue") 980 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 981 maxvalue = expression.args.get("maxvalue") 982 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 983 cycle = expression.args.get("cycle") 984 cycle_sql = "" 985 986 if cycle is not None: 987 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 988 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 989 990 sequence_opts = "" 991 if start or increment or cycle_sql: 992 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 993 sequence_opts = f" ({sequence_opts.strip()})" 994 995 expr = self.sql(expression, "expression") 996 expr = f"({expr})" if expr else "IDENTITY" 997 998 return f"GENERATED{this} AS {expr}{sequence_opts}" 999 1000 def generatedasrowcolumnconstraint_sql( 1001 self, expression: exp.GeneratedAsRowColumnConstraint 1002 ) -> str: 1003 start = "START" if expression.args.get("start") else "END" 1004 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1005 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 1006 1007 def periodforsystemtimeconstraint_sql( 1008 self, expression: exp.PeriodForSystemTimeConstraint 1009 ) -> str: 1010 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 1011 1012 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 1013 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 1014 1015 def transformcolumnconstraint_sql(self, expression: exp.TransformColumnConstraint) -> str: 1016 return f"AS {self.sql(expression, 'this')}" 1017 1018 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 1019 desc = expression.args.get("desc") 1020 if desc is not None: 1021 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 1022 return "PRIMARY KEY" 1023 1024 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1025 this = self.sql(expression, "this") 1026 this = f" {this}" if this else "" 1027 index_type = expression.args.get("index_type") 1028 index_type = f" USING {index_type}" if index_type else "" 1029 on_conflict = self.sql(expression, "on_conflict") 1030 on_conflict = f" {on_conflict}" if on_conflict else "" 1031 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1032 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}" 1033 1034 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 1035 return self.sql(expression, "this") 1036 1037 def create_sql(self, expression: exp.Create) -> str: 1038 kind = self.sql(expression, "kind") 1039 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1040 properties = expression.args.get("properties") 1041 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1042 1043 this = self.createable_sql(expression, properties_locs) 1044 1045 properties_sql = "" 1046 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1047 exp.Properties.Location.POST_WITH 1048 ): 1049 properties_sql = self.sql( 1050 exp.Properties( 1051 expressions=[ 1052 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1053 *properties_locs[exp.Properties.Location.POST_WITH], 1054 ] 1055 ) 1056 ) 1057 1058 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1059 properties_sql = self.sep() + properties_sql 1060 elif not self.pretty: 1061 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1062 properties_sql = f" {properties_sql}" 1063 1064 begin = " BEGIN" if expression.args.get("begin") else "" 1065 end = " END" if expression.args.get("end") else "" 1066 1067 expression_sql = self.sql(expression, "expression") 1068 if expression_sql: 1069 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1070 1071 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1072 postalias_props_sql = "" 1073 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1074 postalias_props_sql = self.properties( 1075 exp.Properties( 1076 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1077 ), 1078 wrapped=False, 1079 ) 1080 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1081 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1082 1083 postindex_props_sql = "" 1084 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1085 postindex_props_sql = self.properties( 1086 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1087 wrapped=False, 1088 prefix=" ", 1089 ) 1090 1091 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1092 indexes = f" {indexes}" if indexes else "" 1093 index_sql = indexes + postindex_props_sql 1094 1095 replace = " OR REPLACE" if expression.args.get("replace") else "" 1096 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1097 unique = " UNIQUE" if expression.args.get("unique") else "" 1098 1099 clustered = expression.args.get("clustered") 1100 if clustered is None: 1101 clustered_sql = "" 1102 elif clustered: 1103 clustered_sql = " CLUSTERED COLUMNSTORE" 1104 else: 1105 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1106 1107 postcreate_props_sql = "" 1108 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1109 postcreate_props_sql = self.properties( 1110 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1111 sep=" ", 1112 prefix=" ", 1113 wrapped=False, 1114 ) 1115 1116 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1117 1118 postexpression_props_sql = "" 1119 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1120 postexpression_props_sql = self.properties( 1121 exp.Properties( 1122 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1123 ), 1124 sep=" ", 1125 prefix=" ", 1126 wrapped=False, 1127 ) 1128 1129 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1130 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1131 no_schema_binding = ( 1132 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1133 ) 1134 1135 clone = self.sql(expression, "clone") 1136 clone = f" {clone}" if clone else "" 1137 1138 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1139 return self.prepend_ctes(expression, expression_sql) 1140 1141 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1142 start = self.sql(expression, "start") 1143 start = f"START WITH {start}" if start else "" 1144 increment = self.sql(expression, "increment") 1145 increment = f" INCREMENT BY {increment}" if increment else "" 1146 minvalue = self.sql(expression, "minvalue") 1147 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1148 maxvalue = self.sql(expression, "maxvalue") 1149 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1150 owned = self.sql(expression, "owned") 1151 owned = f" OWNED BY {owned}" if owned else "" 1152 1153 cache = expression.args.get("cache") 1154 if cache is None: 1155 cache_str = "" 1156 elif cache is True: 1157 cache_str = " CACHE" 1158 else: 1159 cache_str = f" CACHE {cache}" 1160 1161 options = self.expressions(expression, key="options", flat=True, sep=" ") 1162 options = f" {options}" if options else "" 1163 1164 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip() 1165 1166 def clone_sql(self, expression: exp.Clone) -> str: 1167 this = self.sql(expression, "this") 1168 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1169 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1170 return f"{shallow}{keyword} {this}" 1171 1172 def describe_sql(self, expression: exp.Describe) -> str: 1173 style = expression.args.get("style") 1174 style = f" {style}" if style else "" 1175 partition = self.sql(expression, "partition") 1176 partition = f" {partition}" if partition else "" 1177 return f"DESCRIBE{style} {self.sql(expression, 'this')}{partition}" 1178 1179 def heredoc_sql(self, expression: exp.Heredoc) -> str: 1180 tag = self.sql(expression, "tag") 1181 return f"${tag}${self.sql(expression, 'this')}${tag}$" 1182 1183 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 1184 with_ = self.sql(expression, "with") 1185 if with_: 1186 sql = f"{with_}{self.sep()}{sql}" 1187 return sql 1188 1189 def with_sql(self, expression: exp.With) -> str: 1190 sql = self.expressions(expression, flat=True) 1191 recursive = ( 1192 "RECURSIVE " 1193 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 1194 else "" 1195 ) 1196 1197 return f"WITH {recursive}{sql}" 1198 1199 def cte_sql(self, expression: exp.CTE) -> str: 1200 alias = expression.args.get("alias") 1201 if alias: 1202 alias.add_comments(expression.pop_comments()) 1203 1204 alias_sql = self.sql(expression, "alias") 1205 1206 materialized = expression.args.get("materialized") 1207 if materialized is False: 1208 materialized = "NOT MATERIALIZED " 1209 elif materialized: 1210 materialized = "MATERIALIZED " 1211 1212 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}" 1213 1214 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1215 alias = self.sql(expression, "this") 1216 columns = self.expressions(expression, key="columns", flat=True) 1217 columns = f"({columns})" if columns else "" 1218 1219 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1220 columns = "" 1221 self.unsupported("Named columns are not supported in table alias.") 1222 1223 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1224 alias = self._next_name() 1225 1226 return f"{alias}{columns}" 1227 1228 def bitstring_sql(self, expression: exp.BitString) -> str: 1229 this = self.sql(expression, "this") 1230 if self.dialect.BIT_START: 1231 return f"{self.dialect.BIT_START}{this}{self.dialect.BIT_END}" 1232 return f"{int(this, 2)}" 1233 1234 def hexstring_sql(self, expression: exp.HexString) -> str: 1235 this = self.sql(expression, "this") 1236 if self.dialect.HEX_START: 1237 return f"{self.dialect.HEX_START}{this}{self.dialect.HEX_END}" 1238 return f"{int(this, 16)}" 1239 1240 def bytestring_sql(self, expression: exp.ByteString) -> str: 1241 this = self.sql(expression, "this") 1242 if self.dialect.BYTE_START: 1243 return f"{self.dialect.BYTE_START}{this}{self.dialect.BYTE_END}" 1244 return this 1245 1246 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1247 this = self.sql(expression, "this") 1248 escape = expression.args.get("escape") 1249 1250 if self.dialect.UNICODE_START: 1251 escape_substitute = r"\\\1" 1252 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1253 else: 1254 escape_substitute = r"\\u\1" 1255 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1256 1257 if escape: 1258 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1259 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1260 else: 1261 escape_pattern = ESCAPED_UNICODE_RE 1262 escape_sql = "" 1263 1264 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1265 this = escape_pattern.sub(escape_substitute, this) 1266 1267 return f"{left_quote}{this}{right_quote}{escape_sql}" 1268 1269 def rawstring_sql(self, expression: exp.RawString) -> str: 1270 string = self.escape_str(expression.this.replace("\\", "\\\\"), escape_backslash=False) 1271 return f"{self.dialect.QUOTE_START}{string}{self.dialect.QUOTE_END}" 1272 1273 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 1274 this = self.sql(expression, "this") 1275 specifier = self.sql(expression, "expression") 1276 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 1277 return f"{this}{specifier}" 1278 1279 def datatype_sql(self, expression: exp.DataType) -> str: 1280 nested = "" 1281 values = "" 1282 interior = self.expressions(expression, flat=True) 1283 1284 type_value = expression.this 1285 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1286 type_sql = self.sql(expression, "kind") 1287 else: 1288 type_sql = ( 1289 self.TYPE_MAPPING.get(type_value, type_value.value) 1290 if isinstance(type_value, exp.DataType.Type) 1291 else type_value 1292 ) 1293 1294 if interior: 1295 if expression.args.get("nested"): 1296 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1297 if expression.args.get("values") is not None: 1298 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1299 values = self.expressions(expression, key="values", flat=True) 1300 values = f"{delimiters[0]}{values}{delimiters[1]}" 1301 elif type_value == exp.DataType.Type.INTERVAL: 1302 nested = f" {interior}" 1303 else: 1304 nested = f"({interior})" 1305 1306 type_sql = f"{type_sql}{nested}{values}" 1307 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1308 exp.DataType.Type.TIMETZ, 1309 exp.DataType.Type.TIMESTAMPTZ, 1310 ): 1311 type_sql = f"{type_sql} WITH TIME ZONE" 1312 1313 return type_sql 1314 1315 def directory_sql(self, expression: exp.Directory) -> str: 1316 local = "LOCAL " if expression.args.get("local") else "" 1317 row_format = self.sql(expression, "row_format") 1318 row_format = f" {row_format}" if row_format else "" 1319 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1320 1321 def delete_sql(self, expression: exp.Delete) -> str: 1322 this = self.sql(expression, "this") 1323 this = f" FROM {this}" if this else "" 1324 using = self.sql(expression, "using") 1325 using = f" USING {using}" if using else "" 1326 cluster = self.sql(expression, "cluster") 1327 cluster = f" {cluster}" if cluster else "" 1328 where = self.sql(expression, "where") 1329 returning = self.sql(expression, "returning") 1330 limit = self.sql(expression, "limit") 1331 tables = self.expressions(expression, key="tables") 1332 tables = f" {tables}" if tables else "" 1333 if self.RETURNING_END: 1334 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1335 else: 1336 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1337 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1338 1339 def drop_sql(self, expression: exp.Drop) -> str: 1340 this = self.sql(expression, "this") 1341 expressions = self.expressions(expression, flat=True) 1342 expressions = f" ({expressions})" if expressions else "" 1343 kind = expression.args["kind"] 1344 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1345 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1346 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1347 on_cluster = self.sql(expression, "cluster") 1348 on_cluster = f" {on_cluster}" if on_cluster else "" 1349 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1350 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1351 cascade = " CASCADE" if expression.args.get("cascade") else "" 1352 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1353 purge = " PURGE" if expression.args.get("purge") else "" 1354 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}" 1355 1356 def set_operation(self, expression: exp.SetOperation) -> str: 1357 op_type = type(expression) 1358 op_name = op_type.key.upper() 1359 1360 distinct = expression.args.get("distinct") 1361 if ( 1362 distinct is False 1363 and op_type in (exp.Except, exp.Intersect) 1364 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1365 ): 1366 self.unsupported(f"{op_name} ALL is not supported") 1367 1368 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1369 1370 if distinct is None: 1371 distinct = default_distinct 1372 if distinct is None: 1373 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1374 1375 if distinct is default_distinct: 1376 kind = "" 1377 else: 1378 kind = " DISTINCT" if distinct else " ALL" 1379 1380 by_name = " BY NAME" if expression.args.get("by_name") else "" 1381 return f"{op_name}{kind}{by_name}" 1382 1383 def set_operations(self, expression: exp.SetOperation) -> str: 1384 if not self.SET_OP_MODIFIERS: 1385 limit = expression.args.get("limit") 1386 order = expression.args.get("order") 1387 1388 if limit or order: 1389 select = self._move_ctes_to_top_level( 1390 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1391 ) 1392 1393 if limit: 1394 select = select.limit(limit.pop(), copy=False) 1395 if order: 1396 select = select.order_by(order.pop(), copy=False) 1397 return self.sql(select) 1398 1399 sqls: t.List[str] = [] 1400 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1401 1402 while stack: 1403 node = stack.pop() 1404 1405 if isinstance(node, exp.SetOperation): 1406 stack.append(node.expression) 1407 stack.append( 1408 self.maybe_comment( 1409 self.set_operation(node), comments=node.comments, separated=True 1410 ) 1411 ) 1412 stack.append(node.this) 1413 else: 1414 sqls.append(self.sql(node)) 1415 1416 this = self.sep().join(sqls) 1417 this = self.query_modifiers(expression, this) 1418 return self.prepend_ctes(expression, this) 1419 1420 def fetch_sql(self, expression: exp.Fetch) -> str: 1421 direction = expression.args.get("direction") 1422 direction = f" {direction}" if direction else "" 1423 count = self.sql(expression, "count") 1424 count = f" {count}" if count else "" 1425 if expression.args.get("percent"): 1426 count = f"{count} PERCENT" 1427 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1428 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1429 1430 def filter_sql(self, expression: exp.Filter) -> str: 1431 if self.AGGREGATE_FILTER_SUPPORTED: 1432 this = self.sql(expression, "this") 1433 where = self.sql(expression, "expression").strip() 1434 return f"{this} FILTER({where})" 1435 1436 agg = expression.this 1437 agg_arg = agg.this 1438 cond = expression.expression.this 1439 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1440 return self.sql(agg) 1441 1442 def hint_sql(self, expression: exp.Hint) -> str: 1443 if not self.QUERY_HINTS: 1444 self.unsupported("Hints are not supported") 1445 return "" 1446 1447 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1448 1449 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1450 using = self.sql(expression, "using") 1451 using = f" USING {using}" if using else "" 1452 columns = self.expressions(expression, key="columns", flat=True) 1453 columns = f"({columns})" if columns else "" 1454 partition_by = self.expressions(expression, key="partition_by", flat=True) 1455 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1456 where = self.sql(expression, "where") 1457 include = self.expressions(expression, key="include", flat=True) 1458 if include: 1459 include = f" INCLUDE ({include})" 1460 with_storage = self.expressions(expression, key="with_storage", flat=True) 1461 with_storage = f" WITH ({with_storage})" if with_storage else "" 1462 tablespace = self.sql(expression, "tablespace") 1463 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1464 on = self.sql(expression, "on") 1465 on = f" ON {on}" if on else "" 1466 1467 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}" 1468 1469 def index_sql(self, expression: exp.Index) -> str: 1470 unique = "UNIQUE " if expression.args.get("unique") else "" 1471 primary = "PRIMARY " if expression.args.get("primary") else "" 1472 amp = "AMP " if expression.args.get("amp") else "" 1473 name = self.sql(expression, "this") 1474 name = f"{name} " if name else "" 1475 table = self.sql(expression, "table") 1476 table = f"{self.INDEX_ON} {table}" if table else "" 1477 1478 index = "INDEX " if not table else "" 1479 1480 params = self.sql(expression, "params") 1481 return f"{unique}{primary}{amp}{index}{name}{table}{params}" 1482 1483 def identifier_sql(self, expression: exp.Identifier) -> str: 1484 text = expression.name 1485 lower = text.lower() 1486 text = lower if self.normalize and not expression.quoted else text 1487 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1488 if ( 1489 expression.quoted 1490 or self.dialect.can_identify(text, self.identify) 1491 or lower in self.RESERVED_KEYWORDS 1492 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1493 ): 1494 text = f"{self._identifier_start}{text}{self._identifier_end}" 1495 return text 1496 1497 def hex_sql(self, expression: exp.Hex) -> str: 1498 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1499 if self.dialect.HEX_LOWERCASE: 1500 text = self.func("LOWER", text) 1501 1502 return text 1503 1504 def lowerhex_sql(self, expression: exp.LowerHex) -> str: 1505 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1506 if not self.dialect.HEX_LOWERCASE: 1507 text = self.func("LOWER", text) 1508 return text 1509 1510 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1511 input_format = self.sql(expression, "input_format") 1512 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1513 output_format = self.sql(expression, "output_format") 1514 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1515 return self.sep().join((input_format, output_format)) 1516 1517 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1518 string = self.sql(exp.Literal.string(expression.name)) 1519 return f"{prefix}{string}" 1520 1521 def partition_sql(self, expression: exp.Partition) -> str: 1522 return f"PARTITION({self.expressions(expression, flat=True)})" 1523 1524 def properties_sql(self, expression: exp.Properties) -> str: 1525 root_properties = [] 1526 with_properties = [] 1527 1528 for p in expression.expressions: 1529 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1530 if p_loc == exp.Properties.Location.POST_WITH: 1531 with_properties.append(p) 1532 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1533 root_properties.append(p) 1534 1535 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1536 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1537 1538 if root_props and with_props and not self.pretty: 1539 with_props = " " + with_props 1540 1541 return root_props + with_props 1542 1543 def root_properties(self, properties: exp.Properties) -> str: 1544 if properties.expressions: 1545 return self.expressions(properties, indent=False, sep=" ") 1546 return "" 1547 1548 def properties( 1549 self, 1550 properties: exp.Properties, 1551 prefix: str = "", 1552 sep: str = ", ", 1553 suffix: str = "", 1554 wrapped: bool = True, 1555 ) -> str: 1556 if properties.expressions: 1557 expressions = self.expressions(properties, sep=sep, indent=False) 1558 if expressions: 1559 expressions = self.wrap(expressions) if wrapped else expressions 1560 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1561 return "" 1562 1563 def with_properties(self, properties: exp.Properties) -> str: 1564 return self.properties(properties, prefix=self.seg(self.WITH_PROPERTIES_PREFIX, sep="")) 1565 1566 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1567 properties_locs = defaultdict(list) 1568 for p in properties.expressions: 1569 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1570 if p_loc != exp.Properties.Location.UNSUPPORTED: 1571 properties_locs[p_loc].append(p) 1572 else: 1573 self.unsupported(f"Unsupported property {p.key}") 1574 1575 return properties_locs 1576 1577 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1578 if isinstance(expression.this, exp.Dot): 1579 return self.sql(expression, "this") 1580 return f"'{expression.name}'" if string_key else expression.name 1581 1582 def property_sql(self, expression: exp.Property) -> str: 1583 property_cls = expression.__class__ 1584 if property_cls == exp.Property: 1585 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1586 1587 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1588 if not property_name: 1589 self.unsupported(f"Unsupported property {expression.key}") 1590 1591 return f"{property_name}={self.sql(expression, 'this')}" 1592 1593 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1594 if self.SUPPORTS_CREATE_TABLE_LIKE: 1595 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1596 options = f" {options}" if options else "" 1597 1598 like = f"LIKE {self.sql(expression, 'this')}{options}" 1599 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1600 like = f"({like})" 1601 1602 return like 1603 1604 if expression.expressions: 1605 self.unsupported("Transpilation of LIKE property options is unsupported") 1606 1607 select = exp.select("*").from_(expression.this).limit(0) 1608 return f"AS {self.sql(select)}" 1609 1610 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1611 no = "NO " if expression.args.get("no") else "" 1612 protection = " PROTECTION" if expression.args.get("protection") else "" 1613 return f"{no}FALLBACK{protection}" 1614 1615 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1616 no = "NO " if expression.args.get("no") else "" 1617 local = expression.args.get("local") 1618 local = f"{local} " if local else "" 1619 dual = "DUAL " if expression.args.get("dual") else "" 1620 before = "BEFORE " if expression.args.get("before") else "" 1621 after = "AFTER " if expression.args.get("after") else "" 1622 return f"{no}{local}{dual}{before}{after}JOURNAL" 1623 1624 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1625 freespace = self.sql(expression, "this") 1626 percent = " PERCENT" if expression.args.get("percent") else "" 1627 return f"FREESPACE={freespace}{percent}" 1628 1629 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1630 if expression.args.get("default"): 1631 property = "DEFAULT" 1632 elif expression.args.get("on"): 1633 property = "ON" 1634 else: 1635 property = "OFF" 1636 return f"CHECKSUM={property}" 1637 1638 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1639 if expression.args.get("no"): 1640 return "NO MERGEBLOCKRATIO" 1641 if expression.args.get("default"): 1642 return "DEFAULT MERGEBLOCKRATIO" 1643 1644 percent = " PERCENT" if expression.args.get("percent") else "" 1645 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1646 1647 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1648 default = expression.args.get("default") 1649 minimum = expression.args.get("minimum") 1650 maximum = expression.args.get("maximum") 1651 if default or minimum or maximum: 1652 if default: 1653 prop = "DEFAULT" 1654 elif minimum: 1655 prop = "MINIMUM" 1656 else: 1657 prop = "MAXIMUM" 1658 return f"{prop} DATABLOCKSIZE" 1659 units = expression.args.get("units") 1660 units = f" {units}" if units else "" 1661 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1662 1663 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1664 autotemp = expression.args.get("autotemp") 1665 always = expression.args.get("always") 1666 default = expression.args.get("default") 1667 manual = expression.args.get("manual") 1668 never = expression.args.get("never") 1669 1670 if autotemp is not None: 1671 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1672 elif always: 1673 prop = "ALWAYS" 1674 elif default: 1675 prop = "DEFAULT" 1676 elif manual: 1677 prop = "MANUAL" 1678 elif never: 1679 prop = "NEVER" 1680 return f"BLOCKCOMPRESSION={prop}" 1681 1682 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1683 no = expression.args.get("no") 1684 no = " NO" if no else "" 1685 concurrent = expression.args.get("concurrent") 1686 concurrent = " CONCURRENT" if concurrent else "" 1687 target = self.sql(expression, "target") 1688 target = f" {target}" if target else "" 1689 return f"WITH{no}{concurrent} ISOLATED LOADING{target}" 1690 1691 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1692 if isinstance(expression.this, list): 1693 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1694 if expression.this: 1695 modulus = self.sql(expression, "this") 1696 remainder = self.sql(expression, "expression") 1697 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1698 1699 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1700 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1701 return f"FROM ({from_expressions}) TO ({to_expressions})" 1702 1703 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1704 this = self.sql(expression, "this") 1705 1706 for_values_or_default = expression.expression 1707 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1708 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1709 else: 1710 for_values_or_default = " DEFAULT" 1711 1712 return f"PARTITION OF {this}{for_values_or_default}" 1713 1714 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1715 kind = expression.args.get("kind") 1716 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1717 for_or_in = expression.args.get("for_or_in") 1718 for_or_in = f" {for_or_in}" if for_or_in else "" 1719 lock_type = expression.args.get("lock_type") 1720 override = " OVERRIDE" if expression.args.get("override") else "" 1721 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1722 1723 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1724 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1725 statistics = expression.args.get("statistics") 1726 statistics_sql = "" 1727 if statistics is not None: 1728 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1729 return f"{data_sql}{statistics_sql}" 1730 1731 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1732 this = self.sql(expression, "this") 1733 this = f"HISTORY_TABLE={this}" if this else "" 1734 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1735 data_consistency = ( 1736 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1737 ) 1738 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1739 retention_period = ( 1740 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1741 ) 1742 1743 if this: 1744 on_sql = self.func("ON", this, data_consistency, retention_period) 1745 else: 1746 on_sql = "ON" if expression.args.get("on") else "OFF" 1747 1748 sql = f"SYSTEM_VERSIONING={on_sql}" 1749 1750 return f"WITH({sql})" if expression.args.get("with") else sql 1751 1752 def insert_sql(self, expression: exp.Insert) -> str: 1753 hint = self.sql(expression, "hint") 1754 overwrite = expression.args.get("overwrite") 1755 1756 if isinstance(expression.this, exp.Directory): 1757 this = " OVERWRITE" if overwrite else " INTO" 1758 else: 1759 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1760 1761 stored = self.sql(expression, "stored") 1762 stored = f" {stored}" if stored else "" 1763 alternative = expression.args.get("alternative") 1764 alternative = f" OR {alternative}" if alternative else "" 1765 ignore = " IGNORE" if expression.args.get("ignore") else "" 1766 is_function = expression.args.get("is_function") 1767 if is_function: 1768 this = f"{this} FUNCTION" 1769 this = f"{this} {self.sql(expression, 'this')}" 1770 1771 exists = " IF EXISTS" if expression.args.get("exists") else "" 1772 where = self.sql(expression, "where") 1773 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1774 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1775 on_conflict = self.sql(expression, "conflict") 1776 on_conflict = f" {on_conflict}" if on_conflict else "" 1777 by_name = " BY NAME" if expression.args.get("by_name") else "" 1778 returning = self.sql(expression, "returning") 1779 1780 if self.RETURNING_END: 1781 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1782 else: 1783 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1784 1785 partition_by = self.sql(expression, "partition") 1786 partition_by = f" {partition_by}" if partition_by else "" 1787 settings = self.sql(expression, "settings") 1788 settings = f" {settings}" if settings else "" 1789 1790 source = self.sql(expression, "source") 1791 source = f"TABLE {source}" if source else "" 1792 1793 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1794 return self.prepend_ctes(expression, sql) 1795 1796 def introducer_sql(self, expression: exp.Introducer) -> str: 1797 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1798 1799 def kill_sql(self, expression: exp.Kill) -> str: 1800 kind = self.sql(expression, "kind") 1801 kind = f" {kind}" if kind else "" 1802 this = self.sql(expression, "this") 1803 this = f" {this}" if this else "" 1804 return f"KILL{kind}{this}" 1805 1806 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1807 return expression.name 1808 1809 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1810 return expression.name 1811 1812 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1813 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1814 1815 constraint = self.sql(expression, "constraint") 1816 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1817 1818 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1819 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1820 action = self.sql(expression, "action") 1821 1822 expressions = self.expressions(expression, flat=True) 1823 if expressions: 1824 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1825 expressions = f" {set_keyword}{expressions}" 1826 1827 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}" 1828 1829 def returning_sql(self, expression: exp.Returning) -> str: 1830 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1831 1832 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1833 fields = self.sql(expression, "fields") 1834 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1835 escaped = self.sql(expression, "escaped") 1836 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1837 items = self.sql(expression, "collection_items") 1838 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1839 keys = self.sql(expression, "map_keys") 1840 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1841 lines = self.sql(expression, "lines") 1842 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1843 null = self.sql(expression, "null") 1844 null = f" NULL DEFINED AS {null}" if null else "" 1845 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1846 1847 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1848 return f"WITH ({self.expressions(expression, flat=True)})" 1849 1850 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1851 this = f"{self.sql(expression, 'this')} INDEX" 1852 target = self.sql(expression, "target") 1853 target = f" FOR {target}" if target else "" 1854 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1855 1856 def historicaldata_sql(self, expression: exp.HistoricalData) -> str: 1857 this = self.sql(expression, "this") 1858 kind = self.sql(expression, "kind") 1859 expr = self.sql(expression, "expression") 1860 return f"{this} ({kind} => {expr})" 1861 1862 def table_parts(self, expression: exp.Table) -> str: 1863 return ".".join( 1864 self.sql(part) 1865 for part in ( 1866 expression.args.get("catalog"), 1867 expression.args.get("db"), 1868 expression.args.get("this"), 1869 ) 1870 if part is not None 1871 ) 1872 1873 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1874 table = self.table_parts(expression) 1875 only = "ONLY " if expression.args.get("only") else "" 1876 partition = self.sql(expression, "partition") 1877 partition = f" {partition}" if partition else "" 1878 version = self.sql(expression, "version") 1879 version = f" {version}" if version else "" 1880 alias = self.sql(expression, "alias") 1881 alias = f"{sep}{alias}" if alias else "" 1882 1883 sample = self.sql(expression, "sample") 1884 if self.dialect.ALIAS_POST_TABLESAMPLE: 1885 sample_pre_alias = sample 1886 sample_post_alias = "" 1887 else: 1888 sample_pre_alias = "" 1889 sample_post_alias = sample 1890 1891 hints = self.expressions(expression, key="hints", sep=" ") 1892 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1893 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1894 joins = self.indent( 1895 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1896 ) 1897 laterals = self.expressions(expression, key="laterals", sep="") 1898 1899 file_format = self.sql(expression, "format") 1900 if file_format: 1901 pattern = self.sql(expression, "pattern") 1902 pattern = f", PATTERN => {pattern}" if pattern else "" 1903 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1904 1905 ordinality = expression.args.get("ordinality") or "" 1906 if ordinality: 1907 ordinality = f" WITH ORDINALITY{alias}" 1908 alias = "" 1909 1910 when = self.sql(expression, "when") 1911 if when: 1912 table = f"{table} {when}" 1913 1914 changes = self.sql(expression, "changes") 1915 changes = f" {changes}" if changes else "" 1916 1917 rows_from = self.expressions(expression, key="rows_from") 1918 if rows_from: 1919 table = f"ROWS FROM {self.wrap(rows_from)}" 1920 1921 return f"{only}{table}{changes}{partition}{version}{file_format}{sample_pre_alias}{alias}{hints}{pivots}{sample_post_alias}{joins}{laterals}{ordinality}" 1922 1923 def tablesample_sql( 1924 self, 1925 expression: exp.TableSample, 1926 tablesample_keyword: t.Optional[str] = None, 1927 ) -> str: 1928 method = self.sql(expression, "method") 1929 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1930 numerator = self.sql(expression, "bucket_numerator") 1931 denominator = self.sql(expression, "bucket_denominator") 1932 field = self.sql(expression, "bucket_field") 1933 field = f" ON {field}" if field else "" 1934 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1935 seed = self.sql(expression, "seed") 1936 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1937 1938 size = self.sql(expression, "size") 1939 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1940 size = f"{size} ROWS" 1941 1942 percent = self.sql(expression, "percent") 1943 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1944 percent = f"{percent} PERCENT" 1945 1946 expr = f"{bucket}{percent}{size}" 1947 if self.TABLESAMPLE_REQUIRES_PARENS: 1948 expr = f"({expr})" 1949 1950 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}" 1951 1952 def pivot_sql(self, expression: exp.Pivot) -> str: 1953 expressions = self.expressions(expression, flat=True) 1954 1955 if expression.this: 1956 this = self.sql(expression, "this") 1957 if not expressions: 1958 return f"UNPIVOT {this}" 1959 1960 on = f"{self.seg('ON')} {expressions}" 1961 using = self.expressions(expression, key="using", flat=True) 1962 using = f"{self.seg('USING')} {using}" if using else "" 1963 group = self.sql(expression, "group") 1964 return f"PIVOT {this}{on}{using}{group}" 1965 1966 alias = self.sql(expression, "alias") 1967 alias = f" AS {alias}" if alias else "" 1968 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 1969 1970 field = self.sql(expression, "field") 1971 1972 include_nulls = expression.args.get("include_nulls") 1973 if include_nulls is not None: 1974 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1975 else: 1976 nulls = "" 1977 1978 default_on_null = self.sql(expression, "default_on_null") 1979 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 1980 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}" 1981 1982 def version_sql(self, expression: exp.Version) -> str: 1983 this = f"FOR {expression.name}" 1984 kind = expression.text("kind") 1985 expr = self.sql(expression, "expression") 1986 return f"{this} {kind} {expr}" 1987 1988 def tuple_sql(self, expression: exp.Tuple) -> str: 1989 return f"({self.expressions(expression, dynamic=True, new_line=True, skip_first=True, skip_last=True)})" 1990 1991 def update_sql(self, expression: exp.Update) -> str: 1992 this = self.sql(expression, "this") 1993 set_sql = self.expressions(expression, flat=True) 1994 from_sql = self.sql(expression, "from") 1995 where_sql = self.sql(expression, "where") 1996 returning = self.sql(expression, "returning") 1997 order = self.sql(expression, "order") 1998 limit = self.sql(expression, "limit") 1999 if self.RETURNING_END: 2000 expression_sql = f"{from_sql}{where_sql}{returning}" 2001 else: 2002 expression_sql = f"{returning}{from_sql}{where_sql}" 2003 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2004 return self.prepend_ctes(expression, sql) 2005 2006 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2007 values_as_table = values_as_table and self.VALUES_AS_TABLE 2008 2009 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2010 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2011 args = self.expressions(expression) 2012 alias = self.sql(expression, "alias") 2013 values = f"VALUES{self.seg('')}{args}" 2014 values = ( 2015 f"({values})" 2016 if self.WRAP_DERIVED_VALUES 2017 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2018 else values 2019 ) 2020 return f"{values} AS {alias}" if alias else values 2021 2022 # Converts `VALUES...` expression into a series of select unions. 2023 alias_node = expression.args.get("alias") 2024 column_names = alias_node and alias_node.columns 2025 2026 selects: t.List[exp.Query] = [] 2027 2028 for i, tup in enumerate(expression.expressions): 2029 row = tup.expressions 2030 2031 if i == 0 and column_names: 2032 row = [ 2033 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2034 ] 2035 2036 selects.append(exp.Select(expressions=row)) 2037 2038 if self.pretty: 2039 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2040 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2041 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2042 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2043 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2044 2045 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2046 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2047 return f"({unions}){alias}" 2048 2049 def var_sql(self, expression: exp.Var) -> str: 2050 return self.sql(expression, "this") 2051 2052 @unsupported_args("expressions") 2053 def into_sql(self, expression: exp.Into) -> str: 2054 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2055 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2056 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 2057 2058 def from_sql(self, expression: exp.From) -> str: 2059 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 2060 2061 def groupingsets_sql(self, expression: exp.GroupingSets) -> str: 2062 grouping_sets = self.expressions(expression, indent=False) 2063 return f"GROUPING SETS {self.wrap(grouping_sets)}" 2064 2065 def rollup_sql(self, expression: exp.Rollup) -> str: 2066 expressions = self.expressions(expression, indent=False) 2067 return f"ROLLUP {self.wrap(expressions)}" if expressions else "WITH ROLLUP" 2068 2069 def cube_sql(self, expression: exp.Cube) -> str: 2070 expressions = self.expressions(expression, indent=False) 2071 return f"CUBE {self.wrap(expressions)}" if expressions else "WITH CUBE" 2072 2073 def group_sql(self, expression: exp.Group) -> str: 2074 group_by_all = expression.args.get("all") 2075 if group_by_all is True: 2076 modifier = " ALL" 2077 elif group_by_all is False: 2078 modifier = " DISTINCT" 2079 else: 2080 modifier = "" 2081 2082 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2083 2084 grouping_sets = self.expressions(expression, key="grouping_sets") 2085 cube = self.expressions(expression, key="cube") 2086 rollup = self.expressions(expression, key="rollup") 2087 2088 groupings = csv( 2089 self.seg(grouping_sets) if grouping_sets else "", 2090 self.seg(cube) if cube else "", 2091 self.seg(rollup) if rollup else "", 2092 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2093 sep=self.GROUPINGS_SEP, 2094 ) 2095 2096 if ( 2097 expression.expressions 2098 and groupings 2099 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2100 ): 2101 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2102 2103 return f"{group_by}{groupings}" 2104 2105 def having_sql(self, expression: exp.Having) -> str: 2106 this = self.indent(self.sql(expression, "this")) 2107 return f"{self.seg('HAVING')}{self.sep()}{this}" 2108 2109 def connect_sql(self, expression: exp.Connect) -> str: 2110 start = self.sql(expression, "start") 2111 start = self.seg(f"START WITH {start}") if start else "" 2112 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2113 connect = self.sql(expression, "connect") 2114 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2115 return start + connect 2116 2117 def prior_sql(self, expression: exp.Prior) -> str: 2118 return f"PRIOR {self.sql(expression, 'this')}" 2119 2120 def join_sql(self, expression: exp.Join) -> str: 2121 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2122 side = None 2123 else: 2124 side = expression.side 2125 2126 op_sql = " ".join( 2127 op 2128 for op in ( 2129 expression.method, 2130 "GLOBAL" if expression.args.get("global") else None, 2131 side, 2132 expression.kind, 2133 expression.hint if self.JOIN_HINTS else None, 2134 ) 2135 if op 2136 ) 2137 match_cond = self.sql(expression, "match_condition") 2138 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2139 on_sql = self.sql(expression, "on") 2140 using = expression.args.get("using") 2141 2142 if not on_sql and using: 2143 on_sql = csv(*(self.sql(column) for column in using)) 2144 2145 this = expression.this 2146 this_sql = self.sql(this) 2147 2148 if on_sql: 2149 on_sql = self.indent(on_sql, skip_first=True) 2150 space = self.seg(" " * self.pad) if self.pretty else " " 2151 if using: 2152 on_sql = f"{space}USING ({on_sql})" 2153 else: 2154 on_sql = f"{space}ON {on_sql}" 2155 elif not op_sql: 2156 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2157 return f" {this_sql}" 2158 2159 return f", {this_sql}" 2160 2161 if op_sql != "STRAIGHT_JOIN": 2162 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2163 2164 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}" 2165 2166 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 2167 args = self.expressions(expression, flat=True) 2168 args = f"({args})" if len(args.split(",")) > 1 else args 2169 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 2170 2171 def lateral_op(self, expression: exp.Lateral) -> str: 2172 cross_apply = expression.args.get("cross_apply") 2173 2174 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2175 if cross_apply is True: 2176 op = "INNER JOIN " 2177 elif cross_apply is False: 2178 op = "LEFT JOIN " 2179 else: 2180 op = "" 2181 2182 return f"{op}LATERAL" 2183 2184 def lateral_sql(self, expression: exp.Lateral) -> str: 2185 this = self.sql(expression, "this") 2186 2187 if expression.args.get("view"): 2188 alias = expression.args["alias"] 2189 columns = self.expressions(alias, key="columns", flat=True) 2190 table = f" {alias.name}" if alias.name else "" 2191 columns = f" AS {columns}" if columns else "" 2192 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2193 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2194 2195 alias = self.sql(expression, "alias") 2196 alias = f" AS {alias}" if alias else "" 2197 return f"{self.lateral_op(expression)} {this}{alias}" 2198 2199 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2200 this = self.sql(expression, "this") 2201 2202 args = [ 2203 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2204 for e in (expression.args.get(k) for k in ("offset", "expression")) 2205 if e 2206 ] 2207 2208 args_sql = ", ".join(self.sql(e) for e in args) 2209 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2210 expressions = self.expressions(expression, flat=True) 2211 expressions = f" BY {expressions}" if expressions else "" 2212 2213 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}" 2214 2215 def offset_sql(self, expression: exp.Offset) -> str: 2216 this = self.sql(expression, "this") 2217 value = expression.expression 2218 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2219 expressions = self.expressions(expression, flat=True) 2220 expressions = f" BY {expressions}" if expressions else "" 2221 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}" 2222 2223 def setitem_sql(self, expression: exp.SetItem) -> str: 2224 kind = self.sql(expression, "kind") 2225 kind = f"{kind} " if kind else "" 2226 this = self.sql(expression, "this") 2227 expressions = self.expressions(expression) 2228 collate = self.sql(expression, "collate") 2229 collate = f" COLLATE {collate}" if collate else "" 2230 global_ = "GLOBAL " if expression.args.get("global") else "" 2231 return f"{global_}{kind}{this}{expressions}{collate}" 2232 2233 def set_sql(self, expression: exp.Set) -> str: 2234 expressions = ( 2235 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2236 ) 2237 tag = " TAG" if expression.args.get("tag") else "" 2238 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 2239 2240 def pragma_sql(self, expression: exp.Pragma) -> str: 2241 return f"PRAGMA {self.sql(expression, 'this')}" 2242 2243 def lock_sql(self, expression: exp.Lock) -> str: 2244 if not self.LOCKING_READS_SUPPORTED: 2245 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2246 return "" 2247 2248 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2249 expressions = self.expressions(expression, flat=True) 2250 expressions = f" OF {expressions}" if expressions else "" 2251 wait = expression.args.get("wait") 2252 2253 if wait is not None: 2254 if isinstance(wait, exp.Literal): 2255 wait = f" WAIT {self.sql(wait)}" 2256 else: 2257 wait = " NOWAIT" if wait else " SKIP LOCKED" 2258 2259 return f"{lock_type}{expressions}{wait or ''}" 2260 2261 def literal_sql(self, expression: exp.Literal) -> str: 2262 text = expression.this or "" 2263 if expression.is_string: 2264 text = f"{self.dialect.QUOTE_START}{self.escape_str(text)}{self.dialect.QUOTE_END}" 2265 return text 2266 2267 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2268 if self.dialect.ESCAPED_SEQUENCES: 2269 to_escaped = self.dialect.ESCAPED_SEQUENCES 2270 text = "".join( 2271 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2272 ) 2273 2274 return self._replace_line_breaks(text).replace( 2275 self.dialect.QUOTE_END, self._escaped_quote_end 2276 ) 2277 2278 def loaddata_sql(self, expression: exp.LoadData) -> str: 2279 local = " LOCAL" if expression.args.get("local") else "" 2280 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2281 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2282 this = f" INTO TABLE {self.sql(expression, 'this')}" 2283 partition = self.sql(expression, "partition") 2284 partition = f" {partition}" if partition else "" 2285 input_format = self.sql(expression, "input_format") 2286 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2287 serde = self.sql(expression, "serde") 2288 serde = f" SERDE {serde}" if serde else "" 2289 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 2290 2291 def null_sql(self, *_) -> str: 2292 return "NULL" 2293 2294 def boolean_sql(self, expression: exp.Boolean) -> str: 2295 return "TRUE" if expression.this else "FALSE" 2296 2297 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2298 this = self.sql(expression, "this") 2299 this = f"{this} " if this else this 2300 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2301 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore 2302 2303 def withfill_sql(self, expression: exp.WithFill) -> str: 2304 from_sql = self.sql(expression, "from") 2305 from_sql = f" FROM {from_sql}" if from_sql else "" 2306 to_sql = self.sql(expression, "to") 2307 to_sql = f" TO {to_sql}" if to_sql else "" 2308 step_sql = self.sql(expression, "step") 2309 step_sql = f" STEP {step_sql}" if step_sql else "" 2310 interpolated_values = [ 2311 f"{self.sql(named_expression, 'alias')} AS {self.sql(named_expression, 'this')}" 2312 for named_expression in expression.args.get("interpolate") or [] 2313 ] 2314 interpolate = ( 2315 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2316 ) 2317 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}" 2318 2319 def cluster_sql(self, expression: exp.Cluster) -> str: 2320 return self.op_expressions("CLUSTER BY", expression) 2321 2322 def distribute_sql(self, expression: exp.Distribute) -> str: 2323 return self.op_expressions("DISTRIBUTE BY", expression) 2324 2325 def sort_sql(self, expression: exp.Sort) -> str: 2326 return self.op_expressions("SORT BY", expression) 2327 2328 def ordered_sql(self, expression: exp.Ordered) -> str: 2329 desc = expression.args.get("desc") 2330 asc = not desc 2331 2332 nulls_first = expression.args.get("nulls_first") 2333 nulls_last = not nulls_first 2334 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2335 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2336 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2337 2338 this = self.sql(expression, "this") 2339 2340 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2341 nulls_sort_change = "" 2342 if nulls_first and ( 2343 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2344 ): 2345 nulls_sort_change = " NULLS FIRST" 2346 elif ( 2347 nulls_last 2348 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2349 and not nulls_are_last 2350 ): 2351 nulls_sort_change = " NULLS LAST" 2352 2353 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2354 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2355 window = expression.find_ancestor(exp.Window, exp.Select) 2356 if isinstance(window, exp.Window) and window.args.get("spec"): 2357 self.unsupported( 2358 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2359 ) 2360 nulls_sort_change = "" 2361 elif ( 2362 self.NULL_ORDERING_SUPPORTED is False 2363 and (isinstance(expression.find_ancestor(exp.AggFunc, exp.Select), exp.AggFunc)) 2364 and ( 2365 (asc and nulls_sort_change == " NULLS LAST") 2366 or (desc and nulls_sort_change == " NULLS FIRST") 2367 ) 2368 ): 2369 self.unsupported( 2370 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2371 ) 2372 nulls_sort_change = "" 2373 elif self.NULL_ORDERING_SUPPORTED is None: 2374 if expression.this.is_int: 2375 self.unsupported( 2376 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2377 ) 2378 elif not isinstance(expression.this, exp.Rand): 2379 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2380 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2381 nulls_sort_change = "" 2382 2383 with_fill = self.sql(expression, "with_fill") 2384 with_fill = f" {with_fill}" if with_fill else "" 2385 2386 return f"{this}{sort_order}{nulls_sort_change}{with_fill}" 2387 2388 def matchrecognizemeasure_sql(self, expression: exp.MatchRecognizeMeasure) -> str: 2389 window_frame = self.sql(expression, "window_frame") 2390 window_frame = f"{window_frame} " if window_frame else "" 2391 2392 this = self.sql(expression, "this") 2393 2394 return f"{window_frame}{this}" 2395 2396 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2397 partition = self.partition_by_sql(expression) 2398 order = self.sql(expression, "order") 2399 measures = self.expressions(expression, key="measures") 2400 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2401 rows = self.sql(expression, "rows") 2402 rows = self.seg(rows) if rows else "" 2403 after = self.sql(expression, "after") 2404 after = self.seg(after) if after else "" 2405 pattern = self.sql(expression, "pattern") 2406 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2407 definition_sqls = [ 2408 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2409 for definition in expression.args.get("define", []) 2410 ] 2411 definitions = self.expressions(sqls=definition_sqls) 2412 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2413 body = "".join( 2414 ( 2415 partition, 2416 order, 2417 measures, 2418 rows, 2419 after, 2420 pattern, 2421 define, 2422 ) 2423 ) 2424 alias = self.sql(expression, "alias") 2425 alias = f" {alias}" if alias else "" 2426 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 2427 2428 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2429 limit = expression.args.get("limit") 2430 2431 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2432 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2433 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2434 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2435 2436 return csv( 2437 *sqls, 2438 *[self.sql(join) for join in expression.args.get("joins") or []], 2439 self.sql(expression, "connect"), 2440 self.sql(expression, "match"), 2441 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2442 self.sql(expression, "prewhere"), 2443 self.sql(expression, "where"), 2444 self.sql(expression, "group"), 2445 self.sql(expression, "having"), 2446 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2447 self.sql(expression, "order"), 2448 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2449 *self.after_limit_modifiers(expression), 2450 self.options_modifier(expression), 2451 sep="", 2452 ) 2453 2454 def options_modifier(self, expression: exp.Expression) -> str: 2455 options = self.expressions(expression, key="options") 2456 return f" {options}" if options else "" 2457 2458 def queryoption_sql(self, expression: exp.QueryOption) -> str: 2459 return "" 2460 2461 def offset_limit_modifiers( 2462 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2463 ) -> t.List[str]: 2464 return [ 2465 self.sql(expression, "offset") if fetch else self.sql(limit), 2466 self.sql(limit) if fetch else self.sql(expression, "offset"), 2467 ] 2468 2469 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 2470 locks = self.expressions(expression, key="locks", sep=" ") 2471 locks = f" {locks}" if locks else "" 2472 return [locks, self.sql(expression, "sample")] 2473 2474 def select_sql(self, expression: exp.Select) -> str: 2475 into = expression.args.get("into") 2476 if not self.SUPPORTS_SELECT_INTO and into: 2477 into.pop() 2478 2479 hint = self.sql(expression, "hint") 2480 distinct = self.sql(expression, "distinct") 2481 distinct = f" {distinct}" if distinct else "" 2482 kind = self.sql(expression, "kind") 2483 2484 limit = expression.args.get("limit") 2485 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2486 top = self.limit_sql(limit, top=True) 2487 limit.pop() 2488 else: 2489 top = "" 2490 2491 expressions = self.expressions(expression) 2492 2493 if kind: 2494 if kind in self.SELECT_KINDS: 2495 kind = f" AS {kind}" 2496 else: 2497 if kind == "STRUCT": 2498 expressions = self.expressions( 2499 sqls=[ 2500 self.sql( 2501 exp.Struct( 2502 expressions=[ 2503 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2504 if isinstance(e, exp.Alias) 2505 else e 2506 for e in expression.expressions 2507 ] 2508 ) 2509 ) 2510 ] 2511 ) 2512 kind = "" 2513 2514 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2515 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2516 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2517 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2518 sql = self.query_modifiers( 2519 expression, 2520 f"SELECT{top_distinct}{kind}{expressions}", 2521 self.sql(expression, "into", comment=False), 2522 self.sql(expression, "from", comment=False), 2523 ) 2524 2525 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2526 if expression.args.get("with"): 2527 sql = self.maybe_comment(sql, expression) 2528 expression.pop_comments() 2529 2530 sql = self.prepend_ctes(expression, sql) 2531 2532 if not self.SUPPORTS_SELECT_INTO and into: 2533 if into.args.get("temporary"): 2534 table_kind = " TEMPORARY" 2535 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2536 table_kind = " UNLOGGED" 2537 else: 2538 table_kind = "" 2539 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2540 2541 return sql 2542 2543 def schema_sql(self, expression: exp.Schema) -> str: 2544 this = self.sql(expression, "this") 2545 sql = self.schema_columns_sql(expression) 2546 return f"{this} {sql}" if this and sql else this or sql 2547 2548 def schema_columns_sql(self, expression: exp.Schema) -> str: 2549 if expression.expressions: 2550 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2551 return "" 2552 2553 def star_sql(self, expression: exp.Star) -> str: 2554 except_ = self.expressions(expression, key="except", flat=True) 2555 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2556 replace = self.expressions(expression, key="replace", flat=True) 2557 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2558 rename = self.expressions(expression, key="rename", flat=True) 2559 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2560 return f"*{except_}{replace}{rename}" 2561 2562 def parameter_sql(self, expression: exp.Parameter) -> str: 2563 this = self.sql(expression, "this") 2564 return f"{self.PARAMETER_TOKEN}{this}" 2565 2566 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2567 this = self.sql(expression, "this") 2568 kind = expression.text("kind") 2569 if kind: 2570 kind = f"{kind}." 2571 return f"@@{kind}{this}" 2572 2573 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2574 return f"{self.NAMED_PLACEHOLDER_TOKEN}{expression.name}" if expression.this else "?" 2575 2576 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2577 alias = self.sql(expression, "alias") 2578 alias = f"{sep}{alias}" if alias else "" 2579 sample = self.sql(expression, "sample") 2580 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2581 alias = f"{sample}{alias}" 2582 2583 # Set to None so it's not generated again by self.query_modifiers() 2584 expression.set("sample", None) 2585 2586 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2587 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2588 return self.prepend_ctes(expression, sql) 2589 2590 def qualify_sql(self, expression: exp.Qualify) -> str: 2591 this = self.indent(self.sql(expression, "this")) 2592 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2593 2594 def unnest_sql(self, expression: exp.Unnest) -> str: 2595 args = self.expressions(expression, flat=True) 2596 2597 alias = expression.args.get("alias") 2598 offset = expression.args.get("offset") 2599 2600 if self.UNNEST_WITH_ORDINALITY: 2601 if alias and isinstance(offset, exp.Expression): 2602 alias.append("columns", offset) 2603 2604 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2605 columns = alias.columns 2606 alias = self.sql(columns[0]) if columns else "" 2607 else: 2608 alias = self.sql(alias) 2609 2610 alias = f" AS {alias}" if alias else alias 2611 if self.UNNEST_WITH_ORDINALITY: 2612 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2613 else: 2614 if isinstance(offset, exp.Expression): 2615 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2616 elif offset: 2617 suffix = f"{alias} WITH OFFSET" 2618 else: 2619 suffix = alias 2620 2621 return f"UNNEST({args}){suffix}" 2622 2623 def prewhere_sql(self, expression: exp.PreWhere) -> str: 2624 return "" 2625 2626 def where_sql(self, expression: exp.Where) -> str: 2627 this = self.indent(self.sql(expression, "this")) 2628 return f"{self.seg('WHERE')}{self.sep()}{this}" 2629 2630 def window_sql(self, expression: exp.Window) -> str: 2631 this = self.sql(expression, "this") 2632 partition = self.partition_by_sql(expression) 2633 order = expression.args.get("order") 2634 order = self.order_sql(order, flat=True) if order else "" 2635 spec = self.sql(expression, "spec") 2636 alias = self.sql(expression, "alias") 2637 over = self.sql(expression, "over") or "OVER" 2638 2639 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2640 2641 first = expression.args.get("first") 2642 if first is None: 2643 first = "" 2644 else: 2645 first = "FIRST" if first else "LAST" 2646 2647 if not partition and not order and not spec and alias: 2648 return f"{this} {alias}" 2649 2650 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2651 return f"{this} ({args})" 2652 2653 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2654 partition = self.expressions(expression, key="partition_by", flat=True) 2655 return f"PARTITION BY {partition}" if partition else "" 2656 2657 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2658 kind = self.sql(expression, "kind") 2659 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2660 end = ( 2661 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2662 or "CURRENT ROW" 2663 ) 2664 return f"{kind} BETWEEN {start} AND {end}" 2665 2666 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2667 this = self.sql(expression, "this") 2668 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2669 return f"{this} WITHIN GROUP ({expression_sql})" 2670 2671 def between_sql(self, expression: exp.Between) -> str: 2672 this = self.sql(expression, "this") 2673 low = self.sql(expression, "low") 2674 high = self.sql(expression, "high") 2675 return f"{this} BETWEEN {low} AND {high}" 2676 2677 def bracket_offset_expressions( 2678 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2679 ) -> t.List[exp.Expression]: 2680 return apply_index_offset( 2681 expression.this, 2682 expression.expressions, 2683 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2684 ) 2685 2686 def bracket_sql(self, expression: exp.Bracket) -> str: 2687 expressions = self.bracket_offset_expressions(expression) 2688 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2689 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2690 2691 def all_sql(self, expression: exp.All) -> str: 2692 return f"ALL {self.wrap(expression)}" 2693 2694 def any_sql(self, expression: exp.Any) -> str: 2695 this = self.sql(expression, "this") 2696 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2697 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2698 this = self.wrap(this) 2699 return f"ANY{this}" 2700 return f"ANY {this}" 2701 2702 def exists_sql(self, expression: exp.Exists) -> str: 2703 return f"EXISTS{self.wrap(expression)}" 2704 2705 def case_sql(self, expression: exp.Case) -> str: 2706 this = self.sql(expression, "this") 2707 statements = [f"CASE {this}" if this else "CASE"] 2708 2709 for e in expression.args["ifs"]: 2710 statements.append(f"WHEN {self.sql(e, 'this')}") 2711 statements.append(f"THEN {self.sql(e, 'true')}") 2712 2713 default = self.sql(expression, "default") 2714 2715 if default: 2716 statements.append(f"ELSE {default}") 2717 2718 statements.append("END") 2719 2720 if self.pretty and self.too_wide(statements): 2721 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2722 2723 return " ".join(statements) 2724 2725 def constraint_sql(self, expression: exp.Constraint) -> str: 2726 this = self.sql(expression, "this") 2727 expressions = self.expressions(expression, flat=True) 2728 return f"CONSTRAINT {this} {expressions}" 2729 2730 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2731 order = expression.args.get("order") 2732 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2733 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2734 2735 def extract_sql(self, expression: exp.Extract) -> str: 2736 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2737 expression_sql = self.sql(expression, "expression") 2738 return f"EXTRACT({this} FROM {expression_sql})" 2739 2740 def trim_sql(self, expression: exp.Trim) -> str: 2741 trim_type = self.sql(expression, "position") 2742 2743 if trim_type == "LEADING": 2744 func_name = "LTRIM" 2745 elif trim_type == "TRAILING": 2746 func_name = "RTRIM" 2747 else: 2748 func_name = "TRIM" 2749 2750 return self.func(func_name, expression.this, expression.expression) 2751 2752 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2753 args = expression.expressions 2754 if isinstance(expression, exp.ConcatWs): 2755 args = args[1:] # Skip the delimiter 2756 2757 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2758 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2759 2760 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2761 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2762 2763 return args 2764 2765 def concat_sql(self, expression: exp.Concat) -> str: 2766 expressions = self.convert_concat_args(expression) 2767 2768 # Some dialects don't allow a single-argument CONCAT call 2769 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2770 return self.sql(expressions[0]) 2771 2772 return self.func("CONCAT", *expressions) 2773 2774 def concatws_sql(self, expression: exp.ConcatWs) -> str: 2775 return self.func( 2776 "CONCAT_WS", seq_get(expression.expressions, 0), *self.convert_concat_args(expression) 2777 ) 2778 2779 def check_sql(self, expression: exp.Check) -> str: 2780 this = self.sql(expression, key="this") 2781 return f"CHECK ({this})" 2782 2783 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2784 expressions = self.expressions(expression, flat=True) 2785 reference = self.sql(expression, "reference") 2786 reference = f" {reference}" if reference else "" 2787 delete = self.sql(expression, "delete") 2788 delete = f" ON DELETE {delete}" if delete else "" 2789 update = self.sql(expression, "update") 2790 update = f" ON UPDATE {update}" if update else "" 2791 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}" 2792 2793 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2794 expressions = self.expressions(expression, flat=True) 2795 options = self.expressions(expression, key="options", flat=True, sep=" ") 2796 options = f" {options}" if options else "" 2797 return f"PRIMARY KEY ({expressions}){options}" 2798 2799 def if_sql(self, expression: exp.If) -> str: 2800 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2801 2802 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2803 modifier = expression.args.get("modifier") 2804 modifier = f" {modifier}" if modifier else "" 2805 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2806 2807 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2808 return f"{self.sql(expression, 'this')}{self.JSON_KEY_VALUE_PAIR_SEP} {self.sql(expression, 'expression')}" 2809 2810 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2811 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2812 2813 if expression.args.get("escape"): 2814 path = self.escape_str(path) 2815 2816 if self.QUOTE_JSON_PATH: 2817 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2818 2819 return path 2820 2821 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2822 if isinstance(expression, exp.JSONPathPart): 2823 transform = self.TRANSFORMS.get(expression.__class__) 2824 if not callable(transform): 2825 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2826 return "" 2827 2828 return transform(self, expression) 2829 2830 if isinstance(expression, int): 2831 return str(expression) 2832 2833 if self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2834 escaped = expression.replace("'", "\\'") 2835 escaped = f"\\'{expression}\\'" 2836 else: 2837 escaped = expression.replace('"', '\\"') 2838 escaped = f'"{escaped}"' 2839 2840 return escaped 2841 2842 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2843 return f"{self.sql(expression, 'this')} FORMAT JSON" 2844 2845 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2846 null_handling = expression.args.get("null_handling") 2847 null_handling = f" {null_handling}" if null_handling else "" 2848 2849 unique_keys = expression.args.get("unique_keys") 2850 if unique_keys is not None: 2851 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2852 else: 2853 unique_keys = "" 2854 2855 return_type = self.sql(expression, "return_type") 2856 return_type = f" RETURNING {return_type}" if return_type else "" 2857 encoding = self.sql(expression, "encoding") 2858 encoding = f" ENCODING {encoding}" if encoding else "" 2859 2860 return self.func( 2861 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2862 *expression.expressions, 2863 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2864 ) 2865 2866 def jsonobjectagg_sql(self, expression: exp.JSONObjectAgg) -> str: 2867 return self.jsonobject_sql(expression) 2868 2869 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2870 null_handling = expression.args.get("null_handling") 2871 null_handling = f" {null_handling}" if null_handling else "" 2872 return_type = self.sql(expression, "return_type") 2873 return_type = f" RETURNING {return_type}" if return_type else "" 2874 strict = " STRICT" if expression.args.get("strict") else "" 2875 return self.func( 2876 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2877 ) 2878 2879 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2880 this = self.sql(expression, "this") 2881 order = self.sql(expression, "order") 2882 null_handling = expression.args.get("null_handling") 2883 null_handling = f" {null_handling}" if null_handling else "" 2884 return_type = self.sql(expression, "return_type") 2885 return_type = f" RETURNING {return_type}" if return_type else "" 2886 strict = " STRICT" if expression.args.get("strict") else "" 2887 return self.func( 2888 "JSON_ARRAYAGG", 2889 this, 2890 suffix=f"{order}{null_handling}{return_type}{strict})", 2891 ) 2892 2893 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2894 path = self.sql(expression, "path") 2895 path = f" PATH {path}" if path else "" 2896 nested_schema = self.sql(expression, "nested_schema") 2897 2898 if nested_schema: 2899 return f"NESTED{path} {nested_schema}" 2900 2901 this = self.sql(expression, "this") 2902 kind = self.sql(expression, "kind") 2903 kind = f" {kind}" if kind else "" 2904 return f"{this}{kind}{path}" 2905 2906 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2907 return self.func("COLUMNS", *expression.expressions) 2908 2909 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2910 this = self.sql(expression, "this") 2911 path = self.sql(expression, "path") 2912 path = f", {path}" if path else "" 2913 error_handling = expression.args.get("error_handling") 2914 error_handling = f" {error_handling}" if error_handling else "" 2915 empty_handling = expression.args.get("empty_handling") 2916 empty_handling = f" {empty_handling}" if empty_handling else "" 2917 schema = self.sql(expression, "schema") 2918 return self.func( 2919 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2920 ) 2921 2922 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2923 this = self.sql(expression, "this") 2924 kind = self.sql(expression, "kind") 2925 path = self.sql(expression, "path") 2926 path = f" {path}" if path else "" 2927 as_json = " AS JSON" if expression.args.get("as_json") else "" 2928 return f"{this} {kind}{path}{as_json}" 2929 2930 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2931 this = self.sql(expression, "this") 2932 path = self.sql(expression, "path") 2933 path = f", {path}" if path else "" 2934 expressions = self.expressions(expression) 2935 with_ = ( 2936 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2937 if expressions 2938 else "" 2939 ) 2940 return f"OPENJSON({this}{path}){with_}" 2941 2942 def in_sql(self, expression: exp.In) -> str: 2943 query = expression.args.get("query") 2944 unnest = expression.args.get("unnest") 2945 field = expression.args.get("field") 2946 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2947 2948 if query: 2949 in_sql = self.sql(query) 2950 elif unnest: 2951 in_sql = self.in_unnest_op(unnest) 2952 elif field: 2953 in_sql = self.sql(field) 2954 else: 2955 in_sql = f"({self.expressions(expression, flat=True)})" 2956 2957 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 2958 2959 def in_unnest_op(self, unnest: exp.Unnest) -> str: 2960 return f"(SELECT {self.sql(unnest)})" 2961 2962 def interval_sql(self, expression: exp.Interval) -> str: 2963 unit = self.sql(expression, "unit") 2964 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2965 unit = self.TIME_PART_SINGULARS.get(unit, unit) 2966 unit = f" {unit}" if unit else "" 2967 2968 if self.SINGLE_STRING_INTERVAL: 2969 this = expression.this.name if expression.this else "" 2970 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2971 2972 this = self.sql(expression, "this") 2973 if this: 2974 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2975 this = f" {this}" if unwrapped else f" ({this})" 2976 2977 return f"INTERVAL{this}{unit}" 2978 2979 def return_sql(self, expression: exp.Return) -> str: 2980 return f"RETURN {self.sql(expression, 'this')}" 2981 2982 def reference_sql(self, expression: exp.Reference) -> str: 2983 this = self.sql(expression, "this") 2984 expressions = self.expressions(expression, flat=True) 2985 expressions = f"({expressions})" if expressions else "" 2986 options = self.expressions(expression, key="options", flat=True, sep=" ") 2987 options = f" {options}" if options else "" 2988 return f"REFERENCES {this}{expressions}{options}" 2989 2990 def anonymous_sql(self, expression: exp.Anonymous) -> str: 2991 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 2992 parent = expression.parent 2993 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 2994 return self.func( 2995 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 2996 ) 2997 2998 def paren_sql(self, expression: exp.Paren) -> str: 2999 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 3000 return f"({sql}{self.seg(')', sep='')}" 3001 3002 def neg_sql(self, expression: exp.Neg) -> str: 3003 # This makes sure we don't convert "- - 5" to "--5", which is a comment 3004 this_sql = self.sql(expression, "this") 3005 sep = " " if this_sql[0] == "-" else "" 3006 return f"-{sep}{this_sql}" 3007 3008 def not_sql(self, expression: exp.Not) -> str: 3009 return f"NOT {self.sql(expression, 'this')}" 3010 3011 def alias_sql(self, expression: exp.Alias) -> str: 3012 alias = self.sql(expression, "alias") 3013 alias = f" AS {alias}" if alias else "" 3014 return f"{self.sql(expression, 'this')}{alias}" 3015 3016 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3017 alias = expression.args["alias"] 3018 3019 identifier_alias = isinstance(alias, exp.Identifier) 3020 literal_alias = isinstance(alias, exp.Literal) 3021 3022 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3023 alias.replace(exp.Literal.string(alias.output_name)) 3024 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3025 alias.replace(exp.to_identifier(alias.output_name)) 3026 3027 return self.alias_sql(expression) 3028 3029 def aliases_sql(self, expression: exp.Aliases) -> str: 3030 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 3031 3032 def atindex_sql(self, expression: exp.AtTimeZone) -> str: 3033 this = self.sql(expression, "this") 3034 index = self.sql(expression, "expression") 3035 return f"{this} AT {index}" 3036 3037 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 3038 this = self.sql(expression, "this") 3039 zone = self.sql(expression, "zone") 3040 return f"{this} AT TIME ZONE {zone}" 3041 3042 def fromtimezone_sql(self, expression: exp.FromTimeZone) -> str: 3043 this = self.sql(expression, "this") 3044 zone = self.sql(expression, "zone") 3045 return f"{this} AT TIME ZONE {zone} AT TIME ZONE 'UTC'" 3046 3047 def add_sql(self, expression: exp.Add) -> str: 3048 return self.binary(expression, "+") 3049 3050 def and_sql( 3051 self, expression: exp.And, stack: t.Optional[t.List[str | exp.Expression]] = None 3052 ) -> str: 3053 return self.connector_sql(expression, "AND", stack) 3054 3055 def or_sql( 3056 self, expression: exp.Or, stack: t.Optional[t.List[str | exp.Expression]] = None 3057 ) -> str: 3058 return self.connector_sql(expression, "OR", stack) 3059 3060 def xor_sql( 3061 self, expression: exp.Xor, stack: t.Optional[t.List[str | exp.Expression]] = None 3062 ) -> str: 3063 return self.connector_sql(expression, "XOR", stack) 3064 3065 def connector_sql( 3066 self, 3067 expression: exp.Connector, 3068 op: str, 3069 stack: t.Optional[t.List[str | exp.Expression]] = None, 3070 ) -> str: 3071 if stack is not None: 3072 if expression.expressions: 3073 stack.append(self.expressions(expression, sep=f" {op} ")) 3074 else: 3075 stack.append(expression.right) 3076 if expression.comments and self.comments: 3077 for comment in expression.comments: 3078 if comment: 3079 op += f" /*{self.pad_comment(comment)}*/" 3080 stack.extend((op, expression.left)) 3081 return op 3082 3083 stack = [expression] 3084 sqls: t.List[str] = [] 3085 ops = set() 3086 3087 while stack: 3088 node = stack.pop() 3089 if isinstance(node, exp.Connector): 3090 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3091 else: 3092 sql = self.sql(node) 3093 if sqls and sqls[-1] in ops: 3094 sqls[-1] += f" {sql}" 3095 else: 3096 sqls.append(sql) 3097 3098 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3099 return sep.join(sqls) 3100 3101 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 3102 return self.binary(expression, "&") 3103 3104 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 3105 return self.binary(expression, "<<") 3106 3107 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 3108 return f"~{self.sql(expression, 'this')}" 3109 3110 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 3111 return self.binary(expression, "|") 3112 3113 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 3114 return self.binary(expression, ">>") 3115 3116 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 3117 return self.binary(expression, "^") 3118 3119 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3120 format_sql = self.sql(expression, "format") 3121 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3122 to_sql = self.sql(expression, "to") 3123 to_sql = f" {to_sql}" if to_sql else "" 3124 action = self.sql(expression, "action") 3125 action = f" {action}" if action else "" 3126 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})" 3127 3128 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 3129 zone = self.sql(expression, "this") 3130 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 3131 3132 def collate_sql(self, expression: exp.Collate) -> str: 3133 if self.COLLATE_IS_FUNC: 3134 return self.function_fallback_sql(expression) 3135 return self.binary(expression, "COLLATE") 3136 3137 def command_sql(self, expression: exp.Command) -> str: 3138 return f"{self.sql(expression, 'this')} {expression.text('expression').strip()}" 3139 3140 def comment_sql(self, expression: exp.Comment) -> str: 3141 this = self.sql(expression, "this") 3142 kind = expression.args["kind"] 3143 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3144 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3145 expression_sql = self.sql(expression, "expression") 3146 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}" 3147 3148 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3149 this = self.sql(expression, "this") 3150 delete = " DELETE" if expression.args.get("delete") else "" 3151 recompress = self.sql(expression, "recompress") 3152 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3153 to_disk = self.sql(expression, "to_disk") 3154 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3155 to_volume = self.sql(expression, "to_volume") 3156 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3157 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 3158 3159 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3160 where = self.sql(expression, "where") 3161 group = self.sql(expression, "group") 3162 aggregates = self.expressions(expression, key="aggregates") 3163 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3164 3165 if not (where or group or aggregates) and len(expression.expressions) == 1: 3166 return f"TTL {self.expressions(expression, flat=True)}" 3167 3168 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 3169 3170 def transaction_sql(self, expression: exp.Transaction) -> str: 3171 return "BEGIN" 3172 3173 def commit_sql(self, expression: exp.Commit) -> str: 3174 chain = expression.args.get("chain") 3175 if chain is not None: 3176 chain = " AND CHAIN" if chain else " AND NO CHAIN" 3177 3178 return f"COMMIT{chain or ''}" 3179 3180 def rollback_sql(self, expression: exp.Rollback) -> str: 3181 savepoint = expression.args.get("savepoint") 3182 savepoint = f" TO {savepoint}" if savepoint else "" 3183 return f"ROLLBACK{savepoint}" 3184 3185 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3186 this = self.sql(expression, "this") 3187 3188 dtype = self.sql(expression, "dtype") 3189 if dtype: 3190 collate = self.sql(expression, "collate") 3191 collate = f" COLLATE {collate}" if collate else "" 3192 using = self.sql(expression, "using") 3193 using = f" USING {using}" if using else "" 3194 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3195 3196 default = self.sql(expression, "default") 3197 if default: 3198 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3199 3200 comment = self.sql(expression, "comment") 3201 if comment: 3202 return f"ALTER COLUMN {this} COMMENT {comment}" 3203 3204 allow_null = expression.args.get("allow_null") 3205 drop = expression.args.get("drop") 3206 3207 if not drop and not allow_null: 3208 self.unsupported("Unsupported ALTER COLUMN syntax") 3209 3210 if allow_null is not None: 3211 keyword = "DROP" if drop else "SET" 3212 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3213 3214 return f"ALTER COLUMN {this} DROP DEFAULT" 3215 3216 def alterdiststyle_sql(self, expression: exp.AlterDistStyle) -> str: 3217 this = self.sql(expression, "this") 3218 if not isinstance(expression.this, exp.Var): 3219 this = f"KEY DISTKEY {this}" 3220 return f"ALTER DISTSTYLE {this}" 3221 3222 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3223 compound = " COMPOUND" if expression.args.get("compound") else "" 3224 this = self.sql(expression, "this") 3225 expressions = self.expressions(expression, flat=True) 3226 expressions = f"({expressions})" if expressions else "" 3227 return f"ALTER{compound} SORTKEY {this or expressions}" 3228 3229 def renametable_sql(self, expression: exp.RenameTable) -> str: 3230 if not self.RENAME_TABLE_WITH_DB: 3231 # Remove db from tables 3232 expression = expression.transform( 3233 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3234 ).assert_is(exp.RenameTable) 3235 this = self.sql(expression, "this") 3236 return f"RENAME TO {this}" 3237 3238 def renamecolumn_sql(self, expression: exp.RenameColumn) -> str: 3239 exists = " IF EXISTS" if expression.args.get("exists") else "" 3240 old_column = self.sql(expression, "this") 3241 new_column = self.sql(expression, "to") 3242 return f"RENAME COLUMN{exists} {old_column} TO {new_column}" 3243 3244 def alterset_sql(self, expression: exp.AlterSet) -> str: 3245 exprs = self.expressions(expression, flat=True) 3246 return f"SET {exprs}" 3247 3248 def alter_sql(self, expression: exp.Alter) -> str: 3249 actions = expression.args["actions"] 3250 3251 if isinstance(actions[0], exp.ColumnDef): 3252 actions = self.add_column_sql(expression) 3253 elif isinstance(actions[0], exp.Schema): 3254 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3255 elif isinstance(actions[0], exp.Delete): 3256 actions = self.expressions(expression, key="actions", flat=True) 3257 elif isinstance(actions[0], exp.Query): 3258 actions = "AS " + self.expressions(expression, key="actions") 3259 else: 3260 actions = self.expressions(expression, key="actions", flat=True) 3261 3262 exists = " IF EXISTS" if expression.args.get("exists") else "" 3263 on_cluster = self.sql(expression, "cluster") 3264 on_cluster = f" {on_cluster}" if on_cluster else "" 3265 only = " ONLY" if expression.args.get("only") else "" 3266 options = self.expressions(expression, key="options") 3267 options = f", {options}" if options else "" 3268 kind = self.sql(expression, "kind") 3269 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3270 3271 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}" 3272 3273 def add_column_sql(self, expression: exp.Alter) -> str: 3274 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3275 return self.expressions( 3276 expression, 3277 key="actions", 3278 prefix="ADD COLUMN ", 3279 skip_first=True, 3280 ) 3281 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 3282 3283 def droppartition_sql(self, expression: exp.DropPartition) -> str: 3284 expressions = self.expressions(expression) 3285 exists = " IF EXISTS " if expression.args.get("exists") else " " 3286 return f"DROP{exists}{expressions}" 3287 3288 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 3289 return f"ADD {self.expressions(expression)}" 3290 3291 def distinct_sql(self, expression: exp.Distinct) -> str: 3292 this = self.expressions(expression, flat=True) 3293 3294 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3295 case = exp.case() 3296 for arg in expression.expressions: 3297 case = case.when(arg.is_(exp.null()), exp.null()) 3298 this = self.sql(case.else_(f"({this})")) 3299 3300 this = f" {this}" if this else "" 3301 3302 on = self.sql(expression, "on") 3303 on = f" ON {on}" if on else "" 3304 return f"DISTINCT{this}{on}" 3305 3306 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 3307 return self._embed_ignore_nulls(expression, "IGNORE NULLS") 3308 3309 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 3310 return self._embed_ignore_nulls(expression, "RESPECT NULLS") 3311 3312 def havingmax_sql(self, expression: exp.HavingMax) -> str: 3313 this_sql = self.sql(expression, "this") 3314 expression_sql = self.sql(expression, "expression") 3315 kind = "MAX" if expression.args.get("max") else "MIN" 3316 return f"{this_sql} HAVING {kind} {expression_sql}" 3317 3318 def intdiv_sql(self, expression: exp.IntDiv) -> str: 3319 return self.sql( 3320 exp.Cast( 3321 this=exp.Div(this=expression.this, expression=expression.expression), 3322 to=exp.DataType(this=exp.DataType.Type.INT), 3323 ) 3324 ) 3325 3326 def dpipe_sql(self, expression: exp.DPipe) -> str: 3327 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 3328 return self.func( 3329 "CONCAT", *(exp.cast(e, exp.DataType.Type.TEXT) for e in expression.flatten()) 3330 ) 3331 return self.binary(expression, "||") 3332 3333 def div_sql(self, expression: exp.Div) -> str: 3334 l, r = expression.left, expression.right 3335 3336 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3337 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3338 3339 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3340 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3341 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3342 3343 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3344 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3345 return self.sql( 3346 exp.cast( 3347 l / r, 3348 to=exp.DataType.Type.BIGINT, 3349 ) 3350 ) 3351 3352 return self.binary(expression, "/") 3353 3354 def overlaps_sql(self, expression: exp.Overlaps) -> str: 3355 return self.binary(expression, "OVERLAPS") 3356 3357 def distance_sql(self, expression: exp.Distance) -> str: 3358 return self.binary(expression, "<->") 3359 3360 def dot_sql(self, expression: exp.Dot) -> str: 3361 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 3362 3363 def eq_sql(self, expression: exp.EQ) -> str: 3364 return self.binary(expression, "=") 3365 3366 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 3367 return self.binary(expression, ":=") 3368 3369 def escape_sql(self, expression: exp.Escape) -> str: 3370 return self.binary(expression, "ESCAPE") 3371 3372 def glob_sql(self, expression: exp.Glob) -> str: 3373 return self.binary(expression, "GLOB") 3374 3375 def gt_sql(self, expression: exp.GT) -> str: 3376 return self.binary(expression, ">") 3377 3378 def gte_sql(self, expression: exp.GTE) -> str: 3379 return self.binary(expression, ">=") 3380 3381 def ilike_sql(self, expression: exp.ILike) -> str: 3382 return self.binary(expression, "ILIKE") 3383 3384 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 3385 return self.binary(expression, "ILIKE ANY") 3386 3387 def is_sql(self, expression: exp.Is) -> str: 3388 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 3389 return self.sql( 3390 expression.this if expression.expression.this else exp.not_(expression.this) 3391 ) 3392 return self.binary(expression, "IS") 3393 3394 def like_sql(self, expression: exp.Like) -> str: 3395 return self.binary(expression, "LIKE") 3396 3397 def likeany_sql(self, expression: exp.LikeAny) -> str: 3398 return self.binary(expression, "LIKE ANY") 3399 3400 def similarto_sql(self, expression: exp.SimilarTo) -> str: 3401 return self.binary(expression, "SIMILAR TO") 3402 3403 def lt_sql(self, expression: exp.LT) -> str: 3404 return self.binary(expression, "<") 3405 3406 def lte_sql(self, expression: exp.LTE) -> str: 3407 return self.binary(expression, "<=") 3408 3409 def mod_sql(self, expression: exp.Mod) -> str: 3410 return self.binary(expression, "%") 3411 3412 def mul_sql(self, expression: exp.Mul) -> str: 3413 return self.binary(expression, "*") 3414 3415 def neq_sql(self, expression: exp.NEQ) -> str: 3416 return self.binary(expression, "<>") 3417 3418 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 3419 return self.binary(expression, "IS NOT DISTINCT FROM") 3420 3421 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 3422 return self.binary(expression, "IS DISTINCT FROM") 3423 3424 def slice_sql(self, expression: exp.Slice) -> str: 3425 return self.binary(expression, ":") 3426 3427 def sub_sql(self, expression: exp.Sub) -> str: 3428 return self.binary(expression, "-") 3429 3430 def trycast_sql(self, expression: exp.TryCast) -> str: 3431 return self.cast_sql(expression, safe_prefix="TRY_") 3432 3433 def try_sql(self, expression: exp.Try) -> str: 3434 if not self.TRY_SUPPORTED: 3435 self.unsupported("Unsupported TRY function") 3436 return self.sql(expression, "this") 3437 3438 return self.func("TRY", expression.this) 3439 3440 def log_sql(self, expression: exp.Log) -> str: 3441 this = expression.this 3442 expr = expression.expression 3443 3444 if self.dialect.LOG_BASE_FIRST is False: 3445 this, expr = expr, this 3446 elif self.dialect.LOG_BASE_FIRST is None and expr: 3447 if this.name in ("2", "10"): 3448 return self.func(f"LOG{this.name}", expr) 3449 3450 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3451 3452 return self.func("LOG", this, expr) 3453 3454 def use_sql(self, expression: exp.Use) -> str: 3455 kind = self.sql(expression, "kind") 3456 kind = f" {kind}" if kind else "" 3457 this = self.sql(expression, "this") 3458 this = f" {this}" if this else "" 3459 return f"USE{kind}{this}" 3460 3461 def binary(self, expression: exp.Binary, op: str) -> str: 3462 sqls: t.List[str] = [] 3463 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3464 binary_type = type(expression) 3465 3466 while stack: 3467 node = stack.pop() 3468 3469 if type(node) is binary_type: 3470 op_func = node.args.get("operator") 3471 if op_func: 3472 op = f"OPERATOR({self.sql(op_func)})" 3473 3474 stack.append(node.right) 3475 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3476 stack.append(node.left) 3477 else: 3478 sqls.append(self.sql(node)) 3479 3480 return "".join(sqls) 3481 3482 def function_fallback_sql(self, expression: exp.Func) -> str: 3483 args = [] 3484 3485 for key in expression.arg_types: 3486 arg_value = expression.args.get(key) 3487 3488 if isinstance(arg_value, list): 3489 for value in arg_value: 3490 args.append(value) 3491 elif arg_value is not None: 3492 args.append(arg_value) 3493 3494 if self.normalize_functions: 3495 name = expression.sql_name() 3496 else: 3497 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3498 3499 return self.func(name, *args) 3500 3501 def func( 3502 self, 3503 name: str, 3504 *args: t.Optional[exp.Expression | str], 3505 prefix: str = "(", 3506 suffix: str = ")", 3507 normalize: bool = True, 3508 ) -> str: 3509 name = self.normalize_func(name) if normalize else name 3510 return f"{name}{prefix}{self.format_args(*args)}{suffix}" 3511 3512 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 3513 arg_sqls = tuple( 3514 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3515 ) 3516 if self.pretty and self.too_wide(arg_sqls): 3517 return self.indent("\n" + ",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 3518 return ", ".join(arg_sqls) 3519 3520 def too_wide(self, args: t.Iterable) -> bool: 3521 return sum(len(arg) for arg in args) > self.max_text_width 3522 3523 def format_time( 3524 self, 3525 expression: exp.Expression, 3526 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3527 inverse_time_trie: t.Optional[t.Dict] = None, 3528 ) -> t.Optional[str]: 3529 return format_time( 3530 self.sql(expression, "format"), 3531 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3532 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3533 ) 3534 3535 def expressions( 3536 self, 3537 expression: t.Optional[exp.Expression] = None, 3538 key: t.Optional[str] = None, 3539 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3540 flat: bool = False, 3541 indent: bool = True, 3542 skip_first: bool = False, 3543 skip_last: bool = False, 3544 sep: str = ", ", 3545 prefix: str = "", 3546 dynamic: bool = False, 3547 new_line: bool = False, 3548 ) -> str: 3549 expressions = expression.args.get(key or "expressions") if expression else sqls 3550 3551 if not expressions: 3552 return "" 3553 3554 if flat: 3555 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3556 3557 num_sqls = len(expressions) 3558 result_sqls = [] 3559 3560 for i, e in enumerate(expressions): 3561 sql = self.sql(e, comment=False) 3562 if not sql: 3563 continue 3564 3565 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3566 3567 if self.pretty: 3568 if self.leading_comma: 3569 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3570 else: 3571 result_sqls.append( 3572 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3573 ) 3574 else: 3575 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3576 3577 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3578 if new_line: 3579 result_sqls.insert(0, "") 3580 result_sqls.append("") 3581 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3582 else: 3583 result_sql = "".join(result_sqls) 3584 3585 return ( 3586 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3587 if indent 3588 else result_sql 3589 ) 3590 3591 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3592 flat = flat or isinstance(expression.parent, exp.Properties) 3593 expressions_sql = self.expressions(expression, flat=flat) 3594 if flat: 3595 return f"{op} {expressions_sql}" 3596 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 3597 3598 def naked_property(self, expression: exp.Property) -> str: 3599 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3600 if not property_name: 3601 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3602 return f"{property_name} {self.sql(expression, 'this')}" 3603 3604 def tag_sql(self, expression: exp.Tag) -> str: 3605 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 3606 3607 def token_sql(self, token_type: TokenType) -> str: 3608 return self.TOKEN_MAPPING.get(token_type, token_type.name) 3609 3610 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3611 this = self.sql(expression, "this") 3612 expressions = self.no_identify(self.expressions, expression) 3613 expressions = ( 3614 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3615 ) 3616 return f"{this}{expressions}" 3617 3618 def joinhint_sql(self, expression: exp.JoinHint) -> str: 3619 this = self.sql(expression, "this") 3620 expressions = self.expressions(expression, flat=True) 3621 return f"{this}({expressions})" 3622 3623 def kwarg_sql(self, expression: exp.Kwarg) -> str: 3624 return self.binary(expression, "=>") 3625 3626 def when_sql(self, expression: exp.When) -> str: 3627 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3628 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3629 condition = self.sql(expression, "condition") 3630 condition = f" AND {condition}" if condition else "" 3631 3632 then_expression = expression.args.get("then") 3633 if isinstance(then_expression, exp.Insert): 3634 this = self.sql(then_expression, "this") 3635 this = f"INSERT {this}" if this else "INSERT" 3636 then = self.sql(then_expression, "expression") 3637 then = f"{this} VALUES {then}" if then else this 3638 elif isinstance(then_expression, exp.Update): 3639 if isinstance(then_expression.args.get("expressions"), exp.Star): 3640 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3641 else: 3642 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3643 else: 3644 then = self.sql(then_expression) 3645 return f"WHEN {matched}{source}{condition} THEN {then}" 3646 3647 def merge_sql(self, expression: exp.Merge) -> str: 3648 table = expression.this 3649 table_alias = "" 3650 3651 hints = table.args.get("hints") 3652 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3653 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3654 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3655 3656 this = self.sql(table) 3657 using = f"USING {self.sql(expression, 'using')}" 3658 on = f"ON {self.sql(expression, 'on')}" 3659 expressions = self.expressions(expression, sep=" ", indent=False) 3660 returning = self.sql(expression, "returning") 3661 if returning: 3662 expressions = f"{expressions}{returning}" 3663 3664 sep = self.sep() 3665 3666 return self.prepend_ctes( 3667 expression, 3668 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{expressions}", 3669 ) 3670 3671 @unsupported_args("format") 3672 def tochar_sql(self, expression: exp.ToChar) -> str: 3673 return self.sql(exp.cast(expression.this, exp.DataType.Type.TEXT)) 3674 3675 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3676 if not self.SUPPORTS_TO_NUMBER: 3677 self.unsupported("Unsupported TO_NUMBER function") 3678 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3679 3680 fmt = expression.args.get("format") 3681 if not fmt: 3682 self.unsupported("Conversion format is required for TO_NUMBER") 3683 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3684 3685 return self.func("TO_NUMBER", expression.this, fmt) 3686 3687 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3688 this = self.sql(expression, "this") 3689 kind = self.sql(expression, "kind") 3690 settings_sql = self.expressions(expression, key="settings", sep=" ") 3691 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3692 return f"{this}({kind}{args})" 3693 3694 def dictrange_sql(self, expression: exp.DictRange) -> str: 3695 this = self.sql(expression, "this") 3696 max = self.sql(expression, "max") 3697 min = self.sql(expression, "min") 3698 return f"{this}(MIN {min} MAX {max})" 3699 3700 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 3701 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 3702 3703 def duplicatekeyproperty_sql(self, expression: exp.DuplicateKeyProperty) -> str: 3704 return f"DUPLICATE KEY ({self.expressions(expression, flat=True)})" 3705 3706 # https://docs.starrocks.io/docs/sql-reference/sql-statements/data-definition/CREATE_TABLE/#distribution_desc 3707 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3708 expressions = self.expressions(expression, flat=True) 3709 expressions = f" {self.wrap(expressions)}" if expressions else "" 3710 buckets = self.sql(expression, "buckets") 3711 kind = self.sql(expression, "kind") 3712 buckets = f" BUCKETS {buckets}" if buckets else "" 3713 order = self.sql(expression, "order") 3714 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}" 3715 3716 def oncluster_sql(self, expression: exp.OnCluster) -> str: 3717 return "" 3718 3719 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3720 expressions = self.expressions(expression, key="expressions", flat=True) 3721 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3722 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3723 buckets = self.sql(expression, "buckets") 3724 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 3725 3726 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3727 this = self.sql(expression, "this") 3728 having = self.sql(expression, "having") 3729 3730 if having: 3731 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3732 3733 return self.func("ANY_VALUE", this) 3734 3735 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3736 transform = self.func("TRANSFORM", *expression.expressions) 3737 row_format_before = self.sql(expression, "row_format_before") 3738 row_format_before = f" {row_format_before}" if row_format_before else "" 3739 record_writer = self.sql(expression, "record_writer") 3740 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3741 using = f" USING {self.sql(expression, 'command_script')}" 3742 schema = self.sql(expression, "schema") 3743 schema = f" AS {schema}" if schema else "" 3744 row_format_after = self.sql(expression, "row_format_after") 3745 row_format_after = f" {row_format_after}" if row_format_after else "" 3746 record_reader = self.sql(expression, "record_reader") 3747 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3748 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 3749 3750 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3751 key_block_size = self.sql(expression, "key_block_size") 3752 if key_block_size: 3753 return f"KEY_BLOCK_SIZE = {key_block_size}" 3754 3755 using = self.sql(expression, "using") 3756 if using: 3757 return f"USING {using}" 3758 3759 parser = self.sql(expression, "parser") 3760 if parser: 3761 return f"WITH PARSER {parser}" 3762 3763 comment = self.sql(expression, "comment") 3764 if comment: 3765 return f"COMMENT {comment}" 3766 3767 visible = expression.args.get("visible") 3768 if visible is not None: 3769 return "VISIBLE" if visible else "INVISIBLE" 3770 3771 engine_attr = self.sql(expression, "engine_attr") 3772 if engine_attr: 3773 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3774 3775 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3776 if secondary_engine_attr: 3777 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3778 3779 self.unsupported("Unsupported index constraint option.") 3780 return "" 3781 3782 def checkcolumnconstraint_sql(self, expression: exp.CheckColumnConstraint) -> str: 3783 enforced = " ENFORCED" if expression.args.get("enforced") else "" 3784 return f"CHECK ({self.sql(expression, 'this')}){enforced}" 3785 3786 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3787 kind = self.sql(expression, "kind") 3788 kind = f"{kind} INDEX" if kind else "INDEX" 3789 this = self.sql(expression, "this") 3790 this = f" {this}" if this else "" 3791 index_type = self.sql(expression, "index_type") 3792 index_type = f" USING {index_type}" if index_type else "" 3793 expressions = self.expressions(expression, flat=True) 3794 expressions = f" ({expressions})" if expressions else "" 3795 options = self.expressions(expression, key="options", sep=" ") 3796 options = f" {options}" if options else "" 3797 return f"{kind}{this}{index_type}{expressions}{options}" 3798 3799 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3800 if self.NVL2_SUPPORTED: 3801 return self.function_fallback_sql(expression) 3802 3803 case = exp.Case().when( 3804 expression.this.is_(exp.null()).not_(copy=False), 3805 expression.args["true"], 3806 copy=False, 3807 ) 3808 else_cond = expression.args.get("false") 3809 if else_cond: 3810 case.else_(else_cond, copy=False) 3811 3812 return self.sql(case) 3813 3814 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3815 this = self.sql(expression, "this") 3816 expr = self.sql(expression, "expression") 3817 iterator = self.sql(expression, "iterator") 3818 condition = self.sql(expression, "condition") 3819 condition = f" IF {condition}" if condition else "" 3820 return f"{this} FOR {expr} IN {iterator}{condition}" 3821 3822 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3823 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3824 3825 def opclass_sql(self, expression: exp.Opclass) -> str: 3826 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3827 3828 def predict_sql(self, expression: exp.Predict) -> str: 3829 model = self.sql(expression, "this") 3830 model = f"MODEL {model}" 3831 table = self.sql(expression, "expression") 3832 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3833 parameters = self.sql(expression, "params_struct") 3834 return self.func("PREDICT", model, table, parameters or None) 3835 3836 def forin_sql(self, expression: exp.ForIn) -> str: 3837 this = self.sql(expression, "this") 3838 expression_sql = self.sql(expression, "expression") 3839 return f"FOR {this} DO {expression_sql}" 3840 3841 def refresh_sql(self, expression: exp.Refresh) -> str: 3842 this = self.sql(expression, "this") 3843 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3844 return f"REFRESH {table}{this}" 3845 3846 def toarray_sql(self, expression: exp.ToArray) -> str: 3847 arg = expression.this 3848 if not arg.type: 3849 from sqlglot.optimizer.annotate_types import annotate_types 3850 3851 arg = annotate_types(arg) 3852 3853 if arg.is_type(exp.DataType.Type.ARRAY): 3854 return self.sql(arg) 3855 3856 cond_for_null = arg.is_(exp.null()) 3857 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False))) 3858 3859 def tsordstotime_sql(self, expression: exp.TsOrDsToTime) -> str: 3860 this = expression.this 3861 if isinstance(this, exp.TsOrDsToTime) or this.is_type(exp.DataType.Type.TIME): 3862 return self.sql(this) 3863 3864 return self.sql(exp.cast(this, exp.DataType.Type.TIME)) 3865 3866 def tsordstotimestamp_sql(self, expression: exp.TsOrDsToTimestamp) -> str: 3867 this = expression.this 3868 if isinstance(this, exp.TsOrDsToTimestamp) or this.is_type(exp.DataType.Type.TIMESTAMP): 3869 return self.sql(this) 3870 3871 return self.sql(exp.cast(this, exp.DataType.Type.TIMESTAMP)) 3872 3873 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3874 this = expression.this 3875 time_format = self.format_time(expression) 3876 3877 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3878 return self.sql( 3879 exp.cast( 3880 exp.StrToTime(this=this, format=expression.args["format"]), 3881 exp.DataType.Type.DATE, 3882 ) 3883 ) 3884 3885 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3886 return self.sql(this) 3887 3888 return self.sql(exp.cast(this, exp.DataType.Type.DATE)) 3889 3890 def unixdate_sql(self, expression: exp.UnixDate) -> str: 3891 return self.sql( 3892 exp.func( 3893 "DATEDIFF", 3894 expression.this, 3895 exp.cast(exp.Literal.string("1970-01-01"), exp.DataType.Type.DATE), 3896 "day", 3897 ) 3898 ) 3899 3900 def lastday_sql(self, expression: exp.LastDay) -> str: 3901 if self.LAST_DAY_SUPPORTS_DATE_PART: 3902 return self.function_fallback_sql(expression) 3903 3904 unit = expression.text("unit") 3905 if unit and unit != "MONTH": 3906 self.unsupported("Date parts are not supported in LAST_DAY.") 3907 3908 return self.func("LAST_DAY", expression.this) 3909 3910 def dateadd_sql(self, expression: exp.DateAdd) -> str: 3911 from sqlglot.dialects.dialect import unit_to_str 3912 3913 return self.func( 3914 "DATE_ADD", expression.this, expression.expression, unit_to_str(expression) 3915 ) 3916 3917 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3918 if self.CAN_IMPLEMENT_ARRAY_ANY: 3919 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3920 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3921 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3922 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3923 3924 from sqlglot.dialects import Dialect 3925 3926 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3927 if self.dialect.__class__ != Dialect: 3928 self.unsupported("ARRAY_ANY is unsupported") 3929 3930 return self.function_fallback_sql(expression) 3931 3932 def struct_sql(self, expression: exp.Struct) -> str: 3933 expression.set( 3934 "expressions", 3935 [ 3936 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 3937 if isinstance(e, exp.PropertyEQ) 3938 else e 3939 for e in expression.expressions 3940 ], 3941 ) 3942 3943 return self.function_fallback_sql(expression) 3944 3945 def partitionrange_sql(self, expression: exp.PartitionRange) -> str: 3946 low = self.sql(expression, "this") 3947 high = self.sql(expression, "expression") 3948 3949 return f"{low} TO {high}" 3950 3951 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 3952 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 3953 tables = f" {self.expressions(expression)}" 3954 3955 exists = " IF EXISTS" if expression.args.get("exists") else "" 3956 3957 on_cluster = self.sql(expression, "cluster") 3958 on_cluster = f" {on_cluster}" if on_cluster else "" 3959 3960 identity = self.sql(expression, "identity") 3961 identity = f" {identity} IDENTITY" if identity else "" 3962 3963 option = self.sql(expression, "option") 3964 option = f" {option}" if option else "" 3965 3966 partition = self.sql(expression, "partition") 3967 partition = f" {partition}" if partition else "" 3968 3969 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}" 3970 3971 # This transpiles T-SQL's CONVERT function 3972 # https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16 3973 def convert_sql(self, expression: exp.Convert) -> str: 3974 to = expression.this 3975 value = expression.expression 3976 style = expression.args.get("style") 3977 safe = expression.args.get("safe") 3978 strict = expression.args.get("strict") 3979 3980 if not to or not value: 3981 return "" 3982 3983 # Retrieve length of datatype and override to default if not specified 3984 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 3985 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 3986 3987 transformed: t.Optional[exp.Expression] = None 3988 cast = exp.Cast if strict else exp.TryCast 3989 3990 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 3991 if isinstance(style, exp.Literal) and style.is_int: 3992 from sqlglot.dialects.tsql import TSQL 3993 3994 style_value = style.name 3995 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 3996 if not converted_style: 3997 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 3998 3999 fmt = exp.Literal.string(converted_style) 4000 4001 if to.this == exp.DataType.Type.DATE: 4002 transformed = exp.StrToDate(this=value, format=fmt) 4003 elif to.this == exp.DataType.Type.DATETIME: 4004 transformed = exp.StrToTime(this=value, format=fmt) 4005 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4006 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4007 elif to.this == exp.DataType.Type.TEXT: 4008 transformed = exp.TimeToStr(this=value, format=fmt) 4009 4010 if not transformed: 4011 transformed = cast(this=value, to=to, safe=safe) 4012 4013 return self.sql(transformed) 4014 4015 def _jsonpathkey_sql(self, expression: exp.JSONPathKey) -> str: 4016 this = expression.this 4017 if isinstance(this, exp.JSONPathWildcard): 4018 this = self.json_path_part(this) 4019 return f".{this}" if this else "" 4020 4021 if exp.SAFE_IDENTIFIER_RE.match(this): 4022 return f".{this}" 4023 4024 this = self.json_path_part(this) 4025 return f"[{this}]" if self.JSON_PATH_BRACKETED_KEY_SUPPORTED else f".{this}" 4026 4027 def _jsonpathsubscript_sql(self, expression: exp.JSONPathSubscript) -> str: 4028 this = self.json_path_part(expression.this) 4029 return f"[{this}]" if this else "" 4030 4031 def _simplify_unless_literal(self, expression: E) -> E: 4032 if not isinstance(expression, exp.Literal): 4033 from sqlglot.optimizer.simplify import simplify 4034 4035 expression = simplify(expression, dialect=self.dialect) 4036 4037 return expression 4038 4039 def _embed_ignore_nulls(self, expression: exp.IgnoreNulls | exp.RespectNulls, text: str) -> str: 4040 if self.IGNORE_NULLS_IN_FUNC and not expression.meta.get("inline"): 4041 # The first modifier here will be the one closest to the AggFunc's arg 4042 mods = sorted( 4043 expression.find_all(exp.HavingMax, exp.Order, exp.Limit), 4044 key=lambda x: 0 4045 if isinstance(x, exp.HavingMax) 4046 else (1 if isinstance(x, exp.Order) else 2), 4047 ) 4048 4049 if mods: 4050 mod = mods[0] 4051 this = expression.__class__(this=mod.this.copy()) 4052 this.meta["inline"] = True 4053 mod.this.replace(this) 4054 return self.sql(expression.this) 4055 4056 agg_func = expression.find(exp.AggFunc) 4057 4058 if agg_func: 4059 return self.sql(agg_func)[:-1] + f" {text})" 4060 4061 return f"{self.sql(expression, 'this')} {text}" 4062 4063 def _replace_line_breaks(self, string: str) -> str: 4064 """We don't want to extra indent line breaks so we temporarily replace them with sentinels.""" 4065 if self.pretty: 4066 return string.replace("\n", self.SENTINEL_LINE_BREAK) 4067 return string 4068 4069 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4070 option = self.sql(expression, "this") 4071 4072 if expression.expressions: 4073 upper = option.upper() 4074 4075 # Snowflake FILE_FORMAT options are separated by whitespace 4076 sep = " " if upper == "FILE_FORMAT" else ", " 4077 4078 # Databricks copy/format options do not set their list of values with EQ 4079 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4080 values = self.expressions(expression, flat=True, sep=sep) 4081 return f"{option}{op}({values})" 4082 4083 value = self.sql(expression, "expression") 4084 4085 if not value: 4086 return option 4087 4088 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4089 4090 return f"{option}{op}{value}" 4091 4092 def credentials_sql(self, expression: exp.Credentials) -> str: 4093 cred_expr = expression.args.get("credentials") 4094 if isinstance(cred_expr, exp.Literal): 4095 # Redshift case: CREDENTIALS <string> 4096 credentials = self.sql(expression, "credentials") 4097 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4098 else: 4099 # Snowflake case: CREDENTIALS = (...) 4100 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4101 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4102 4103 storage = self.sql(expression, "storage") 4104 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4105 4106 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4107 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4108 4109 iam_role = self.sql(expression, "iam_role") 4110 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4111 4112 region = self.sql(expression, "region") 4113 region = f" REGION {region}" if region else "" 4114 4115 return f"{credentials}{storage}{encryption}{iam_role}{region}" 4116 4117 def copy_sql(self, expression: exp.Copy) -> str: 4118 this = self.sql(expression, "this") 4119 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4120 4121 credentials = self.sql(expression, "credentials") 4122 credentials = self.seg(credentials) if credentials else "" 4123 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4124 files = self.expressions(expression, key="files", flat=True) 4125 4126 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4127 params = self.expressions( 4128 expression, 4129 key="params", 4130 sep=sep, 4131 new_line=True, 4132 skip_last=True, 4133 skip_first=True, 4134 indent=self.COPY_PARAMS_ARE_WRAPPED, 4135 ) 4136 4137 if params: 4138 if self.COPY_PARAMS_ARE_WRAPPED: 4139 params = f" WITH ({params})" 4140 elif not self.pretty: 4141 params = f" {params}" 4142 4143 return f"COPY{this}{kind} {files}{credentials}{params}" 4144 4145 def semicolon_sql(self, expression: exp.Semicolon) -> str: 4146 return "" 4147 4148 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4149 on_sql = "ON" if expression.args.get("on") else "OFF" 4150 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4151 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4152 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4153 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4154 4155 if filter_col or retention_period: 4156 on_sql = self.func("ON", filter_col, retention_period) 4157 4158 return f"DATA_DELETION={on_sql}" 4159 4160 def maskingpolicycolumnconstraint_sql( 4161 self, expression: exp.MaskingPolicyColumnConstraint 4162 ) -> str: 4163 this = self.sql(expression, "this") 4164 expressions = self.expressions(expression, flat=True) 4165 expressions = f" USING ({expressions})" if expressions else "" 4166 return f"MASKING POLICY {this}{expressions}" 4167 4168 def gapfill_sql(self, expression: exp.GapFill) -> str: 4169 this = self.sql(expression, "this") 4170 this = f"TABLE {this}" 4171 return self.func("GAP_FILL", this, *[v for k, v in expression.args.items() if k != "this"]) 4172 4173 def scope_resolution(self, rhs: str, scope_name: str) -> str: 4174 return self.func("SCOPE_RESOLUTION", scope_name or None, rhs) 4175 4176 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4177 this = self.sql(expression, "this") 4178 expr = expression.expression 4179 4180 if isinstance(expr, exp.Func): 4181 # T-SQL's CLR functions are case sensitive 4182 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4183 else: 4184 expr = self.sql(expression, "expression") 4185 4186 return self.scope_resolution(expr, this) 4187 4188 def parsejson_sql(self, expression: exp.ParseJSON) -> str: 4189 if self.PARSE_JSON_NAME is None: 4190 return self.sql(expression.this) 4191 4192 return self.func(self.PARSE_JSON_NAME, expression.this, expression.expression) 4193 4194 def rand_sql(self, expression: exp.Rand) -> str: 4195 lower = self.sql(expression, "lower") 4196 upper = self.sql(expression, "upper") 4197 4198 if lower and upper: 4199 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4200 return self.func("RAND", expression.this) 4201 4202 def changes_sql(self, expression: exp.Changes) -> str: 4203 information = self.sql(expression, "information") 4204 information = f"INFORMATION => {information}" 4205 at_before = self.sql(expression, "at_before") 4206 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4207 end = self.sql(expression, "end") 4208 end = f"{self.seg('')}{end}" if end else "" 4209 4210 return f"CHANGES ({information}){at_before}{end}" 4211 4212 def pad_sql(self, expression: exp.Pad) -> str: 4213 prefix = "L" if expression.args.get("is_left") else "R" 4214 4215 fill_pattern = self.sql(expression, "fill_pattern") or None 4216 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4217 fill_pattern = "' '" 4218 4219 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern) 4220 4221 def summarize_sql(self, expression: exp.Summarize) -> str: 4222 table = " TABLE" if expression.args.get("table") else "" 4223 return f"SUMMARIZE{table} {self.sql(expression.this)}" 4224 4225 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4226 generate_series = exp.GenerateSeries(**expression.args) 4227 4228 parent = expression.parent 4229 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4230 parent = parent.parent 4231 4232 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4233 return self.sql(exp.Unnest(expressions=[generate_series])) 4234 4235 if isinstance(parent, exp.Select): 4236 self.unsupported("GenerateSeries projection unnesting is not supported.") 4237 4238 return self.sql(generate_series) 4239 4240 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4241 exprs = expression.expressions 4242 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4243 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4244 else: 4245 rhs = self.expressions(expression) 4246 4247 return self.func(name, expression.this, rhs) 4248 4249 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4250 if self.SUPPORTS_CONVERT_TIMEZONE: 4251 return self.function_fallback_sql(expression) 4252 4253 source_tz = expression.args.get("source_tz") 4254 target_tz = expression.args.get("target_tz") 4255 timestamp = expression.args.get("timestamp") 4256 4257 if source_tz and timestamp: 4258 timestamp = exp.AtTimeZone( 4259 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4260 ) 4261 4262 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4263 4264 return self.sql(expr) 4265 4266 def json_sql(self, expression: exp.JSON) -> str: 4267 this = self.sql(expression, "this") 4268 this = f" {this}" if this else "" 4269 4270 _with = expression.args.get("with") 4271 4272 if _with is None: 4273 with_sql = "" 4274 elif not _with: 4275 with_sql = " WITHOUT" 4276 else: 4277 with_sql = " WITH" 4278 4279 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4280 4281 return f"JSON{this}{with_sql}{unique_sql}" 4282 4283 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4284 def _generate_on_options(arg: t.Any) -> str: 4285 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4286 4287 path = self.sql(expression, "path") 4288 returning = self.sql(expression, "returning") 4289 returning = f" RETURNING {returning}" if returning else "" 4290 4291 on_condition = self.sql(expression, "on_condition") 4292 on_condition = f" {on_condition}" if on_condition else "" 4293 4294 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}") 4295 4296 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4297 else_ = "ELSE " if expression.args.get("else_") else "" 4298 condition = self.sql(expression, "expression") 4299 condition = f"WHEN {condition} THEN " if condition else else_ 4300 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4301 return f"{condition}{insert}" 4302 4303 def multitableinserts_sql(self, expression: exp.MultitableInserts) -> str: 4304 kind = self.sql(expression, "kind") 4305 expressions = self.seg(self.expressions(expression, sep=" ")) 4306 res = f"INSERT {kind}{expressions}{self.seg(self.sql(expression, 'source'))}" 4307 return res 4308 4309 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4310 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4311 empty = expression.args.get("empty") 4312 empty = ( 4313 f"DEFAULT {empty} ON EMPTY" 4314 if isinstance(empty, exp.Expression) 4315 else self.sql(expression, "empty") 4316 ) 4317 4318 error = expression.args.get("error") 4319 error = ( 4320 f"DEFAULT {error} ON ERROR" 4321 if isinstance(error, exp.Expression) 4322 else self.sql(expression, "error") 4323 ) 4324 4325 if error and empty: 4326 error = ( 4327 f"{empty} {error}" 4328 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4329 else f"{error} {empty}" 4330 ) 4331 empty = "" 4332 4333 null = self.sql(expression, "null") 4334 4335 return f"{empty}{error}{null}" 4336 4337 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4338 this = self.sql(expression, "this") 4339 path = self.sql(expression, "path") 4340 4341 passing = self.expressions(expression, "passing") 4342 passing = f" PASSING {passing}" if passing else "" 4343 4344 on_condition = self.sql(expression, "on_condition") 4345 on_condition = f" {on_condition}" if on_condition else "" 4346 4347 path = f"{path}{passing}{on_condition}" 4348 4349 return self.func("JSON_EXISTS", this, path) 4350 4351 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4352 array_agg = self.function_fallback_sql(expression) 4353 4354 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4355 parent = expression.parent 4356 if isinstance(parent, exp.Filter): 4357 parent_cond = parent.expression.this 4358 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4359 else: 4360 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4361 this = expression.this 4362 this_sql = ( 4363 self.expressions(this) 4364 if isinstance(this, exp.Distinct) 4365 else self.sql(expression, "this") 4366 ) 4367 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4368 4369 return array_agg 4370 4371 def apply_sql(self, expression: exp.Apply) -> str: 4372 this = self.sql(expression, "this") 4373 expr = self.sql(expression, "expression") 4374 4375 return f"{this} APPLY({expr})" 4376 4377 def grant_sql(self, expression: exp.Grant) -> str: 4378 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4379 4380 kind = self.sql(expression, "kind") 4381 kind = f" {kind}" if kind else "" 4382 4383 securable = self.sql(expression, "securable") 4384 securable = f" {securable}" if securable else "" 4385 4386 principals = self.expressions(expression, key="principals", flat=True) 4387 4388 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4389 4390 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}" 4391 4392 def grantprivilege_sql(self, expression: exp.GrantPrivilege): 4393 this = self.sql(expression, "this") 4394 columns = self.expressions(expression, flat=True) 4395 columns = f"({columns})" if columns else "" 4396 4397 return f"{this}{columns}" 4398 4399 def grantprincipal_sql(self, expression: exp.GrantPrincipal): 4400 this = self.sql(expression, "this") 4401 4402 kind = self.sql(expression, "kind") 4403 kind = f"{kind} " if kind else "" 4404 4405 return f"{kind}{this}" 4406 4407 def columns_sql(self, expression: exp.Columns): 4408 func = self.function_fallback_sql(expression) 4409 if expression.args.get("unpack"): 4410 func = f"*{func}" 4411 4412 return func 4413 4414 def overlay_sql(self, expression: exp.Overlay): 4415 this = self.sql(expression, "this") 4416 expr = self.sql(expression, "expression") 4417 from_sql = self.sql(expression, "from") 4418 for_sql = self.sql(expression, "for") 4419 for_sql = f" FOR {for_sql}" if for_sql else "" 4420 4421 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})"
Generator converts a given syntax tree to the corresponding SQL string.
Arguments:
- pretty: Whether 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 to normalize identifiers to lowercase. Default: False.
- pad: The pad size in a formatted string. For example, this affects the indentation of a projection in a query, relative to its nesting level. Default: 2.
- indent: The indentation size in a formatted string. For example, this affects the
indentation of subqueries and filters under a
WHERE
clause. Default: 2. - normalize_functions: How to normalize 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: Whether 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 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, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None)
639 def __init__( 640 self, 641 pretty: t.Optional[bool] = None, 642 identify: str | bool = False, 643 normalize: bool = False, 644 pad: int = 2, 645 indent: int = 2, 646 normalize_functions: t.Optional[str | bool] = None, 647 unsupported_level: ErrorLevel = ErrorLevel.WARN, 648 max_unsupported: int = 3, 649 leading_comma: bool = False, 650 max_text_width: int = 80, 651 comments: bool = True, 652 dialect: DialectType = None, 653 ): 654 import sqlglot 655 from sqlglot.dialects import Dialect 656 657 self.pretty = pretty if pretty is not None else sqlglot.pretty 658 self.identify = identify 659 self.normalize = normalize 660 self.pad = pad 661 self._indent = indent 662 self.unsupported_level = unsupported_level 663 self.max_unsupported = max_unsupported 664 self.leading_comma = leading_comma 665 self.max_text_width = max_text_width 666 self.comments = comments 667 self.dialect = Dialect.get_or_raise(dialect) 668 669 # This is both a Dialect property and a Generator argument, so we prioritize the latter 670 self.normalize_functions = ( 671 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 672 ) 673 674 self.unsupported_messages: t.List[str] = [] 675 self._escaped_quote_end: str = ( 676 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 677 ) 678 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 679 680 self._next_name = name_sequence("_t") 681 682 self._identifier_start = self.dialect.IDENTIFIER_START 683 self._identifier_end = self.dialect.IDENTIFIER_END
TRANSFORMS: Dict[Type[sqlglot.expressions.Expression], Callable[..., str]] =
{<class 'sqlglot.expressions.JSONPathFilter'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathKey'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathRecursive'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathRoot'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathScript'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathSelector'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathSlice'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathSubscript'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathUnion'>: <function <lambda>>, <class 'sqlglot.expressions.JSONPathWildcard'>: <function <lambda>>, <class 'sqlglot.expressions.AllowedValuesProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ArrayContainsAll'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ArrayOverlaps'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.AutoRefreshProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.BackupProperty'>: <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.ClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CollateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CommentColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ConnectByRoot'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CopyGrantsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DateFormatColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DefaultColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DynamicProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.EmptyProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.EncodeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.EphemeralColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExcludeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExecuteAsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Except'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExternalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.GlobalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.HeapProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.IcebergProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InheritsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InlineLengthColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Intersect'>: <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.NonClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NoPrimaryIndexProperty'>: <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.Operator'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OutputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.PathColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.PivotAny'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ProjectionPolicyColumnConstraint'>: <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.SecureProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SecurityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SetConfigProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SettingsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SharingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SqlReadWriteProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SqlSecurityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.StabilityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Stream'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.StreamingTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.StrictProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TemporaryProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TagColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TitleColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ToMap'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ToTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TransformModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TransientProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Union'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.UnloggedProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Uuid'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.UppercaseColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.VarMap'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ViewAttributeProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.VolatileProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithJournalTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithSchemaBindingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithOperator'>: <function Generator.<lambda>>}
SUPPORTED_JSON_PATH_PARTS =
{<class 'sqlglot.expressions.JSONPathKey'>, <class 'sqlglot.expressions.JSONPathWildcard'>, <class 'sqlglot.expressions.JSONPathFilter'>, <class 'sqlglot.expressions.JSONPathUnion'>, <class 'sqlglot.expressions.JSONPathSubscript'>, <class 'sqlglot.expressions.JSONPathSelector'>, <class 'sqlglot.expressions.JSONPathSlice'>, <class 'sqlglot.expressions.JSONPathScript'>, <class 'sqlglot.expressions.JSONPathRoot'>, <class 'sqlglot.expressions.JSONPathRecursive'>}
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', <Type.ROWVERSION: 'ROWVERSION'>: 'VARBINARY'}
TIME_PART_SINGULARS =
{'MICROSECONDS': 'MICROSECOND', 'SECONDS': 'SECOND', 'MINUTES': 'MINUTE', 'HOURS': 'HOUR', 'DAYS': 'DAY', 'WEEKS': 'WEEK', 'MONTHS': 'MONTH', 'QUARTERS': 'QUARTER', 'YEARS': 'YEAR'}
AFTER_HAVING_MODIFIER_TRANSFORMS =
{'cluster': <function Generator.<lambda>>, 'distribute': <function Generator.<lambda>>, 'sort': <function Generator.<lambda>>, 'windows': <function Generator.<lambda>>, 'qualify': <function Generator.<lambda>>}
PROPERTIES_LOCATION =
{<class 'sqlglot.expressions.AllowedValuesProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.AlgorithmProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.AutoIncrementProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.AutoRefreshProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.BackupProperty'>: <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.DistributedByProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DuplicateKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DataBlocksizeProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.DataDeletionProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <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.DynamicProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.DistKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DistStyleProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.EmptyProperty'>: <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.GlobalProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.HeapProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.InheritsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.IcebergProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <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.LockProperty'>: <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.SecureProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.SecurityProperty'>: <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.SetConfigProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SharingProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.SequenceProperties'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.SortKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SqlReadWriteProperty'>: <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.StreamingTableProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.StrictProperty'>: <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.UnloggedProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.ViewAttributeProperty'>: <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.WithSchemaBindingProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.WithSystemVersioningProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>}
WITH_SEPARATED_COMMENTS: Tuple[Type[sqlglot.expressions.Expression], ...] =
(<class 'sqlglot.expressions.Command'>, <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.MultitableInserts'>, <class 'sqlglot.expressions.Select'>, <class 'sqlglot.expressions.SetOperation'>, <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.SetOperation'>)
UNWRAPPED_INTERVAL_VALUES: Tuple[Type[sqlglot.expressions.Expression], ...] =
(<class 'sqlglot.expressions.Column'>, <class 'sqlglot.expressions.Literal'>, <class 'sqlglot.expressions.Neg'>, <class 'sqlglot.expressions.Paren'>)
PARAMETERIZABLE_TEXT_TYPES =
{<Type.NCHAR: 'NCHAR'>, <Type.CHAR: 'CHAR'>, <Type.VARCHAR: 'VARCHAR'>, <Type.NVARCHAR: 'NVARCHAR'>}
685 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 686 """ 687 Generates the SQL string corresponding to the given syntax tree. 688 689 Args: 690 expression: The syntax tree. 691 copy: Whether to copy the expression. The generator performs mutations so 692 it is safer to copy. 693 694 Returns: 695 The SQL string corresponding to `expression`. 696 """ 697 if copy: 698 expression = expression.copy() 699 700 expression = self.preprocess(expression) 701 702 self.unsupported_messages = [] 703 sql = self.sql(expression).strip() 704 705 if self.pretty: 706 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 707 708 if self.unsupported_level == ErrorLevel.IGNORE: 709 return sql 710 711 if self.unsupported_level == ErrorLevel.WARN: 712 for msg in self.unsupported_messages: 713 logger.warning(msg) 714 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 715 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 716 717 return sql
Generates the SQL string corresponding to the given syntax tree.
Arguments:
- expression: The syntax tree.
- copy: Whether to copy the expression. The generator performs mutations so it is safer to copy.
Returns:
The SQL string corresponding to
expression
.
def
preprocess( self, expression: sqlglot.expressions.Expression) -> sqlglot.expressions.Expression:
719 def preprocess(self, expression: exp.Expression) -> exp.Expression: 720 """Apply generic preprocessing transformations to a given expression.""" 721 expression = self._move_ctes_to_top_level(expression) 722 723 if self.ENSURE_BOOLS: 724 from sqlglot.transforms import ensure_bools 725 726 expression = ensure_bools(expression) 727 728 return expression
Apply generic preprocessing transformations to a given expression.
def
maybe_comment( self, sql: str, expression: Optional[sqlglot.expressions.Expression] = None, comments: Optional[List[str]] = None, separated: bool = False) -> str:
757 def maybe_comment( 758 self, 759 sql: str, 760 expression: t.Optional[exp.Expression] = None, 761 comments: t.Optional[t.List[str]] = None, 762 separated: bool = False, 763 ) -> str: 764 comments = ( 765 ((expression and expression.comments) if comments is None else comments) # type: ignore 766 if self.comments 767 else None 768 ) 769 770 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 771 return sql 772 773 comments_sql = " ".join( 774 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 775 ) 776 777 if not comments_sql: 778 return sql 779 780 comments_sql = self._replace_line_breaks(comments_sql) 781 782 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 783 return ( 784 f"{self.sep()}{comments_sql}{sql}" 785 if not sql or sql[0].isspace() 786 else f"{comments_sql}{self.sep()}{sql}" 787 ) 788 789 return f"{sql} {comments_sql}"
791 def wrap(self, expression: exp.Expression | str) -> str: 792 this_sql = ( 793 self.sql(expression) 794 if isinstance(expression, exp.UNWRAPPED_QUERIES) 795 else self.sql(expression, "this") 796 ) 797 if not this_sql: 798 return "()" 799 800 this_sql = self.indent(this_sql, level=1, pad=0) 801 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:
817 def indent( 818 self, 819 sql: str, 820 level: int = 0, 821 pad: t.Optional[int] = None, 822 skip_first: bool = False, 823 skip_last: bool = False, 824 ) -> str: 825 if not self.pretty or not sql: 826 return sql 827 828 pad = self.pad if pad is None else pad 829 lines = sql.split("\n") 830 831 return "\n".join( 832 ( 833 line 834 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 835 else f"{' ' * (level * self._indent + pad)}{line}" 836 ) 837 for i, line in enumerate(lines) 838 )
def
sql( self, expression: Union[str, sqlglot.expressions.Expression, NoneType], key: Optional[str] = None, comment: bool = True) -> str:
840 def sql( 841 self, 842 expression: t.Optional[str | exp.Expression], 843 key: t.Optional[str] = None, 844 comment: bool = True, 845 ) -> str: 846 if not expression: 847 return "" 848 849 if isinstance(expression, str): 850 return expression 851 852 if key: 853 value = expression.args.get(key) 854 if value: 855 return self.sql(value) 856 return "" 857 858 transform = self.TRANSFORMS.get(expression.__class__) 859 860 if callable(transform): 861 sql = transform(self, expression) 862 elif isinstance(expression, exp.Expression): 863 exp_handler_name = f"{expression.key}_sql" 864 865 if hasattr(self, exp_handler_name): 866 sql = getattr(self, exp_handler_name)(expression) 867 elif isinstance(expression, exp.Func): 868 sql = self.function_fallback_sql(expression) 869 elif isinstance(expression, exp.Property): 870 sql = self.property_sql(expression) 871 else: 872 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 873 else: 874 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 875 876 return self.maybe_comment(sql, expression) if self.comments and comment else sql
883 def cache_sql(self, expression: exp.Cache) -> str: 884 lazy = " LAZY" if expression.args.get("lazy") else "" 885 table = self.sql(expression, "this") 886 options = expression.args.get("options") 887 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 888 sql = self.sql(expression, "expression") 889 sql = f" AS{self.sep()}{sql}" if sql else "" 890 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 891 return self.prepend_ctes(expression, sql)
893 def characterset_sql(self, expression: exp.CharacterSet) -> str: 894 if isinstance(expression.parent, exp.Cast): 895 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 896 default = "DEFAULT " if expression.args.get("default") else "" 897 return f"{default}CHARACTER SET={self.sql(expression, 'this')}"
911 def column_sql(self, expression: exp.Column) -> str: 912 join_mark = " (+)" if expression.args.get("join_mark") else "" 913 914 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 915 join_mark = "" 916 self.unsupported("Outer join syntax using the (+) operator is not supported.") 917 918 return f"{self.column_parts(expression)}{join_mark}"
926 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 927 column = self.sql(expression, "this") 928 kind = self.sql(expression, "kind") 929 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 930 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 931 kind = f"{sep}{kind}" if kind else "" 932 constraints = f" {constraints}" if constraints else "" 933 position = self.sql(expression, "position") 934 position = f" {position}" if position else "" 935 936 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 937 kind = "" 938 939 return f"{exists}{column}{kind}{constraints}{position}"
def
computedcolumnconstraint_sql(self, expression: sqlglot.expressions.ComputedColumnConstraint) -> str:
946 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 947 this = self.sql(expression, "this") 948 if expression.args.get("not_null"): 949 persisted = " PERSISTED NOT NULL" 950 elif expression.args.get("persisted"): 951 persisted = " PERSISTED" 952 else: 953 persisted = "" 954 return f"AS {this}{persisted}"
def
compresscolumnconstraint_sql(self, expression: sqlglot.expressions.CompressColumnConstraint) -> str:
def
generatedasidentitycolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsIdentityColumnConstraint) -> str:
967 def generatedasidentitycolumnconstraint_sql( 968 self, expression: exp.GeneratedAsIdentityColumnConstraint 969 ) -> str: 970 this = "" 971 if expression.this is not None: 972 on_null = " ON NULL" if expression.args.get("on_null") else "" 973 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 974 975 start = expression.args.get("start") 976 start = f"START WITH {start}" if start else "" 977 increment = expression.args.get("increment") 978 increment = f" INCREMENT BY {increment}" if increment else "" 979 minvalue = expression.args.get("minvalue") 980 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 981 maxvalue = expression.args.get("maxvalue") 982 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 983 cycle = expression.args.get("cycle") 984 cycle_sql = "" 985 986 if cycle is not None: 987 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 988 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 989 990 sequence_opts = "" 991 if start or increment or cycle_sql: 992 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 993 sequence_opts = f" ({sequence_opts.strip()})" 994 995 expr = self.sql(expression, "expression") 996 expr = f"({expr})" if expr else "IDENTITY" 997 998 return f"GENERATED{this} AS {expr}{sequence_opts}"
def
generatedasrowcolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsRowColumnConstraint) -> str:
1000 def generatedasrowcolumnconstraint_sql( 1001 self, expression: exp.GeneratedAsRowColumnConstraint 1002 ) -> str: 1003 start = "START" if expression.args.get("start") else "END" 1004 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1005 return f"GENERATED ALWAYS AS ROW {start}{hidden}"
def
periodforsystemtimeconstraint_sql( self, expression: sqlglot.expressions.PeriodForSystemTimeConstraint) -> str:
def
notnullcolumnconstraint_sql(self, expression: sqlglot.expressions.NotNullColumnConstraint) -> str:
def
transformcolumnconstraint_sql(self, expression: sqlglot.expressions.TransformColumnConstraint) -> str:
def
primarykeycolumnconstraint_sql(self, expression: sqlglot.expressions.PrimaryKeyColumnConstraint) -> str:
def
uniquecolumnconstraint_sql(self, expression: sqlglot.expressions.UniqueColumnConstraint) -> str:
1024 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1025 this = self.sql(expression, "this") 1026 this = f" {this}" if this else "" 1027 index_type = expression.args.get("index_type") 1028 index_type = f" USING {index_type}" if index_type else "" 1029 on_conflict = self.sql(expression, "on_conflict") 1030 on_conflict = f" {on_conflict}" if on_conflict else "" 1031 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1032 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}"
1037 def create_sql(self, expression: exp.Create) -> str: 1038 kind = self.sql(expression, "kind") 1039 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1040 properties = expression.args.get("properties") 1041 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1042 1043 this = self.createable_sql(expression, properties_locs) 1044 1045 properties_sql = "" 1046 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1047 exp.Properties.Location.POST_WITH 1048 ): 1049 properties_sql = self.sql( 1050 exp.Properties( 1051 expressions=[ 1052 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1053 *properties_locs[exp.Properties.Location.POST_WITH], 1054 ] 1055 ) 1056 ) 1057 1058 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1059 properties_sql = self.sep() + properties_sql 1060 elif not self.pretty: 1061 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1062 properties_sql = f" {properties_sql}" 1063 1064 begin = " BEGIN" if expression.args.get("begin") else "" 1065 end = " END" if expression.args.get("end") else "" 1066 1067 expression_sql = self.sql(expression, "expression") 1068 if expression_sql: 1069 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1070 1071 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1072 postalias_props_sql = "" 1073 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1074 postalias_props_sql = self.properties( 1075 exp.Properties( 1076 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1077 ), 1078 wrapped=False, 1079 ) 1080 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1081 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1082 1083 postindex_props_sql = "" 1084 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1085 postindex_props_sql = self.properties( 1086 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1087 wrapped=False, 1088 prefix=" ", 1089 ) 1090 1091 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1092 indexes = f" {indexes}" if indexes else "" 1093 index_sql = indexes + postindex_props_sql 1094 1095 replace = " OR REPLACE" if expression.args.get("replace") else "" 1096 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1097 unique = " UNIQUE" if expression.args.get("unique") else "" 1098 1099 clustered = expression.args.get("clustered") 1100 if clustered is None: 1101 clustered_sql = "" 1102 elif clustered: 1103 clustered_sql = " CLUSTERED COLUMNSTORE" 1104 else: 1105 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1106 1107 postcreate_props_sql = "" 1108 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1109 postcreate_props_sql = self.properties( 1110 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1111 sep=" ", 1112 prefix=" ", 1113 wrapped=False, 1114 ) 1115 1116 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1117 1118 postexpression_props_sql = "" 1119 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1120 postexpression_props_sql = self.properties( 1121 exp.Properties( 1122 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1123 ), 1124 sep=" ", 1125 prefix=" ", 1126 wrapped=False, 1127 ) 1128 1129 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1130 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1131 no_schema_binding = ( 1132 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1133 ) 1134 1135 clone = self.sql(expression, "clone") 1136 clone = f" {clone}" if clone else "" 1137 1138 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_sql}{expression_sql}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1139 return self.prepend_ctes(expression, expression_sql)
1141 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1142 start = self.sql(expression, "start") 1143 start = f"START WITH {start}" if start else "" 1144 increment = self.sql(expression, "increment") 1145 increment = f" INCREMENT BY {increment}" if increment else "" 1146 minvalue = self.sql(expression, "minvalue") 1147 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1148 maxvalue = self.sql(expression, "maxvalue") 1149 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1150 owned = self.sql(expression, "owned") 1151 owned = f" OWNED BY {owned}" if owned else "" 1152 1153 cache = expression.args.get("cache") 1154 if cache is None: 1155 cache_str = "" 1156 elif cache is True: 1157 cache_str = " CACHE" 1158 else: 1159 cache_str = f" CACHE {cache}" 1160 1161 options = self.expressions(expression, key="options", flat=True, sep=" ") 1162 options = f" {options}" if options else "" 1163 1164 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip()
1166 def clone_sql(self, expression: exp.Clone) -> str: 1167 this = self.sql(expression, "this") 1168 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1169 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1170 return f"{shallow}{keyword} {this}"
1172 def describe_sql(self, expression: exp.Describe) -> str: 1173 style = expression.args.get("style") 1174 style = f" {style}" if style else "" 1175 partition = self.sql(expression, "partition") 1176 partition = f" {partition}" if partition else "" 1177 return f"DESCRIBE{style} {self.sql(expression, 'this')}{partition}"
1199 def cte_sql(self, expression: exp.CTE) -> str: 1200 alias = expression.args.get("alias") 1201 if alias: 1202 alias.add_comments(expression.pop_comments()) 1203 1204 alias_sql = self.sql(expression, "alias") 1205 1206 materialized = expression.args.get("materialized") 1207 if materialized is False: 1208 materialized = "NOT MATERIALIZED " 1209 elif materialized: 1210 materialized = "MATERIALIZED " 1211 1212 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}"
1214 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1215 alias = self.sql(expression, "this") 1216 columns = self.expressions(expression, key="columns", flat=True) 1217 columns = f"({columns})" if columns else "" 1218 1219 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1220 columns = "" 1221 self.unsupported("Named columns are not supported in table alias.") 1222 1223 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1224 alias = self._next_name() 1225 1226 return f"{alias}{columns}"
1246 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1247 this = self.sql(expression, "this") 1248 escape = expression.args.get("escape") 1249 1250 if self.dialect.UNICODE_START: 1251 escape_substitute = r"\\\1" 1252 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1253 else: 1254 escape_substitute = r"\\u\1" 1255 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1256 1257 if escape: 1258 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1259 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1260 else: 1261 escape_pattern = ESCAPED_UNICODE_RE 1262 escape_sql = "" 1263 1264 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1265 this = escape_pattern.sub(escape_substitute, this) 1266 1267 return f"{left_quote}{this}{right_quote}{escape_sql}"
1279 def datatype_sql(self, expression: exp.DataType) -> str: 1280 nested = "" 1281 values = "" 1282 interior = self.expressions(expression, flat=True) 1283 1284 type_value = expression.this 1285 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1286 type_sql = self.sql(expression, "kind") 1287 else: 1288 type_sql = ( 1289 self.TYPE_MAPPING.get(type_value, type_value.value) 1290 if isinstance(type_value, exp.DataType.Type) 1291 else type_value 1292 ) 1293 1294 if interior: 1295 if expression.args.get("nested"): 1296 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1297 if expression.args.get("values") is not None: 1298 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1299 values = self.expressions(expression, key="values", flat=True) 1300 values = f"{delimiters[0]}{values}{delimiters[1]}" 1301 elif type_value == exp.DataType.Type.INTERVAL: 1302 nested = f" {interior}" 1303 else: 1304 nested = f"({interior})" 1305 1306 type_sql = f"{type_sql}{nested}{values}" 1307 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1308 exp.DataType.Type.TIMETZ, 1309 exp.DataType.Type.TIMESTAMPTZ, 1310 ): 1311 type_sql = f"{type_sql} WITH TIME ZONE" 1312 1313 return type_sql
1315 def directory_sql(self, expression: exp.Directory) -> str: 1316 local = "LOCAL " if expression.args.get("local") else "" 1317 row_format = self.sql(expression, "row_format") 1318 row_format = f" {row_format}" if row_format else "" 1319 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}"
1321 def delete_sql(self, expression: exp.Delete) -> str: 1322 this = self.sql(expression, "this") 1323 this = f" FROM {this}" if this else "" 1324 using = self.sql(expression, "using") 1325 using = f" USING {using}" if using else "" 1326 cluster = self.sql(expression, "cluster") 1327 cluster = f" {cluster}" if cluster else "" 1328 where = self.sql(expression, "where") 1329 returning = self.sql(expression, "returning") 1330 limit = self.sql(expression, "limit") 1331 tables = self.expressions(expression, key="tables") 1332 tables = f" {tables}" if tables else "" 1333 if self.RETURNING_END: 1334 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1335 else: 1336 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1337 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}")
1339 def drop_sql(self, expression: exp.Drop) -> str: 1340 this = self.sql(expression, "this") 1341 expressions = self.expressions(expression, flat=True) 1342 expressions = f" ({expressions})" if expressions else "" 1343 kind = expression.args["kind"] 1344 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1345 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1346 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1347 on_cluster = self.sql(expression, "cluster") 1348 on_cluster = f" {on_cluster}" if on_cluster else "" 1349 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1350 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1351 cascade = " CASCADE" if expression.args.get("cascade") else "" 1352 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1353 purge = " PURGE" if expression.args.get("purge") else "" 1354 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}"
1356 def set_operation(self, expression: exp.SetOperation) -> str: 1357 op_type = type(expression) 1358 op_name = op_type.key.upper() 1359 1360 distinct = expression.args.get("distinct") 1361 if ( 1362 distinct is False 1363 and op_type in (exp.Except, exp.Intersect) 1364 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1365 ): 1366 self.unsupported(f"{op_name} ALL is not supported") 1367 1368 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1369 1370 if distinct is None: 1371 distinct = default_distinct 1372 if distinct is None: 1373 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1374 1375 if distinct is default_distinct: 1376 kind = "" 1377 else: 1378 kind = " DISTINCT" if distinct else " ALL" 1379 1380 by_name = " BY NAME" if expression.args.get("by_name") else "" 1381 return f"{op_name}{kind}{by_name}"
1383 def set_operations(self, expression: exp.SetOperation) -> str: 1384 if not self.SET_OP_MODIFIERS: 1385 limit = expression.args.get("limit") 1386 order = expression.args.get("order") 1387 1388 if limit or order: 1389 select = self._move_ctes_to_top_level( 1390 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1391 ) 1392 1393 if limit: 1394 select = select.limit(limit.pop(), copy=False) 1395 if order: 1396 select = select.order_by(order.pop(), copy=False) 1397 return self.sql(select) 1398 1399 sqls: t.List[str] = [] 1400 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1401 1402 while stack: 1403 node = stack.pop() 1404 1405 if isinstance(node, exp.SetOperation): 1406 stack.append(node.expression) 1407 stack.append( 1408 self.maybe_comment( 1409 self.set_operation(node), comments=node.comments, separated=True 1410 ) 1411 ) 1412 stack.append(node.this) 1413 else: 1414 sqls.append(self.sql(node)) 1415 1416 this = self.sep().join(sqls) 1417 this = self.query_modifiers(expression, this) 1418 return self.prepend_ctes(expression, this)
1420 def fetch_sql(self, expression: exp.Fetch) -> str: 1421 direction = expression.args.get("direction") 1422 direction = f" {direction}" if direction else "" 1423 count = self.sql(expression, "count") 1424 count = f" {count}" if count else "" 1425 if expression.args.get("percent"): 1426 count = f"{count} PERCENT" 1427 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1428 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}"
1430 def filter_sql(self, expression: exp.Filter) -> str: 1431 if self.AGGREGATE_FILTER_SUPPORTED: 1432 this = self.sql(expression, "this") 1433 where = self.sql(expression, "expression").strip() 1434 return f"{this} FILTER({where})" 1435 1436 agg = expression.this 1437 agg_arg = agg.this 1438 cond = expression.expression.this 1439 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1440 return self.sql(agg)
1449 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1450 using = self.sql(expression, "using") 1451 using = f" USING {using}" if using else "" 1452 columns = self.expressions(expression, key="columns", flat=True) 1453 columns = f"({columns})" if columns else "" 1454 partition_by = self.expressions(expression, key="partition_by", flat=True) 1455 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1456 where = self.sql(expression, "where") 1457 include = self.expressions(expression, key="include", flat=True) 1458 if include: 1459 include = f" INCLUDE ({include})" 1460 with_storage = self.expressions(expression, key="with_storage", flat=True) 1461 with_storage = f" WITH ({with_storage})" if with_storage else "" 1462 tablespace = self.sql(expression, "tablespace") 1463 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1464 on = self.sql(expression, "on") 1465 on = f" ON {on}" if on else "" 1466 1467 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}"
1469 def index_sql(self, expression: exp.Index) -> str: 1470 unique = "UNIQUE " if expression.args.get("unique") else "" 1471 primary = "PRIMARY " if expression.args.get("primary") else "" 1472 amp = "AMP " if expression.args.get("amp") else "" 1473 name = self.sql(expression, "this") 1474 name = f"{name} " if name else "" 1475 table = self.sql(expression, "table") 1476 table = f"{self.INDEX_ON} {table}" if table else "" 1477 1478 index = "INDEX " if not table else "" 1479 1480 params = self.sql(expression, "params") 1481 return f"{unique}{primary}{amp}{index}{name}{table}{params}"
1483 def identifier_sql(self, expression: exp.Identifier) -> str: 1484 text = expression.name 1485 lower = text.lower() 1486 text = lower if self.normalize and not expression.quoted else text 1487 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1488 if ( 1489 expression.quoted 1490 or self.dialect.can_identify(text, self.identify) 1491 or lower in self.RESERVED_KEYWORDS 1492 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1493 ): 1494 text = f"{self._identifier_start}{text}{self._identifier_end}" 1495 return text
1510 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1511 input_format = self.sql(expression, "input_format") 1512 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1513 output_format = self.sql(expression, "output_format") 1514 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1515 return self.sep().join((input_format, output_format))
1524 def properties_sql(self, expression: exp.Properties) -> str: 1525 root_properties = [] 1526 with_properties = [] 1527 1528 for p in expression.expressions: 1529 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1530 if p_loc == exp.Properties.Location.POST_WITH: 1531 with_properties.append(p) 1532 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1533 root_properties.append(p) 1534 1535 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1536 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1537 1538 if root_props and with_props and not self.pretty: 1539 with_props = " " + with_props 1540 1541 return root_props + with_props
def
properties( self, properties: sqlglot.expressions.Properties, prefix: str = '', sep: str = ', ', suffix: str = '', wrapped: bool = True) -> str:
1548 def properties( 1549 self, 1550 properties: exp.Properties, 1551 prefix: str = "", 1552 sep: str = ", ", 1553 suffix: str = "", 1554 wrapped: bool = True, 1555 ) -> str: 1556 if properties.expressions: 1557 expressions = self.expressions(properties, sep=sep, indent=False) 1558 if expressions: 1559 expressions = self.wrap(expressions) if wrapped else expressions 1560 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1561 return ""
1566 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1567 properties_locs = defaultdict(list) 1568 for p in properties.expressions: 1569 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1570 if p_loc != exp.Properties.Location.UNSUPPORTED: 1571 properties_locs[p_loc].append(p) 1572 else: 1573 self.unsupported(f"Unsupported property {p.key}") 1574 1575 return properties_locs
def
property_name( self, expression: sqlglot.expressions.Property, string_key: bool = False) -> str:
1582 def property_sql(self, expression: exp.Property) -> str: 1583 property_cls = expression.__class__ 1584 if property_cls == exp.Property: 1585 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1586 1587 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1588 if not property_name: 1589 self.unsupported(f"Unsupported property {expression.key}") 1590 1591 return f"{property_name}={self.sql(expression, 'this')}"
1593 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1594 if self.SUPPORTS_CREATE_TABLE_LIKE: 1595 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1596 options = f" {options}" if options else "" 1597 1598 like = f"LIKE {self.sql(expression, 'this')}{options}" 1599 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1600 like = f"({like})" 1601 1602 return like 1603 1604 if expression.expressions: 1605 self.unsupported("Transpilation of LIKE property options is unsupported") 1606 1607 select = exp.select("*").from_(expression.this).limit(0) 1608 return f"AS {self.sql(select)}"
1615 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1616 no = "NO " if expression.args.get("no") else "" 1617 local = expression.args.get("local") 1618 local = f"{local} " if local else "" 1619 dual = "DUAL " if expression.args.get("dual") else "" 1620 before = "BEFORE " if expression.args.get("before") else "" 1621 after = "AFTER " if expression.args.get("after") else "" 1622 return f"{no}{local}{dual}{before}{after}JOURNAL"
def
mergeblockratioproperty_sql(self, expression: sqlglot.expressions.MergeBlockRatioProperty) -> str:
1638 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1639 if expression.args.get("no"): 1640 return "NO MERGEBLOCKRATIO" 1641 if expression.args.get("default"): 1642 return "DEFAULT MERGEBLOCKRATIO" 1643 1644 percent = " PERCENT" if expression.args.get("percent") else "" 1645 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}"
1647 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1648 default = expression.args.get("default") 1649 minimum = expression.args.get("minimum") 1650 maximum = expression.args.get("maximum") 1651 if default or minimum or maximum: 1652 if default: 1653 prop = "DEFAULT" 1654 elif minimum: 1655 prop = "MINIMUM" 1656 else: 1657 prop = "MAXIMUM" 1658 return f"{prop} DATABLOCKSIZE" 1659 units = expression.args.get("units") 1660 units = f" {units}" if units else "" 1661 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}"
def
blockcompressionproperty_sql(self, expression: sqlglot.expressions.BlockCompressionProperty) -> str:
1663 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1664 autotemp = expression.args.get("autotemp") 1665 always = expression.args.get("always") 1666 default = expression.args.get("default") 1667 manual = expression.args.get("manual") 1668 never = expression.args.get("never") 1669 1670 if autotemp is not None: 1671 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1672 elif always: 1673 prop = "ALWAYS" 1674 elif default: 1675 prop = "DEFAULT" 1676 elif manual: 1677 prop = "MANUAL" 1678 elif never: 1679 prop = "NEVER" 1680 return f"BLOCKCOMPRESSION={prop}"
def
isolatedloadingproperty_sql(self, expression: sqlglot.expressions.IsolatedLoadingProperty) -> str:
1682 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1683 no = expression.args.get("no") 1684 no = " NO" if no else "" 1685 concurrent = expression.args.get("concurrent") 1686 concurrent = " CONCURRENT" if concurrent else "" 1687 target = self.sql(expression, "target") 1688 target = f" {target}" if target else "" 1689 return f"WITH{no}{concurrent} ISOLATED LOADING{target}"
1691 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1692 if isinstance(expression.this, list): 1693 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1694 if expression.this: 1695 modulus = self.sql(expression, "this") 1696 remainder = self.sql(expression, "expression") 1697 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1698 1699 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1700 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1701 return f"FROM ({from_expressions}) TO ({to_expressions})"
1703 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1704 this = self.sql(expression, "this") 1705 1706 for_values_or_default = expression.expression 1707 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1708 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1709 else: 1710 for_values_or_default = " DEFAULT" 1711 1712 return f"PARTITION OF {this}{for_values_or_default}"
1714 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1715 kind = expression.args.get("kind") 1716 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1717 for_or_in = expression.args.get("for_or_in") 1718 for_or_in = f" {for_or_in}" if for_or_in else "" 1719 lock_type = expression.args.get("lock_type") 1720 override = " OVERRIDE" if expression.args.get("override") else "" 1721 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}"
1723 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1724 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1725 statistics = expression.args.get("statistics") 1726 statistics_sql = "" 1727 if statistics is not None: 1728 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1729 return f"{data_sql}{statistics_sql}"
def
withsystemversioningproperty_sql( self, expression: sqlglot.expressions.WithSystemVersioningProperty) -> str:
1731 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1732 this = self.sql(expression, "this") 1733 this = f"HISTORY_TABLE={this}" if this else "" 1734 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1735 data_consistency = ( 1736 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1737 ) 1738 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1739 retention_period = ( 1740 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1741 ) 1742 1743 if this: 1744 on_sql = self.func("ON", this, data_consistency, retention_period) 1745 else: 1746 on_sql = "ON" if expression.args.get("on") else "OFF" 1747 1748 sql = f"SYSTEM_VERSIONING={on_sql}" 1749 1750 return f"WITH({sql})" if expression.args.get("with") else sql
1752 def insert_sql(self, expression: exp.Insert) -> str: 1753 hint = self.sql(expression, "hint") 1754 overwrite = expression.args.get("overwrite") 1755 1756 if isinstance(expression.this, exp.Directory): 1757 this = " OVERWRITE" if overwrite else " INTO" 1758 else: 1759 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1760 1761 stored = self.sql(expression, "stored") 1762 stored = f" {stored}" if stored else "" 1763 alternative = expression.args.get("alternative") 1764 alternative = f" OR {alternative}" if alternative else "" 1765 ignore = " IGNORE" if expression.args.get("ignore") else "" 1766 is_function = expression.args.get("is_function") 1767 if is_function: 1768 this = f"{this} FUNCTION" 1769 this = f"{this} {self.sql(expression, 'this')}" 1770 1771 exists = " IF EXISTS" if expression.args.get("exists") else "" 1772 where = self.sql(expression, "where") 1773 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1774 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1775 on_conflict = self.sql(expression, "conflict") 1776 on_conflict = f" {on_conflict}" if on_conflict else "" 1777 by_name = " BY NAME" if expression.args.get("by_name") else "" 1778 returning = self.sql(expression, "returning") 1779 1780 if self.RETURNING_END: 1781 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1782 else: 1783 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1784 1785 partition_by = self.sql(expression, "partition") 1786 partition_by = f" {partition_by}" if partition_by else "" 1787 settings = self.sql(expression, "settings") 1788 settings = f" {settings}" if settings else "" 1789 1790 source = self.sql(expression, "source") 1791 source = f"TABLE {source}" if source else "" 1792 1793 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1794 return self.prepend_ctes(expression, sql)
1812 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1813 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1814 1815 constraint = self.sql(expression, "constraint") 1816 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1817 1818 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1819 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1820 action = self.sql(expression, "action") 1821 1822 expressions = self.expressions(expression, flat=True) 1823 if expressions: 1824 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1825 expressions = f" {set_keyword}{expressions}" 1826 1827 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}"
def
rowformatdelimitedproperty_sql(self, expression: sqlglot.expressions.RowFormatDelimitedProperty) -> str:
1832 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1833 fields = self.sql(expression, "fields") 1834 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1835 escaped = self.sql(expression, "escaped") 1836 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1837 items = self.sql(expression, "collection_items") 1838 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1839 keys = self.sql(expression, "map_keys") 1840 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1841 lines = self.sql(expression, "lines") 1842 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1843 null = self.sql(expression, "null") 1844 null = f" NULL DEFINED AS {null}" if null else "" 1845 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}"
1873 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1874 table = self.table_parts(expression) 1875 only = "ONLY " if expression.args.get("only") else "" 1876 partition = self.sql(expression, "partition") 1877 partition = f" {partition}" if partition else "" 1878 version = self.sql(expression, "version") 1879 version = f" {version}" if version else "" 1880 alias = self.sql(expression, "alias") 1881 alias = f"{sep}{alias}" if alias else "" 1882 1883 sample = self.sql(expression, "sample") 1884 if self.dialect.ALIAS_POST_TABLESAMPLE: 1885 sample_pre_alias = sample 1886 sample_post_alias = "" 1887 else: 1888 sample_pre_alias = "" 1889 sample_post_alias = sample 1890 1891 hints = self.expressions(expression, key="hints", sep=" ") 1892 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1893 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1894 joins = self.indent( 1895 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1896 ) 1897 laterals = self.expressions(expression, key="laterals", sep="") 1898 1899 file_format = self.sql(expression, "format") 1900 if file_format: 1901 pattern = self.sql(expression, "pattern") 1902 pattern = f", PATTERN => {pattern}" if pattern else "" 1903 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1904 1905 ordinality = expression.args.get("ordinality") or "" 1906 if ordinality: 1907 ordinality = f" WITH ORDINALITY{alias}" 1908 alias = "" 1909 1910 when = self.sql(expression, "when") 1911 if when: 1912 table = f"{table} {when}" 1913 1914 changes = self.sql(expression, "changes") 1915 changes = f" {changes}" if changes else "" 1916 1917 rows_from = self.expressions(expression, key="rows_from") 1918 if rows_from: 1919 table = f"ROWS FROM {self.wrap(rows_from)}" 1920 1921 return f"{only}{table}{changes}{partition}{version}{file_format}{sample_pre_alias}{alias}{hints}{pivots}{sample_post_alias}{joins}{laterals}{ordinality}"
def
tablesample_sql( self, expression: sqlglot.expressions.TableSample, tablesample_keyword: Optional[str] = None) -> str:
1923 def tablesample_sql( 1924 self, 1925 expression: exp.TableSample, 1926 tablesample_keyword: t.Optional[str] = None, 1927 ) -> str: 1928 method = self.sql(expression, "method") 1929 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1930 numerator = self.sql(expression, "bucket_numerator") 1931 denominator = self.sql(expression, "bucket_denominator") 1932 field = self.sql(expression, "bucket_field") 1933 field = f" ON {field}" if field else "" 1934 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1935 seed = self.sql(expression, "seed") 1936 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1937 1938 size = self.sql(expression, "size") 1939 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1940 size = f"{size} ROWS" 1941 1942 percent = self.sql(expression, "percent") 1943 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1944 percent = f"{percent} PERCENT" 1945 1946 expr = f"{bucket}{percent}{size}" 1947 if self.TABLESAMPLE_REQUIRES_PARENS: 1948 expr = f"({expr})" 1949 1950 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}"
1952 def pivot_sql(self, expression: exp.Pivot) -> str: 1953 expressions = self.expressions(expression, flat=True) 1954 1955 if expression.this: 1956 this = self.sql(expression, "this") 1957 if not expressions: 1958 return f"UNPIVOT {this}" 1959 1960 on = f"{self.seg('ON')} {expressions}" 1961 using = self.expressions(expression, key="using", flat=True) 1962 using = f"{self.seg('USING')} {using}" if using else "" 1963 group = self.sql(expression, "group") 1964 return f"PIVOT {this}{on}{using}{group}" 1965 1966 alias = self.sql(expression, "alias") 1967 alias = f" AS {alias}" if alias else "" 1968 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 1969 1970 field = self.sql(expression, "field") 1971 1972 include_nulls = expression.args.get("include_nulls") 1973 if include_nulls is not None: 1974 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 1975 else: 1976 nulls = "" 1977 1978 default_on_null = self.sql(expression, "default_on_null") 1979 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 1980 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}"
1991 def update_sql(self, expression: exp.Update) -> str: 1992 this = self.sql(expression, "this") 1993 set_sql = self.expressions(expression, flat=True) 1994 from_sql = self.sql(expression, "from") 1995 where_sql = self.sql(expression, "where") 1996 returning = self.sql(expression, "returning") 1997 order = self.sql(expression, "order") 1998 limit = self.sql(expression, "limit") 1999 if self.RETURNING_END: 2000 expression_sql = f"{from_sql}{where_sql}{returning}" 2001 else: 2002 expression_sql = f"{returning}{from_sql}{where_sql}" 2003 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2004 return self.prepend_ctes(expression, sql)
2006 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2007 values_as_table = values_as_table and self.VALUES_AS_TABLE 2008 2009 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2010 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2011 args = self.expressions(expression) 2012 alias = self.sql(expression, "alias") 2013 values = f"VALUES{self.seg('')}{args}" 2014 values = ( 2015 f"({values})" 2016 if self.WRAP_DERIVED_VALUES 2017 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2018 else values 2019 ) 2020 return f"{values} AS {alias}" if alias else values 2021 2022 # Converts `VALUES...` expression into a series of select unions. 2023 alias_node = expression.args.get("alias") 2024 column_names = alias_node and alias_node.columns 2025 2026 selects: t.List[exp.Query] = [] 2027 2028 for i, tup in enumerate(expression.expressions): 2029 row = tup.expressions 2030 2031 if i == 0 and column_names: 2032 row = [ 2033 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2034 ] 2035 2036 selects.append(exp.Select(expressions=row)) 2037 2038 if self.pretty: 2039 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2040 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2041 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2042 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2043 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2044 2045 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2046 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2047 return f"({unions}){alias}"
2052 @unsupported_args("expressions") 2053 def into_sql(self, expression: exp.Into) -> str: 2054 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2055 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2056 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}"
2073 def group_sql(self, expression: exp.Group) -> str: 2074 group_by_all = expression.args.get("all") 2075 if group_by_all is True: 2076 modifier = " ALL" 2077 elif group_by_all is False: 2078 modifier = " DISTINCT" 2079 else: 2080 modifier = "" 2081 2082 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2083 2084 grouping_sets = self.expressions(expression, key="grouping_sets") 2085 cube = self.expressions(expression, key="cube") 2086 rollup = self.expressions(expression, key="rollup") 2087 2088 groupings = csv( 2089 self.seg(grouping_sets) if grouping_sets else "", 2090 self.seg(cube) if cube else "", 2091 self.seg(rollup) if rollup else "", 2092 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2093 sep=self.GROUPINGS_SEP, 2094 ) 2095 2096 if ( 2097 expression.expressions 2098 and groupings 2099 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2100 ): 2101 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2102 2103 return f"{group_by}{groupings}"
2109 def connect_sql(self, expression: exp.Connect) -> str: 2110 start = self.sql(expression, "start") 2111 start = self.seg(f"START WITH {start}") if start else "" 2112 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2113 connect = self.sql(expression, "connect") 2114 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2115 return start + connect
2120 def join_sql(self, expression: exp.Join) -> str: 2121 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2122 side = None 2123 else: 2124 side = expression.side 2125 2126 op_sql = " ".join( 2127 op 2128 for op in ( 2129 expression.method, 2130 "GLOBAL" if expression.args.get("global") else None, 2131 side, 2132 expression.kind, 2133 expression.hint if self.JOIN_HINTS else None, 2134 ) 2135 if op 2136 ) 2137 match_cond = self.sql(expression, "match_condition") 2138 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2139 on_sql = self.sql(expression, "on") 2140 using = expression.args.get("using") 2141 2142 if not on_sql and using: 2143 on_sql = csv(*(self.sql(column) for column in using)) 2144 2145 this = expression.this 2146 this_sql = self.sql(this) 2147 2148 if on_sql: 2149 on_sql = self.indent(on_sql, skip_first=True) 2150 space = self.seg(" " * self.pad) if self.pretty else " " 2151 if using: 2152 on_sql = f"{space}USING ({on_sql})" 2153 else: 2154 on_sql = f"{space}ON {on_sql}" 2155 elif not op_sql: 2156 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2157 return f" {this_sql}" 2158 2159 return f", {this_sql}" 2160 2161 if op_sql != "STRAIGHT_JOIN": 2162 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2163 2164 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}"
2171 def lateral_op(self, expression: exp.Lateral) -> str: 2172 cross_apply = expression.args.get("cross_apply") 2173 2174 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2175 if cross_apply is True: 2176 op = "INNER JOIN " 2177 elif cross_apply is False: 2178 op = "LEFT JOIN " 2179 else: 2180 op = "" 2181 2182 return f"{op}LATERAL"
2184 def lateral_sql(self, expression: exp.Lateral) -> str: 2185 this = self.sql(expression, "this") 2186 2187 if expression.args.get("view"): 2188 alias = expression.args["alias"] 2189 columns = self.expressions(alias, key="columns", flat=True) 2190 table = f" {alias.name}" if alias.name else "" 2191 columns = f" AS {columns}" if columns else "" 2192 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2193 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2194 2195 alias = self.sql(expression, "alias") 2196 alias = f" AS {alias}" if alias else "" 2197 return f"{self.lateral_op(expression)} {this}{alias}"
2199 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2200 this = self.sql(expression, "this") 2201 2202 args = [ 2203 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2204 for e in (expression.args.get(k) for k in ("offset", "expression")) 2205 if e 2206 ] 2207 2208 args_sql = ", ".join(self.sql(e) for e in args) 2209 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2210 expressions = self.expressions(expression, flat=True) 2211 expressions = f" BY {expressions}" if expressions else "" 2212 2213 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}"
2215 def offset_sql(self, expression: exp.Offset) -> str: 2216 this = self.sql(expression, "this") 2217 value = expression.expression 2218 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2219 expressions = self.expressions(expression, flat=True) 2220 expressions = f" BY {expressions}" if expressions else "" 2221 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}"
2223 def setitem_sql(self, expression: exp.SetItem) -> str: 2224 kind = self.sql(expression, "kind") 2225 kind = f"{kind} " if kind else "" 2226 this = self.sql(expression, "this") 2227 expressions = self.expressions(expression) 2228 collate = self.sql(expression, "collate") 2229 collate = f" COLLATE {collate}" if collate else "" 2230 global_ = "GLOBAL " if expression.args.get("global") else "" 2231 return f"{global_}{kind}{this}{expressions}{collate}"
2233 def set_sql(self, expression: exp.Set) -> str: 2234 expressions = ( 2235 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2236 ) 2237 tag = " TAG" if expression.args.get("tag") else "" 2238 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}"
2243 def lock_sql(self, expression: exp.Lock) -> str: 2244 if not self.LOCKING_READS_SUPPORTED: 2245 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2246 return "" 2247 2248 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2249 expressions = self.expressions(expression, flat=True) 2250 expressions = f" OF {expressions}" if expressions else "" 2251 wait = expression.args.get("wait") 2252 2253 if wait is not None: 2254 if isinstance(wait, exp.Literal): 2255 wait = f" WAIT {self.sql(wait)}" 2256 else: 2257 wait = " NOWAIT" if wait else " SKIP LOCKED" 2258 2259 return f"{lock_type}{expressions}{wait or ''}"
def
escape_str(self, text: str, escape_backslash: bool = True) -> str:
2267 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2268 if self.dialect.ESCAPED_SEQUENCES: 2269 to_escaped = self.dialect.ESCAPED_SEQUENCES 2270 text = "".join( 2271 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2272 ) 2273 2274 return self._replace_line_breaks(text).replace( 2275 self.dialect.QUOTE_END, self._escaped_quote_end 2276 )
2278 def loaddata_sql(self, expression: exp.LoadData) -> str: 2279 local = " LOCAL" if expression.args.get("local") else "" 2280 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2281 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2282 this = f" INTO TABLE {self.sql(expression, 'this')}" 2283 partition = self.sql(expression, "partition") 2284 partition = f" {partition}" if partition else "" 2285 input_format = self.sql(expression, "input_format") 2286 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2287 serde = self.sql(expression, "serde") 2288 serde = f" SERDE {serde}" if serde else "" 2289 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}"
2297 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2298 this = self.sql(expression, "this") 2299 this = f"{this} " if this else this 2300 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2301 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore
2303 def withfill_sql(self, expression: exp.WithFill) -> str: 2304 from_sql = self.sql(expression, "from") 2305 from_sql = f" FROM {from_sql}" if from_sql else "" 2306 to_sql = self.sql(expression, "to") 2307 to_sql = f" TO {to_sql}" if to_sql else "" 2308 step_sql = self.sql(expression, "step") 2309 step_sql = f" STEP {step_sql}" if step_sql else "" 2310 interpolated_values = [ 2311 f"{self.sql(named_expression, 'alias')} AS {self.sql(named_expression, 'this')}" 2312 for named_expression in expression.args.get("interpolate") or [] 2313 ] 2314 interpolate = ( 2315 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2316 ) 2317 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}"
2328 def ordered_sql(self, expression: exp.Ordered) -> str: 2329 desc = expression.args.get("desc") 2330 asc = not desc 2331 2332 nulls_first = expression.args.get("nulls_first") 2333 nulls_last = not nulls_first 2334 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2335 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2336 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2337 2338 this = self.sql(expression, "this") 2339 2340 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2341 nulls_sort_change = "" 2342 if nulls_first and ( 2343 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2344 ): 2345 nulls_sort_change = " NULLS FIRST" 2346 elif ( 2347 nulls_last 2348 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2349 and not nulls_are_last 2350 ): 2351 nulls_sort_change = " NULLS LAST" 2352 2353 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2354 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2355 window = expression.find_ancestor(exp.Window, exp.Select) 2356 if isinstance(window, exp.Window) and window.args.get("spec"): 2357 self.unsupported( 2358 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2359 ) 2360 nulls_sort_change = "" 2361 elif ( 2362 self.NULL_ORDERING_SUPPORTED is False 2363 and (isinstance(expression.find_ancestor(exp.AggFunc, exp.Select), exp.AggFunc)) 2364 and ( 2365 (asc and nulls_sort_change == " NULLS LAST") 2366 or (desc and nulls_sort_change == " NULLS FIRST") 2367 ) 2368 ): 2369 self.unsupported( 2370 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2371 ) 2372 nulls_sort_change = "" 2373 elif self.NULL_ORDERING_SUPPORTED is None: 2374 if expression.this.is_int: 2375 self.unsupported( 2376 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2377 ) 2378 elif not isinstance(expression.this, exp.Rand): 2379 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2380 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2381 nulls_sort_change = "" 2382 2383 with_fill = self.sql(expression, "with_fill") 2384 with_fill = f" {with_fill}" if with_fill else "" 2385 2386 return f"{this}{sort_order}{nulls_sort_change}{with_fill}"
2396 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2397 partition = self.partition_by_sql(expression) 2398 order = self.sql(expression, "order") 2399 measures = self.expressions(expression, key="measures") 2400 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2401 rows = self.sql(expression, "rows") 2402 rows = self.seg(rows) if rows else "" 2403 after = self.sql(expression, "after") 2404 after = self.seg(after) if after else "" 2405 pattern = self.sql(expression, "pattern") 2406 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2407 definition_sqls = [ 2408 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2409 for definition in expression.args.get("define", []) 2410 ] 2411 definitions = self.expressions(sqls=definition_sqls) 2412 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2413 body = "".join( 2414 ( 2415 partition, 2416 order, 2417 measures, 2418 rows, 2419 after, 2420 pattern, 2421 define, 2422 ) 2423 ) 2424 alias = self.sql(expression, "alias") 2425 alias = f" {alias}" if alias else "" 2426 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}"
2428 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2429 limit = expression.args.get("limit") 2430 2431 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2432 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2433 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2434 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2435 2436 return csv( 2437 *sqls, 2438 *[self.sql(join) for join in expression.args.get("joins") or []], 2439 self.sql(expression, "connect"), 2440 self.sql(expression, "match"), 2441 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2442 self.sql(expression, "prewhere"), 2443 self.sql(expression, "where"), 2444 self.sql(expression, "group"), 2445 self.sql(expression, "having"), 2446 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2447 self.sql(expression, "order"), 2448 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2449 *self.after_limit_modifiers(expression), 2450 self.options_modifier(expression), 2451 sep="", 2452 )
def
offset_limit_modifiers( self, expression: sqlglot.expressions.Expression, fetch: bool, limit: Union[sqlglot.expressions.Fetch, sqlglot.expressions.Limit, NoneType]) -> List[str]:
2461 def offset_limit_modifiers( 2462 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2463 ) -> t.List[str]: 2464 return [ 2465 self.sql(expression, "offset") if fetch else self.sql(limit), 2466 self.sql(limit) if fetch else self.sql(expression, "offset"), 2467 ]
2474 def select_sql(self, expression: exp.Select) -> str: 2475 into = expression.args.get("into") 2476 if not self.SUPPORTS_SELECT_INTO and into: 2477 into.pop() 2478 2479 hint = self.sql(expression, "hint") 2480 distinct = self.sql(expression, "distinct") 2481 distinct = f" {distinct}" if distinct else "" 2482 kind = self.sql(expression, "kind") 2483 2484 limit = expression.args.get("limit") 2485 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2486 top = self.limit_sql(limit, top=True) 2487 limit.pop() 2488 else: 2489 top = "" 2490 2491 expressions = self.expressions(expression) 2492 2493 if kind: 2494 if kind in self.SELECT_KINDS: 2495 kind = f" AS {kind}" 2496 else: 2497 if kind == "STRUCT": 2498 expressions = self.expressions( 2499 sqls=[ 2500 self.sql( 2501 exp.Struct( 2502 expressions=[ 2503 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2504 if isinstance(e, exp.Alias) 2505 else e 2506 for e in expression.expressions 2507 ] 2508 ) 2509 ) 2510 ] 2511 ) 2512 kind = "" 2513 2514 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2515 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2516 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2517 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2518 sql = self.query_modifiers( 2519 expression, 2520 f"SELECT{top_distinct}{kind}{expressions}", 2521 self.sql(expression, "into", comment=False), 2522 self.sql(expression, "from", comment=False), 2523 ) 2524 2525 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2526 if expression.args.get("with"): 2527 sql = self.maybe_comment(sql, expression) 2528 expression.pop_comments() 2529 2530 sql = self.prepend_ctes(expression, sql) 2531 2532 if not self.SUPPORTS_SELECT_INTO and into: 2533 if into.args.get("temporary"): 2534 table_kind = " TEMPORARY" 2535 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2536 table_kind = " UNLOGGED" 2537 else: 2538 table_kind = "" 2539 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2540 2541 return sql
2553 def star_sql(self, expression: exp.Star) -> str: 2554 except_ = self.expressions(expression, key="except", flat=True) 2555 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2556 replace = self.expressions(expression, key="replace", flat=True) 2557 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2558 rename = self.expressions(expression, key="rename", flat=True) 2559 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2560 return f"*{except_}{replace}{rename}"
2576 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2577 alias = self.sql(expression, "alias") 2578 alias = f"{sep}{alias}" if alias else "" 2579 sample = self.sql(expression, "sample") 2580 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2581 alias = f"{sample}{alias}" 2582 2583 # Set to None so it's not generated again by self.query_modifiers() 2584 expression.set("sample", None) 2585 2586 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2587 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2588 return self.prepend_ctes(expression, sql)
2594 def unnest_sql(self, expression: exp.Unnest) -> str: 2595 args = self.expressions(expression, flat=True) 2596 2597 alias = expression.args.get("alias") 2598 offset = expression.args.get("offset") 2599 2600 if self.UNNEST_WITH_ORDINALITY: 2601 if alias and isinstance(offset, exp.Expression): 2602 alias.append("columns", offset) 2603 2604 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2605 columns = alias.columns 2606 alias = self.sql(columns[0]) if columns else "" 2607 else: 2608 alias = self.sql(alias) 2609 2610 alias = f" AS {alias}" if alias else alias 2611 if self.UNNEST_WITH_ORDINALITY: 2612 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2613 else: 2614 if isinstance(offset, exp.Expression): 2615 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2616 elif offset: 2617 suffix = f"{alias} WITH OFFSET" 2618 else: 2619 suffix = alias 2620 2621 return f"UNNEST({args}){suffix}"
2630 def window_sql(self, expression: exp.Window) -> str: 2631 this = self.sql(expression, "this") 2632 partition = self.partition_by_sql(expression) 2633 order = expression.args.get("order") 2634 order = self.order_sql(order, flat=True) if order else "" 2635 spec = self.sql(expression, "spec") 2636 alias = self.sql(expression, "alias") 2637 over = self.sql(expression, "over") or "OVER" 2638 2639 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2640 2641 first = expression.args.get("first") 2642 if first is None: 2643 first = "" 2644 else: 2645 first = "FIRST" if first else "LAST" 2646 2647 if not partition and not order and not spec and alias: 2648 return f"{this} {alias}" 2649 2650 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2651 return f"{this} ({args})"
def
partition_by_sql( self, expression: sqlglot.expressions.Window | sqlglot.expressions.MatchRecognize) -> str:
2657 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2658 kind = self.sql(expression, "kind") 2659 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2660 end = ( 2661 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2662 or "CURRENT ROW" 2663 ) 2664 return f"{kind} BETWEEN {start} AND {end}"
def
bracket_offset_expressions( self, expression: sqlglot.expressions.Bracket, index_offset: Optional[int] = None) -> List[sqlglot.expressions.Expression]:
2677 def bracket_offset_expressions( 2678 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2679 ) -> t.List[exp.Expression]: 2680 return apply_index_offset( 2681 expression.this, 2682 expression.expressions, 2683 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2684 )
2694 def any_sql(self, expression: exp.Any) -> str: 2695 this = self.sql(expression, "this") 2696 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2697 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2698 this = self.wrap(this) 2699 return f"ANY{this}" 2700 return f"ANY {this}"
2705 def case_sql(self, expression: exp.Case) -> str: 2706 this = self.sql(expression, "this") 2707 statements = [f"CASE {this}" if this else "CASE"] 2708 2709 for e in expression.args["ifs"]: 2710 statements.append(f"WHEN {self.sql(e, 'this')}") 2711 statements.append(f"THEN {self.sql(e, 'true')}") 2712 2713 default = self.sql(expression, "default") 2714 2715 if default: 2716 statements.append(f"ELSE {default}") 2717 2718 statements.append("END") 2719 2720 if self.pretty and self.too_wide(statements): 2721 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2722 2723 return " ".join(statements)
2740 def trim_sql(self, expression: exp.Trim) -> str: 2741 trim_type = self.sql(expression, "position") 2742 2743 if trim_type == "LEADING": 2744 func_name = "LTRIM" 2745 elif trim_type == "TRAILING": 2746 func_name = "RTRIM" 2747 else: 2748 func_name = "TRIM" 2749 2750 return self.func(func_name, expression.this, expression.expression)
def
convert_concat_args( self, expression: sqlglot.expressions.Concat | sqlglot.expressions.ConcatWs) -> List[sqlglot.expressions.Expression]:
2752 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2753 args = expression.expressions 2754 if isinstance(expression, exp.ConcatWs): 2755 args = args[1:] # Skip the delimiter 2756 2757 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2758 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2759 2760 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2761 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2762 2763 return args
2765 def concat_sql(self, expression: exp.Concat) -> str: 2766 expressions = self.convert_concat_args(expression) 2767 2768 # Some dialects don't allow a single-argument CONCAT call 2769 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2770 return self.sql(expressions[0]) 2771 2772 return self.func("CONCAT", *expressions)
2783 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2784 expressions = self.expressions(expression, flat=True) 2785 reference = self.sql(expression, "reference") 2786 reference = f" {reference}" if reference else "" 2787 delete = self.sql(expression, "delete") 2788 delete = f" ON DELETE {delete}" if delete else "" 2789 update = self.sql(expression, "update") 2790 update = f" ON UPDATE {update}" if update else "" 2791 return f"FOREIGN KEY ({expressions}){reference}{delete}{update}"
2793 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2794 expressions = self.expressions(expression, flat=True) 2795 options = self.expressions(expression, key="options", flat=True, sep=" ") 2796 options = f" {options}" if options else "" 2797 return f"PRIMARY KEY ({expressions}){options}"
2810 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2811 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2812 2813 if expression.args.get("escape"): 2814 path = self.escape_str(path) 2815 2816 if self.QUOTE_JSON_PATH: 2817 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2818 2819 return path
2821 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2822 if isinstance(expression, exp.JSONPathPart): 2823 transform = self.TRANSFORMS.get(expression.__class__) 2824 if not callable(transform): 2825 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2826 return "" 2827 2828 return transform(self, expression) 2829 2830 if isinstance(expression, int): 2831 return str(expression) 2832 2833 if self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2834 escaped = expression.replace("'", "\\'") 2835 escaped = f"\\'{expression}\\'" 2836 else: 2837 escaped = expression.replace('"', '\\"') 2838 escaped = f'"{escaped}"' 2839 2840 return escaped
def
jsonobject_sql( self, expression: sqlglot.expressions.JSONObject | sqlglot.expressions.JSONObjectAgg) -> str:
2845 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2846 null_handling = expression.args.get("null_handling") 2847 null_handling = f" {null_handling}" if null_handling else "" 2848 2849 unique_keys = expression.args.get("unique_keys") 2850 if unique_keys is not None: 2851 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2852 else: 2853 unique_keys = "" 2854 2855 return_type = self.sql(expression, "return_type") 2856 return_type = f" RETURNING {return_type}" if return_type else "" 2857 encoding = self.sql(expression, "encoding") 2858 encoding = f" ENCODING {encoding}" if encoding else "" 2859 2860 return self.func( 2861 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2862 *expression.expressions, 2863 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2864 )
2869 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2870 null_handling = expression.args.get("null_handling") 2871 null_handling = f" {null_handling}" if null_handling else "" 2872 return_type = self.sql(expression, "return_type") 2873 return_type = f" RETURNING {return_type}" if return_type else "" 2874 strict = " STRICT" if expression.args.get("strict") else "" 2875 return self.func( 2876 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2877 )
2879 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2880 this = self.sql(expression, "this") 2881 order = self.sql(expression, "order") 2882 null_handling = expression.args.get("null_handling") 2883 null_handling = f" {null_handling}" if null_handling else "" 2884 return_type = self.sql(expression, "return_type") 2885 return_type = f" RETURNING {return_type}" if return_type else "" 2886 strict = " STRICT" if expression.args.get("strict") else "" 2887 return self.func( 2888 "JSON_ARRAYAGG", 2889 this, 2890 suffix=f"{order}{null_handling}{return_type}{strict})", 2891 )
2893 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2894 path = self.sql(expression, "path") 2895 path = f" PATH {path}" if path else "" 2896 nested_schema = self.sql(expression, "nested_schema") 2897 2898 if nested_schema: 2899 return f"NESTED{path} {nested_schema}" 2900 2901 this = self.sql(expression, "this") 2902 kind = self.sql(expression, "kind") 2903 kind = f" {kind}" if kind else "" 2904 return f"{this}{kind}{path}"
2909 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2910 this = self.sql(expression, "this") 2911 path = self.sql(expression, "path") 2912 path = f", {path}" if path else "" 2913 error_handling = expression.args.get("error_handling") 2914 error_handling = f" {error_handling}" if error_handling else "" 2915 empty_handling = expression.args.get("empty_handling") 2916 empty_handling = f" {empty_handling}" if empty_handling else "" 2917 schema = self.sql(expression, "schema") 2918 return self.func( 2919 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2920 )
2922 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2923 this = self.sql(expression, "this") 2924 kind = self.sql(expression, "kind") 2925 path = self.sql(expression, "path") 2926 path = f" {path}" if path else "" 2927 as_json = " AS JSON" if expression.args.get("as_json") else "" 2928 return f"{this} {kind}{path}{as_json}"
2930 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2931 this = self.sql(expression, "this") 2932 path = self.sql(expression, "path") 2933 path = f", {path}" if path else "" 2934 expressions = self.expressions(expression) 2935 with_ = ( 2936 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2937 if expressions 2938 else "" 2939 ) 2940 return f"OPENJSON({this}{path}){with_}"
2942 def in_sql(self, expression: exp.In) -> str: 2943 query = expression.args.get("query") 2944 unnest = expression.args.get("unnest") 2945 field = expression.args.get("field") 2946 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2947 2948 if query: 2949 in_sql = self.sql(query) 2950 elif unnest: 2951 in_sql = self.in_unnest_op(unnest) 2952 elif field: 2953 in_sql = self.sql(field) 2954 else: 2955 in_sql = f"({self.expressions(expression, flat=True)})" 2956 2957 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}"
2962 def interval_sql(self, expression: exp.Interval) -> str: 2963 unit = self.sql(expression, "unit") 2964 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 2965 unit = self.TIME_PART_SINGULARS.get(unit, unit) 2966 unit = f" {unit}" if unit else "" 2967 2968 if self.SINGLE_STRING_INTERVAL: 2969 this = expression.this.name if expression.this else "" 2970 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 2971 2972 this = self.sql(expression, "this") 2973 if this: 2974 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 2975 this = f" {this}" if unwrapped else f" ({this})" 2976 2977 return f"INTERVAL{this}{unit}"
2982 def reference_sql(self, expression: exp.Reference) -> str: 2983 this = self.sql(expression, "this") 2984 expressions = self.expressions(expression, flat=True) 2985 expressions = f"({expressions})" if expressions else "" 2986 options = self.expressions(expression, key="options", flat=True, sep=" ") 2987 options = f" {options}" if options else "" 2988 return f"REFERENCES {this}{expressions}{options}"
2990 def anonymous_sql(self, expression: exp.Anonymous) -> str: 2991 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 2992 parent = expression.parent 2993 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 2994 return self.func( 2995 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 2996 )
3016 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3017 alias = expression.args["alias"] 3018 3019 identifier_alias = isinstance(alias, exp.Identifier) 3020 literal_alias = isinstance(alias, exp.Literal) 3021 3022 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3023 alias.replace(exp.Literal.string(alias.output_name)) 3024 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3025 alias.replace(exp.to_identifier(alias.output_name)) 3026 3027 return self.alias_sql(expression)
def
and_sql( self, expression: sqlglot.expressions.And, stack: Optional[List[str | sqlglot.expressions.Expression]] = None) -> str:
def
or_sql( self, expression: sqlglot.expressions.Or, stack: Optional[List[str | sqlglot.expressions.Expression]] = None) -> str:
def
xor_sql( self, expression: sqlglot.expressions.Xor, stack: Optional[List[str | sqlglot.expressions.Expression]] = None) -> str:
def
connector_sql( self, expression: sqlglot.expressions.Connector, op: str, stack: Optional[List[str | sqlglot.expressions.Expression]] = None) -> str:
3065 def connector_sql( 3066 self, 3067 expression: exp.Connector, 3068 op: str, 3069 stack: t.Optional[t.List[str | exp.Expression]] = None, 3070 ) -> str: 3071 if stack is not None: 3072 if expression.expressions: 3073 stack.append(self.expressions(expression, sep=f" {op} ")) 3074 else: 3075 stack.append(expression.right) 3076 if expression.comments and self.comments: 3077 for comment in expression.comments: 3078 if comment: 3079 op += f" /*{self.pad_comment(comment)}*/" 3080 stack.extend((op, expression.left)) 3081 return op 3082 3083 stack = [expression] 3084 sqls: t.List[str] = [] 3085 ops = set() 3086 3087 while stack: 3088 node = stack.pop() 3089 if isinstance(node, exp.Connector): 3090 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3091 else: 3092 sql = self.sql(node) 3093 if sqls and sqls[-1] in ops: 3094 sqls[-1] += f" {sql}" 3095 else: 3096 sqls.append(sql) 3097 3098 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3099 return sep.join(sqls)
def
cast_sql( self, expression: sqlglot.expressions.Cast, safe_prefix: Optional[str] = None) -> str:
3119 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3120 format_sql = self.sql(expression, "format") 3121 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3122 to_sql = self.sql(expression, "to") 3123 to_sql = f" {to_sql}" if to_sql else "" 3124 action = self.sql(expression, "action") 3125 action = f" {action}" if action else "" 3126 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})"
3140 def comment_sql(self, expression: exp.Comment) -> str: 3141 this = self.sql(expression, "this") 3142 kind = expression.args["kind"] 3143 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3144 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3145 expression_sql = self.sql(expression, "expression") 3146 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}"
3148 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3149 this = self.sql(expression, "this") 3150 delete = " DELETE" if expression.args.get("delete") else "" 3151 recompress = self.sql(expression, "recompress") 3152 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3153 to_disk = self.sql(expression, "to_disk") 3154 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3155 to_volume = self.sql(expression, "to_volume") 3156 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3157 return f"{this}{delete}{recompress}{to_disk}{to_volume}"
3159 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3160 where = self.sql(expression, "where") 3161 group = self.sql(expression, "group") 3162 aggregates = self.expressions(expression, key="aggregates") 3163 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3164 3165 if not (where or group or aggregates) and len(expression.expressions) == 1: 3166 return f"TTL {self.expressions(expression, flat=True)}" 3167 3168 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}"
3185 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3186 this = self.sql(expression, "this") 3187 3188 dtype = self.sql(expression, "dtype") 3189 if dtype: 3190 collate = self.sql(expression, "collate") 3191 collate = f" COLLATE {collate}" if collate else "" 3192 using = self.sql(expression, "using") 3193 using = f" USING {using}" if using else "" 3194 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3195 3196 default = self.sql(expression, "default") 3197 if default: 3198 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3199 3200 comment = self.sql(expression, "comment") 3201 if comment: 3202 return f"ALTER COLUMN {this} COMMENT {comment}" 3203 3204 allow_null = expression.args.get("allow_null") 3205 drop = expression.args.get("drop") 3206 3207 if not drop and not allow_null: 3208 self.unsupported("Unsupported ALTER COLUMN syntax") 3209 3210 if allow_null is not None: 3211 keyword = "DROP" if drop else "SET" 3212 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3213 3214 return f"ALTER COLUMN {this} DROP DEFAULT"
3222 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3223 compound = " COMPOUND" if expression.args.get("compound") else "" 3224 this = self.sql(expression, "this") 3225 expressions = self.expressions(expression, flat=True) 3226 expressions = f"({expressions})" if expressions else "" 3227 return f"ALTER{compound} SORTKEY {this or expressions}"
3229 def renametable_sql(self, expression: exp.RenameTable) -> str: 3230 if not self.RENAME_TABLE_WITH_DB: 3231 # Remove db from tables 3232 expression = expression.transform( 3233 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3234 ).assert_is(exp.RenameTable) 3235 this = self.sql(expression, "this") 3236 return f"RENAME TO {this}"
3248 def alter_sql(self, expression: exp.Alter) -> str: 3249 actions = expression.args["actions"] 3250 3251 if isinstance(actions[0], exp.ColumnDef): 3252 actions = self.add_column_sql(expression) 3253 elif isinstance(actions[0], exp.Schema): 3254 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3255 elif isinstance(actions[0], exp.Delete): 3256 actions = self.expressions(expression, key="actions", flat=True) 3257 elif isinstance(actions[0], exp.Query): 3258 actions = "AS " + self.expressions(expression, key="actions") 3259 else: 3260 actions = self.expressions(expression, key="actions", flat=True) 3261 3262 exists = " IF EXISTS" if expression.args.get("exists") else "" 3263 on_cluster = self.sql(expression, "cluster") 3264 on_cluster = f" {on_cluster}" if on_cluster else "" 3265 only = " ONLY" if expression.args.get("only") else "" 3266 options = self.expressions(expression, key="options") 3267 options = f", {options}" if options else "" 3268 kind = self.sql(expression, "kind") 3269 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3270 3271 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}"
3273 def add_column_sql(self, expression: exp.Alter) -> str: 3274 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3275 return self.expressions( 3276 expression, 3277 key="actions", 3278 prefix="ADD COLUMN ", 3279 skip_first=True, 3280 ) 3281 return f"ADD {self.expressions(expression, key='actions', flat=True)}"
3291 def distinct_sql(self, expression: exp.Distinct) -> str: 3292 this = self.expressions(expression, flat=True) 3293 3294 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3295 case = exp.case() 3296 for arg in expression.expressions: 3297 case = case.when(arg.is_(exp.null()), exp.null()) 3298 this = self.sql(case.else_(f"({this})")) 3299 3300 this = f" {this}" if this else "" 3301 3302 on = self.sql(expression, "on") 3303 on = f" ON {on}" if on else "" 3304 return f"DISTINCT{this}{on}"
3333 def div_sql(self, expression: exp.Div) -> str: 3334 l, r = expression.left, expression.right 3335 3336 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3337 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3338 3339 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3340 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3341 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3342 3343 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3344 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3345 return self.sql( 3346 exp.cast( 3347 l / r, 3348 to=exp.DataType.Type.BIGINT, 3349 ) 3350 ) 3351 3352 return self.binary(expression, "/")
3440 def log_sql(self, expression: exp.Log) -> str: 3441 this = expression.this 3442 expr = expression.expression 3443 3444 if self.dialect.LOG_BASE_FIRST is False: 3445 this, expr = expr, this 3446 elif self.dialect.LOG_BASE_FIRST is None and expr: 3447 if this.name in ("2", "10"): 3448 return self.func(f"LOG{this.name}", expr) 3449 3450 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3451 3452 return self.func("LOG", this, expr)
3461 def binary(self, expression: exp.Binary, op: str) -> str: 3462 sqls: t.List[str] = [] 3463 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3464 binary_type = type(expression) 3465 3466 while stack: 3467 node = stack.pop() 3468 3469 if type(node) is binary_type: 3470 op_func = node.args.get("operator") 3471 if op_func: 3472 op = f"OPERATOR({self.sql(op_func)})" 3473 3474 stack.append(node.right) 3475 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3476 stack.append(node.left) 3477 else: 3478 sqls.append(self.sql(node)) 3479 3480 return "".join(sqls)
3482 def function_fallback_sql(self, expression: exp.Func) -> str: 3483 args = [] 3484 3485 for key in expression.arg_types: 3486 arg_value = expression.args.get(key) 3487 3488 if isinstance(arg_value, list): 3489 for value in arg_value: 3490 args.append(value) 3491 elif arg_value is not None: 3492 args.append(arg_value) 3493 3494 if self.normalize_functions: 3495 name = expression.sql_name() 3496 else: 3497 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3498 3499 return self.func(name, *args)
def
func( self, name: str, *args: Union[str, sqlglot.expressions.Expression, NoneType], prefix: str = '(', suffix: str = ')', normalize: bool = True) -> str:
3501 def func( 3502 self, 3503 name: str, 3504 *args: t.Optional[exp.Expression | str], 3505 prefix: str = "(", 3506 suffix: str = ")", 3507 normalize: bool = True, 3508 ) -> str: 3509 name = self.normalize_func(name) if normalize else name 3510 return f"{name}{prefix}{self.format_args(*args)}{suffix}"
3512 def format_args(self, *args: t.Optional[str | exp.Expression]) -> str: 3513 arg_sqls = tuple( 3514 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3515 ) 3516 if self.pretty and self.too_wide(arg_sqls): 3517 return self.indent("\n" + ",\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True) 3518 return ", ".join(arg_sqls)
def
format_time( self, expression: sqlglot.expressions.Expression, inverse_time_mapping: Optional[Dict[str, str]] = None, inverse_time_trie: Optional[Dict] = None) -> Optional[str]:
3523 def format_time( 3524 self, 3525 expression: exp.Expression, 3526 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3527 inverse_time_trie: t.Optional[t.Dict] = None, 3528 ) -> t.Optional[str]: 3529 return format_time( 3530 self.sql(expression, "format"), 3531 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3532 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3533 )
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, skip_last: bool = False, sep: str = ', ', prefix: str = '', dynamic: bool = False, new_line: bool = False) -> str:
3535 def expressions( 3536 self, 3537 expression: t.Optional[exp.Expression] = None, 3538 key: t.Optional[str] = None, 3539 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3540 flat: bool = False, 3541 indent: bool = True, 3542 skip_first: bool = False, 3543 skip_last: bool = False, 3544 sep: str = ", ", 3545 prefix: str = "", 3546 dynamic: bool = False, 3547 new_line: bool = False, 3548 ) -> str: 3549 expressions = expression.args.get(key or "expressions") if expression else sqls 3550 3551 if not expressions: 3552 return "" 3553 3554 if flat: 3555 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3556 3557 num_sqls = len(expressions) 3558 result_sqls = [] 3559 3560 for i, e in enumerate(expressions): 3561 sql = self.sql(e, comment=False) 3562 if not sql: 3563 continue 3564 3565 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3566 3567 if self.pretty: 3568 if self.leading_comma: 3569 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3570 else: 3571 result_sqls.append( 3572 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3573 ) 3574 else: 3575 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3576 3577 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3578 if new_line: 3579 result_sqls.insert(0, "") 3580 result_sqls.append("") 3581 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3582 else: 3583 result_sql = "".join(result_sqls) 3584 3585 return ( 3586 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3587 if indent 3588 else result_sql 3589 )
def
op_expressions( self, op: str, expression: sqlglot.expressions.Expression, flat: bool = False) -> str:
3591 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3592 flat = flat or isinstance(expression.parent, exp.Properties) 3593 expressions_sql = self.expressions(expression, flat=flat) 3594 if flat: 3595 return f"{op} {expressions_sql}" 3596 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}"
3598 def naked_property(self, expression: exp.Property) -> str: 3599 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3600 if not property_name: 3601 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3602 return f"{property_name} {self.sql(expression, 'this')}"
3610 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3611 this = self.sql(expression, "this") 3612 expressions = self.no_identify(self.expressions, expression) 3613 expressions = ( 3614 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3615 ) 3616 return f"{this}{expressions}"
3626 def when_sql(self, expression: exp.When) -> str: 3627 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3628 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3629 condition = self.sql(expression, "condition") 3630 condition = f" AND {condition}" if condition else "" 3631 3632 then_expression = expression.args.get("then") 3633 if isinstance(then_expression, exp.Insert): 3634 this = self.sql(then_expression, "this") 3635 this = f"INSERT {this}" if this else "INSERT" 3636 then = self.sql(then_expression, "expression") 3637 then = f"{this} VALUES {then}" if then else this 3638 elif isinstance(then_expression, exp.Update): 3639 if isinstance(then_expression.args.get("expressions"), exp.Star): 3640 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3641 else: 3642 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3643 else: 3644 then = self.sql(then_expression) 3645 return f"WHEN {matched}{source}{condition} THEN {then}"
3647 def merge_sql(self, expression: exp.Merge) -> str: 3648 table = expression.this 3649 table_alias = "" 3650 3651 hints = table.args.get("hints") 3652 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3653 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3654 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3655 3656 this = self.sql(table) 3657 using = f"USING {self.sql(expression, 'using')}" 3658 on = f"ON {self.sql(expression, 'on')}" 3659 expressions = self.expressions(expression, sep=" ", indent=False) 3660 returning = self.sql(expression, "returning") 3661 if returning: 3662 expressions = f"{expressions}{returning}" 3663 3664 sep = self.sep() 3665 3666 return self.prepend_ctes( 3667 expression, 3668 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{expressions}", 3669 )
3675 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3676 if not self.SUPPORTS_TO_NUMBER: 3677 self.unsupported("Unsupported TO_NUMBER function") 3678 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3679 3680 fmt = expression.args.get("format") 3681 if not fmt: 3682 self.unsupported("Conversion format is required for TO_NUMBER") 3683 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3684 3685 return self.func("TO_NUMBER", expression.this, fmt)
3687 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3688 this = self.sql(expression, "this") 3689 kind = self.sql(expression, "kind") 3690 settings_sql = self.expressions(expression, key="settings", sep=" ") 3691 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3692 return f"{this}({kind}{args})"
3707 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3708 expressions = self.expressions(expression, flat=True) 3709 expressions = f" {self.wrap(expressions)}" if expressions else "" 3710 buckets = self.sql(expression, "buckets") 3711 kind = self.sql(expression, "kind") 3712 buckets = f" BUCKETS {buckets}" if buckets else "" 3713 order = self.sql(expression, "order") 3714 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}"
3719 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3720 expressions = self.expressions(expression, key="expressions", flat=True) 3721 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3722 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3723 buckets = self.sql(expression, "buckets") 3724 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS"
3726 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3727 this = self.sql(expression, "this") 3728 having = self.sql(expression, "having") 3729 3730 if having: 3731 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3732 3733 return self.func("ANY_VALUE", this)
3735 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3736 transform = self.func("TRANSFORM", *expression.expressions) 3737 row_format_before = self.sql(expression, "row_format_before") 3738 row_format_before = f" {row_format_before}" if row_format_before else "" 3739 record_writer = self.sql(expression, "record_writer") 3740 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3741 using = f" USING {self.sql(expression, 'command_script')}" 3742 schema = self.sql(expression, "schema") 3743 schema = f" AS {schema}" if schema else "" 3744 row_format_after = self.sql(expression, "row_format_after") 3745 row_format_after = f" {row_format_after}" if row_format_after else "" 3746 record_reader = self.sql(expression, "record_reader") 3747 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3748 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}"
3750 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3751 key_block_size = self.sql(expression, "key_block_size") 3752 if key_block_size: 3753 return f"KEY_BLOCK_SIZE = {key_block_size}" 3754 3755 using = self.sql(expression, "using") 3756 if using: 3757 return f"USING {using}" 3758 3759 parser = self.sql(expression, "parser") 3760 if parser: 3761 return f"WITH PARSER {parser}" 3762 3763 comment = self.sql(expression, "comment") 3764 if comment: 3765 return f"COMMENT {comment}" 3766 3767 visible = expression.args.get("visible") 3768 if visible is not None: 3769 return "VISIBLE" if visible else "INVISIBLE" 3770 3771 engine_attr = self.sql(expression, "engine_attr") 3772 if engine_attr: 3773 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3774 3775 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3776 if secondary_engine_attr: 3777 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3778 3779 self.unsupported("Unsupported index constraint option.") 3780 return ""
3786 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3787 kind = self.sql(expression, "kind") 3788 kind = f"{kind} INDEX" if kind else "INDEX" 3789 this = self.sql(expression, "this") 3790 this = f" {this}" if this else "" 3791 index_type = self.sql(expression, "index_type") 3792 index_type = f" USING {index_type}" if index_type else "" 3793 expressions = self.expressions(expression, flat=True) 3794 expressions = f" ({expressions})" if expressions else "" 3795 options = self.expressions(expression, key="options", sep=" ") 3796 options = f" {options}" if options else "" 3797 return f"{kind}{this}{index_type}{expressions}{options}"
3799 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3800 if self.NVL2_SUPPORTED: 3801 return self.function_fallback_sql(expression) 3802 3803 case = exp.Case().when( 3804 expression.this.is_(exp.null()).not_(copy=False), 3805 expression.args["true"], 3806 copy=False, 3807 ) 3808 else_cond = expression.args.get("false") 3809 if else_cond: 3810 case.else_(else_cond, copy=False) 3811 3812 return self.sql(case)
3814 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3815 this = self.sql(expression, "this") 3816 expr = self.sql(expression, "expression") 3817 iterator = self.sql(expression, "iterator") 3818 condition = self.sql(expression, "condition") 3819 condition = f" IF {condition}" if condition else "" 3820 return f"{this} FOR {expr} IN {iterator}{condition}"
3828 def predict_sql(self, expression: exp.Predict) -> str: 3829 model = self.sql(expression, "this") 3830 model = f"MODEL {model}" 3831 table = self.sql(expression, "expression") 3832 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3833 parameters = self.sql(expression, "params_struct") 3834 return self.func("PREDICT", model, table, parameters or None)
3846 def toarray_sql(self, expression: exp.ToArray) -> str: 3847 arg = expression.this 3848 if not arg.type: 3849 from sqlglot.optimizer.annotate_types import annotate_types 3850 3851 arg = annotate_types(arg) 3852 3853 if arg.is_type(exp.DataType.Type.ARRAY): 3854 return self.sql(arg) 3855 3856 cond_for_null = arg.is_(exp.null()) 3857 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False)))
3873 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3874 this = expression.this 3875 time_format = self.format_time(expression) 3876 3877 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3878 return self.sql( 3879 exp.cast( 3880 exp.StrToTime(this=this, format=expression.args["format"]), 3881 exp.DataType.Type.DATE, 3882 ) 3883 ) 3884 3885 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3886 return self.sql(this) 3887 3888 return self.sql(exp.cast(this, exp.DataType.Type.DATE))
3900 def lastday_sql(self, expression: exp.LastDay) -> str: 3901 if self.LAST_DAY_SUPPORTS_DATE_PART: 3902 return self.function_fallback_sql(expression) 3903 3904 unit = expression.text("unit") 3905 if unit and unit != "MONTH": 3906 self.unsupported("Date parts are not supported in LAST_DAY.") 3907 3908 return self.func("LAST_DAY", expression.this)
3917 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3918 if self.CAN_IMPLEMENT_ARRAY_ANY: 3919 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3920 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3921 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3922 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3923 3924 from sqlglot.dialects import Dialect 3925 3926 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3927 if self.dialect.__class__ != Dialect: 3928 self.unsupported("ARRAY_ANY is unsupported") 3929 3930 return self.function_fallback_sql(expression)
3932 def struct_sql(self, expression: exp.Struct) -> str: 3933 expression.set( 3934 "expressions", 3935 [ 3936 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 3937 if isinstance(e, exp.PropertyEQ) 3938 else e 3939 for e in expression.expressions 3940 ], 3941 ) 3942 3943 return self.function_fallback_sql(expression)
3951 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 3952 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 3953 tables = f" {self.expressions(expression)}" 3954 3955 exists = " IF EXISTS" if expression.args.get("exists") else "" 3956 3957 on_cluster = self.sql(expression, "cluster") 3958 on_cluster = f" {on_cluster}" if on_cluster else "" 3959 3960 identity = self.sql(expression, "identity") 3961 identity = f" {identity} IDENTITY" if identity else "" 3962 3963 option = self.sql(expression, "option") 3964 option = f" {option}" if option else "" 3965 3966 partition = self.sql(expression, "partition") 3967 partition = f" {partition}" if partition else "" 3968 3969 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}"
3973 def convert_sql(self, expression: exp.Convert) -> str: 3974 to = expression.this 3975 value = expression.expression 3976 style = expression.args.get("style") 3977 safe = expression.args.get("safe") 3978 strict = expression.args.get("strict") 3979 3980 if not to or not value: 3981 return "" 3982 3983 # Retrieve length of datatype and override to default if not specified 3984 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 3985 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 3986 3987 transformed: t.Optional[exp.Expression] = None 3988 cast = exp.Cast if strict else exp.TryCast 3989 3990 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 3991 if isinstance(style, exp.Literal) and style.is_int: 3992 from sqlglot.dialects.tsql import TSQL 3993 3994 style_value = style.name 3995 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 3996 if not converted_style: 3997 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 3998 3999 fmt = exp.Literal.string(converted_style) 4000 4001 if to.this == exp.DataType.Type.DATE: 4002 transformed = exp.StrToDate(this=value, format=fmt) 4003 elif to.this == exp.DataType.Type.DATETIME: 4004 transformed = exp.StrToTime(this=value, format=fmt) 4005 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4006 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4007 elif to.this == exp.DataType.Type.TEXT: 4008 transformed = exp.TimeToStr(this=value, format=fmt) 4009 4010 if not transformed: 4011 transformed = cast(this=value, to=to, safe=safe) 4012 4013 return self.sql(transformed)
4069 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4070 option = self.sql(expression, "this") 4071 4072 if expression.expressions: 4073 upper = option.upper() 4074 4075 # Snowflake FILE_FORMAT options are separated by whitespace 4076 sep = " " if upper == "FILE_FORMAT" else ", " 4077 4078 # Databricks copy/format options do not set their list of values with EQ 4079 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4080 values = self.expressions(expression, flat=True, sep=sep) 4081 return f"{option}{op}({values})" 4082 4083 value = self.sql(expression, "expression") 4084 4085 if not value: 4086 return option 4087 4088 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4089 4090 return f"{option}{op}{value}"
4092 def credentials_sql(self, expression: exp.Credentials) -> str: 4093 cred_expr = expression.args.get("credentials") 4094 if isinstance(cred_expr, exp.Literal): 4095 # Redshift case: CREDENTIALS <string> 4096 credentials = self.sql(expression, "credentials") 4097 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4098 else: 4099 # Snowflake case: CREDENTIALS = (...) 4100 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4101 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4102 4103 storage = self.sql(expression, "storage") 4104 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4105 4106 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4107 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4108 4109 iam_role = self.sql(expression, "iam_role") 4110 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4111 4112 region = self.sql(expression, "region") 4113 region = f" REGION {region}" if region else "" 4114 4115 return f"{credentials}{storage}{encryption}{iam_role}{region}"
4117 def copy_sql(self, expression: exp.Copy) -> str: 4118 this = self.sql(expression, "this") 4119 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4120 4121 credentials = self.sql(expression, "credentials") 4122 credentials = self.seg(credentials) if credentials else "" 4123 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4124 files = self.expressions(expression, key="files", flat=True) 4125 4126 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4127 params = self.expressions( 4128 expression, 4129 key="params", 4130 sep=sep, 4131 new_line=True, 4132 skip_last=True, 4133 skip_first=True, 4134 indent=self.COPY_PARAMS_ARE_WRAPPED, 4135 ) 4136 4137 if params: 4138 if self.COPY_PARAMS_ARE_WRAPPED: 4139 params = f" WITH ({params})" 4140 elif not self.pretty: 4141 params = f" {params}" 4142 4143 return f"COPY{this}{kind} {files}{credentials}{params}"
4148 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4149 on_sql = "ON" if expression.args.get("on") else "OFF" 4150 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4151 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4152 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4153 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4154 4155 if filter_col or retention_period: 4156 on_sql = self.func("ON", filter_col, retention_period) 4157 4158 return f"DATA_DELETION={on_sql}"
def
maskingpolicycolumnconstraint_sql( self, expression: sqlglot.expressions.MaskingPolicyColumnConstraint) -> str:
4160 def maskingpolicycolumnconstraint_sql( 4161 self, expression: exp.MaskingPolicyColumnConstraint 4162 ) -> str: 4163 this = self.sql(expression, "this") 4164 expressions = self.expressions(expression, flat=True) 4165 expressions = f" USING ({expressions})" if expressions else "" 4166 return f"MASKING POLICY {this}{expressions}"
4176 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4177 this = self.sql(expression, "this") 4178 expr = expression.expression 4179 4180 if isinstance(expr, exp.Func): 4181 # T-SQL's CLR functions are case sensitive 4182 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4183 else: 4184 expr = self.sql(expression, "expression") 4185 4186 return self.scope_resolution(expr, this)
4194 def rand_sql(self, expression: exp.Rand) -> str: 4195 lower = self.sql(expression, "lower") 4196 upper = self.sql(expression, "upper") 4197 4198 if lower and upper: 4199 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4200 return self.func("RAND", expression.this)
4202 def changes_sql(self, expression: exp.Changes) -> str: 4203 information = self.sql(expression, "information") 4204 information = f"INFORMATION => {information}" 4205 at_before = self.sql(expression, "at_before") 4206 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4207 end = self.sql(expression, "end") 4208 end = f"{self.seg('')}{end}" if end else "" 4209 4210 return f"CHANGES ({information}){at_before}{end}"
4212 def pad_sql(self, expression: exp.Pad) -> str: 4213 prefix = "L" if expression.args.get("is_left") else "R" 4214 4215 fill_pattern = self.sql(expression, "fill_pattern") or None 4216 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4217 fill_pattern = "' '" 4218 4219 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern)
def
explodinggenerateseries_sql(self, expression: sqlglot.expressions.ExplodingGenerateSeries) -> str:
4225 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4226 generate_series = exp.GenerateSeries(**expression.args) 4227 4228 parent = expression.parent 4229 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4230 parent = parent.parent 4231 4232 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4233 return self.sql(exp.Unnest(expressions=[generate_series])) 4234 4235 if isinstance(parent, exp.Select): 4236 self.unsupported("GenerateSeries projection unnesting is not supported.") 4237 4238 return self.sql(generate_series)
def
arrayconcat_sql( self, expression: sqlglot.expressions.ArrayConcat, name: str = 'ARRAY_CONCAT') -> str:
4240 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4241 exprs = expression.expressions 4242 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4243 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4244 else: 4245 rhs = self.expressions(expression) 4246 4247 return self.func(name, expression.this, rhs)
4249 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4250 if self.SUPPORTS_CONVERT_TIMEZONE: 4251 return self.function_fallback_sql(expression) 4252 4253 source_tz = expression.args.get("source_tz") 4254 target_tz = expression.args.get("target_tz") 4255 timestamp = expression.args.get("timestamp") 4256 4257 if source_tz and timestamp: 4258 timestamp = exp.AtTimeZone( 4259 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4260 ) 4261 4262 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4263 4264 return self.sql(expr)
4266 def json_sql(self, expression: exp.JSON) -> str: 4267 this = self.sql(expression, "this") 4268 this = f" {this}" if this else "" 4269 4270 _with = expression.args.get("with") 4271 4272 if _with is None: 4273 with_sql = "" 4274 elif not _with: 4275 with_sql = " WITHOUT" 4276 else: 4277 with_sql = " WITH" 4278 4279 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4280 4281 return f"JSON{this}{with_sql}{unique_sql}"
4283 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4284 def _generate_on_options(arg: t.Any) -> str: 4285 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4286 4287 path = self.sql(expression, "path") 4288 returning = self.sql(expression, "returning") 4289 returning = f" RETURNING {returning}" if returning else "" 4290 4291 on_condition = self.sql(expression, "on_condition") 4292 on_condition = f" {on_condition}" if on_condition else "" 4293 4294 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}")
4296 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4297 else_ = "ELSE " if expression.args.get("else_") else "" 4298 condition = self.sql(expression, "expression") 4299 condition = f"WHEN {condition} THEN " if condition else else_ 4300 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4301 return f"{condition}{insert}"
4309 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4310 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4311 empty = expression.args.get("empty") 4312 empty = ( 4313 f"DEFAULT {empty} ON EMPTY" 4314 if isinstance(empty, exp.Expression) 4315 else self.sql(expression, "empty") 4316 ) 4317 4318 error = expression.args.get("error") 4319 error = ( 4320 f"DEFAULT {error} ON ERROR" 4321 if isinstance(error, exp.Expression) 4322 else self.sql(expression, "error") 4323 ) 4324 4325 if error and empty: 4326 error = ( 4327 f"{empty} {error}" 4328 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4329 else f"{error} {empty}" 4330 ) 4331 empty = "" 4332 4333 null = self.sql(expression, "null") 4334 4335 return f"{empty}{error}{null}"
4337 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4338 this = self.sql(expression, "this") 4339 path = self.sql(expression, "path") 4340 4341 passing = self.expressions(expression, "passing") 4342 passing = f" PASSING {passing}" if passing else "" 4343 4344 on_condition = self.sql(expression, "on_condition") 4345 on_condition = f" {on_condition}" if on_condition else "" 4346 4347 path = f"{path}{passing}{on_condition}" 4348 4349 return self.func("JSON_EXISTS", this, path)
4351 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4352 array_agg = self.function_fallback_sql(expression) 4353 4354 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4355 parent = expression.parent 4356 if isinstance(parent, exp.Filter): 4357 parent_cond = parent.expression.this 4358 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4359 else: 4360 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4361 this = expression.this 4362 this_sql = ( 4363 self.expressions(this) 4364 if isinstance(this, exp.Distinct) 4365 else self.sql(expression, "this") 4366 ) 4367 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4368 4369 return array_agg
4377 def grant_sql(self, expression: exp.Grant) -> str: 4378 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4379 4380 kind = self.sql(expression, "kind") 4381 kind = f" {kind}" if kind else "" 4382 4383 securable = self.sql(expression, "securable") 4384 securable = f" {securable}" if securable else "" 4385 4386 principals = self.expressions(expression, key="principals", flat=True) 4387 4388 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4389 4390 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}"
4414 def overlay_sql(self, expression: exp.Overlay): 4415 this = self.sql(expression, "this") 4416 expr = self.sql(expression, "expression") 4417 from_sql = self.sql(expression, "from") 4418 for_sql = self.sql(expression, "for") 4419 for_sql = f" FOR {for_sql}" if for_sql else "" 4420 4421 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})"