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.Int64: lambda self, e: self.sql(exp.cast(e.this, exp.DataType.Type.BIGINT)), 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.SwapTable: lambda self, e: f"SWAP WITH {self.sql(e, 'this')}", 190 exp.TemporaryProperty: lambda *_: "TEMPORARY", 191 exp.Tags: lambda self, e: f"TAG ({self.expressions(e, flat=True)})", 192 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 193 exp.ToMap: lambda self, e: f"MAP {self.sql(e, 'this')}", 194 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 195 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 196 exp.TransientProperty: lambda *_: "TRANSIENT", 197 exp.Union: lambda self, e: self.set_operations(e), 198 exp.UnloggedProperty: lambda *_: "UNLOGGED", 199 exp.Uuid: lambda *_: "UUID()", 200 exp.UppercaseColumnConstraint: lambda *_: "UPPERCASE", 201 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 202 exp.ViewAttributeProperty: lambda self, e: f"WITH {self.sql(e, 'this')}", 203 exp.VolatileProperty: lambda *_: "VOLATILE", 204 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 205 exp.WithProcedureOptions: lambda self, e: f"WITH {self.expressions(e, flat=True)}", 206 exp.WithSchemaBindingProperty: lambda self, e: f"WITH SCHEMA {self.sql(e, 'this')}", 207 exp.WithOperator: lambda self, e: f"{self.sql(e, 'this')} WITH {self.sql(e, 'op')}", 208 } 209 210 # Whether null ordering is supported in order by 211 # True: Full Support, None: No support, False: No support for certain cases 212 # such as window specifications, aggregate functions etc 213 NULL_ORDERING_SUPPORTED: t.Optional[bool] = True 214 215 # Whether ignore nulls is inside the agg or outside. 216 # FIRST(x IGNORE NULLS) OVER vs FIRST (x) IGNORE NULLS OVER 217 IGNORE_NULLS_IN_FUNC = False 218 219 # Whether locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 220 LOCKING_READS_SUPPORTED = False 221 222 # Whether the EXCEPT and INTERSECT operations can return duplicates 223 EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = True 224 225 # Wrap derived values in parens, usually standard but spark doesn't support it 226 WRAP_DERIVED_VALUES = True 227 228 # Whether create function uses an AS before the RETURN 229 CREATE_FUNCTION_RETURN_AS = True 230 231 # Whether MERGE ... WHEN MATCHED BY SOURCE is allowed 232 MATCHED_BY_SOURCE = True 233 234 # Whether the INTERVAL expression works only with values like '1 day' 235 SINGLE_STRING_INTERVAL = False 236 237 # Whether the plural form of date parts like day (i.e. "days") is supported in INTERVALs 238 INTERVAL_ALLOWS_PLURAL_FORM = True 239 240 # Whether limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 241 LIMIT_FETCH = "ALL" 242 243 # Whether limit and fetch allows expresions or just limits 244 LIMIT_ONLY_LITERALS = False 245 246 # Whether a table is allowed to be renamed with a db 247 RENAME_TABLE_WITH_DB = True 248 249 # The separator for grouping sets and rollups 250 GROUPINGS_SEP = "," 251 252 # The string used for creating an index on a table 253 INDEX_ON = "ON" 254 255 # Whether join hints should be generated 256 JOIN_HINTS = True 257 258 # Whether table hints should be generated 259 TABLE_HINTS = True 260 261 # Whether query hints should be generated 262 QUERY_HINTS = True 263 264 # What kind of separator to use for query hints 265 QUERY_HINT_SEP = ", " 266 267 # Whether comparing against booleans (e.g. x IS TRUE) is supported 268 IS_BOOL_ALLOWED = True 269 270 # Whether to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 271 DUPLICATE_KEY_UPDATE_WITH_SET = True 272 273 # Whether to generate the limit as TOP <value> instead of LIMIT <value> 274 LIMIT_IS_TOP = False 275 276 # Whether to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 277 RETURNING_END = True 278 279 # Whether to generate an unquoted value for EXTRACT's date part argument 280 EXTRACT_ALLOWS_QUOTES = True 281 282 # Whether TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 283 TZ_TO_WITH_TIME_ZONE = False 284 285 # Whether the NVL2 function is supported 286 NVL2_SUPPORTED = True 287 288 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 289 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 290 291 # Whether VALUES statements can be used as derived tables. 292 # MySQL 5 and Redshift do not allow this, so when False, it will convert 293 # SELECT * VALUES into SELECT UNION 294 VALUES_AS_TABLE = True 295 296 # Whether the word COLUMN is included when adding a column with ALTER TABLE 297 ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = True 298 299 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 300 UNNEST_WITH_ORDINALITY = True 301 302 # Whether FILTER (WHERE cond) can be used for conditional aggregation 303 AGGREGATE_FILTER_SUPPORTED = True 304 305 # Whether JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 306 SEMI_ANTI_JOIN_WITH_SIDE = True 307 308 # Whether to include the type of a computed column in the CREATE DDL 309 COMPUTED_COLUMN_WITH_TYPE = True 310 311 # Whether CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 312 SUPPORTS_TABLE_COPY = True 313 314 # Whether parentheses are required around the table sample's expression 315 TABLESAMPLE_REQUIRES_PARENS = True 316 317 # Whether a table sample clause's size needs to be followed by the ROWS keyword 318 TABLESAMPLE_SIZE_IS_ROWS = True 319 320 # The keyword(s) to use when generating a sample clause 321 TABLESAMPLE_KEYWORDS = "TABLESAMPLE" 322 323 # Whether the TABLESAMPLE clause supports a method name, like BERNOULLI 324 TABLESAMPLE_WITH_METHOD = True 325 326 # The keyword to use when specifying the seed of a sample clause 327 TABLESAMPLE_SEED_KEYWORD = "SEED" 328 329 # Whether COLLATE is a function instead of a binary operator 330 COLLATE_IS_FUNC = False 331 332 # Whether data types support additional specifiers like e.g. CHAR or BYTE (oracle) 333 DATA_TYPE_SPECIFIERS_ALLOWED = False 334 335 # Whether conditions require booleans WHERE x = 0 vs WHERE x 336 ENSURE_BOOLS = False 337 338 # Whether the "RECURSIVE" keyword is required when defining recursive CTEs 339 CTE_RECURSIVE_KEYWORD_REQUIRED = True 340 341 # Whether CONCAT requires >1 arguments 342 SUPPORTS_SINGLE_ARG_CONCAT = True 343 344 # Whether LAST_DAY function supports a date part argument 345 LAST_DAY_SUPPORTS_DATE_PART = True 346 347 # Whether named columns are allowed in table aliases 348 SUPPORTS_TABLE_ALIAS_COLUMNS = True 349 350 # Whether UNPIVOT aliases are Identifiers (False means they're Literals) 351 UNPIVOT_ALIASES_ARE_IDENTIFIERS = True 352 353 # What delimiter to use for separating JSON key/value pairs 354 JSON_KEY_VALUE_PAIR_SEP = ":" 355 356 # INSERT OVERWRITE TABLE x override 357 INSERT_OVERWRITE = " OVERWRITE TABLE" 358 359 # Whether the SELECT .. INTO syntax is used instead of CTAS 360 SUPPORTS_SELECT_INTO = False 361 362 # Whether UNLOGGED tables can be created 363 SUPPORTS_UNLOGGED_TABLES = False 364 365 # Whether the CREATE TABLE LIKE statement is supported 366 SUPPORTS_CREATE_TABLE_LIKE = True 367 368 # Whether the LikeProperty needs to be specified inside of the schema clause 369 LIKE_PROPERTY_INSIDE_SCHEMA = False 370 371 # Whether DISTINCT can be followed by multiple args in an AggFunc. If not, it will be 372 # transpiled into a series of CASE-WHEN-ELSE, ultimately using a tuple conseisting of the args 373 MULTI_ARG_DISTINCT = True 374 375 # Whether the JSON extraction operators expect a value of type JSON 376 JSON_TYPE_REQUIRED_FOR_EXTRACTION = False 377 378 # Whether bracketed keys like ["foo"] are supported in JSON paths 379 JSON_PATH_BRACKETED_KEY_SUPPORTED = True 380 381 # Whether to escape keys using single quotes in JSON paths 382 JSON_PATH_SINGLE_QUOTE_ESCAPE = False 383 384 # The JSONPathPart expressions supported by this dialect 385 SUPPORTED_JSON_PATH_PARTS = ALL_JSON_PATH_PARTS.copy() 386 387 # Whether any(f(x) for x in array) can be implemented by this dialect 388 CAN_IMPLEMENT_ARRAY_ANY = False 389 390 # Whether the function TO_NUMBER is supported 391 SUPPORTS_TO_NUMBER = True 392 393 # Whether or not set op modifiers apply to the outer set op or select. 394 # SELECT * FROM x UNION SELECT * FROM y LIMIT 1 395 # True means limit 1 happens after the set op, False means it it happens on y. 396 SET_OP_MODIFIERS = True 397 398 # Whether parameters from COPY statement are wrapped in parentheses 399 COPY_PARAMS_ARE_WRAPPED = True 400 401 # Whether values of params are set with "=" token or empty space 402 COPY_PARAMS_EQ_REQUIRED = False 403 404 # Whether COPY statement has INTO keyword 405 COPY_HAS_INTO_KEYWORD = True 406 407 # Whether the conditional TRY(expression) function is supported 408 TRY_SUPPORTED = True 409 410 # Whether the UESCAPE syntax in unicode strings is supported 411 SUPPORTS_UESCAPE = True 412 413 # The keyword to use when generating a star projection with excluded columns 414 STAR_EXCEPT = "EXCEPT" 415 416 # The HEX function name 417 HEX_FUNC = "HEX" 418 419 # The keywords to use when prefixing & separating WITH based properties 420 WITH_PROPERTIES_PREFIX = "WITH" 421 422 # Whether to quote the generated expression of exp.JsonPath 423 QUOTE_JSON_PATH = True 424 425 # Whether the text pattern/fill (3rd) parameter of RPAD()/LPAD() is optional (defaults to space) 426 PAD_FILL_PATTERN_IS_REQUIRED = False 427 428 # Whether a projection can explode into multiple rows, e.g. by unnesting an array. 429 SUPPORTS_EXPLODING_PROJECTIONS = True 430 431 # Whether ARRAY_CONCAT can be generated with varlen args or if it should be reduced to 2-arg version 432 ARRAY_CONCAT_IS_VAR_LEN = True 433 434 # Whether CONVERT_TIMEZONE() is supported; if not, it will be generated as exp.AtTimeZone 435 SUPPORTS_CONVERT_TIMEZONE = False 436 437 # Whether MEDIAN(expr) is supported; if not, it will be generated as PERCENTILE_CONT(expr, 0.5) 438 SUPPORTS_MEDIAN = True 439 440 # Whether UNIX_SECONDS(timestamp) is supported 441 SUPPORTS_UNIX_SECONDS = False 442 443 # The name to generate for the JSONPath expression. If `None`, only `this` will be generated 444 PARSE_JSON_NAME: t.Optional[str] = "PARSE_JSON" 445 446 # The function name of the exp.ArraySize expression 447 ARRAY_SIZE_NAME: str = "ARRAY_LENGTH" 448 449 # Whether exp.ArraySize should generate the dimension arg too (valid for Postgres & DuckDB) 450 # None -> Doesn't support it at all 451 # False (DuckDB) -> Has backwards-compatible support, but preferably generated without 452 # True (Postgres) -> Explicitly requires it 453 ARRAY_SIZE_DIM_REQUIRED: t.Optional[bool] = None 454 455 TYPE_MAPPING = { 456 exp.DataType.Type.DATETIME2: "TIMESTAMP", 457 exp.DataType.Type.NCHAR: "CHAR", 458 exp.DataType.Type.NVARCHAR: "VARCHAR", 459 exp.DataType.Type.MEDIUMTEXT: "TEXT", 460 exp.DataType.Type.LONGTEXT: "TEXT", 461 exp.DataType.Type.TINYTEXT: "TEXT", 462 exp.DataType.Type.MEDIUMBLOB: "BLOB", 463 exp.DataType.Type.LONGBLOB: "BLOB", 464 exp.DataType.Type.TINYBLOB: "BLOB", 465 exp.DataType.Type.INET: "INET", 466 exp.DataType.Type.ROWVERSION: "VARBINARY", 467 exp.DataType.Type.SMALLDATETIME: "TIMESTAMP", 468 } 469 470 TIME_PART_SINGULARS = { 471 "MICROSECONDS": "MICROSECOND", 472 "SECONDS": "SECOND", 473 "MINUTES": "MINUTE", 474 "HOURS": "HOUR", 475 "DAYS": "DAY", 476 "WEEKS": "WEEK", 477 "MONTHS": "MONTH", 478 "QUARTERS": "QUARTER", 479 "YEARS": "YEAR", 480 } 481 482 AFTER_HAVING_MODIFIER_TRANSFORMS = { 483 "cluster": lambda self, e: self.sql(e, "cluster"), 484 "distribute": lambda self, e: self.sql(e, "distribute"), 485 "sort": lambda self, e: self.sql(e, "sort"), 486 "windows": lambda self, e: ( 487 self.seg("WINDOW ") + self.expressions(e, key="windows", flat=True) 488 if e.args.get("windows") 489 else "" 490 ), 491 "qualify": lambda self, e: self.sql(e, "qualify"), 492 } 493 494 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 495 496 STRUCT_DELIMITER = ("<", ">") 497 498 PARAMETER_TOKEN = "@" 499 NAMED_PLACEHOLDER_TOKEN = ":" 500 501 EXPRESSION_PRECEDES_PROPERTIES_CREATABLES: t.Set[str] = set() 502 503 PROPERTIES_LOCATION = { 504 exp.AllowedValuesProperty: exp.Properties.Location.POST_SCHEMA, 505 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 506 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 507 exp.AutoRefreshProperty: exp.Properties.Location.POST_SCHEMA, 508 exp.BackupProperty: exp.Properties.Location.POST_SCHEMA, 509 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 510 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 511 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 512 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 513 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 514 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 515 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 516 exp.DistributedByProperty: exp.Properties.Location.POST_SCHEMA, 517 exp.DuplicateKeyProperty: exp.Properties.Location.POST_SCHEMA, 518 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 519 exp.DataDeletionProperty: exp.Properties.Location.POST_SCHEMA, 520 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 521 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 522 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 523 exp.DynamicProperty: exp.Properties.Location.POST_CREATE, 524 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 525 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 526 exp.EmptyProperty: exp.Properties.Location.POST_SCHEMA, 527 exp.EncodeProperty: exp.Properties.Location.POST_EXPRESSION, 528 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 529 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 530 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 531 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 532 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 533 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 534 exp.GlobalProperty: exp.Properties.Location.POST_CREATE, 535 exp.HeapProperty: exp.Properties.Location.POST_WITH, 536 exp.InheritsProperty: exp.Properties.Location.POST_SCHEMA, 537 exp.IcebergProperty: exp.Properties.Location.POST_CREATE, 538 exp.IncludeProperty: exp.Properties.Location.POST_SCHEMA, 539 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 540 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 541 exp.JournalProperty: exp.Properties.Location.POST_NAME, 542 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 543 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 544 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 545 exp.LockProperty: exp.Properties.Location.POST_SCHEMA, 546 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 547 exp.LogProperty: exp.Properties.Location.POST_NAME, 548 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 549 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 550 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 551 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 552 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 553 exp.Order: exp.Properties.Location.POST_SCHEMA, 554 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 555 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 556 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 557 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 558 exp.Property: exp.Properties.Location.POST_WITH, 559 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 560 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 561 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 562 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 563 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 564 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 565 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 566 exp.SecureProperty: exp.Properties.Location.POST_CREATE, 567 exp.SecurityProperty: exp.Properties.Location.POST_SCHEMA, 568 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 569 exp.Set: exp.Properties.Location.POST_SCHEMA, 570 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 571 exp.SetProperty: exp.Properties.Location.POST_CREATE, 572 exp.SetConfigProperty: exp.Properties.Location.POST_SCHEMA, 573 exp.SharingProperty: exp.Properties.Location.POST_EXPRESSION, 574 exp.SequenceProperties: exp.Properties.Location.POST_EXPRESSION, 575 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 576 exp.SqlReadWriteProperty: exp.Properties.Location.POST_SCHEMA, 577 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 578 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 579 exp.StreamingTableProperty: exp.Properties.Location.POST_CREATE, 580 exp.StrictProperty: exp.Properties.Location.POST_SCHEMA, 581 exp.Tags: exp.Properties.Location.POST_WITH, 582 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 583 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 584 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 585 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 586 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 587 exp.UnloggedProperty: exp.Properties.Location.POST_CREATE, 588 exp.ViewAttributeProperty: exp.Properties.Location.POST_SCHEMA, 589 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 590 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 591 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 592 exp.WithProcedureOptions: exp.Properties.Location.POST_SCHEMA, 593 exp.WithSchemaBindingProperty: exp.Properties.Location.POST_SCHEMA, 594 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 595 } 596 597 # Keywords that can't be used as unquoted identifier names 598 RESERVED_KEYWORDS: t.Set[str] = set() 599 600 # Expressions whose comments are separated from them for better formatting 601 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 602 exp.Command, 603 exp.Create, 604 exp.Describe, 605 exp.Delete, 606 exp.Drop, 607 exp.From, 608 exp.Insert, 609 exp.Join, 610 exp.MultitableInserts, 611 exp.Select, 612 exp.SetOperation, 613 exp.Update, 614 exp.Where, 615 exp.With, 616 ) 617 618 # Expressions that should not have their comments generated in maybe_comment 619 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 620 exp.Binary, 621 exp.SetOperation, 622 ) 623 624 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 625 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 626 exp.Column, 627 exp.Literal, 628 exp.Neg, 629 exp.Paren, 630 ) 631 632 PARAMETERIZABLE_TEXT_TYPES = { 633 exp.DataType.Type.NVARCHAR, 634 exp.DataType.Type.VARCHAR, 635 exp.DataType.Type.CHAR, 636 exp.DataType.Type.NCHAR, 637 } 638 639 # Expressions that need to have all CTEs under them bubbled up to them 640 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 641 642 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 643 644 __slots__ = ( 645 "pretty", 646 "identify", 647 "normalize", 648 "pad", 649 "_indent", 650 "normalize_functions", 651 "unsupported_level", 652 "max_unsupported", 653 "leading_comma", 654 "max_text_width", 655 "comments", 656 "dialect", 657 "unsupported_messages", 658 "_escaped_quote_end", 659 "_escaped_identifier_end", 660 "_next_name", 661 "_identifier_start", 662 "_identifier_end", 663 "_quote_json_path_key_using_brackets", 664 ) 665 666 def __init__( 667 self, 668 pretty: t.Optional[bool] = None, 669 identify: str | bool = False, 670 normalize: bool = False, 671 pad: int = 2, 672 indent: int = 2, 673 normalize_functions: t.Optional[str | bool] = None, 674 unsupported_level: ErrorLevel = ErrorLevel.WARN, 675 max_unsupported: int = 3, 676 leading_comma: bool = False, 677 max_text_width: int = 80, 678 comments: bool = True, 679 dialect: DialectType = None, 680 ): 681 import sqlglot 682 from sqlglot.dialects import Dialect 683 684 self.pretty = pretty if pretty is not None else sqlglot.pretty 685 self.identify = identify 686 self.normalize = normalize 687 self.pad = pad 688 self._indent = indent 689 self.unsupported_level = unsupported_level 690 self.max_unsupported = max_unsupported 691 self.leading_comma = leading_comma 692 self.max_text_width = max_text_width 693 self.comments = comments 694 self.dialect = Dialect.get_or_raise(dialect) 695 696 # This is both a Dialect property and a Generator argument, so we prioritize the latter 697 self.normalize_functions = ( 698 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 699 ) 700 701 self.unsupported_messages: t.List[str] = [] 702 self._escaped_quote_end: str = ( 703 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 704 ) 705 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 706 707 self._next_name = name_sequence("_t") 708 709 self._identifier_start = self.dialect.IDENTIFIER_START 710 self._identifier_end = self.dialect.IDENTIFIER_END 711 712 self._quote_json_path_key_using_brackets = True 713 714 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 715 """ 716 Generates the SQL string corresponding to the given syntax tree. 717 718 Args: 719 expression: The syntax tree. 720 copy: Whether to copy the expression. The generator performs mutations so 721 it is safer to copy. 722 723 Returns: 724 The SQL string corresponding to `expression`. 725 """ 726 if copy: 727 expression = expression.copy() 728 729 expression = self.preprocess(expression) 730 731 self.unsupported_messages = [] 732 sql = self.sql(expression).strip() 733 734 if self.pretty: 735 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 736 737 if self.unsupported_level == ErrorLevel.IGNORE: 738 return sql 739 740 if self.unsupported_level == ErrorLevel.WARN: 741 for msg in self.unsupported_messages: 742 logger.warning(msg) 743 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 744 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 745 746 return sql 747 748 def preprocess(self, expression: exp.Expression) -> exp.Expression: 749 """Apply generic preprocessing transformations to a given expression.""" 750 expression = self._move_ctes_to_top_level(expression) 751 752 if self.ENSURE_BOOLS: 753 from sqlglot.transforms import ensure_bools 754 755 expression = ensure_bools(expression) 756 757 return expression 758 759 def _move_ctes_to_top_level(self, expression: E) -> E: 760 if ( 761 not expression.parent 762 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 763 and any(node.parent is not expression for node in expression.find_all(exp.With)) 764 ): 765 from sqlglot.transforms import move_ctes_to_top_level 766 767 expression = move_ctes_to_top_level(expression) 768 return expression 769 770 def unsupported(self, message: str) -> None: 771 if self.unsupported_level == ErrorLevel.IMMEDIATE: 772 raise UnsupportedError(message) 773 self.unsupported_messages.append(message) 774 775 def sep(self, sep: str = " ") -> str: 776 return f"{sep.strip()}\n" if self.pretty else sep 777 778 def seg(self, sql: str, sep: str = " ") -> str: 779 return f"{self.sep(sep)}{sql}" 780 781 def pad_comment(self, comment: str) -> str: 782 comment = " " + comment if comment[0].strip() else comment 783 comment = comment + " " if comment[-1].strip() else comment 784 return comment 785 786 def maybe_comment( 787 self, 788 sql: str, 789 expression: t.Optional[exp.Expression] = None, 790 comments: t.Optional[t.List[str]] = None, 791 separated: bool = False, 792 ) -> str: 793 comments = ( 794 ((expression and expression.comments) if comments is None else comments) # type: ignore 795 if self.comments 796 else None 797 ) 798 799 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 800 return sql 801 802 comments_sql = " ".join( 803 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 804 ) 805 806 if not comments_sql: 807 return sql 808 809 comments_sql = self._replace_line_breaks(comments_sql) 810 811 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 812 return ( 813 f"{self.sep()}{comments_sql}{sql}" 814 if not sql or sql[0].isspace() 815 else f"{comments_sql}{self.sep()}{sql}" 816 ) 817 818 return f"{sql} {comments_sql}" 819 820 def wrap(self, expression: exp.Expression | str) -> str: 821 this_sql = ( 822 self.sql(expression) 823 if isinstance(expression, exp.UNWRAPPED_QUERIES) 824 else self.sql(expression, "this") 825 ) 826 if not this_sql: 827 return "()" 828 829 this_sql = self.indent(this_sql, level=1, pad=0) 830 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 831 832 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 833 original = self.identify 834 self.identify = False 835 result = func(*args, **kwargs) 836 self.identify = original 837 return result 838 839 def normalize_func(self, name: str) -> str: 840 if self.normalize_functions == "upper" or self.normalize_functions is True: 841 return name.upper() 842 if self.normalize_functions == "lower": 843 return name.lower() 844 return name 845 846 def indent( 847 self, 848 sql: str, 849 level: int = 0, 850 pad: t.Optional[int] = None, 851 skip_first: bool = False, 852 skip_last: bool = False, 853 ) -> str: 854 if not self.pretty or not sql: 855 return sql 856 857 pad = self.pad if pad is None else pad 858 lines = sql.split("\n") 859 860 return "\n".join( 861 ( 862 line 863 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 864 else f"{' ' * (level * self._indent + pad)}{line}" 865 ) 866 for i, line in enumerate(lines) 867 ) 868 869 def sql( 870 self, 871 expression: t.Optional[str | exp.Expression], 872 key: t.Optional[str] = None, 873 comment: bool = True, 874 ) -> str: 875 if not expression: 876 return "" 877 878 if isinstance(expression, str): 879 return expression 880 881 if key: 882 value = expression.args.get(key) 883 if value: 884 return self.sql(value) 885 return "" 886 887 transform = self.TRANSFORMS.get(expression.__class__) 888 889 if callable(transform): 890 sql = transform(self, expression) 891 elif isinstance(expression, exp.Expression): 892 exp_handler_name = f"{expression.key}_sql" 893 894 if hasattr(self, exp_handler_name): 895 sql = getattr(self, exp_handler_name)(expression) 896 elif isinstance(expression, exp.Func): 897 sql = self.function_fallback_sql(expression) 898 elif isinstance(expression, exp.Property): 899 sql = self.property_sql(expression) 900 else: 901 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 902 else: 903 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 904 905 return self.maybe_comment(sql, expression) if self.comments and comment else sql 906 907 def uncache_sql(self, expression: exp.Uncache) -> str: 908 table = self.sql(expression, "this") 909 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 910 return f"UNCACHE TABLE{exists_sql} {table}" 911 912 def cache_sql(self, expression: exp.Cache) -> str: 913 lazy = " LAZY" if expression.args.get("lazy") else "" 914 table = self.sql(expression, "this") 915 options = expression.args.get("options") 916 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 917 sql = self.sql(expression, "expression") 918 sql = f" AS{self.sep()}{sql}" if sql else "" 919 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 920 return self.prepend_ctes(expression, sql) 921 922 def characterset_sql(self, expression: exp.CharacterSet) -> str: 923 if isinstance(expression.parent, exp.Cast): 924 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 925 default = "DEFAULT " if expression.args.get("default") else "" 926 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 927 928 def column_parts(self, expression: exp.Column) -> str: 929 return ".".join( 930 self.sql(part) 931 for part in ( 932 expression.args.get("catalog"), 933 expression.args.get("db"), 934 expression.args.get("table"), 935 expression.args.get("this"), 936 ) 937 if part 938 ) 939 940 def column_sql(self, expression: exp.Column) -> str: 941 join_mark = " (+)" if expression.args.get("join_mark") else "" 942 943 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 944 join_mark = "" 945 self.unsupported("Outer join syntax using the (+) operator is not supported.") 946 947 return f"{self.column_parts(expression)}{join_mark}" 948 949 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 950 this = self.sql(expression, "this") 951 this = f" {this}" if this else "" 952 position = self.sql(expression, "position") 953 return f"{position}{this}" 954 955 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 956 column = self.sql(expression, "this") 957 kind = self.sql(expression, "kind") 958 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 959 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 960 kind = f"{sep}{kind}" if kind else "" 961 constraints = f" {constraints}" if constraints else "" 962 position = self.sql(expression, "position") 963 position = f" {position}" if position else "" 964 965 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 966 kind = "" 967 968 return f"{exists}{column}{kind}{constraints}{position}" 969 970 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 971 this = self.sql(expression, "this") 972 kind_sql = self.sql(expression, "kind").strip() 973 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 974 975 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 976 this = self.sql(expression, "this") 977 if expression.args.get("not_null"): 978 persisted = " PERSISTED NOT NULL" 979 elif expression.args.get("persisted"): 980 persisted = " PERSISTED" 981 else: 982 persisted = "" 983 return f"AS {this}{persisted}" 984 985 def autoincrementcolumnconstraint_sql(self, _) -> str: 986 return self.token_sql(TokenType.AUTO_INCREMENT) 987 988 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 989 if isinstance(expression.this, list): 990 this = self.wrap(self.expressions(expression, key="this", flat=True)) 991 else: 992 this = self.sql(expression, "this") 993 994 return f"COMPRESS {this}" 995 996 def generatedasidentitycolumnconstraint_sql( 997 self, expression: exp.GeneratedAsIdentityColumnConstraint 998 ) -> str: 999 this = "" 1000 if expression.this is not None: 1001 on_null = " ON NULL" if expression.args.get("on_null") else "" 1002 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 1003 1004 start = expression.args.get("start") 1005 start = f"START WITH {start}" if start else "" 1006 increment = expression.args.get("increment") 1007 increment = f" INCREMENT BY {increment}" if increment else "" 1008 minvalue = expression.args.get("minvalue") 1009 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1010 maxvalue = expression.args.get("maxvalue") 1011 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1012 cycle = expression.args.get("cycle") 1013 cycle_sql = "" 1014 1015 if cycle is not None: 1016 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 1017 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 1018 1019 sequence_opts = "" 1020 if start or increment or cycle_sql: 1021 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 1022 sequence_opts = f" ({sequence_opts.strip()})" 1023 1024 expr = self.sql(expression, "expression") 1025 expr = f"({expr})" if expr else "IDENTITY" 1026 1027 return f"GENERATED{this} AS {expr}{sequence_opts}" 1028 1029 def generatedasrowcolumnconstraint_sql( 1030 self, expression: exp.GeneratedAsRowColumnConstraint 1031 ) -> str: 1032 start = "START" if expression.args.get("start") else "END" 1033 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1034 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 1035 1036 def periodforsystemtimeconstraint_sql( 1037 self, expression: exp.PeriodForSystemTimeConstraint 1038 ) -> str: 1039 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 1040 1041 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 1042 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 1043 1044 def transformcolumnconstraint_sql(self, expression: exp.TransformColumnConstraint) -> str: 1045 return f"AS {self.sql(expression, 'this')}" 1046 1047 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 1048 desc = expression.args.get("desc") 1049 if desc is not None: 1050 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 1051 return "PRIMARY KEY" 1052 1053 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1054 this = self.sql(expression, "this") 1055 this = f" {this}" if this else "" 1056 index_type = expression.args.get("index_type") 1057 index_type = f" USING {index_type}" if index_type else "" 1058 on_conflict = self.sql(expression, "on_conflict") 1059 on_conflict = f" {on_conflict}" if on_conflict else "" 1060 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1061 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}" 1062 1063 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 1064 return self.sql(expression, "this") 1065 1066 def create_sql(self, expression: exp.Create) -> str: 1067 kind = self.sql(expression, "kind") 1068 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1069 properties = expression.args.get("properties") 1070 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1071 1072 this = self.createable_sql(expression, properties_locs) 1073 1074 properties_sql = "" 1075 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1076 exp.Properties.Location.POST_WITH 1077 ): 1078 properties_sql = self.sql( 1079 exp.Properties( 1080 expressions=[ 1081 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1082 *properties_locs[exp.Properties.Location.POST_WITH], 1083 ] 1084 ) 1085 ) 1086 1087 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1088 properties_sql = self.sep() + properties_sql 1089 elif not self.pretty: 1090 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1091 properties_sql = f" {properties_sql}" 1092 1093 begin = " BEGIN" if expression.args.get("begin") else "" 1094 end = " END" if expression.args.get("end") else "" 1095 1096 expression_sql = self.sql(expression, "expression") 1097 if expression_sql: 1098 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1099 1100 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1101 postalias_props_sql = "" 1102 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1103 postalias_props_sql = self.properties( 1104 exp.Properties( 1105 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1106 ), 1107 wrapped=False, 1108 ) 1109 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1110 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1111 1112 postindex_props_sql = "" 1113 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1114 postindex_props_sql = self.properties( 1115 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1116 wrapped=False, 1117 prefix=" ", 1118 ) 1119 1120 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1121 indexes = f" {indexes}" if indexes else "" 1122 index_sql = indexes + postindex_props_sql 1123 1124 replace = " OR REPLACE" if expression.args.get("replace") else "" 1125 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1126 unique = " UNIQUE" if expression.args.get("unique") else "" 1127 1128 clustered = expression.args.get("clustered") 1129 if clustered is None: 1130 clustered_sql = "" 1131 elif clustered: 1132 clustered_sql = " CLUSTERED COLUMNSTORE" 1133 else: 1134 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1135 1136 postcreate_props_sql = "" 1137 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1138 postcreate_props_sql = self.properties( 1139 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1140 sep=" ", 1141 prefix=" ", 1142 wrapped=False, 1143 ) 1144 1145 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1146 1147 postexpression_props_sql = "" 1148 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1149 postexpression_props_sql = self.properties( 1150 exp.Properties( 1151 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1152 ), 1153 sep=" ", 1154 prefix=" ", 1155 wrapped=False, 1156 ) 1157 1158 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1159 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1160 no_schema_binding = ( 1161 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1162 ) 1163 1164 clone = self.sql(expression, "clone") 1165 clone = f" {clone}" if clone else "" 1166 1167 if kind in self.EXPRESSION_PRECEDES_PROPERTIES_CREATABLES: 1168 properties_expression = f"{expression_sql}{properties_sql}" 1169 else: 1170 properties_expression = f"{properties_sql}{expression_sql}" 1171 1172 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_expression}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1173 return self.prepend_ctes(expression, expression_sql) 1174 1175 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1176 start = self.sql(expression, "start") 1177 start = f"START WITH {start}" if start else "" 1178 increment = self.sql(expression, "increment") 1179 increment = f" INCREMENT BY {increment}" if increment else "" 1180 minvalue = self.sql(expression, "minvalue") 1181 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1182 maxvalue = self.sql(expression, "maxvalue") 1183 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1184 owned = self.sql(expression, "owned") 1185 owned = f" OWNED BY {owned}" if owned else "" 1186 1187 cache = expression.args.get("cache") 1188 if cache is None: 1189 cache_str = "" 1190 elif cache is True: 1191 cache_str = " CACHE" 1192 else: 1193 cache_str = f" CACHE {cache}" 1194 1195 options = self.expressions(expression, key="options", flat=True, sep=" ") 1196 options = f" {options}" if options else "" 1197 1198 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip() 1199 1200 def clone_sql(self, expression: exp.Clone) -> str: 1201 this = self.sql(expression, "this") 1202 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1203 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1204 return f"{shallow}{keyword} {this}" 1205 1206 def describe_sql(self, expression: exp.Describe) -> str: 1207 style = expression.args.get("style") 1208 style = f" {style}" if style else "" 1209 partition = self.sql(expression, "partition") 1210 partition = f" {partition}" if partition else "" 1211 format = self.sql(expression, "format") 1212 format = f" {format}" if format else "" 1213 1214 return f"DESCRIBE{style}{format} {self.sql(expression, 'this')}{partition}" 1215 1216 def heredoc_sql(self, expression: exp.Heredoc) -> str: 1217 tag = self.sql(expression, "tag") 1218 return f"${tag}${self.sql(expression, 'this')}${tag}$" 1219 1220 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 1221 with_ = self.sql(expression, "with") 1222 if with_: 1223 sql = f"{with_}{self.sep()}{sql}" 1224 return sql 1225 1226 def with_sql(self, expression: exp.With) -> str: 1227 sql = self.expressions(expression, flat=True) 1228 recursive = ( 1229 "RECURSIVE " 1230 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 1231 else "" 1232 ) 1233 1234 return f"WITH {recursive}{sql}" 1235 1236 def cte_sql(self, expression: exp.CTE) -> str: 1237 alias = expression.args.get("alias") 1238 if alias: 1239 alias.add_comments(expression.pop_comments()) 1240 1241 alias_sql = self.sql(expression, "alias") 1242 1243 materialized = expression.args.get("materialized") 1244 if materialized is False: 1245 materialized = "NOT MATERIALIZED " 1246 elif materialized: 1247 materialized = "MATERIALIZED " 1248 1249 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}" 1250 1251 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1252 alias = self.sql(expression, "this") 1253 columns = self.expressions(expression, key="columns", flat=True) 1254 columns = f"({columns})" if columns else "" 1255 1256 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1257 columns = "" 1258 self.unsupported("Named columns are not supported in table alias.") 1259 1260 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1261 alias = self._next_name() 1262 1263 return f"{alias}{columns}" 1264 1265 def bitstring_sql(self, expression: exp.BitString) -> str: 1266 this = self.sql(expression, "this") 1267 if self.dialect.BIT_START: 1268 return f"{self.dialect.BIT_START}{this}{self.dialect.BIT_END}" 1269 return f"{int(this, 2)}" 1270 1271 def hexstring_sql(self, expression: exp.HexString) -> str: 1272 this = self.sql(expression, "this") 1273 if self.dialect.HEX_START: 1274 return f"{self.dialect.HEX_START}{this}{self.dialect.HEX_END}" 1275 return f"{int(this, 16)}" 1276 1277 def bytestring_sql(self, expression: exp.ByteString) -> str: 1278 this = self.sql(expression, "this") 1279 if self.dialect.BYTE_START: 1280 return f"{self.dialect.BYTE_START}{this}{self.dialect.BYTE_END}" 1281 return this 1282 1283 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1284 this = self.sql(expression, "this") 1285 escape = expression.args.get("escape") 1286 1287 if self.dialect.UNICODE_START: 1288 escape_substitute = r"\\\1" 1289 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1290 else: 1291 escape_substitute = r"\\u\1" 1292 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1293 1294 if escape: 1295 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1296 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1297 else: 1298 escape_pattern = ESCAPED_UNICODE_RE 1299 escape_sql = "" 1300 1301 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1302 this = escape_pattern.sub(escape_substitute, this) 1303 1304 return f"{left_quote}{this}{right_quote}{escape_sql}" 1305 1306 def rawstring_sql(self, expression: exp.RawString) -> str: 1307 string = self.escape_str(expression.this.replace("\\", "\\\\"), escape_backslash=False) 1308 return f"{self.dialect.QUOTE_START}{string}{self.dialect.QUOTE_END}" 1309 1310 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 1311 this = self.sql(expression, "this") 1312 specifier = self.sql(expression, "expression") 1313 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 1314 return f"{this}{specifier}" 1315 1316 def datatype_sql(self, expression: exp.DataType) -> str: 1317 nested = "" 1318 values = "" 1319 interior = self.expressions(expression, flat=True) 1320 1321 type_value = expression.this 1322 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1323 type_sql = self.sql(expression, "kind") 1324 else: 1325 type_sql = ( 1326 self.TYPE_MAPPING.get(type_value, type_value.value) 1327 if isinstance(type_value, exp.DataType.Type) 1328 else type_value 1329 ) 1330 1331 if interior: 1332 if expression.args.get("nested"): 1333 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1334 if expression.args.get("values") is not None: 1335 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1336 values = self.expressions(expression, key="values", flat=True) 1337 values = f"{delimiters[0]}{values}{delimiters[1]}" 1338 elif type_value == exp.DataType.Type.INTERVAL: 1339 nested = f" {interior}" 1340 else: 1341 nested = f"({interior})" 1342 1343 type_sql = f"{type_sql}{nested}{values}" 1344 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1345 exp.DataType.Type.TIMETZ, 1346 exp.DataType.Type.TIMESTAMPTZ, 1347 ): 1348 type_sql = f"{type_sql} WITH TIME ZONE" 1349 1350 return type_sql 1351 1352 def directory_sql(self, expression: exp.Directory) -> str: 1353 local = "LOCAL " if expression.args.get("local") else "" 1354 row_format = self.sql(expression, "row_format") 1355 row_format = f" {row_format}" if row_format else "" 1356 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1357 1358 def delete_sql(self, expression: exp.Delete) -> str: 1359 this = self.sql(expression, "this") 1360 this = f" FROM {this}" if this else "" 1361 using = self.sql(expression, "using") 1362 using = f" USING {using}" if using else "" 1363 cluster = self.sql(expression, "cluster") 1364 cluster = f" {cluster}" if cluster else "" 1365 where = self.sql(expression, "where") 1366 returning = self.sql(expression, "returning") 1367 limit = self.sql(expression, "limit") 1368 tables = self.expressions(expression, key="tables") 1369 tables = f" {tables}" if tables else "" 1370 if self.RETURNING_END: 1371 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1372 else: 1373 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1374 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1375 1376 def drop_sql(self, expression: exp.Drop) -> str: 1377 this = self.sql(expression, "this") 1378 expressions = self.expressions(expression, flat=True) 1379 expressions = f" ({expressions})" if expressions else "" 1380 kind = expression.args["kind"] 1381 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1382 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1383 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1384 on_cluster = self.sql(expression, "cluster") 1385 on_cluster = f" {on_cluster}" if on_cluster else "" 1386 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1387 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1388 cascade = " CASCADE" if expression.args.get("cascade") else "" 1389 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1390 purge = " PURGE" if expression.args.get("purge") else "" 1391 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}" 1392 1393 def set_operation(self, expression: exp.SetOperation) -> str: 1394 op_type = type(expression) 1395 op_name = op_type.key.upper() 1396 1397 distinct = expression.args.get("distinct") 1398 if ( 1399 distinct is False 1400 and op_type in (exp.Except, exp.Intersect) 1401 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1402 ): 1403 self.unsupported(f"{op_name} ALL is not supported") 1404 1405 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1406 1407 if distinct is None: 1408 distinct = default_distinct 1409 if distinct is None: 1410 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1411 1412 if distinct is default_distinct: 1413 kind = "" 1414 else: 1415 kind = " DISTINCT" if distinct else " ALL" 1416 1417 by_name = " BY NAME" if expression.args.get("by_name") else "" 1418 return f"{op_name}{kind}{by_name}" 1419 1420 def set_operations(self, expression: exp.SetOperation) -> str: 1421 if not self.SET_OP_MODIFIERS: 1422 limit = expression.args.get("limit") 1423 order = expression.args.get("order") 1424 1425 if limit or order: 1426 select = self._move_ctes_to_top_level( 1427 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1428 ) 1429 1430 if limit: 1431 select = select.limit(limit.pop(), copy=False) 1432 if order: 1433 select = select.order_by(order.pop(), copy=False) 1434 return self.sql(select) 1435 1436 sqls: t.List[str] = [] 1437 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1438 1439 while stack: 1440 node = stack.pop() 1441 1442 if isinstance(node, exp.SetOperation): 1443 stack.append(node.expression) 1444 stack.append( 1445 self.maybe_comment( 1446 self.set_operation(node), comments=node.comments, separated=True 1447 ) 1448 ) 1449 stack.append(node.this) 1450 else: 1451 sqls.append(self.sql(node)) 1452 1453 this = self.sep().join(sqls) 1454 this = self.query_modifiers(expression, this) 1455 return self.prepend_ctes(expression, this) 1456 1457 def fetch_sql(self, expression: exp.Fetch) -> str: 1458 direction = expression.args.get("direction") 1459 direction = f" {direction}" if direction else "" 1460 count = self.sql(expression, "count") 1461 count = f" {count}" if count else "" 1462 if expression.args.get("percent"): 1463 count = f"{count} PERCENT" 1464 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1465 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1466 1467 def filter_sql(self, expression: exp.Filter) -> str: 1468 if self.AGGREGATE_FILTER_SUPPORTED: 1469 this = self.sql(expression, "this") 1470 where = self.sql(expression, "expression").strip() 1471 return f"{this} FILTER({where})" 1472 1473 agg = expression.this 1474 agg_arg = agg.this 1475 cond = expression.expression.this 1476 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1477 return self.sql(agg) 1478 1479 def hint_sql(self, expression: exp.Hint) -> str: 1480 if not self.QUERY_HINTS: 1481 self.unsupported("Hints are not supported") 1482 return "" 1483 1484 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1485 1486 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1487 using = self.sql(expression, "using") 1488 using = f" USING {using}" if using else "" 1489 columns = self.expressions(expression, key="columns", flat=True) 1490 columns = f"({columns})" if columns else "" 1491 partition_by = self.expressions(expression, key="partition_by", flat=True) 1492 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1493 where = self.sql(expression, "where") 1494 include = self.expressions(expression, key="include", flat=True) 1495 if include: 1496 include = f" INCLUDE ({include})" 1497 with_storage = self.expressions(expression, key="with_storage", flat=True) 1498 with_storage = f" WITH ({with_storage})" if with_storage else "" 1499 tablespace = self.sql(expression, "tablespace") 1500 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1501 on = self.sql(expression, "on") 1502 on = f" ON {on}" if on else "" 1503 1504 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}" 1505 1506 def index_sql(self, expression: exp.Index) -> str: 1507 unique = "UNIQUE " if expression.args.get("unique") else "" 1508 primary = "PRIMARY " if expression.args.get("primary") else "" 1509 amp = "AMP " if expression.args.get("amp") else "" 1510 name = self.sql(expression, "this") 1511 name = f"{name} " if name else "" 1512 table = self.sql(expression, "table") 1513 table = f"{self.INDEX_ON} {table}" if table else "" 1514 1515 index = "INDEX " if not table else "" 1516 1517 params = self.sql(expression, "params") 1518 return f"{unique}{primary}{amp}{index}{name}{table}{params}" 1519 1520 def identifier_sql(self, expression: exp.Identifier) -> str: 1521 text = expression.name 1522 lower = text.lower() 1523 text = lower if self.normalize and not expression.quoted else text 1524 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1525 if ( 1526 expression.quoted 1527 or self.dialect.can_identify(text, self.identify) 1528 or lower in self.RESERVED_KEYWORDS 1529 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1530 ): 1531 text = f"{self._identifier_start}{text}{self._identifier_end}" 1532 return text 1533 1534 def hex_sql(self, expression: exp.Hex) -> str: 1535 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1536 if self.dialect.HEX_LOWERCASE: 1537 text = self.func("LOWER", text) 1538 1539 return text 1540 1541 def lowerhex_sql(self, expression: exp.LowerHex) -> str: 1542 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1543 if not self.dialect.HEX_LOWERCASE: 1544 text = self.func("LOWER", text) 1545 return text 1546 1547 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1548 input_format = self.sql(expression, "input_format") 1549 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1550 output_format = self.sql(expression, "output_format") 1551 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1552 return self.sep().join((input_format, output_format)) 1553 1554 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1555 string = self.sql(exp.Literal.string(expression.name)) 1556 return f"{prefix}{string}" 1557 1558 def partition_sql(self, expression: exp.Partition) -> str: 1559 return f"PARTITION({self.expressions(expression, flat=True)})" 1560 1561 def properties_sql(self, expression: exp.Properties) -> str: 1562 root_properties = [] 1563 with_properties = [] 1564 1565 for p in expression.expressions: 1566 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1567 if p_loc == exp.Properties.Location.POST_WITH: 1568 with_properties.append(p) 1569 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1570 root_properties.append(p) 1571 1572 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1573 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1574 1575 if root_props and with_props and not self.pretty: 1576 with_props = " " + with_props 1577 1578 return root_props + with_props 1579 1580 def root_properties(self, properties: exp.Properties) -> str: 1581 if properties.expressions: 1582 return self.expressions(properties, indent=False, sep=" ") 1583 return "" 1584 1585 def properties( 1586 self, 1587 properties: exp.Properties, 1588 prefix: str = "", 1589 sep: str = ", ", 1590 suffix: str = "", 1591 wrapped: bool = True, 1592 ) -> str: 1593 if properties.expressions: 1594 expressions = self.expressions(properties, sep=sep, indent=False) 1595 if expressions: 1596 expressions = self.wrap(expressions) if wrapped else expressions 1597 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1598 return "" 1599 1600 def with_properties(self, properties: exp.Properties) -> str: 1601 return self.properties(properties, prefix=self.seg(self.WITH_PROPERTIES_PREFIX, sep="")) 1602 1603 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1604 properties_locs = defaultdict(list) 1605 for p in properties.expressions: 1606 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1607 if p_loc != exp.Properties.Location.UNSUPPORTED: 1608 properties_locs[p_loc].append(p) 1609 else: 1610 self.unsupported(f"Unsupported property {p.key}") 1611 1612 return properties_locs 1613 1614 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1615 if isinstance(expression.this, exp.Dot): 1616 return self.sql(expression, "this") 1617 return f"'{expression.name}'" if string_key else expression.name 1618 1619 def property_sql(self, expression: exp.Property) -> str: 1620 property_cls = expression.__class__ 1621 if property_cls == exp.Property: 1622 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1623 1624 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1625 if not property_name: 1626 self.unsupported(f"Unsupported property {expression.key}") 1627 1628 return f"{property_name}={self.sql(expression, 'this')}" 1629 1630 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1631 if self.SUPPORTS_CREATE_TABLE_LIKE: 1632 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1633 options = f" {options}" if options else "" 1634 1635 like = f"LIKE {self.sql(expression, 'this')}{options}" 1636 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1637 like = f"({like})" 1638 1639 return like 1640 1641 if expression.expressions: 1642 self.unsupported("Transpilation of LIKE property options is unsupported") 1643 1644 select = exp.select("*").from_(expression.this).limit(0) 1645 return f"AS {self.sql(select)}" 1646 1647 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1648 no = "NO " if expression.args.get("no") else "" 1649 protection = " PROTECTION" if expression.args.get("protection") else "" 1650 return f"{no}FALLBACK{protection}" 1651 1652 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1653 no = "NO " if expression.args.get("no") else "" 1654 local = expression.args.get("local") 1655 local = f"{local} " if local else "" 1656 dual = "DUAL " if expression.args.get("dual") else "" 1657 before = "BEFORE " if expression.args.get("before") else "" 1658 after = "AFTER " if expression.args.get("after") else "" 1659 return f"{no}{local}{dual}{before}{after}JOURNAL" 1660 1661 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1662 freespace = self.sql(expression, "this") 1663 percent = " PERCENT" if expression.args.get("percent") else "" 1664 return f"FREESPACE={freespace}{percent}" 1665 1666 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1667 if expression.args.get("default"): 1668 property = "DEFAULT" 1669 elif expression.args.get("on"): 1670 property = "ON" 1671 else: 1672 property = "OFF" 1673 return f"CHECKSUM={property}" 1674 1675 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1676 if expression.args.get("no"): 1677 return "NO MERGEBLOCKRATIO" 1678 if expression.args.get("default"): 1679 return "DEFAULT MERGEBLOCKRATIO" 1680 1681 percent = " PERCENT" if expression.args.get("percent") else "" 1682 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1683 1684 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1685 default = expression.args.get("default") 1686 minimum = expression.args.get("minimum") 1687 maximum = expression.args.get("maximum") 1688 if default or minimum or maximum: 1689 if default: 1690 prop = "DEFAULT" 1691 elif minimum: 1692 prop = "MINIMUM" 1693 else: 1694 prop = "MAXIMUM" 1695 return f"{prop} DATABLOCKSIZE" 1696 units = expression.args.get("units") 1697 units = f" {units}" if units else "" 1698 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1699 1700 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1701 autotemp = expression.args.get("autotemp") 1702 always = expression.args.get("always") 1703 default = expression.args.get("default") 1704 manual = expression.args.get("manual") 1705 never = expression.args.get("never") 1706 1707 if autotemp is not None: 1708 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1709 elif always: 1710 prop = "ALWAYS" 1711 elif default: 1712 prop = "DEFAULT" 1713 elif manual: 1714 prop = "MANUAL" 1715 elif never: 1716 prop = "NEVER" 1717 return f"BLOCKCOMPRESSION={prop}" 1718 1719 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1720 no = expression.args.get("no") 1721 no = " NO" if no else "" 1722 concurrent = expression.args.get("concurrent") 1723 concurrent = " CONCURRENT" if concurrent else "" 1724 target = self.sql(expression, "target") 1725 target = f" {target}" if target else "" 1726 return f"WITH{no}{concurrent} ISOLATED LOADING{target}" 1727 1728 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1729 if isinstance(expression.this, list): 1730 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1731 if expression.this: 1732 modulus = self.sql(expression, "this") 1733 remainder = self.sql(expression, "expression") 1734 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1735 1736 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1737 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1738 return f"FROM ({from_expressions}) TO ({to_expressions})" 1739 1740 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1741 this = self.sql(expression, "this") 1742 1743 for_values_or_default = expression.expression 1744 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1745 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1746 else: 1747 for_values_or_default = " DEFAULT" 1748 1749 return f"PARTITION OF {this}{for_values_or_default}" 1750 1751 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1752 kind = expression.args.get("kind") 1753 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1754 for_or_in = expression.args.get("for_or_in") 1755 for_or_in = f" {for_or_in}" if for_or_in else "" 1756 lock_type = expression.args.get("lock_type") 1757 override = " OVERRIDE" if expression.args.get("override") else "" 1758 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1759 1760 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1761 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1762 statistics = expression.args.get("statistics") 1763 statistics_sql = "" 1764 if statistics is not None: 1765 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1766 return f"{data_sql}{statistics_sql}" 1767 1768 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1769 this = self.sql(expression, "this") 1770 this = f"HISTORY_TABLE={this}" if this else "" 1771 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1772 data_consistency = ( 1773 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1774 ) 1775 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1776 retention_period = ( 1777 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1778 ) 1779 1780 if this: 1781 on_sql = self.func("ON", this, data_consistency, retention_period) 1782 else: 1783 on_sql = "ON" if expression.args.get("on") else "OFF" 1784 1785 sql = f"SYSTEM_VERSIONING={on_sql}" 1786 1787 return f"WITH({sql})" if expression.args.get("with") else sql 1788 1789 def insert_sql(self, expression: exp.Insert) -> str: 1790 hint = self.sql(expression, "hint") 1791 overwrite = expression.args.get("overwrite") 1792 1793 if isinstance(expression.this, exp.Directory): 1794 this = " OVERWRITE" if overwrite else " INTO" 1795 else: 1796 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1797 1798 stored = self.sql(expression, "stored") 1799 stored = f" {stored}" if stored else "" 1800 alternative = expression.args.get("alternative") 1801 alternative = f" OR {alternative}" if alternative else "" 1802 ignore = " IGNORE" if expression.args.get("ignore") else "" 1803 is_function = expression.args.get("is_function") 1804 if is_function: 1805 this = f"{this} FUNCTION" 1806 this = f"{this} {self.sql(expression, 'this')}" 1807 1808 exists = " IF EXISTS" if expression.args.get("exists") else "" 1809 where = self.sql(expression, "where") 1810 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1811 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1812 on_conflict = self.sql(expression, "conflict") 1813 on_conflict = f" {on_conflict}" if on_conflict else "" 1814 by_name = " BY NAME" if expression.args.get("by_name") else "" 1815 returning = self.sql(expression, "returning") 1816 1817 if self.RETURNING_END: 1818 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1819 else: 1820 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1821 1822 partition_by = self.sql(expression, "partition") 1823 partition_by = f" {partition_by}" if partition_by else "" 1824 settings = self.sql(expression, "settings") 1825 settings = f" {settings}" if settings else "" 1826 1827 source = self.sql(expression, "source") 1828 source = f"TABLE {source}" if source else "" 1829 1830 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1831 return self.prepend_ctes(expression, sql) 1832 1833 def introducer_sql(self, expression: exp.Introducer) -> str: 1834 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1835 1836 def kill_sql(self, expression: exp.Kill) -> str: 1837 kind = self.sql(expression, "kind") 1838 kind = f" {kind}" if kind else "" 1839 this = self.sql(expression, "this") 1840 this = f" {this}" if this else "" 1841 return f"KILL{kind}{this}" 1842 1843 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1844 return expression.name 1845 1846 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1847 return expression.name 1848 1849 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1850 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1851 1852 constraint = self.sql(expression, "constraint") 1853 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1854 1855 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1856 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1857 action = self.sql(expression, "action") 1858 1859 expressions = self.expressions(expression, flat=True) 1860 if expressions: 1861 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1862 expressions = f" {set_keyword}{expressions}" 1863 1864 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}" 1865 1866 def returning_sql(self, expression: exp.Returning) -> str: 1867 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1868 1869 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1870 fields = self.sql(expression, "fields") 1871 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1872 escaped = self.sql(expression, "escaped") 1873 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1874 items = self.sql(expression, "collection_items") 1875 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1876 keys = self.sql(expression, "map_keys") 1877 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1878 lines = self.sql(expression, "lines") 1879 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1880 null = self.sql(expression, "null") 1881 null = f" NULL DEFINED AS {null}" if null else "" 1882 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1883 1884 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1885 return f"WITH ({self.expressions(expression, flat=True)})" 1886 1887 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1888 this = f"{self.sql(expression, 'this')} INDEX" 1889 target = self.sql(expression, "target") 1890 target = f" FOR {target}" if target else "" 1891 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1892 1893 def historicaldata_sql(self, expression: exp.HistoricalData) -> str: 1894 this = self.sql(expression, "this") 1895 kind = self.sql(expression, "kind") 1896 expr = self.sql(expression, "expression") 1897 return f"{this} ({kind} => {expr})" 1898 1899 def table_parts(self, expression: exp.Table) -> str: 1900 return ".".join( 1901 self.sql(part) 1902 for part in ( 1903 expression.args.get("catalog"), 1904 expression.args.get("db"), 1905 expression.args.get("this"), 1906 ) 1907 if part is not None 1908 ) 1909 1910 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1911 table = self.table_parts(expression) 1912 only = "ONLY " if expression.args.get("only") else "" 1913 partition = self.sql(expression, "partition") 1914 partition = f" {partition}" if partition else "" 1915 version = self.sql(expression, "version") 1916 version = f" {version}" if version else "" 1917 alias = self.sql(expression, "alias") 1918 alias = f"{sep}{alias}" if alias else "" 1919 1920 sample = self.sql(expression, "sample") 1921 if self.dialect.ALIAS_POST_TABLESAMPLE: 1922 sample_pre_alias = sample 1923 sample_post_alias = "" 1924 else: 1925 sample_pre_alias = "" 1926 sample_post_alias = sample 1927 1928 hints = self.expressions(expression, key="hints", sep=" ") 1929 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1930 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1931 joins = self.indent( 1932 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1933 ) 1934 laterals = self.expressions(expression, key="laterals", sep="") 1935 1936 file_format = self.sql(expression, "format") 1937 if file_format: 1938 pattern = self.sql(expression, "pattern") 1939 pattern = f", PATTERN => {pattern}" if pattern else "" 1940 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1941 1942 ordinality = expression.args.get("ordinality") or "" 1943 if ordinality: 1944 ordinality = f" WITH ORDINALITY{alias}" 1945 alias = "" 1946 1947 when = self.sql(expression, "when") 1948 if when: 1949 table = f"{table} {when}" 1950 1951 changes = self.sql(expression, "changes") 1952 changes = f" {changes}" if changes else "" 1953 1954 rows_from = self.expressions(expression, key="rows_from") 1955 if rows_from: 1956 table = f"ROWS FROM {self.wrap(rows_from)}" 1957 1958 return f"{only}{table}{changes}{partition}{version}{file_format}{sample_pre_alias}{alias}{hints}{pivots}{sample_post_alias}{joins}{laterals}{ordinality}" 1959 1960 def tablesample_sql( 1961 self, 1962 expression: exp.TableSample, 1963 tablesample_keyword: t.Optional[str] = None, 1964 ) -> str: 1965 method = self.sql(expression, "method") 1966 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1967 numerator = self.sql(expression, "bucket_numerator") 1968 denominator = self.sql(expression, "bucket_denominator") 1969 field = self.sql(expression, "bucket_field") 1970 field = f" ON {field}" if field else "" 1971 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1972 seed = self.sql(expression, "seed") 1973 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1974 1975 size = self.sql(expression, "size") 1976 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1977 size = f"{size} ROWS" 1978 1979 percent = self.sql(expression, "percent") 1980 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1981 percent = f"{percent} PERCENT" 1982 1983 expr = f"{bucket}{percent}{size}" 1984 if self.TABLESAMPLE_REQUIRES_PARENS: 1985 expr = f"({expr})" 1986 1987 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}" 1988 1989 def pivot_sql(self, expression: exp.Pivot) -> str: 1990 expressions = self.expressions(expression, flat=True) 1991 1992 if expression.this: 1993 this = self.sql(expression, "this") 1994 if not expressions: 1995 return f"UNPIVOT {this}" 1996 1997 on = f"{self.seg('ON')} {expressions}" 1998 using = self.expressions(expression, key="using", flat=True) 1999 using = f"{self.seg('USING')} {using}" if using else "" 2000 group = self.sql(expression, "group") 2001 return f"PIVOT {this}{on}{using}{group}" 2002 2003 alias = self.sql(expression, "alias") 2004 alias = f" AS {alias}" if alias else "" 2005 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 2006 2007 field = self.sql(expression, "field") 2008 2009 include_nulls = expression.args.get("include_nulls") 2010 if include_nulls is not None: 2011 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 2012 else: 2013 nulls = "" 2014 2015 default_on_null = self.sql(expression, "default_on_null") 2016 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 2017 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}" 2018 2019 def version_sql(self, expression: exp.Version) -> str: 2020 this = f"FOR {expression.name}" 2021 kind = expression.text("kind") 2022 expr = self.sql(expression, "expression") 2023 return f"{this} {kind} {expr}" 2024 2025 def tuple_sql(self, expression: exp.Tuple) -> str: 2026 return f"({self.expressions(expression, dynamic=True, new_line=True, skip_first=True, skip_last=True)})" 2027 2028 def update_sql(self, expression: exp.Update) -> str: 2029 this = self.sql(expression, "this") 2030 set_sql = self.expressions(expression, flat=True) 2031 from_sql = self.sql(expression, "from") 2032 where_sql = self.sql(expression, "where") 2033 returning = self.sql(expression, "returning") 2034 order = self.sql(expression, "order") 2035 limit = self.sql(expression, "limit") 2036 if self.RETURNING_END: 2037 expression_sql = f"{from_sql}{where_sql}{returning}" 2038 else: 2039 expression_sql = f"{returning}{from_sql}{where_sql}" 2040 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2041 return self.prepend_ctes(expression, sql) 2042 2043 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2044 values_as_table = values_as_table and self.VALUES_AS_TABLE 2045 2046 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2047 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2048 args = self.expressions(expression) 2049 alias = self.sql(expression, "alias") 2050 values = f"VALUES{self.seg('')}{args}" 2051 values = ( 2052 f"({values})" 2053 if self.WRAP_DERIVED_VALUES 2054 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2055 else values 2056 ) 2057 return f"{values} AS {alias}" if alias else values 2058 2059 # Converts `VALUES...` expression into a series of select unions. 2060 alias_node = expression.args.get("alias") 2061 column_names = alias_node and alias_node.columns 2062 2063 selects: t.List[exp.Query] = [] 2064 2065 for i, tup in enumerate(expression.expressions): 2066 row = tup.expressions 2067 2068 if i == 0 and column_names: 2069 row = [ 2070 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2071 ] 2072 2073 selects.append(exp.Select(expressions=row)) 2074 2075 if self.pretty: 2076 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2077 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2078 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2079 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2080 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2081 2082 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2083 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2084 return f"({unions}){alias}" 2085 2086 def var_sql(self, expression: exp.Var) -> str: 2087 return self.sql(expression, "this") 2088 2089 @unsupported_args("expressions") 2090 def into_sql(self, expression: exp.Into) -> str: 2091 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2092 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2093 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 2094 2095 def from_sql(self, expression: exp.From) -> str: 2096 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 2097 2098 def groupingsets_sql(self, expression: exp.GroupingSets) -> str: 2099 grouping_sets = self.expressions(expression, indent=False) 2100 return f"GROUPING SETS {self.wrap(grouping_sets)}" 2101 2102 def rollup_sql(self, expression: exp.Rollup) -> str: 2103 expressions = self.expressions(expression, indent=False) 2104 return f"ROLLUP {self.wrap(expressions)}" if expressions else "WITH ROLLUP" 2105 2106 def cube_sql(self, expression: exp.Cube) -> str: 2107 expressions = self.expressions(expression, indent=False) 2108 return f"CUBE {self.wrap(expressions)}" if expressions else "WITH CUBE" 2109 2110 def group_sql(self, expression: exp.Group) -> str: 2111 group_by_all = expression.args.get("all") 2112 if group_by_all is True: 2113 modifier = " ALL" 2114 elif group_by_all is False: 2115 modifier = " DISTINCT" 2116 else: 2117 modifier = "" 2118 2119 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2120 2121 grouping_sets = self.expressions(expression, key="grouping_sets") 2122 cube = self.expressions(expression, key="cube") 2123 rollup = self.expressions(expression, key="rollup") 2124 2125 groupings = csv( 2126 self.seg(grouping_sets) if grouping_sets else "", 2127 self.seg(cube) if cube else "", 2128 self.seg(rollup) if rollup else "", 2129 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2130 sep=self.GROUPINGS_SEP, 2131 ) 2132 2133 if ( 2134 expression.expressions 2135 and groupings 2136 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2137 ): 2138 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2139 2140 return f"{group_by}{groupings}" 2141 2142 def having_sql(self, expression: exp.Having) -> str: 2143 this = self.indent(self.sql(expression, "this")) 2144 return f"{self.seg('HAVING')}{self.sep()}{this}" 2145 2146 def connect_sql(self, expression: exp.Connect) -> str: 2147 start = self.sql(expression, "start") 2148 start = self.seg(f"START WITH {start}") if start else "" 2149 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2150 connect = self.sql(expression, "connect") 2151 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2152 return start + connect 2153 2154 def prior_sql(self, expression: exp.Prior) -> str: 2155 return f"PRIOR {self.sql(expression, 'this')}" 2156 2157 def join_sql(self, expression: exp.Join) -> str: 2158 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2159 side = None 2160 else: 2161 side = expression.side 2162 2163 op_sql = " ".join( 2164 op 2165 for op in ( 2166 expression.method, 2167 "GLOBAL" if expression.args.get("global") else None, 2168 side, 2169 expression.kind, 2170 expression.hint if self.JOIN_HINTS else None, 2171 ) 2172 if op 2173 ) 2174 match_cond = self.sql(expression, "match_condition") 2175 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2176 on_sql = self.sql(expression, "on") 2177 using = expression.args.get("using") 2178 2179 if not on_sql and using: 2180 on_sql = csv(*(self.sql(column) for column in using)) 2181 2182 this = expression.this 2183 this_sql = self.sql(this) 2184 2185 exprs = self.expressions(expression) 2186 if exprs: 2187 this_sql = f"{this_sql},{self.seg(exprs)}" 2188 2189 if on_sql: 2190 on_sql = self.indent(on_sql, skip_first=True) 2191 space = self.seg(" " * self.pad) if self.pretty else " " 2192 if using: 2193 on_sql = f"{space}USING ({on_sql})" 2194 else: 2195 on_sql = f"{space}ON {on_sql}" 2196 elif not op_sql: 2197 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2198 return f" {this_sql}" 2199 2200 return f", {this_sql}" 2201 2202 if op_sql != "STRAIGHT_JOIN": 2203 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2204 2205 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}" 2206 2207 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 2208 args = self.expressions(expression, flat=True) 2209 args = f"({args})" if len(args.split(",")) > 1 else args 2210 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 2211 2212 def lateral_op(self, expression: exp.Lateral) -> str: 2213 cross_apply = expression.args.get("cross_apply") 2214 2215 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2216 if cross_apply is True: 2217 op = "INNER JOIN " 2218 elif cross_apply is False: 2219 op = "LEFT JOIN " 2220 else: 2221 op = "" 2222 2223 return f"{op}LATERAL" 2224 2225 def lateral_sql(self, expression: exp.Lateral) -> str: 2226 this = self.sql(expression, "this") 2227 2228 if expression.args.get("view"): 2229 alias = expression.args["alias"] 2230 columns = self.expressions(alias, key="columns", flat=True) 2231 table = f" {alias.name}" if alias.name else "" 2232 columns = f" AS {columns}" if columns else "" 2233 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2234 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2235 2236 alias = self.sql(expression, "alias") 2237 alias = f" AS {alias}" if alias else "" 2238 return f"{self.lateral_op(expression)} {this}{alias}" 2239 2240 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2241 this = self.sql(expression, "this") 2242 2243 args = [ 2244 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2245 for e in (expression.args.get(k) for k in ("offset", "expression")) 2246 if e 2247 ] 2248 2249 args_sql = ", ".join(self.sql(e) for e in args) 2250 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2251 expressions = self.expressions(expression, flat=True) 2252 expressions = f" BY {expressions}" if expressions else "" 2253 2254 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}" 2255 2256 def offset_sql(self, expression: exp.Offset) -> str: 2257 this = self.sql(expression, "this") 2258 value = expression.expression 2259 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2260 expressions = self.expressions(expression, flat=True) 2261 expressions = f" BY {expressions}" if expressions else "" 2262 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}" 2263 2264 def setitem_sql(self, expression: exp.SetItem) -> str: 2265 kind = self.sql(expression, "kind") 2266 kind = f"{kind} " if kind else "" 2267 this = self.sql(expression, "this") 2268 expressions = self.expressions(expression) 2269 collate = self.sql(expression, "collate") 2270 collate = f" COLLATE {collate}" if collate else "" 2271 global_ = "GLOBAL " if expression.args.get("global") else "" 2272 return f"{global_}{kind}{this}{expressions}{collate}" 2273 2274 def set_sql(self, expression: exp.Set) -> str: 2275 expressions = ( 2276 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2277 ) 2278 tag = " TAG" if expression.args.get("tag") else "" 2279 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 2280 2281 def pragma_sql(self, expression: exp.Pragma) -> str: 2282 return f"PRAGMA {self.sql(expression, 'this')}" 2283 2284 def lock_sql(self, expression: exp.Lock) -> str: 2285 if not self.LOCKING_READS_SUPPORTED: 2286 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2287 return "" 2288 2289 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2290 expressions = self.expressions(expression, flat=True) 2291 expressions = f" OF {expressions}" if expressions else "" 2292 wait = expression.args.get("wait") 2293 2294 if wait is not None: 2295 if isinstance(wait, exp.Literal): 2296 wait = f" WAIT {self.sql(wait)}" 2297 else: 2298 wait = " NOWAIT" if wait else " SKIP LOCKED" 2299 2300 return f"{lock_type}{expressions}{wait or ''}" 2301 2302 def literal_sql(self, expression: exp.Literal) -> str: 2303 text = expression.this or "" 2304 if expression.is_string: 2305 text = f"{self.dialect.QUOTE_START}{self.escape_str(text)}{self.dialect.QUOTE_END}" 2306 return text 2307 2308 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2309 if self.dialect.ESCAPED_SEQUENCES: 2310 to_escaped = self.dialect.ESCAPED_SEQUENCES 2311 text = "".join( 2312 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2313 ) 2314 2315 return self._replace_line_breaks(text).replace( 2316 self.dialect.QUOTE_END, self._escaped_quote_end 2317 ) 2318 2319 def loaddata_sql(self, expression: exp.LoadData) -> str: 2320 local = " LOCAL" if expression.args.get("local") else "" 2321 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2322 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2323 this = f" INTO TABLE {self.sql(expression, 'this')}" 2324 partition = self.sql(expression, "partition") 2325 partition = f" {partition}" if partition else "" 2326 input_format = self.sql(expression, "input_format") 2327 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2328 serde = self.sql(expression, "serde") 2329 serde = f" SERDE {serde}" if serde else "" 2330 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 2331 2332 def null_sql(self, *_) -> str: 2333 return "NULL" 2334 2335 def boolean_sql(self, expression: exp.Boolean) -> str: 2336 return "TRUE" if expression.this else "FALSE" 2337 2338 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2339 this = self.sql(expression, "this") 2340 this = f"{this} " if this else this 2341 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2342 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore 2343 2344 def withfill_sql(self, expression: exp.WithFill) -> str: 2345 from_sql = self.sql(expression, "from") 2346 from_sql = f" FROM {from_sql}" if from_sql else "" 2347 to_sql = self.sql(expression, "to") 2348 to_sql = f" TO {to_sql}" if to_sql else "" 2349 step_sql = self.sql(expression, "step") 2350 step_sql = f" STEP {step_sql}" if step_sql else "" 2351 interpolated_values = [ 2352 f"{self.sql(e, 'alias')} AS {self.sql(e, 'this')}" 2353 if isinstance(e, exp.Alias) 2354 else self.sql(e, "this") 2355 for e in expression.args.get("interpolate") or [] 2356 ] 2357 interpolate = ( 2358 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2359 ) 2360 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}" 2361 2362 def cluster_sql(self, expression: exp.Cluster) -> str: 2363 return self.op_expressions("CLUSTER BY", expression) 2364 2365 def distribute_sql(self, expression: exp.Distribute) -> str: 2366 return self.op_expressions("DISTRIBUTE BY", expression) 2367 2368 def sort_sql(self, expression: exp.Sort) -> str: 2369 return self.op_expressions("SORT BY", expression) 2370 2371 def ordered_sql(self, expression: exp.Ordered) -> str: 2372 desc = expression.args.get("desc") 2373 asc = not desc 2374 2375 nulls_first = expression.args.get("nulls_first") 2376 nulls_last = not nulls_first 2377 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2378 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2379 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2380 2381 this = self.sql(expression, "this") 2382 2383 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2384 nulls_sort_change = "" 2385 if nulls_first and ( 2386 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2387 ): 2388 nulls_sort_change = " NULLS FIRST" 2389 elif ( 2390 nulls_last 2391 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2392 and not nulls_are_last 2393 ): 2394 nulls_sort_change = " NULLS LAST" 2395 2396 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2397 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2398 window = expression.find_ancestor(exp.Window, exp.Select) 2399 if isinstance(window, exp.Window) and window.args.get("spec"): 2400 self.unsupported( 2401 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2402 ) 2403 nulls_sort_change = "" 2404 elif self.NULL_ORDERING_SUPPORTED is False and ( 2405 (asc and nulls_sort_change == " NULLS LAST") 2406 or (desc and nulls_sort_change == " NULLS FIRST") 2407 ): 2408 # BigQuery does not allow these ordering/nulls combinations when used under 2409 # an aggregation func or under a window containing one 2410 ancestor = expression.find_ancestor(exp.AggFunc, exp.Window, exp.Select) 2411 2412 if isinstance(ancestor, exp.Window): 2413 ancestor = ancestor.this 2414 if isinstance(ancestor, exp.AggFunc): 2415 self.unsupported( 2416 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2417 ) 2418 nulls_sort_change = "" 2419 elif self.NULL_ORDERING_SUPPORTED is None: 2420 if expression.this.is_int: 2421 self.unsupported( 2422 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2423 ) 2424 elif not isinstance(expression.this, exp.Rand): 2425 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2426 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2427 nulls_sort_change = "" 2428 2429 with_fill = self.sql(expression, "with_fill") 2430 with_fill = f" {with_fill}" if with_fill else "" 2431 2432 return f"{this}{sort_order}{nulls_sort_change}{with_fill}" 2433 2434 def matchrecognizemeasure_sql(self, expression: exp.MatchRecognizeMeasure) -> str: 2435 window_frame = self.sql(expression, "window_frame") 2436 window_frame = f"{window_frame} " if window_frame else "" 2437 2438 this = self.sql(expression, "this") 2439 2440 return f"{window_frame}{this}" 2441 2442 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2443 partition = self.partition_by_sql(expression) 2444 order = self.sql(expression, "order") 2445 measures = self.expressions(expression, key="measures") 2446 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2447 rows = self.sql(expression, "rows") 2448 rows = self.seg(rows) if rows else "" 2449 after = self.sql(expression, "after") 2450 after = self.seg(after) if after else "" 2451 pattern = self.sql(expression, "pattern") 2452 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2453 definition_sqls = [ 2454 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2455 for definition in expression.args.get("define", []) 2456 ] 2457 definitions = self.expressions(sqls=definition_sqls) 2458 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2459 body = "".join( 2460 ( 2461 partition, 2462 order, 2463 measures, 2464 rows, 2465 after, 2466 pattern, 2467 define, 2468 ) 2469 ) 2470 alias = self.sql(expression, "alias") 2471 alias = f" {alias}" if alias else "" 2472 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 2473 2474 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2475 limit = expression.args.get("limit") 2476 2477 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2478 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2479 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2480 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2481 2482 return csv( 2483 *sqls, 2484 *[self.sql(join) for join in expression.args.get("joins") or []], 2485 self.sql(expression, "connect"), 2486 self.sql(expression, "match"), 2487 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2488 self.sql(expression, "prewhere"), 2489 self.sql(expression, "where"), 2490 self.sql(expression, "group"), 2491 self.sql(expression, "having"), 2492 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2493 self.sql(expression, "order"), 2494 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2495 *self.after_limit_modifiers(expression), 2496 self.options_modifier(expression), 2497 sep="", 2498 ) 2499 2500 def options_modifier(self, expression: exp.Expression) -> str: 2501 options = self.expressions(expression, key="options") 2502 return f" {options}" if options else "" 2503 2504 def queryoption_sql(self, expression: exp.QueryOption) -> str: 2505 return "" 2506 2507 def offset_limit_modifiers( 2508 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2509 ) -> t.List[str]: 2510 return [ 2511 self.sql(expression, "offset") if fetch else self.sql(limit), 2512 self.sql(limit) if fetch else self.sql(expression, "offset"), 2513 ] 2514 2515 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 2516 locks = self.expressions(expression, key="locks", sep=" ") 2517 locks = f" {locks}" if locks else "" 2518 return [locks, self.sql(expression, "sample")] 2519 2520 def select_sql(self, expression: exp.Select) -> str: 2521 into = expression.args.get("into") 2522 if not self.SUPPORTS_SELECT_INTO and into: 2523 into.pop() 2524 2525 hint = self.sql(expression, "hint") 2526 distinct = self.sql(expression, "distinct") 2527 distinct = f" {distinct}" if distinct else "" 2528 kind = self.sql(expression, "kind") 2529 2530 limit = expression.args.get("limit") 2531 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2532 top = self.limit_sql(limit, top=True) 2533 limit.pop() 2534 else: 2535 top = "" 2536 2537 expressions = self.expressions(expression) 2538 2539 if kind: 2540 if kind in self.SELECT_KINDS: 2541 kind = f" AS {kind}" 2542 else: 2543 if kind == "STRUCT": 2544 expressions = self.expressions( 2545 sqls=[ 2546 self.sql( 2547 exp.Struct( 2548 expressions=[ 2549 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2550 if isinstance(e, exp.Alias) 2551 else e 2552 for e in expression.expressions 2553 ] 2554 ) 2555 ) 2556 ] 2557 ) 2558 kind = "" 2559 2560 operation_modifiers = self.expressions(expression, key="operation_modifiers", sep=" ") 2561 operation_modifiers = f"{self.sep()}{operation_modifiers}" if operation_modifiers else "" 2562 2563 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2564 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2565 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2566 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2567 sql = self.query_modifiers( 2568 expression, 2569 f"SELECT{top_distinct}{operation_modifiers}{kind}{expressions}", 2570 self.sql(expression, "into", comment=False), 2571 self.sql(expression, "from", comment=False), 2572 ) 2573 2574 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2575 if expression.args.get("with"): 2576 sql = self.maybe_comment(sql, expression) 2577 expression.pop_comments() 2578 2579 sql = self.prepend_ctes(expression, sql) 2580 2581 if not self.SUPPORTS_SELECT_INTO and into: 2582 if into.args.get("temporary"): 2583 table_kind = " TEMPORARY" 2584 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2585 table_kind = " UNLOGGED" 2586 else: 2587 table_kind = "" 2588 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2589 2590 return sql 2591 2592 def schema_sql(self, expression: exp.Schema) -> str: 2593 this = self.sql(expression, "this") 2594 sql = self.schema_columns_sql(expression) 2595 return f"{this} {sql}" if this and sql else this or sql 2596 2597 def schema_columns_sql(self, expression: exp.Schema) -> str: 2598 if expression.expressions: 2599 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2600 return "" 2601 2602 def star_sql(self, expression: exp.Star) -> str: 2603 except_ = self.expressions(expression, key="except", flat=True) 2604 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2605 replace = self.expressions(expression, key="replace", flat=True) 2606 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2607 rename = self.expressions(expression, key="rename", flat=True) 2608 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2609 return f"*{except_}{replace}{rename}" 2610 2611 def parameter_sql(self, expression: exp.Parameter) -> str: 2612 this = self.sql(expression, "this") 2613 return f"{self.PARAMETER_TOKEN}{this}" 2614 2615 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2616 this = self.sql(expression, "this") 2617 kind = expression.text("kind") 2618 if kind: 2619 kind = f"{kind}." 2620 return f"@@{kind}{this}" 2621 2622 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2623 return f"{self.NAMED_PLACEHOLDER_TOKEN}{expression.name}" if expression.this else "?" 2624 2625 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2626 alias = self.sql(expression, "alias") 2627 alias = f"{sep}{alias}" if alias else "" 2628 sample = self.sql(expression, "sample") 2629 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2630 alias = f"{sample}{alias}" 2631 2632 # Set to None so it's not generated again by self.query_modifiers() 2633 expression.set("sample", None) 2634 2635 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2636 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2637 return self.prepend_ctes(expression, sql) 2638 2639 def qualify_sql(self, expression: exp.Qualify) -> str: 2640 this = self.indent(self.sql(expression, "this")) 2641 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2642 2643 def unnest_sql(self, expression: exp.Unnest) -> str: 2644 args = self.expressions(expression, flat=True) 2645 2646 alias = expression.args.get("alias") 2647 offset = expression.args.get("offset") 2648 2649 if self.UNNEST_WITH_ORDINALITY: 2650 if alias and isinstance(offset, exp.Expression): 2651 alias.append("columns", offset) 2652 2653 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2654 columns = alias.columns 2655 alias = self.sql(columns[0]) if columns else "" 2656 else: 2657 alias = self.sql(alias) 2658 2659 alias = f" AS {alias}" if alias else alias 2660 if self.UNNEST_WITH_ORDINALITY: 2661 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2662 else: 2663 if isinstance(offset, exp.Expression): 2664 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2665 elif offset: 2666 suffix = f"{alias} WITH OFFSET" 2667 else: 2668 suffix = alias 2669 2670 return f"UNNEST({args}){suffix}" 2671 2672 def prewhere_sql(self, expression: exp.PreWhere) -> str: 2673 return "" 2674 2675 def where_sql(self, expression: exp.Where) -> str: 2676 this = self.indent(self.sql(expression, "this")) 2677 return f"{self.seg('WHERE')}{self.sep()}{this}" 2678 2679 def window_sql(self, expression: exp.Window) -> str: 2680 this = self.sql(expression, "this") 2681 partition = self.partition_by_sql(expression) 2682 order = expression.args.get("order") 2683 order = self.order_sql(order, flat=True) if order else "" 2684 spec = self.sql(expression, "spec") 2685 alias = self.sql(expression, "alias") 2686 over = self.sql(expression, "over") or "OVER" 2687 2688 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2689 2690 first = expression.args.get("first") 2691 if first is None: 2692 first = "" 2693 else: 2694 first = "FIRST" if first else "LAST" 2695 2696 if not partition and not order and not spec and alias: 2697 return f"{this} {alias}" 2698 2699 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2700 return f"{this} ({args})" 2701 2702 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2703 partition = self.expressions(expression, key="partition_by", flat=True) 2704 return f"PARTITION BY {partition}" if partition else "" 2705 2706 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2707 kind = self.sql(expression, "kind") 2708 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2709 end = ( 2710 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2711 or "CURRENT ROW" 2712 ) 2713 return f"{kind} BETWEEN {start} AND {end}" 2714 2715 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2716 this = self.sql(expression, "this") 2717 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2718 return f"{this} WITHIN GROUP ({expression_sql})" 2719 2720 def between_sql(self, expression: exp.Between) -> str: 2721 this = self.sql(expression, "this") 2722 low = self.sql(expression, "low") 2723 high = self.sql(expression, "high") 2724 return f"{this} BETWEEN {low} AND {high}" 2725 2726 def bracket_offset_expressions( 2727 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2728 ) -> t.List[exp.Expression]: 2729 return apply_index_offset( 2730 expression.this, 2731 expression.expressions, 2732 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2733 ) 2734 2735 def bracket_sql(self, expression: exp.Bracket) -> str: 2736 expressions = self.bracket_offset_expressions(expression) 2737 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2738 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2739 2740 def all_sql(self, expression: exp.All) -> str: 2741 return f"ALL {self.wrap(expression)}" 2742 2743 def any_sql(self, expression: exp.Any) -> str: 2744 this = self.sql(expression, "this") 2745 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2746 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2747 this = self.wrap(this) 2748 return f"ANY{this}" 2749 return f"ANY {this}" 2750 2751 def exists_sql(self, expression: exp.Exists) -> str: 2752 return f"EXISTS{self.wrap(expression)}" 2753 2754 def case_sql(self, expression: exp.Case) -> str: 2755 this = self.sql(expression, "this") 2756 statements = [f"CASE {this}" if this else "CASE"] 2757 2758 for e in expression.args["ifs"]: 2759 statements.append(f"WHEN {self.sql(e, 'this')}") 2760 statements.append(f"THEN {self.sql(e, 'true')}") 2761 2762 default = self.sql(expression, "default") 2763 2764 if default: 2765 statements.append(f"ELSE {default}") 2766 2767 statements.append("END") 2768 2769 if self.pretty and self.too_wide(statements): 2770 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2771 2772 return " ".join(statements) 2773 2774 def constraint_sql(self, expression: exp.Constraint) -> str: 2775 this = self.sql(expression, "this") 2776 expressions = self.expressions(expression, flat=True) 2777 return f"CONSTRAINT {this} {expressions}" 2778 2779 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2780 order = expression.args.get("order") 2781 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2782 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2783 2784 def extract_sql(self, expression: exp.Extract) -> str: 2785 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2786 expression_sql = self.sql(expression, "expression") 2787 return f"EXTRACT({this} FROM {expression_sql})" 2788 2789 def trim_sql(self, expression: exp.Trim) -> str: 2790 trim_type = self.sql(expression, "position") 2791 2792 if trim_type == "LEADING": 2793 func_name = "LTRIM" 2794 elif trim_type == "TRAILING": 2795 func_name = "RTRIM" 2796 else: 2797 func_name = "TRIM" 2798 2799 return self.func(func_name, expression.this, expression.expression) 2800 2801 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2802 args = expression.expressions 2803 if isinstance(expression, exp.ConcatWs): 2804 args = args[1:] # Skip the delimiter 2805 2806 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2807 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2808 2809 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2810 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2811 2812 return args 2813 2814 def concat_sql(self, expression: exp.Concat) -> str: 2815 expressions = self.convert_concat_args(expression) 2816 2817 # Some dialects don't allow a single-argument CONCAT call 2818 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2819 return self.sql(expressions[0]) 2820 2821 return self.func("CONCAT", *expressions) 2822 2823 def concatws_sql(self, expression: exp.ConcatWs) -> str: 2824 return self.func( 2825 "CONCAT_WS", seq_get(expression.expressions, 0), *self.convert_concat_args(expression) 2826 ) 2827 2828 def check_sql(self, expression: exp.Check) -> str: 2829 this = self.sql(expression, key="this") 2830 return f"CHECK ({this})" 2831 2832 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2833 expressions = self.expressions(expression, flat=True) 2834 expressions = f" ({expressions})" if expressions else "" 2835 reference = self.sql(expression, "reference") 2836 reference = f" {reference}" if reference else "" 2837 delete = self.sql(expression, "delete") 2838 delete = f" ON DELETE {delete}" if delete else "" 2839 update = self.sql(expression, "update") 2840 update = f" ON UPDATE {update}" if update else "" 2841 return f"FOREIGN KEY{expressions}{reference}{delete}{update}" 2842 2843 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2844 expressions = self.expressions(expression, flat=True) 2845 options = self.expressions(expression, key="options", flat=True, sep=" ") 2846 options = f" {options}" if options else "" 2847 return f"PRIMARY KEY ({expressions}){options}" 2848 2849 def if_sql(self, expression: exp.If) -> str: 2850 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2851 2852 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2853 modifier = expression.args.get("modifier") 2854 modifier = f" {modifier}" if modifier else "" 2855 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2856 2857 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2858 return f"{self.sql(expression, 'this')}{self.JSON_KEY_VALUE_PAIR_SEP} {self.sql(expression, 'expression')}" 2859 2860 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2861 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2862 2863 if expression.args.get("escape"): 2864 path = self.escape_str(path) 2865 2866 if self.QUOTE_JSON_PATH: 2867 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2868 2869 return path 2870 2871 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2872 if isinstance(expression, exp.JSONPathPart): 2873 transform = self.TRANSFORMS.get(expression.__class__) 2874 if not callable(transform): 2875 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2876 return "" 2877 2878 return transform(self, expression) 2879 2880 if isinstance(expression, int): 2881 return str(expression) 2882 2883 if self._quote_json_path_key_using_brackets and self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2884 escaped = expression.replace("'", "\\'") 2885 escaped = f"\\'{expression}\\'" 2886 else: 2887 escaped = expression.replace('"', '\\"') 2888 escaped = f'"{escaped}"' 2889 2890 return escaped 2891 2892 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2893 return f"{self.sql(expression, 'this')} FORMAT JSON" 2894 2895 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2896 null_handling = expression.args.get("null_handling") 2897 null_handling = f" {null_handling}" if null_handling else "" 2898 2899 unique_keys = expression.args.get("unique_keys") 2900 if unique_keys is not None: 2901 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2902 else: 2903 unique_keys = "" 2904 2905 return_type = self.sql(expression, "return_type") 2906 return_type = f" RETURNING {return_type}" if return_type else "" 2907 encoding = self.sql(expression, "encoding") 2908 encoding = f" ENCODING {encoding}" if encoding else "" 2909 2910 return self.func( 2911 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2912 *expression.expressions, 2913 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2914 ) 2915 2916 def jsonobjectagg_sql(self, expression: exp.JSONObjectAgg) -> str: 2917 return self.jsonobject_sql(expression) 2918 2919 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2920 null_handling = expression.args.get("null_handling") 2921 null_handling = f" {null_handling}" if null_handling else "" 2922 return_type = self.sql(expression, "return_type") 2923 return_type = f" RETURNING {return_type}" if return_type else "" 2924 strict = " STRICT" if expression.args.get("strict") else "" 2925 return self.func( 2926 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2927 ) 2928 2929 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2930 this = self.sql(expression, "this") 2931 order = self.sql(expression, "order") 2932 null_handling = expression.args.get("null_handling") 2933 null_handling = f" {null_handling}" if null_handling else "" 2934 return_type = self.sql(expression, "return_type") 2935 return_type = f" RETURNING {return_type}" if return_type else "" 2936 strict = " STRICT" if expression.args.get("strict") else "" 2937 return self.func( 2938 "JSON_ARRAYAGG", 2939 this, 2940 suffix=f"{order}{null_handling}{return_type}{strict})", 2941 ) 2942 2943 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2944 path = self.sql(expression, "path") 2945 path = f" PATH {path}" if path else "" 2946 nested_schema = self.sql(expression, "nested_schema") 2947 2948 if nested_schema: 2949 return f"NESTED{path} {nested_schema}" 2950 2951 this = self.sql(expression, "this") 2952 kind = self.sql(expression, "kind") 2953 kind = f" {kind}" if kind else "" 2954 return f"{this}{kind}{path}" 2955 2956 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2957 return self.func("COLUMNS", *expression.expressions) 2958 2959 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2960 this = self.sql(expression, "this") 2961 path = self.sql(expression, "path") 2962 path = f", {path}" if path else "" 2963 error_handling = expression.args.get("error_handling") 2964 error_handling = f" {error_handling}" if error_handling else "" 2965 empty_handling = expression.args.get("empty_handling") 2966 empty_handling = f" {empty_handling}" if empty_handling else "" 2967 schema = self.sql(expression, "schema") 2968 return self.func( 2969 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2970 ) 2971 2972 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2973 this = self.sql(expression, "this") 2974 kind = self.sql(expression, "kind") 2975 path = self.sql(expression, "path") 2976 path = f" {path}" if path else "" 2977 as_json = " AS JSON" if expression.args.get("as_json") else "" 2978 return f"{this} {kind}{path}{as_json}" 2979 2980 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2981 this = self.sql(expression, "this") 2982 path = self.sql(expression, "path") 2983 path = f", {path}" if path else "" 2984 expressions = self.expressions(expression) 2985 with_ = ( 2986 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2987 if expressions 2988 else "" 2989 ) 2990 return f"OPENJSON({this}{path}){with_}" 2991 2992 def in_sql(self, expression: exp.In) -> str: 2993 query = expression.args.get("query") 2994 unnest = expression.args.get("unnest") 2995 field = expression.args.get("field") 2996 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2997 2998 if query: 2999 in_sql = self.sql(query) 3000 elif unnest: 3001 in_sql = self.in_unnest_op(unnest) 3002 elif field: 3003 in_sql = self.sql(field) 3004 else: 3005 in_sql = f"({self.expressions(expression, flat=True)})" 3006 3007 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 3008 3009 def in_unnest_op(self, unnest: exp.Unnest) -> str: 3010 return f"(SELECT {self.sql(unnest)})" 3011 3012 def interval_sql(self, expression: exp.Interval) -> str: 3013 unit = self.sql(expression, "unit") 3014 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 3015 unit = self.TIME_PART_SINGULARS.get(unit, unit) 3016 unit = f" {unit}" if unit else "" 3017 3018 if self.SINGLE_STRING_INTERVAL: 3019 this = expression.this.name if expression.this else "" 3020 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 3021 3022 this = self.sql(expression, "this") 3023 if this: 3024 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 3025 this = f" {this}" if unwrapped else f" ({this})" 3026 3027 return f"INTERVAL{this}{unit}" 3028 3029 def return_sql(self, expression: exp.Return) -> str: 3030 return f"RETURN {self.sql(expression, 'this')}" 3031 3032 def reference_sql(self, expression: exp.Reference) -> str: 3033 this = self.sql(expression, "this") 3034 expressions = self.expressions(expression, flat=True) 3035 expressions = f"({expressions})" if expressions else "" 3036 options = self.expressions(expression, key="options", flat=True, sep=" ") 3037 options = f" {options}" if options else "" 3038 return f"REFERENCES {this}{expressions}{options}" 3039 3040 def anonymous_sql(self, expression: exp.Anonymous) -> str: 3041 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 3042 parent = expression.parent 3043 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 3044 return self.func( 3045 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 3046 ) 3047 3048 def paren_sql(self, expression: exp.Paren) -> str: 3049 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 3050 return f"({sql}{self.seg(')', sep='')}" 3051 3052 def neg_sql(self, expression: exp.Neg) -> str: 3053 # This makes sure we don't convert "- - 5" to "--5", which is a comment 3054 this_sql = self.sql(expression, "this") 3055 sep = " " if this_sql[0] == "-" else "" 3056 return f"-{sep}{this_sql}" 3057 3058 def not_sql(self, expression: exp.Not) -> str: 3059 return f"NOT {self.sql(expression, 'this')}" 3060 3061 def alias_sql(self, expression: exp.Alias) -> str: 3062 alias = self.sql(expression, "alias") 3063 alias = f" AS {alias}" if alias else "" 3064 return f"{self.sql(expression, 'this')}{alias}" 3065 3066 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3067 alias = expression.args["alias"] 3068 3069 identifier_alias = isinstance(alias, exp.Identifier) 3070 literal_alias = isinstance(alias, exp.Literal) 3071 3072 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3073 alias.replace(exp.Literal.string(alias.output_name)) 3074 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3075 alias.replace(exp.to_identifier(alias.output_name)) 3076 3077 return self.alias_sql(expression) 3078 3079 def aliases_sql(self, expression: exp.Aliases) -> str: 3080 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 3081 3082 def atindex_sql(self, expression: exp.AtTimeZone) -> str: 3083 this = self.sql(expression, "this") 3084 index = self.sql(expression, "expression") 3085 return f"{this} AT {index}" 3086 3087 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 3088 this = self.sql(expression, "this") 3089 zone = self.sql(expression, "zone") 3090 return f"{this} AT TIME ZONE {zone}" 3091 3092 def fromtimezone_sql(self, expression: exp.FromTimeZone) -> str: 3093 this = self.sql(expression, "this") 3094 zone = self.sql(expression, "zone") 3095 return f"{this} AT TIME ZONE {zone} AT TIME ZONE 'UTC'" 3096 3097 def add_sql(self, expression: exp.Add) -> str: 3098 return self.binary(expression, "+") 3099 3100 def and_sql( 3101 self, expression: exp.And, stack: t.Optional[t.List[str | exp.Expression]] = None 3102 ) -> str: 3103 return self.connector_sql(expression, "AND", stack) 3104 3105 def or_sql( 3106 self, expression: exp.Or, stack: t.Optional[t.List[str | exp.Expression]] = None 3107 ) -> str: 3108 return self.connector_sql(expression, "OR", stack) 3109 3110 def xor_sql( 3111 self, expression: exp.Xor, stack: t.Optional[t.List[str | exp.Expression]] = None 3112 ) -> str: 3113 return self.connector_sql(expression, "XOR", stack) 3114 3115 def connector_sql( 3116 self, 3117 expression: exp.Connector, 3118 op: str, 3119 stack: t.Optional[t.List[str | exp.Expression]] = None, 3120 ) -> str: 3121 if stack is not None: 3122 if expression.expressions: 3123 stack.append(self.expressions(expression, sep=f" {op} ")) 3124 else: 3125 stack.append(expression.right) 3126 if expression.comments and self.comments: 3127 for comment in expression.comments: 3128 if comment: 3129 op += f" /*{self.pad_comment(comment)}*/" 3130 stack.extend((op, expression.left)) 3131 return op 3132 3133 stack = [expression] 3134 sqls: t.List[str] = [] 3135 ops = set() 3136 3137 while stack: 3138 node = stack.pop() 3139 if isinstance(node, exp.Connector): 3140 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3141 else: 3142 sql = self.sql(node) 3143 if sqls and sqls[-1] in ops: 3144 sqls[-1] += f" {sql}" 3145 else: 3146 sqls.append(sql) 3147 3148 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3149 return sep.join(sqls) 3150 3151 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 3152 return self.binary(expression, "&") 3153 3154 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 3155 return self.binary(expression, "<<") 3156 3157 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 3158 return f"~{self.sql(expression, 'this')}" 3159 3160 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 3161 return self.binary(expression, "|") 3162 3163 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 3164 return self.binary(expression, ">>") 3165 3166 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 3167 return self.binary(expression, "^") 3168 3169 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3170 format_sql = self.sql(expression, "format") 3171 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3172 to_sql = self.sql(expression, "to") 3173 to_sql = f" {to_sql}" if to_sql else "" 3174 action = self.sql(expression, "action") 3175 action = f" {action}" if action else "" 3176 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})" 3177 3178 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 3179 zone = self.sql(expression, "this") 3180 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 3181 3182 def collate_sql(self, expression: exp.Collate) -> str: 3183 if self.COLLATE_IS_FUNC: 3184 return self.function_fallback_sql(expression) 3185 return self.binary(expression, "COLLATE") 3186 3187 def command_sql(self, expression: exp.Command) -> str: 3188 return f"{self.sql(expression, 'this')} {expression.text('expression').strip()}" 3189 3190 def comment_sql(self, expression: exp.Comment) -> str: 3191 this = self.sql(expression, "this") 3192 kind = expression.args["kind"] 3193 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3194 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3195 expression_sql = self.sql(expression, "expression") 3196 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}" 3197 3198 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3199 this = self.sql(expression, "this") 3200 delete = " DELETE" if expression.args.get("delete") else "" 3201 recompress = self.sql(expression, "recompress") 3202 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3203 to_disk = self.sql(expression, "to_disk") 3204 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3205 to_volume = self.sql(expression, "to_volume") 3206 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3207 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 3208 3209 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3210 where = self.sql(expression, "where") 3211 group = self.sql(expression, "group") 3212 aggregates = self.expressions(expression, key="aggregates") 3213 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3214 3215 if not (where or group or aggregates) and len(expression.expressions) == 1: 3216 return f"TTL {self.expressions(expression, flat=True)}" 3217 3218 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 3219 3220 def transaction_sql(self, expression: exp.Transaction) -> str: 3221 return "BEGIN" 3222 3223 def commit_sql(self, expression: exp.Commit) -> str: 3224 chain = expression.args.get("chain") 3225 if chain is not None: 3226 chain = " AND CHAIN" if chain else " AND NO CHAIN" 3227 3228 return f"COMMIT{chain or ''}" 3229 3230 def rollback_sql(self, expression: exp.Rollback) -> str: 3231 savepoint = expression.args.get("savepoint") 3232 savepoint = f" TO {savepoint}" if savepoint else "" 3233 return f"ROLLBACK{savepoint}" 3234 3235 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3236 this = self.sql(expression, "this") 3237 3238 dtype = self.sql(expression, "dtype") 3239 if dtype: 3240 collate = self.sql(expression, "collate") 3241 collate = f" COLLATE {collate}" if collate else "" 3242 using = self.sql(expression, "using") 3243 using = f" USING {using}" if using else "" 3244 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3245 3246 default = self.sql(expression, "default") 3247 if default: 3248 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3249 3250 comment = self.sql(expression, "comment") 3251 if comment: 3252 return f"ALTER COLUMN {this} COMMENT {comment}" 3253 3254 allow_null = expression.args.get("allow_null") 3255 drop = expression.args.get("drop") 3256 3257 if not drop and not allow_null: 3258 self.unsupported("Unsupported ALTER COLUMN syntax") 3259 3260 if allow_null is not None: 3261 keyword = "DROP" if drop else "SET" 3262 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3263 3264 return f"ALTER COLUMN {this} DROP DEFAULT" 3265 3266 def alterdiststyle_sql(self, expression: exp.AlterDistStyle) -> str: 3267 this = self.sql(expression, "this") 3268 if not isinstance(expression.this, exp.Var): 3269 this = f"KEY DISTKEY {this}" 3270 return f"ALTER DISTSTYLE {this}" 3271 3272 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3273 compound = " COMPOUND" if expression.args.get("compound") else "" 3274 this = self.sql(expression, "this") 3275 expressions = self.expressions(expression, flat=True) 3276 expressions = f"({expressions})" if expressions else "" 3277 return f"ALTER{compound} SORTKEY {this or expressions}" 3278 3279 def alterrename_sql(self, expression: exp.AlterRename) -> str: 3280 if not self.RENAME_TABLE_WITH_DB: 3281 # Remove db from tables 3282 expression = expression.transform( 3283 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3284 ).assert_is(exp.AlterRename) 3285 this = self.sql(expression, "this") 3286 return f"RENAME TO {this}" 3287 3288 def renamecolumn_sql(self, expression: exp.RenameColumn) -> str: 3289 exists = " IF EXISTS" if expression.args.get("exists") else "" 3290 old_column = self.sql(expression, "this") 3291 new_column = self.sql(expression, "to") 3292 return f"RENAME COLUMN{exists} {old_column} TO {new_column}" 3293 3294 def alterset_sql(self, expression: exp.AlterSet) -> str: 3295 exprs = self.expressions(expression, flat=True) 3296 return f"SET {exprs}" 3297 3298 def alter_sql(self, expression: exp.Alter) -> str: 3299 actions = expression.args["actions"] 3300 3301 if isinstance(actions[0], exp.ColumnDef): 3302 actions = self.add_column_sql(expression) 3303 elif isinstance(actions[0], exp.Schema): 3304 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3305 elif isinstance(actions[0], exp.Delete): 3306 actions = self.expressions(expression, key="actions", flat=True) 3307 elif isinstance(actions[0], exp.Query): 3308 actions = "AS " + self.expressions(expression, key="actions") 3309 else: 3310 actions = self.expressions(expression, key="actions", flat=True) 3311 3312 exists = " IF EXISTS" if expression.args.get("exists") else "" 3313 on_cluster = self.sql(expression, "cluster") 3314 on_cluster = f" {on_cluster}" if on_cluster else "" 3315 only = " ONLY" if expression.args.get("only") else "" 3316 options = self.expressions(expression, key="options") 3317 options = f", {options}" if options else "" 3318 kind = self.sql(expression, "kind") 3319 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3320 3321 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}" 3322 3323 def add_column_sql(self, expression: exp.Alter) -> str: 3324 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3325 return self.expressions( 3326 expression, 3327 key="actions", 3328 prefix="ADD COLUMN ", 3329 skip_first=True, 3330 ) 3331 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 3332 3333 def droppartition_sql(self, expression: exp.DropPartition) -> str: 3334 expressions = self.expressions(expression) 3335 exists = " IF EXISTS " if expression.args.get("exists") else " " 3336 return f"DROP{exists}{expressions}" 3337 3338 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 3339 return f"ADD {self.expressions(expression)}" 3340 3341 def distinct_sql(self, expression: exp.Distinct) -> str: 3342 this = self.expressions(expression, flat=True) 3343 3344 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3345 case = exp.case() 3346 for arg in expression.expressions: 3347 case = case.when(arg.is_(exp.null()), exp.null()) 3348 this = self.sql(case.else_(f"({this})")) 3349 3350 this = f" {this}" if this else "" 3351 3352 on = self.sql(expression, "on") 3353 on = f" ON {on}" if on else "" 3354 return f"DISTINCT{this}{on}" 3355 3356 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 3357 return self._embed_ignore_nulls(expression, "IGNORE NULLS") 3358 3359 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 3360 return self._embed_ignore_nulls(expression, "RESPECT NULLS") 3361 3362 def havingmax_sql(self, expression: exp.HavingMax) -> str: 3363 this_sql = self.sql(expression, "this") 3364 expression_sql = self.sql(expression, "expression") 3365 kind = "MAX" if expression.args.get("max") else "MIN" 3366 return f"{this_sql} HAVING {kind} {expression_sql}" 3367 3368 def intdiv_sql(self, expression: exp.IntDiv) -> str: 3369 return self.sql( 3370 exp.Cast( 3371 this=exp.Div(this=expression.this, expression=expression.expression), 3372 to=exp.DataType(this=exp.DataType.Type.INT), 3373 ) 3374 ) 3375 3376 def dpipe_sql(self, expression: exp.DPipe) -> str: 3377 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 3378 return self.func( 3379 "CONCAT", *(exp.cast(e, exp.DataType.Type.TEXT) for e in expression.flatten()) 3380 ) 3381 return self.binary(expression, "||") 3382 3383 def div_sql(self, expression: exp.Div) -> str: 3384 l, r = expression.left, expression.right 3385 3386 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3387 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3388 3389 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3390 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3391 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3392 3393 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3394 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3395 return self.sql( 3396 exp.cast( 3397 l / r, 3398 to=exp.DataType.Type.BIGINT, 3399 ) 3400 ) 3401 3402 return self.binary(expression, "/") 3403 3404 def overlaps_sql(self, expression: exp.Overlaps) -> str: 3405 return self.binary(expression, "OVERLAPS") 3406 3407 def distance_sql(self, expression: exp.Distance) -> str: 3408 return self.binary(expression, "<->") 3409 3410 def dot_sql(self, expression: exp.Dot) -> str: 3411 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 3412 3413 def eq_sql(self, expression: exp.EQ) -> str: 3414 return self.binary(expression, "=") 3415 3416 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 3417 return self.binary(expression, ":=") 3418 3419 def escape_sql(self, expression: exp.Escape) -> str: 3420 return self.binary(expression, "ESCAPE") 3421 3422 def glob_sql(self, expression: exp.Glob) -> str: 3423 return self.binary(expression, "GLOB") 3424 3425 def gt_sql(self, expression: exp.GT) -> str: 3426 return self.binary(expression, ">") 3427 3428 def gte_sql(self, expression: exp.GTE) -> str: 3429 return self.binary(expression, ">=") 3430 3431 def ilike_sql(self, expression: exp.ILike) -> str: 3432 return self.binary(expression, "ILIKE") 3433 3434 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 3435 return self.binary(expression, "ILIKE ANY") 3436 3437 def is_sql(self, expression: exp.Is) -> str: 3438 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 3439 return self.sql( 3440 expression.this if expression.expression.this else exp.not_(expression.this) 3441 ) 3442 return self.binary(expression, "IS") 3443 3444 def like_sql(self, expression: exp.Like) -> str: 3445 return self.binary(expression, "LIKE") 3446 3447 def likeany_sql(self, expression: exp.LikeAny) -> str: 3448 return self.binary(expression, "LIKE ANY") 3449 3450 def similarto_sql(self, expression: exp.SimilarTo) -> str: 3451 return self.binary(expression, "SIMILAR TO") 3452 3453 def lt_sql(self, expression: exp.LT) -> str: 3454 return self.binary(expression, "<") 3455 3456 def lte_sql(self, expression: exp.LTE) -> str: 3457 return self.binary(expression, "<=") 3458 3459 def mod_sql(self, expression: exp.Mod) -> str: 3460 return self.binary(expression, "%") 3461 3462 def mul_sql(self, expression: exp.Mul) -> str: 3463 return self.binary(expression, "*") 3464 3465 def neq_sql(self, expression: exp.NEQ) -> str: 3466 return self.binary(expression, "<>") 3467 3468 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 3469 return self.binary(expression, "IS NOT DISTINCT FROM") 3470 3471 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 3472 return self.binary(expression, "IS DISTINCT FROM") 3473 3474 def slice_sql(self, expression: exp.Slice) -> str: 3475 return self.binary(expression, ":") 3476 3477 def sub_sql(self, expression: exp.Sub) -> str: 3478 return self.binary(expression, "-") 3479 3480 def trycast_sql(self, expression: exp.TryCast) -> str: 3481 return self.cast_sql(expression, safe_prefix="TRY_") 3482 3483 def try_sql(self, expression: exp.Try) -> str: 3484 if not self.TRY_SUPPORTED: 3485 self.unsupported("Unsupported TRY function") 3486 return self.sql(expression, "this") 3487 3488 return self.func("TRY", expression.this) 3489 3490 def log_sql(self, expression: exp.Log) -> str: 3491 this = expression.this 3492 expr = expression.expression 3493 3494 if self.dialect.LOG_BASE_FIRST is False: 3495 this, expr = expr, this 3496 elif self.dialect.LOG_BASE_FIRST is None and expr: 3497 if this.name in ("2", "10"): 3498 return self.func(f"LOG{this.name}", expr) 3499 3500 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3501 3502 return self.func("LOG", this, expr) 3503 3504 def use_sql(self, expression: exp.Use) -> str: 3505 kind = self.sql(expression, "kind") 3506 kind = f" {kind}" if kind else "" 3507 this = self.sql(expression, "this") 3508 this = f" {this}" if this else "" 3509 return f"USE{kind}{this}" 3510 3511 def binary(self, expression: exp.Binary, op: str) -> str: 3512 sqls: t.List[str] = [] 3513 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3514 binary_type = type(expression) 3515 3516 while stack: 3517 node = stack.pop() 3518 3519 if type(node) is binary_type: 3520 op_func = node.args.get("operator") 3521 if op_func: 3522 op = f"OPERATOR({self.sql(op_func)})" 3523 3524 stack.append(node.right) 3525 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3526 stack.append(node.left) 3527 else: 3528 sqls.append(self.sql(node)) 3529 3530 return "".join(sqls) 3531 3532 def function_fallback_sql(self, expression: exp.Func) -> str: 3533 args = [] 3534 3535 for key in expression.arg_types: 3536 arg_value = expression.args.get(key) 3537 3538 if isinstance(arg_value, list): 3539 for value in arg_value: 3540 args.append(value) 3541 elif arg_value is not None: 3542 args.append(arg_value) 3543 3544 if self.dialect.PRESERVE_ORIGINAL_NAMES: 3545 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3546 else: 3547 name = expression.sql_name() 3548 3549 return self.func(name, *args) 3550 3551 def func( 3552 self, 3553 name: str, 3554 *args: t.Optional[exp.Expression | str], 3555 prefix: str = "(", 3556 suffix: str = ")", 3557 normalize: bool = True, 3558 ) -> str: 3559 name = self.normalize_func(name) if normalize else name 3560 return f"{name}{prefix}{self.format_args(*args)}{suffix}" 3561 3562 def format_args(self, *args: t.Optional[str | exp.Expression], sep: str = ", ") -> str: 3563 arg_sqls = tuple( 3564 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3565 ) 3566 if self.pretty and self.too_wide(arg_sqls): 3567 return self.indent( 3568 "\n" + f"{sep.strip()}\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True 3569 ) 3570 return sep.join(arg_sqls) 3571 3572 def too_wide(self, args: t.Iterable) -> bool: 3573 return sum(len(arg) for arg in args) > self.max_text_width 3574 3575 def format_time( 3576 self, 3577 expression: exp.Expression, 3578 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3579 inverse_time_trie: t.Optional[t.Dict] = None, 3580 ) -> t.Optional[str]: 3581 return format_time( 3582 self.sql(expression, "format"), 3583 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3584 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3585 ) 3586 3587 def expressions( 3588 self, 3589 expression: t.Optional[exp.Expression] = None, 3590 key: t.Optional[str] = None, 3591 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3592 flat: bool = False, 3593 indent: bool = True, 3594 skip_first: bool = False, 3595 skip_last: bool = False, 3596 sep: str = ", ", 3597 prefix: str = "", 3598 dynamic: bool = False, 3599 new_line: bool = False, 3600 ) -> str: 3601 expressions = expression.args.get(key or "expressions") if expression else sqls 3602 3603 if not expressions: 3604 return "" 3605 3606 if flat: 3607 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3608 3609 num_sqls = len(expressions) 3610 result_sqls = [] 3611 3612 for i, e in enumerate(expressions): 3613 sql = self.sql(e, comment=False) 3614 if not sql: 3615 continue 3616 3617 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3618 3619 if self.pretty: 3620 if self.leading_comma: 3621 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3622 else: 3623 result_sqls.append( 3624 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3625 ) 3626 else: 3627 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3628 3629 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3630 if new_line: 3631 result_sqls.insert(0, "") 3632 result_sqls.append("") 3633 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3634 else: 3635 result_sql = "".join(result_sqls) 3636 3637 return ( 3638 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3639 if indent 3640 else result_sql 3641 ) 3642 3643 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3644 flat = flat or isinstance(expression.parent, exp.Properties) 3645 expressions_sql = self.expressions(expression, flat=flat) 3646 if flat: 3647 return f"{op} {expressions_sql}" 3648 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 3649 3650 def naked_property(self, expression: exp.Property) -> str: 3651 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3652 if not property_name: 3653 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3654 return f"{property_name} {self.sql(expression, 'this')}" 3655 3656 def tag_sql(self, expression: exp.Tag) -> str: 3657 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 3658 3659 def token_sql(self, token_type: TokenType) -> str: 3660 return self.TOKEN_MAPPING.get(token_type, token_type.name) 3661 3662 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3663 this = self.sql(expression, "this") 3664 expressions = self.no_identify(self.expressions, expression) 3665 expressions = ( 3666 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3667 ) 3668 return f"{this}{expressions}" if expressions.strip() != "" else this 3669 3670 def joinhint_sql(self, expression: exp.JoinHint) -> str: 3671 this = self.sql(expression, "this") 3672 expressions = self.expressions(expression, flat=True) 3673 return f"{this}({expressions})" 3674 3675 def kwarg_sql(self, expression: exp.Kwarg) -> str: 3676 return self.binary(expression, "=>") 3677 3678 def when_sql(self, expression: exp.When) -> str: 3679 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3680 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3681 condition = self.sql(expression, "condition") 3682 condition = f" AND {condition}" if condition else "" 3683 3684 then_expression = expression.args.get("then") 3685 if isinstance(then_expression, exp.Insert): 3686 this = self.sql(then_expression, "this") 3687 this = f"INSERT {this}" if this else "INSERT" 3688 then = self.sql(then_expression, "expression") 3689 then = f"{this} VALUES {then}" if then else this 3690 elif isinstance(then_expression, exp.Update): 3691 if isinstance(then_expression.args.get("expressions"), exp.Star): 3692 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3693 else: 3694 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3695 else: 3696 then = self.sql(then_expression) 3697 return f"WHEN {matched}{source}{condition} THEN {then}" 3698 3699 def whens_sql(self, expression: exp.Whens) -> str: 3700 return self.expressions(expression, sep=" ", indent=False) 3701 3702 def merge_sql(self, expression: exp.Merge) -> str: 3703 table = expression.this 3704 table_alias = "" 3705 3706 hints = table.args.get("hints") 3707 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3708 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3709 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3710 3711 this = self.sql(table) 3712 using = f"USING {self.sql(expression, 'using')}" 3713 on = f"ON {self.sql(expression, 'on')}" 3714 whens = self.sql(expression, "whens") 3715 3716 returning = self.sql(expression, "returning") 3717 if returning: 3718 whens = f"{whens}{returning}" 3719 3720 sep = self.sep() 3721 3722 return self.prepend_ctes( 3723 expression, 3724 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{whens}", 3725 ) 3726 3727 @unsupported_args("format") 3728 def tochar_sql(self, expression: exp.ToChar) -> str: 3729 return self.sql(exp.cast(expression.this, exp.DataType.Type.TEXT)) 3730 3731 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3732 if not self.SUPPORTS_TO_NUMBER: 3733 self.unsupported("Unsupported TO_NUMBER function") 3734 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3735 3736 fmt = expression.args.get("format") 3737 if not fmt: 3738 self.unsupported("Conversion format is required for TO_NUMBER") 3739 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3740 3741 return self.func("TO_NUMBER", expression.this, fmt) 3742 3743 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3744 this = self.sql(expression, "this") 3745 kind = self.sql(expression, "kind") 3746 settings_sql = self.expressions(expression, key="settings", sep=" ") 3747 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3748 return f"{this}({kind}{args})" 3749 3750 def dictrange_sql(self, expression: exp.DictRange) -> str: 3751 this = self.sql(expression, "this") 3752 max = self.sql(expression, "max") 3753 min = self.sql(expression, "min") 3754 return f"{this}(MIN {min} MAX {max})" 3755 3756 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 3757 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 3758 3759 def duplicatekeyproperty_sql(self, expression: exp.DuplicateKeyProperty) -> str: 3760 return f"DUPLICATE KEY ({self.expressions(expression, flat=True)})" 3761 3762 # https://docs.starrocks.io/docs/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE/ 3763 def uniquekeyproperty_sql(self, expression: exp.UniqueKeyProperty) -> str: 3764 return f"UNIQUE KEY ({self.expressions(expression, flat=True)})" 3765 3766 # https://docs.starrocks.io/docs/sql-reference/sql-statements/data-definition/CREATE_TABLE/#distribution_desc 3767 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3768 expressions = self.expressions(expression, flat=True) 3769 expressions = f" {self.wrap(expressions)}" if expressions else "" 3770 buckets = self.sql(expression, "buckets") 3771 kind = self.sql(expression, "kind") 3772 buckets = f" BUCKETS {buckets}" if buckets else "" 3773 order = self.sql(expression, "order") 3774 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}" 3775 3776 def oncluster_sql(self, expression: exp.OnCluster) -> str: 3777 return "" 3778 3779 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3780 expressions = self.expressions(expression, key="expressions", flat=True) 3781 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3782 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3783 buckets = self.sql(expression, "buckets") 3784 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 3785 3786 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3787 this = self.sql(expression, "this") 3788 having = self.sql(expression, "having") 3789 3790 if having: 3791 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3792 3793 return self.func("ANY_VALUE", this) 3794 3795 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3796 transform = self.func("TRANSFORM", *expression.expressions) 3797 row_format_before = self.sql(expression, "row_format_before") 3798 row_format_before = f" {row_format_before}" if row_format_before else "" 3799 record_writer = self.sql(expression, "record_writer") 3800 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3801 using = f" USING {self.sql(expression, 'command_script')}" 3802 schema = self.sql(expression, "schema") 3803 schema = f" AS {schema}" if schema else "" 3804 row_format_after = self.sql(expression, "row_format_after") 3805 row_format_after = f" {row_format_after}" if row_format_after else "" 3806 record_reader = self.sql(expression, "record_reader") 3807 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3808 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 3809 3810 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3811 key_block_size = self.sql(expression, "key_block_size") 3812 if key_block_size: 3813 return f"KEY_BLOCK_SIZE = {key_block_size}" 3814 3815 using = self.sql(expression, "using") 3816 if using: 3817 return f"USING {using}" 3818 3819 parser = self.sql(expression, "parser") 3820 if parser: 3821 return f"WITH PARSER {parser}" 3822 3823 comment = self.sql(expression, "comment") 3824 if comment: 3825 return f"COMMENT {comment}" 3826 3827 visible = expression.args.get("visible") 3828 if visible is not None: 3829 return "VISIBLE" if visible else "INVISIBLE" 3830 3831 engine_attr = self.sql(expression, "engine_attr") 3832 if engine_attr: 3833 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3834 3835 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3836 if secondary_engine_attr: 3837 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3838 3839 self.unsupported("Unsupported index constraint option.") 3840 return "" 3841 3842 def checkcolumnconstraint_sql(self, expression: exp.CheckColumnConstraint) -> str: 3843 enforced = " ENFORCED" if expression.args.get("enforced") else "" 3844 return f"CHECK ({self.sql(expression, 'this')}){enforced}" 3845 3846 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3847 kind = self.sql(expression, "kind") 3848 kind = f"{kind} INDEX" if kind else "INDEX" 3849 this = self.sql(expression, "this") 3850 this = f" {this}" if this else "" 3851 index_type = self.sql(expression, "index_type") 3852 index_type = f" USING {index_type}" if index_type else "" 3853 expressions = self.expressions(expression, flat=True) 3854 expressions = f" ({expressions})" if expressions else "" 3855 options = self.expressions(expression, key="options", sep=" ") 3856 options = f" {options}" if options else "" 3857 return f"{kind}{this}{index_type}{expressions}{options}" 3858 3859 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3860 if self.NVL2_SUPPORTED: 3861 return self.function_fallback_sql(expression) 3862 3863 case = exp.Case().when( 3864 expression.this.is_(exp.null()).not_(copy=False), 3865 expression.args["true"], 3866 copy=False, 3867 ) 3868 else_cond = expression.args.get("false") 3869 if else_cond: 3870 case.else_(else_cond, copy=False) 3871 3872 return self.sql(case) 3873 3874 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3875 this = self.sql(expression, "this") 3876 expr = self.sql(expression, "expression") 3877 iterator = self.sql(expression, "iterator") 3878 condition = self.sql(expression, "condition") 3879 condition = f" IF {condition}" if condition else "" 3880 return f"{this} FOR {expr} IN {iterator}{condition}" 3881 3882 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3883 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3884 3885 def opclass_sql(self, expression: exp.Opclass) -> str: 3886 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3887 3888 def predict_sql(self, expression: exp.Predict) -> str: 3889 model = self.sql(expression, "this") 3890 model = f"MODEL {model}" 3891 table = self.sql(expression, "expression") 3892 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3893 parameters = self.sql(expression, "params_struct") 3894 return self.func("PREDICT", model, table, parameters or None) 3895 3896 def forin_sql(self, expression: exp.ForIn) -> str: 3897 this = self.sql(expression, "this") 3898 expression_sql = self.sql(expression, "expression") 3899 return f"FOR {this} DO {expression_sql}" 3900 3901 def refresh_sql(self, expression: exp.Refresh) -> str: 3902 this = self.sql(expression, "this") 3903 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3904 return f"REFRESH {table}{this}" 3905 3906 def toarray_sql(self, expression: exp.ToArray) -> str: 3907 arg = expression.this 3908 if not arg.type: 3909 from sqlglot.optimizer.annotate_types import annotate_types 3910 3911 arg = annotate_types(arg) 3912 3913 if arg.is_type(exp.DataType.Type.ARRAY): 3914 return self.sql(arg) 3915 3916 cond_for_null = arg.is_(exp.null()) 3917 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False))) 3918 3919 def tsordstotime_sql(self, expression: exp.TsOrDsToTime) -> str: 3920 this = expression.this 3921 if isinstance(this, exp.TsOrDsToTime) or this.is_type(exp.DataType.Type.TIME): 3922 return self.sql(this) 3923 3924 return self.sql(exp.cast(this, exp.DataType.Type.TIME)) 3925 3926 def tsordstotimestamp_sql(self, expression: exp.TsOrDsToTimestamp) -> str: 3927 this = expression.this 3928 if isinstance(this, exp.TsOrDsToTimestamp) or this.is_type(exp.DataType.Type.TIMESTAMP): 3929 return self.sql(this) 3930 3931 return self.sql(exp.cast(this, exp.DataType.Type.TIMESTAMP, dialect=self.dialect)) 3932 3933 def tsordstodatetime_sql(self, expression: exp.TsOrDsToDatetime) -> str: 3934 this = expression.this 3935 if isinstance(this, exp.TsOrDsToDatetime) or this.is_type(exp.DataType.Type.DATETIME): 3936 return self.sql(this) 3937 3938 return self.sql(exp.cast(this, exp.DataType.Type.DATETIME, dialect=self.dialect)) 3939 3940 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3941 this = expression.this 3942 time_format = self.format_time(expression) 3943 3944 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3945 return self.sql( 3946 exp.cast( 3947 exp.StrToTime(this=this, format=expression.args["format"]), 3948 exp.DataType.Type.DATE, 3949 ) 3950 ) 3951 3952 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3953 return self.sql(this) 3954 3955 return self.sql(exp.cast(this, exp.DataType.Type.DATE)) 3956 3957 def unixdate_sql(self, expression: exp.UnixDate) -> str: 3958 return self.sql( 3959 exp.func( 3960 "DATEDIFF", 3961 expression.this, 3962 exp.cast(exp.Literal.string("1970-01-01"), exp.DataType.Type.DATE), 3963 "day", 3964 ) 3965 ) 3966 3967 def lastday_sql(self, expression: exp.LastDay) -> str: 3968 if self.LAST_DAY_SUPPORTS_DATE_PART: 3969 return self.function_fallback_sql(expression) 3970 3971 unit = expression.text("unit") 3972 if unit and unit != "MONTH": 3973 self.unsupported("Date parts are not supported in LAST_DAY.") 3974 3975 return self.func("LAST_DAY", expression.this) 3976 3977 def dateadd_sql(self, expression: exp.DateAdd) -> str: 3978 from sqlglot.dialects.dialect import unit_to_str 3979 3980 return self.func( 3981 "DATE_ADD", expression.this, expression.expression, unit_to_str(expression) 3982 ) 3983 3984 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3985 if self.CAN_IMPLEMENT_ARRAY_ANY: 3986 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3987 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3988 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3989 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3990 3991 from sqlglot.dialects import Dialect 3992 3993 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3994 if self.dialect.__class__ != Dialect: 3995 self.unsupported("ARRAY_ANY is unsupported") 3996 3997 return self.function_fallback_sql(expression) 3998 3999 def struct_sql(self, expression: exp.Struct) -> str: 4000 expression.set( 4001 "expressions", 4002 [ 4003 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 4004 if isinstance(e, exp.PropertyEQ) 4005 else e 4006 for e in expression.expressions 4007 ], 4008 ) 4009 4010 return self.function_fallback_sql(expression) 4011 4012 def partitionrange_sql(self, expression: exp.PartitionRange) -> str: 4013 low = self.sql(expression, "this") 4014 high = self.sql(expression, "expression") 4015 4016 return f"{low} TO {high}" 4017 4018 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 4019 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 4020 tables = f" {self.expressions(expression)}" 4021 4022 exists = " IF EXISTS" if expression.args.get("exists") else "" 4023 4024 on_cluster = self.sql(expression, "cluster") 4025 on_cluster = f" {on_cluster}" if on_cluster else "" 4026 4027 identity = self.sql(expression, "identity") 4028 identity = f" {identity} IDENTITY" if identity else "" 4029 4030 option = self.sql(expression, "option") 4031 option = f" {option}" if option else "" 4032 4033 partition = self.sql(expression, "partition") 4034 partition = f" {partition}" if partition else "" 4035 4036 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}" 4037 4038 # This transpiles T-SQL's CONVERT function 4039 # https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16 4040 def convert_sql(self, expression: exp.Convert) -> str: 4041 to = expression.this 4042 value = expression.expression 4043 style = expression.args.get("style") 4044 safe = expression.args.get("safe") 4045 strict = expression.args.get("strict") 4046 4047 if not to or not value: 4048 return "" 4049 4050 # Retrieve length of datatype and override to default if not specified 4051 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4052 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 4053 4054 transformed: t.Optional[exp.Expression] = None 4055 cast = exp.Cast if strict else exp.TryCast 4056 4057 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 4058 if isinstance(style, exp.Literal) and style.is_int: 4059 from sqlglot.dialects.tsql import TSQL 4060 4061 style_value = style.name 4062 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 4063 if not converted_style: 4064 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 4065 4066 fmt = exp.Literal.string(converted_style) 4067 4068 if to.this == exp.DataType.Type.DATE: 4069 transformed = exp.StrToDate(this=value, format=fmt) 4070 elif to.this in (exp.DataType.Type.DATETIME, exp.DataType.Type.DATETIME2): 4071 transformed = exp.StrToTime(this=value, format=fmt) 4072 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4073 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4074 elif to.this == exp.DataType.Type.TEXT: 4075 transformed = exp.TimeToStr(this=value, format=fmt) 4076 4077 if not transformed: 4078 transformed = cast(this=value, to=to, safe=safe) 4079 4080 return self.sql(transformed) 4081 4082 def _jsonpathkey_sql(self, expression: exp.JSONPathKey) -> str: 4083 this = expression.this 4084 if isinstance(this, exp.JSONPathWildcard): 4085 this = self.json_path_part(this) 4086 return f".{this}" if this else "" 4087 4088 if exp.SAFE_IDENTIFIER_RE.match(this): 4089 return f".{this}" 4090 4091 this = self.json_path_part(this) 4092 return ( 4093 f"[{this}]" 4094 if self._quote_json_path_key_using_brackets and self.JSON_PATH_BRACKETED_KEY_SUPPORTED 4095 else f".{this}" 4096 ) 4097 4098 def _jsonpathsubscript_sql(self, expression: exp.JSONPathSubscript) -> str: 4099 this = self.json_path_part(expression.this) 4100 return f"[{this}]" if this else "" 4101 4102 def _simplify_unless_literal(self, expression: E) -> E: 4103 if not isinstance(expression, exp.Literal): 4104 from sqlglot.optimizer.simplify import simplify 4105 4106 expression = simplify(expression, dialect=self.dialect) 4107 4108 return expression 4109 4110 def _embed_ignore_nulls(self, expression: exp.IgnoreNulls | exp.RespectNulls, text: str) -> str: 4111 if self.IGNORE_NULLS_IN_FUNC and not expression.meta.get("inline"): 4112 # The first modifier here will be the one closest to the AggFunc's arg 4113 mods = sorted( 4114 expression.find_all(exp.HavingMax, exp.Order, exp.Limit), 4115 key=lambda x: 0 4116 if isinstance(x, exp.HavingMax) 4117 else (1 if isinstance(x, exp.Order) else 2), 4118 ) 4119 4120 if mods: 4121 mod = mods[0] 4122 this = expression.__class__(this=mod.this.copy()) 4123 this.meta["inline"] = True 4124 mod.this.replace(this) 4125 return self.sql(expression.this) 4126 4127 agg_func = expression.find(exp.AggFunc) 4128 4129 if agg_func: 4130 return self.sql(agg_func)[:-1] + f" {text})" 4131 4132 return f"{self.sql(expression, 'this')} {text}" 4133 4134 def _replace_line_breaks(self, string: str) -> str: 4135 """We don't want to extra indent line breaks so we temporarily replace them with sentinels.""" 4136 if self.pretty: 4137 return string.replace("\n", self.SENTINEL_LINE_BREAK) 4138 return string 4139 4140 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4141 option = self.sql(expression, "this") 4142 4143 if expression.expressions: 4144 upper = option.upper() 4145 4146 # Snowflake FILE_FORMAT options are separated by whitespace 4147 sep = " " if upper == "FILE_FORMAT" else ", " 4148 4149 # Databricks copy/format options do not set their list of values with EQ 4150 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4151 values = self.expressions(expression, flat=True, sep=sep) 4152 return f"{option}{op}({values})" 4153 4154 value = self.sql(expression, "expression") 4155 4156 if not value: 4157 return option 4158 4159 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4160 4161 return f"{option}{op}{value}" 4162 4163 def credentials_sql(self, expression: exp.Credentials) -> str: 4164 cred_expr = expression.args.get("credentials") 4165 if isinstance(cred_expr, exp.Literal): 4166 # Redshift case: CREDENTIALS <string> 4167 credentials = self.sql(expression, "credentials") 4168 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4169 else: 4170 # Snowflake case: CREDENTIALS = (...) 4171 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4172 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4173 4174 storage = self.sql(expression, "storage") 4175 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4176 4177 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4178 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4179 4180 iam_role = self.sql(expression, "iam_role") 4181 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4182 4183 region = self.sql(expression, "region") 4184 region = f" REGION {region}" if region else "" 4185 4186 return f"{credentials}{storage}{encryption}{iam_role}{region}" 4187 4188 def copy_sql(self, expression: exp.Copy) -> str: 4189 this = self.sql(expression, "this") 4190 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4191 4192 credentials = self.sql(expression, "credentials") 4193 credentials = self.seg(credentials) if credentials else "" 4194 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4195 files = self.expressions(expression, key="files", flat=True) 4196 4197 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4198 params = self.expressions( 4199 expression, 4200 key="params", 4201 sep=sep, 4202 new_line=True, 4203 skip_last=True, 4204 skip_first=True, 4205 indent=self.COPY_PARAMS_ARE_WRAPPED, 4206 ) 4207 4208 if params: 4209 if self.COPY_PARAMS_ARE_WRAPPED: 4210 params = f" WITH ({params})" 4211 elif not self.pretty: 4212 params = f" {params}" 4213 4214 return f"COPY{this}{kind} {files}{credentials}{params}" 4215 4216 def semicolon_sql(self, expression: exp.Semicolon) -> str: 4217 return "" 4218 4219 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4220 on_sql = "ON" if expression.args.get("on") else "OFF" 4221 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4222 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4223 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4224 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4225 4226 if filter_col or retention_period: 4227 on_sql = self.func("ON", filter_col, retention_period) 4228 4229 return f"DATA_DELETION={on_sql}" 4230 4231 def maskingpolicycolumnconstraint_sql( 4232 self, expression: exp.MaskingPolicyColumnConstraint 4233 ) -> str: 4234 this = self.sql(expression, "this") 4235 expressions = self.expressions(expression, flat=True) 4236 expressions = f" USING ({expressions})" if expressions else "" 4237 return f"MASKING POLICY {this}{expressions}" 4238 4239 def gapfill_sql(self, expression: exp.GapFill) -> str: 4240 this = self.sql(expression, "this") 4241 this = f"TABLE {this}" 4242 return self.func("GAP_FILL", this, *[v for k, v in expression.args.items() if k != "this"]) 4243 4244 def scope_resolution(self, rhs: str, scope_name: str) -> str: 4245 return self.func("SCOPE_RESOLUTION", scope_name or None, rhs) 4246 4247 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4248 this = self.sql(expression, "this") 4249 expr = expression.expression 4250 4251 if isinstance(expr, exp.Func): 4252 # T-SQL's CLR functions are case sensitive 4253 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4254 else: 4255 expr = self.sql(expression, "expression") 4256 4257 return self.scope_resolution(expr, this) 4258 4259 def parsejson_sql(self, expression: exp.ParseJSON) -> str: 4260 if self.PARSE_JSON_NAME is None: 4261 return self.sql(expression.this) 4262 4263 return self.func(self.PARSE_JSON_NAME, expression.this, expression.expression) 4264 4265 def rand_sql(self, expression: exp.Rand) -> str: 4266 lower = self.sql(expression, "lower") 4267 upper = self.sql(expression, "upper") 4268 4269 if lower and upper: 4270 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4271 return self.func("RAND", expression.this) 4272 4273 def changes_sql(self, expression: exp.Changes) -> str: 4274 information = self.sql(expression, "information") 4275 information = f"INFORMATION => {information}" 4276 at_before = self.sql(expression, "at_before") 4277 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4278 end = self.sql(expression, "end") 4279 end = f"{self.seg('')}{end}" if end else "" 4280 4281 return f"CHANGES ({information}){at_before}{end}" 4282 4283 def pad_sql(self, expression: exp.Pad) -> str: 4284 prefix = "L" if expression.args.get("is_left") else "R" 4285 4286 fill_pattern = self.sql(expression, "fill_pattern") or None 4287 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4288 fill_pattern = "' '" 4289 4290 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern) 4291 4292 def summarize_sql(self, expression: exp.Summarize) -> str: 4293 table = " TABLE" if expression.args.get("table") else "" 4294 return f"SUMMARIZE{table} {self.sql(expression.this)}" 4295 4296 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4297 generate_series = exp.GenerateSeries(**expression.args) 4298 4299 parent = expression.parent 4300 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4301 parent = parent.parent 4302 4303 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4304 return self.sql(exp.Unnest(expressions=[generate_series])) 4305 4306 if isinstance(parent, exp.Select): 4307 self.unsupported("GenerateSeries projection unnesting is not supported.") 4308 4309 return self.sql(generate_series) 4310 4311 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4312 exprs = expression.expressions 4313 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4314 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4315 else: 4316 rhs = self.expressions(expression) 4317 4318 return self.func(name, expression.this, rhs or None) 4319 4320 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4321 if self.SUPPORTS_CONVERT_TIMEZONE: 4322 return self.function_fallback_sql(expression) 4323 4324 source_tz = expression.args.get("source_tz") 4325 target_tz = expression.args.get("target_tz") 4326 timestamp = expression.args.get("timestamp") 4327 4328 if source_tz and timestamp: 4329 timestamp = exp.AtTimeZone( 4330 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4331 ) 4332 4333 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4334 4335 return self.sql(expr) 4336 4337 def json_sql(self, expression: exp.JSON) -> str: 4338 this = self.sql(expression, "this") 4339 this = f" {this}" if this else "" 4340 4341 _with = expression.args.get("with") 4342 4343 if _with is None: 4344 with_sql = "" 4345 elif not _with: 4346 with_sql = " WITHOUT" 4347 else: 4348 with_sql = " WITH" 4349 4350 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4351 4352 return f"JSON{this}{with_sql}{unique_sql}" 4353 4354 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4355 def _generate_on_options(arg: t.Any) -> str: 4356 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4357 4358 path = self.sql(expression, "path") 4359 returning = self.sql(expression, "returning") 4360 returning = f" RETURNING {returning}" if returning else "" 4361 4362 on_condition = self.sql(expression, "on_condition") 4363 on_condition = f" {on_condition}" if on_condition else "" 4364 4365 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}") 4366 4367 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4368 else_ = "ELSE " if expression.args.get("else_") else "" 4369 condition = self.sql(expression, "expression") 4370 condition = f"WHEN {condition} THEN " if condition else else_ 4371 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4372 return f"{condition}{insert}" 4373 4374 def multitableinserts_sql(self, expression: exp.MultitableInserts) -> str: 4375 kind = self.sql(expression, "kind") 4376 expressions = self.seg(self.expressions(expression, sep=" ")) 4377 res = f"INSERT {kind}{expressions}{self.seg(self.sql(expression, 'source'))}" 4378 return res 4379 4380 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4381 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4382 empty = expression.args.get("empty") 4383 empty = ( 4384 f"DEFAULT {empty} ON EMPTY" 4385 if isinstance(empty, exp.Expression) 4386 else self.sql(expression, "empty") 4387 ) 4388 4389 error = expression.args.get("error") 4390 error = ( 4391 f"DEFAULT {error} ON ERROR" 4392 if isinstance(error, exp.Expression) 4393 else self.sql(expression, "error") 4394 ) 4395 4396 if error and empty: 4397 error = ( 4398 f"{empty} {error}" 4399 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4400 else f"{error} {empty}" 4401 ) 4402 empty = "" 4403 4404 null = self.sql(expression, "null") 4405 4406 return f"{empty}{error}{null}" 4407 4408 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4409 this = self.sql(expression, "this") 4410 path = self.sql(expression, "path") 4411 4412 passing = self.expressions(expression, "passing") 4413 passing = f" PASSING {passing}" if passing else "" 4414 4415 on_condition = self.sql(expression, "on_condition") 4416 on_condition = f" {on_condition}" if on_condition else "" 4417 4418 path = f"{path}{passing}{on_condition}" 4419 4420 return self.func("JSON_EXISTS", this, path) 4421 4422 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4423 array_agg = self.function_fallback_sql(expression) 4424 4425 # Add a NULL FILTER on the column to mimic the results going from a dialect that excludes nulls 4426 # on ARRAY_AGG (e.g Spark) to one that doesn't (e.g. DuckDB) 4427 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4428 parent = expression.parent 4429 if isinstance(parent, exp.Filter): 4430 parent_cond = parent.expression.this 4431 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4432 else: 4433 this = expression.this 4434 # Do not add the filter if the input is not a column (e.g. literal, struct etc) 4435 if this.find(exp.Column): 4436 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4437 this_sql = ( 4438 self.expressions(this) 4439 if isinstance(this, exp.Distinct) 4440 else self.sql(expression, "this") 4441 ) 4442 4443 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4444 4445 return array_agg 4446 4447 def apply_sql(self, expression: exp.Apply) -> str: 4448 this = self.sql(expression, "this") 4449 expr = self.sql(expression, "expression") 4450 4451 return f"{this} APPLY({expr})" 4452 4453 def grant_sql(self, expression: exp.Grant) -> str: 4454 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4455 4456 kind = self.sql(expression, "kind") 4457 kind = f" {kind}" if kind else "" 4458 4459 securable = self.sql(expression, "securable") 4460 securable = f" {securable}" if securable else "" 4461 4462 principals = self.expressions(expression, key="principals", flat=True) 4463 4464 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4465 4466 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}" 4467 4468 def grantprivilege_sql(self, expression: exp.GrantPrivilege): 4469 this = self.sql(expression, "this") 4470 columns = self.expressions(expression, flat=True) 4471 columns = f"({columns})" if columns else "" 4472 4473 return f"{this}{columns}" 4474 4475 def grantprincipal_sql(self, expression: exp.GrantPrincipal): 4476 this = self.sql(expression, "this") 4477 4478 kind = self.sql(expression, "kind") 4479 kind = f"{kind} " if kind else "" 4480 4481 return f"{kind}{this}" 4482 4483 def columns_sql(self, expression: exp.Columns): 4484 func = self.function_fallback_sql(expression) 4485 if expression.args.get("unpack"): 4486 func = f"*{func}" 4487 4488 return func 4489 4490 def overlay_sql(self, expression: exp.Overlay): 4491 this = self.sql(expression, "this") 4492 expr = self.sql(expression, "expression") 4493 from_sql = self.sql(expression, "from") 4494 for_sql = self.sql(expression, "for") 4495 for_sql = f" FOR {for_sql}" if for_sql else "" 4496 4497 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})" 4498 4499 @unsupported_args("format") 4500 def todouble_sql(self, expression: exp.ToDouble) -> str: 4501 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 4502 4503 def string_sql(self, expression: exp.String) -> str: 4504 this = expression.this 4505 zone = expression.args.get("zone") 4506 4507 if zone: 4508 # This is a BigQuery specific argument for STRING(<timestamp_expr>, <time_zone>) 4509 # BigQuery stores timestamps internally as UTC, so ConvertTimezone is used with UTC 4510 # set for source_tz to transpile the time conversion before the STRING cast 4511 this = exp.ConvertTimezone( 4512 source_tz=exp.Literal.string("UTC"), target_tz=zone, timestamp=this 4513 ) 4514 4515 return self.sql(exp.cast(this, exp.DataType.Type.VARCHAR)) 4516 4517 def median_sql(self, expression: exp.Median): 4518 if not self.SUPPORTS_MEDIAN: 4519 return self.sql( 4520 exp.PercentileCont(this=expression.this, expression=exp.Literal.number(0.5)) 4521 ) 4522 4523 return self.function_fallback_sql(expression) 4524 4525 def overflowtruncatebehavior_sql(self, expression: exp.OverflowTruncateBehavior) -> str: 4526 filler = self.sql(expression, "this") 4527 filler = f" {filler}" if filler else "" 4528 with_count = "WITH COUNT" if expression.args.get("with_count") else "WITHOUT COUNT" 4529 return f"TRUNCATE{filler} {with_count}" 4530 4531 def unixseconds_sql(self, expression: exp.UnixSeconds) -> str: 4532 if self.SUPPORTS_UNIX_SECONDS: 4533 return self.function_fallback_sql(expression) 4534 4535 start_ts = exp.cast( 4536 exp.Literal.string("1970-01-01 00:00:00+00"), to=exp.DataType.Type.TIMESTAMPTZ 4537 ) 4538 4539 return self.sql( 4540 exp.TimestampDiff(this=expression.this, expression=start_ts, unit=exp.var("SECONDS")) 4541 ) 4542 4543 def arraysize_sql(self, expression: exp.ArraySize) -> str: 4544 dim = expression.expression 4545 4546 # For dialects that don't support the dimension arg, we can safely transpile it's default value (1st dimension) 4547 if dim and self.ARRAY_SIZE_DIM_REQUIRED is None: 4548 if not (dim.is_int and dim.name == "1"): 4549 self.unsupported("Cannot transpile dimension argument for ARRAY_LENGTH") 4550 dim = None 4551 4552 # If dimension is required but not specified, default initialize it 4553 if self.ARRAY_SIZE_DIM_REQUIRED and not dim: 4554 dim = exp.Literal.number(1) 4555 4556 return self.func(self.ARRAY_SIZE_NAME, expression.this, dim) 4557 4558 def attach_sql(self, expression: exp.Attach) -> str: 4559 this = self.sql(expression, "this") 4560 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 4561 expressions = self.expressions(expression) 4562 expressions = f" ({expressions})" if expressions else "" 4563 4564 return f"ATTACH{exists_sql} {this}{expressions}" 4565 4566 def detach_sql(self, expression: exp.Detach) -> str: 4567 this = self.sql(expression, "this") 4568 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 4569 4570 return f"DETACH{exists_sql} {this}" 4571 4572 def attachoption_sql(self, expression: exp.AttachOption) -> str: 4573 this = self.sql(expression, "this") 4574 value = self.sql(expression, "expression") 4575 value = f" {value}" if value else "" 4576 return f"{this}{value}" 4577 4578 def featuresattime_sql(self, expression: exp.FeaturesAtTime) -> str: 4579 this_sql = self.sql(expression, "this") 4580 if isinstance(expression.this, exp.Table): 4581 this_sql = f"TABLE {this_sql}" 4582 4583 return self.func( 4584 "FEATURES_AT_TIME", 4585 this_sql, 4586 expression.args.get("time"), 4587 expression.args.get("num_rows"), 4588 expression.args.get("ignore_feature_nulls"), 4589 ) 4590 4591 def watermarkcolumnconstraint_sql(self, expression: exp.WatermarkColumnConstraint) -> str: 4592 return ( 4593 f"WATERMARK FOR {self.sql(expression, 'this')} AS {self.sql(expression, 'expression')}" 4594 ) 4595 4596 def encodeproperty_sql(self, expression: exp.EncodeProperty) -> str: 4597 encode = "KEY ENCODE" if expression.args.get("key") else "ENCODE" 4598 encode = f"{encode} {self.sql(expression, 'this')}" 4599 4600 properties = expression.args.get("properties") 4601 if properties: 4602 encode = f"{encode} {self.properties(properties)}" 4603 4604 return encode 4605 4606 def includeproperty_sql(self, expression: exp.IncludeProperty) -> str: 4607 this = self.sql(expression, "this") 4608 include = f"INCLUDE {this}" 4609 4610 column_def = self.sql(expression, "column_def") 4611 if column_def: 4612 include = f"{include} {column_def}" 4613 4614 alias = self.sql(expression, "alias") 4615 if alias: 4616 include = f"{include} AS {alias}" 4617 4618 return include 4619 4620 def xmlelement_sql(self, expression: exp.XMLElement) -> str: 4621 name = f"NAME {self.sql(expression, 'this')}" 4622 return self.func("XMLELEMENT", name, *expression.expressions) 4623 4624 def partitionbyrangeproperty_sql(self, expression: exp.PartitionByRangeProperty) -> str: 4625 partitions = self.expressions(expression, "partition_expressions") 4626 create = self.expressions(expression, "create_expressions") 4627 return f"PARTITION BY RANGE {self.wrap(partitions)} {self.wrap(create)}" 4628 4629 def partitionbyrangepropertydynamic_sql( 4630 self, expression: exp.PartitionByRangePropertyDynamic 4631 ) -> str: 4632 start = self.sql(expression, "start") 4633 end = self.sql(expression, "end") 4634 4635 every = expression.args["every"] 4636 if isinstance(every, exp.Interval) and every.this.is_string: 4637 every.this.replace(exp.Literal.number(every.name)) 4638 4639 return f"START {self.wrap(start)} END {self.wrap(end)} EVERY {self.wrap(self.sql(every))}"
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.Int64: lambda self, e: self.sql(exp.cast(e.this, exp.DataType.Type.BIGINT)), 153 exp.LanguageProperty: lambda self, e: self.naked_property(e), 154 exp.LocationProperty: lambda self, e: self.naked_property(e), 155 exp.LogProperty: lambda _, e: f"{'NO ' if e.args.get('no') else ''}LOG", 156 exp.MaterializedProperty: lambda *_: "MATERIALIZED", 157 exp.NonClusteredColumnConstraint: lambda self, 158 e: f"NONCLUSTERED ({self.expressions(e, 'this', indent=False)})", 159 exp.NoPrimaryIndexProperty: lambda *_: "NO PRIMARY INDEX", 160 exp.NotForReplicationColumnConstraint: lambda *_: "NOT FOR REPLICATION", 161 exp.OnCommitProperty: lambda _, 162 e: f"ON COMMIT {'DELETE' if e.args.get('delete') else 'PRESERVE'} ROWS", 163 exp.OnProperty: lambda self, e: f"ON {self.sql(e, 'this')}", 164 exp.OnUpdateColumnConstraint: lambda self, e: f"ON UPDATE {self.sql(e, 'this')}", 165 exp.Operator: lambda self, e: self.binary(e, ""), # The operator is produced in `binary` 166 exp.OutputModelProperty: lambda self, e: f"OUTPUT{self.sql(e, 'this')}", 167 exp.PathColumnConstraint: lambda self, e: f"PATH {self.sql(e, 'this')}", 168 exp.PivotAny: lambda self, e: f"ANY{self.sql(e, 'this')}", 169 exp.ProjectionPolicyColumnConstraint: lambda self, 170 e: f"PROJECTION POLICY {self.sql(e, 'this')}", 171 exp.RemoteWithConnectionModelProperty: lambda self, 172 e: f"REMOTE WITH CONNECTION {self.sql(e, 'this')}", 173 exp.ReturnsProperty: lambda self, e: ( 174 "RETURNS NULL ON NULL INPUT" if e.args.get("null") else self.naked_property(e) 175 ), 176 exp.SampleProperty: lambda self, e: f"SAMPLE BY {self.sql(e, 'this')}", 177 exp.SecureProperty: lambda *_: "SECURE", 178 exp.SecurityProperty: lambda self, e: f"SECURITY {self.sql(e, 'this')}", 179 exp.SetConfigProperty: lambda self, e: self.sql(e, "this"), 180 exp.SetProperty: lambda _, e: f"{'MULTI' if e.args.get('multi') else ''}SET", 181 exp.SettingsProperty: lambda self, e: f"SETTINGS{self.seg('')}{(self.expressions(e))}", 182 exp.SharingProperty: lambda self, e: f"SHARING={self.sql(e, 'this')}", 183 exp.SqlReadWriteProperty: lambda _, e: e.name, 184 exp.SqlSecurityProperty: lambda _, 185 e: f"SQL SECURITY {'DEFINER' if e.args.get('definer') else 'INVOKER'}", 186 exp.StabilityProperty: lambda _, e: e.name, 187 exp.Stream: lambda self, e: f"STREAM {self.sql(e, 'this')}", 188 exp.StreamingTableProperty: lambda *_: "STREAMING", 189 exp.StrictProperty: lambda *_: "STRICT", 190 exp.SwapTable: lambda self, e: f"SWAP WITH {self.sql(e, 'this')}", 191 exp.TemporaryProperty: lambda *_: "TEMPORARY", 192 exp.Tags: lambda self, e: f"TAG ({self.expressions(e, flat=True)})", 193 exp.TitleColumnConstraint: lambda self, e: f"TITLE {self.sql(e, 'this')}", 194 exp.ToMap: lambda self, e: f"MAP {self.sql(e, 'this')}", 195 exp.ToTableProperty: lambda self, e: f"TO {self.sql(e.this)}", 196 exp.TransformModelProperty: lambda self, e: self.func("TRANSFORM", *e.expressions), 197 exp.TransientProperty: lambda *_: "TRANSIENT", 198 exp.Union: lambda self, e: self.set_operations(e), 199 exp.UnloggedProperty: lambda *_: "UNLOGGED", 200 exp.Uuid: lambda *_: "UUID()", 201 exp.UppercaseColumnConstraint: lambda *_: "UPPERCASE", 202 exp.VarMap: lambda self, e: self.func("MAP", e.args["keys"], e.args["values"]), 203 exp.ViewAttributeProperty: lambda self, e: f"WITH {self.sql(e, 'this')}", 204 exp.VolatileProperty: lambda *_: "VOLATILE", 205 exp.WithJournalTableProperty: lambda self, e: f"WITH JOURNAL TABLE={self.sql(e, 'this')}", 206 exp.WithProcedureOptions: lambda self, e: f"WITH {self.expressions(e, flat=True)}", 207 exp.WithSchemaBindingProperty: lambda self, e: f"WITH SCHEMA {self.sql(e, 'this')}", 208 exp.WithOperator: lambda self, e: f"{self.sql(e, 'this')} WITH {self.sql(e, 'op')}", 209 } 210 211 # Whether null ordering is supported in order by 212 # True: Full Support, None: No support, False: No support for certain cases 213 # such as window specifications, aggregate functions etc 214 NULL_ORDERING_SUPPORTED: t.Optional[bool] = True 215 216 # Whether ignore nulls is inside the agg or outside. 217 # FIRST(x IGNORE NULLS) OVER vs FIRST (x) IGNORE NULLS OVER 218 IGNORE_NULLS_IN_FUNC = False 219 220 # Whether locking reads (i.e. SELECT ... FOR UPDATE/SHARE) are supported 221 LOCKING_READS_SUPPORTED = False 222 223 # Whether the EXCEPT and INTERSECT operations can return duplicates 224 EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = True 225 226 # Wrap derived values in parens, usually standard but spark doesn't support it 227 WRAP_DERIVED_VALUES = True 228 229 # Whether create function uses an AS before the RETURN 230 CREATE_FUNCTION_RETURN_AS = True 231 232 # Whether MERGE ... WHEN MATCHED BY SOURCE is allowed 233 MATCHED_BY_SOURCE = True 234 235 # Whether the INTERVAL expression works only with values like '1 day' 236 SINGLE_STRING_INTERVAL = False 237 238 # Whether the plural form of date parts like day (i.e. "days") is supported in INTERVALs 239 INTERVAL_ALLOWS_PLURAL_FORM = True 240 241 # Whether limit and fetch are supported (possible values: "ALL", "LIMIT", "FETCH") 242 LIMIT_FETCH = "ALL" 243 244 # Whether limit and fetch allows expresions or just limits 245 LIMIT_ONLY_LITERALS = False 246 247 # Whether a table is allowed to be renamed with a db 248 RENAME_TABLE_WITH_DB = True 249 250 # The separator for grouping sets and rollups 251 GROUPINGS_SEP = "," 252 253 # The string used for creating an index on a table 254 INDEX_ON = "ON" 255 256 # Whether join hints should be generated 257 JOIN_HINTS = True 258 259 # Whether table hints should be generated 260 TABLE_HINTS = True 261 262 # Whether query hints should be generated 263 QUERY_HINTS = True 264 265 # What kind of separator to use for query hints 266 QUERY_HINT_SEP = ", " 267 268 # Whether comparing against booleans (e.g. x IS TRUE) is supported 269 IS_BOOL_ALLOWED = True 270 271 # Whether to include the "SET" keyword in the "INSERT ... ON DUPLICATE KEY UPDATE" statement 272 DUPLICATE_KEY_UPDATE_WITH_SET = True 273 274 # Whether to generate the limit as TOP <value> instead of LIMIT <value> 275 LIMIT_IS_TOP = False 276 277 # Whether to generate INSERT INTO ... RETURNING or INSERT INTO RETURNING ... 278 RETURNING_END = True 279 280 # Whether to generate an unquoted value for EXTRACT's date part argument 281 EXTRACT_ALLOWS_QUOTES = True 282 283 # Whether TIMETZ / TIMESTAMPTZ will be generated using the "WITH TIME ZONE" syntax 284 TZ_TO_WITH_TIME_ZONE = False 285 286 # Whether the NVL2 function is supported 287 NVL2_SUPPORTED = True 288 289 # https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax 290 SELECT_KINDS: t.Tuple[str, ...] = ("STRUCT", "VALUE") 291 292 # Whether VALUES statements can be used as derived tables. 293 # MySQL 5 and Redshift do not allow this, so when False, it will convert 294 # SELECT * VALUES into SELECT UNION 295 VALUES_AS_TABLE = True 296 297 # Whether the word COLUMN is included when adding a column with ALTER TABLE 298 ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = True 299 300 # UNNEST WITH ORDINALITY (presto) instead of UNNEST WITH OFFSET (bigquery) 301 UNNEST_WITH_ORDINALITY = True 302 303 # Whether FILTER (WHERE cond) can be used for conditional aggregation 304 AGGREGATE_FILTER_SUPPORTED = True 305 306 # Whether JOIN sides (LEFT, RIGHT) are supported in conjunction with SEMI/ANTI join kinds 307 SEMI_ANTI_JOIN_WITH_SIDE = True 308 309 # Whether to include the type of a computed column in the CREATE DDL 310 COMPUTED_COLUMN_WITH_TYPE = True 311 312 # Whether CREATE TABLE .. COPY .. is supported. False means we'll generate CLONE instead of COPY 313 SUPPORTS_TABLE_COPY = True 314 315 # Whether parentheses are required around the table sample's expression 316 TABLESAMPLE_REQUIRES_PARENS = True 317 318 # Whether a table sample clause's size needs to be followed by the ROWS keyword 319 TABLESAMPLE_SIZE_IS_ROWS = True 320 321 # The keyword(s) to use when generating a sample clause 322 TABLESAMPLE_KEYWORDS = "TABLESAMPLE" 323 324 # Whether the TABLESAMPLE clause supports a method name, like BERNOULLI 325 TABLESAMPLE_WITH_METHOD = True 326 327 # The keyword to use when specifying the seed of a sample clause 328 TABLESAMPLE_SEED_KEYWORD = "SEED" 329 330 # Whether COLLATE is a function instead of a binary operator 331 COLLATE_IS_FUNC = False 332 333 # Whether data types support additional specifiers like e.g. CHAR or BYTE (oracle) 334 DATA_TYPE_SPECIFIERS_ALLOWED = False 335 336 # Whether conditions require booleans WHERE x = 0 vs WHERE x 337 ENSURE_BOOLS = False 338 339 # Whether the "RECURSIVE" keyword is required when defining recursive CTEs 340 CTE_RECURSIVE_KEYWORD_REQUIRED = True 341 342 # Whether CONCAT requires >1 arguments 343 SUPPORTS_SINGLE_ARG_CONCAT = True 344 345 # Whether LAST_DAY function supports a date part argument 346 LAST_DAY_SUPPORTS_DATE_PART = True 347 348 # Whether named columns are allowed in table aliases 349 SUPPORTS_TABLE_ALIAS_COLUMNS = True 350 351 # Whether UNPIVOT aliases are Identifiers (False means they're Literals) 352 UNPIVOT_ALIASES_ARE_IDENTIFIERS = True 353 354 # What delimiter to use for separating JSON key/value pairs 355 JSON_KEY_VALUE_PAIR_SEP = ":" 356 357 # INSERT OVERWRITE TABLE x override 358 INSERT_OVERWRITE = " OVERWRITE TABLE" 359 360 # Whether the SELECT .. INTO syntax is used instead of CTAS 361 SUPPORTS_SELECT_INTO = False 362 363 # Whether UNLOGGED tables can be created 364 SUPPORTS_UNLOGGED_TABLES = False 365 366 # Whether the CREATE TABLE LIKE statement is supported 367 SUPPORTS_CREATE_TABLE_LIKE = True 368 369 # Whether the LikeProperty needs to be specified inside of the schema clause 370 LIKE_PROPERTY_INSIDE_SCHEMA = False 371 372 # Whether DISTINCT can be followed by multiple args in an AggFunc. If not, it will be 373 # transpiled into a series of CASE-WHEN-ELSE, ultimately using a tuple conseisting of the args 374 MULTI_ARG_DISTINCT = True 375 376 # Whether the JSON extraction operators expect a value of type JSON 377 JSON_TYPE_REQUIRED_FOR_EXTRACTION = False 378 379 # Whether bracketed keys like ["foo"] are supported in JSON paths 380 JSON_PATH_BRACKETED_KEY_SUPPORTED = True 381 382 # Whether to escape keys using single quotes in JSON paths 383 JSON_PATH_SINGLE_QUOTE_ESCAPE = False 384 385 # The JSONPathPart expressions supported by this dialect 386 SUPPORTED_JSON_PATH_PARTS = ALL_JSON_PATH_PARTS.copy() 387 388 # Whether any(f(x) for x in array) can be implemented by this dialect 389 CAN_IMPLEMENT_ARRAY_ANY = False 390 391 # Whether the function TO_NUMBER is supported 392 SUPPORTS_TO_NUMBER = True 393 394 # Whether or not set op modifiers apply to the outer set op or select. 395 # SELECT * FROM x UNION SELECT * FROM y LIMIT 1 396 # True means limit 1 happens after the set op, False means it it happens on y. 397 SET_OP_MODIFIERS = True 398 399 # Whether parameters from COPY statement are wrapped in parentheses 400 COPY_PARAMS_ARE_WRAPPED = True 401 402 # Whether values of params are set with "=" token or empty space 403 COPY_PARAMS_EQ_REQUIRED = False 404 405 # Whether COPY statement has INTO keyword 406 COPY_HAS_INTO_KEYWORD = True 407 408 # Whether the conditional TRY(expression) function is supported 409 TRY_SUPPORTED = True 410 411 # Whether the UESCAPE syntax in unicode strings is supported 412 SUPPORTS_UESCAPE = True 413 414 # The keyword to use when generating a star projection with excluded columns 415 STAR_EXCEPT = "EXCEPT" 416 417 # The HEX function name 418 HEX_FUNC = "HEX" 419 420 # The keywords to use when prefixing & separating WITH based properties 421 WITH_PROPERTIES_PREFIX = "WITH" 422 423 # Whether to quote the generated expression of exp.JsonPath 424 QUOTE_JSON_PATH = True 425 426 # Whether the text pattern/fill (3rd) parameter of RPAD()/LPAD() is optional (defaults to space) 427 PAD_FILL_PATTERN_IS_REQUIRED = False 428 429 # Whether a projection can explode into multiple rows, e.g. by unnesting an array. 430 SUPPORTS_EXPLODING_PROJECTIONS = True 431 432 # Whether ARRAY_CONCAT can be generated with varlen args or if it should be reduced to 2-arg version 433 ARRAY_CONCAT_IS_VAR_LEN = True 434 435 # Whether CONVERT_TIMEZONE() is supported; if not, it will be generated as exp.AtTimeZone 436 SUPPORTS_CONVERT_TIMEZONE = False 437 438 # Whether MEDIAN(expr) is supported; if not, it will be generated as PERCENTILE_CONT(expr, 0.5) 439 SUPPORTS_MEDIAN = True 440 441 # Whether UNIX_SECONDS(timestamp) is supported 442 SUPPORTS_UNIX_SECONDS = False 443 444 # The name to generate for the JSONPath expression. If `None`, only `this` will be generated 445 PARSE_JSON_NAME: t.Optional[str] = "PARSE_JSON" 446 447 # The function name of the exp.ArraySize expression 448 ARRAY_SIZE_NAME: str = "ARRAY_LENGTH" 449 450 # Whether exp.ArraySize should generate the dimension arg too (valid for Postgres & DuckDB) 451 # None -> Doesn't support it at all 452 # False (DuckDB) -> Has backwards-compatible support, but preferably generated without 453 # True (Postgres) -> Explicitly requires it 454 ARRAY_SIZE_DIM_REQUIRED: t.Optional[bool] = None 455 456 TYPE_MAPPING = { 457 exp.DataType.Type.DATETIME2: "TIMESTAMP", 458 exp.DataType.Type.NCHAR: "CHAR", 459 exp.DataType.Type.NVARCHAR: "VARCHAR", 460 exp.DataType.Type.MEDIUMTEXT: "TEXT", 461 exp.DataType.Type.LONGTEXT: "TEXT", 462 exp.DataType.Type.TINYTEXT: "TEXT", 463 exp.DataType.Type.MEDIUMBLOB: "BLOB", 464 exp.DataType.Type.LONGBLOB: "BLOB", 465 exp.DataType.Type.TINYBLOB: "BLOB", 466 exp.DataType.Type.INET: "INET", 467 exp.DataType.Type.ROWVERSION: "VARBINARY", 468 exp.DataType.Type.SMALLDATETIME: "TIMESTAMP", 469 } 470 471 TIME_PART_SINGULARS = { 472 "MICROSECONDS": "MICROSECOND", 473 "SECONDS": "SECOND", 474 "MINUTES": "MINUTE", 475 "HOURS": "HOUR", 476 "DAYS": "DAY", 477 "WEEKS": "WEEK", 478 "MONTHS": "MONTH", 479 "QUARTERS": "QUARTER", 480 "YEARS": "YEAR", 481 } 482 483 AFTER_HAVING_MODIFIER_TRANSFORMS = { 484 "cluster": lambda self, e: self.sql(e, "cluster"), 485 "distribute": lambda self, e: self.sql(e, "distribute"), 486 "sort": lambda self, e: self.sql(e, "sort"), 487 "windows": lambda self, e: ( 488 self.seg("WINDOW ") + self.expressions(e, key="windows", flat=True) 489 if e.args.get("windows") 490 else "" 491 ), 492 "qualify": lambda self, e: self.sql(e, "qualify"), 493 } 494 495 TOKEN_MAPPING: t.Dict[TokenType, str] = {} 496 497 STRUCT_DELIMITER = ("<", ">") 498 499 PARAMETER_TOKEN = "@" 500 NAMED_PLACEHOLDER_TOKEN = ":" 501 502 EXPRESSION_PRECEDES_PROPERTIES_CREATABLES: t.Set[str] = set() 503 504 PROPERTIES_LOCATION = { 505 exp.AllowedValuesProperty: exp.Properties.Location.POST_SCHEMA, 506 exp.AlgorithmProperty: exp.Properties.Location.POST_CREATE, 507 exp.AutoIncrementProperty: exp.Properties.Location.POST_SCHEMA, 508 exp.AutoRefreshProperty: exp.Properties.Location.POST_SCHEMA, 509 exp.BackupProperty: exp.Properties.Location.POST_SCHEMA, 510 exp.BlockCompressionProperty: exp.Properties.Location.POST_NAME, 511 exp.CharacterSetProperty: exp.Properties.Location.POST_SCHEMA, 512 exp.ChecksumProperty: exp.Properties.Location.POST_NAME, 513 exp.CollateProperty: exp.Properties.Location.POST_SCHEMA, 514 exp.CopyGrantsProperty: exp.Properties.Location.POST_SCHEMA, 515 exp.Cluster: exp.Properties.Location.POST_SCHEMA, 516 exp.ClusteredByProperty: exp.Properties.Location.POST_SCHEMA, 517 exp.DistributedByProperty: exp.Properties.Location.POST_SCHEMA, 518 exp.DuplicateKeyProperty: exp.Properties.Location.POST_SCHEMA, 519 exp.DataBlocksizeProperty: exp.Properties.Location.POST_NAME, 520 exp.DataDeletionProperty: exp.Properties.Location.POST_SCHEMA, 521 exp.DefinerProperty: exp.Properties.Location.POST_CREATE, 522 exp.DictRange: exp.Properties.Location.POST_SCHEMA, 523 exp.DictProperty: exp.Properties.Location.POST_SCHEMA, 524 exp.DynamicProperty: exp.Properties.Location.POST_CREATE, 525 exp.DistKeyProperty: exp.Properties.Location.POST_SCHEMA, 526 exp.DistStyleProperty: exp.Properties.Location.POST_SCHEMA, 527 exp.EmptyProperty: exp.Properties.Location.POST_SCHEMA, 528 exp.EncodeProperty: exp.Properties.Location.POST_EXPRESSION, 529 exp.EngineProperty: exp.Properties.Location.POST_SCHEMA, 530 exp.ExecuteAsProperty: exp.Properties.Location.POST_SCHEMA, 531 exp.ExternalProperty: exp.Properties.Location.POST_CREATE, 532 exp.FallbackProperty: exp.Properties.Location.POST_NAME, 533 exp.FileFormatProperty: exp.Properties.Location.POST_WITH, 534 exp.FreespaceProperty: exp.Properties.Location.POST_NAME, 535 exp.GlobalProperty: exp.Properties.Location.POST_CREATE, 536 exp.HeapProperty: exp.Properties.Location.POST_WITH, 537 exp.InheritsProperty: exp.Properties.Location.POST_SCHEMA, 538 exp.IcebergProperty: exp.Properties.Location.POST_CREATE, 539 exp.IncludeProperty: exp.Properties.Location.POST_SCHEMA, 540 exp.InputModelProperty: exp.Properties.Location.POST_SCHEMA, 541 exp.IsolatedLoadingProperty: exp.Properties.Location.POST_NAME, 542 exp.JournalProperty: exp.Properties.Location.POST_NAME, 543 exp.LanguageProperty: exp.Properties.Location.POST_SCHEMA, 544 exp.LikeProperty: exp.Properties.Location.POST_SCHEMA, 545 exp.LocationProperty: exp.Properties.Location.POST_SCHEMA, 546 exp.LockProperty: exp.Properties.Location.POST_SCHEMA, 547 exp.LockingProperty: exp.Properties.Location.POST_ALIAS, 548 exp.LogProperty: exp.Properties.Location.POST_NAME, 549 exp.MaterializedProperty: exp.Properties.Location.POST_CREATE, 550 exp.MergeBlockRatioProperty: exp.Properties.Location.POST_NAME, 551 exp.NoPrimaryIndexProperty: exp.Properties.Location.POST_EXPRESSION, 552 exp.OnProperty: exp.Properties.Location.POST_SCHEMA, 553 exp.OnCommitProperty: exp.Properties.Location.POST_EXPRESSION, 554 exp.Order: exp.Properties.Location.POST_SCHEMA, 555 exp.OutputModelProperty: exp.Properties.Location.POST_SCHEMA, 556 exp.PartitionedByProperty: exp.Properties.Location.POST_WITH, 557 exp.PartitionedOfProperty: exp.Properties.Location.POST_SCHEMA, 558 exp.PrimaryKey: exp.Properties.Location.POST_SCHEMA, 559 exp.Property: exp.Properties.Location.POST_WITH, 560 exp.RemoteWithConnectionModelProperty: exp.Properties.Location.POST_SCHEMA, 561 exp.ReturnsProperty: exp.Properties.Location.POST_SCHEMA, 562 exp.RowFormatProperty: exp.Properties.Location.POST_SCHEMA, 563 exp.RowFormatDelimitedProperty: exp.Properties.Location.POST_SCHEMA, 564 exp.RowFormatSerdeProperty: exp.Properties.Location.POST_SCHEMA, 565 exp.SampleProperty: exp.Properties.Location.POST_SCHEMA, 566 exp.SchemaCommentProperty: exp.Properties.Location.POST_SCHEMA, 567 exp.SecureProperty: exp.Properties.Location.POST_CREATE, 568 exp.SecurityProperty: exp.Properties.Location.POST_SCHEMA, 569 exp.SerdeProperties: exp.Properties.Location.POST_SCHEMA, 570 exp.Set: exp.Properties.Location.POST_SCHEMA, 571 exp.SettingsProperty: exp.Properties.Location.POST_SCHEMA, 572 exp.SetProperty: exp.Properties.Location.POST_CREATE, 573 exp.SetConfigProperty: exp.Properties.Location.POST_SCHEMA, 574 exp.SharingProperty: exp.Properties.Location.POST_EXPRESSION, 575 exp.SequenceProperties: exp.Properties.Location.POST_EXPRESSION, 576 exp.SortKeyProperty: exp.Properties.Location.POST_SCHEMA, 577 exp.SqlReadWriteProperty: exp.Properties.Location.POST_SCHEMA, 578 exp.SqlSecurityProperty: exp.Properties.Location.POST_CREATE, 579 exp.StabilityProperty: exp.Properties.Location.POST_SCHEMA, 580 exp.StreamingTableProperty: exp.Properties.Location.POST_CREATE, 581 exp.StrictProperty: exp.Properties.Location.POST_SCHEMA, 582 exp.Tags: exp.Properties.Location.POST_WITH, 583 exp.TemporaryProperty: exp.Properties.Location.POST_CREATE, 584 exp.ToTableProperty: exp.Properties.Location.POST_SCHEMA, 585 exp.TransientProperty: exp.Properties.Location.POST_CREATE, 586 exp.TransformModelProperty: exp.Properties.Location.POST_SCHEMA, 587 exp.MergeTreeTTL: exp.Properties.Location.POST_SCHEMA, 588 exp.UnloggedProperty: exp.Properties.Location.POST_CREATE, 589 exp.ViewAttributeProperty: exp.Properties.Location.POST_SCHEMA, 590 exp.VolatileProperty: exp.Properties.Location.POST_CREATE, 591 exp.WithDataProperty: exp.Properties.Location.POST_EXPRESSION, 592 exp.WithJournalTableProperty: exp.Properties.Location.POST_NAME, 593 exp.WithProcedureOptions: exp.Properties.Location.POST_SCHEMA, 594 exp.WithSchemaBindingProperty: exp.Properties.Location.POST_SCHEMA, 595 exp.WithSystemVersioningProperty: exp.Properties.Location.POST_SCHEMA, 596 } 597 598 # Keywords that can't be used as unquoted identifier names 599 RESERVED_KEYWORDS: t.Set[str] = set() 600 601 # Expressions whose comments are separated from them for better formatting 602 WITH_SEPARATED_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 603 exp.Command, 604 exp.Create, 605 exp.Describe, 606 exp.Delete, 607 exp.Drop, 608 exp.From, 609 exp.Insert, 610 exp.Join, 611 exp.MultitableInserts, 612 exp.Select, 613 exp.SetOperation, 614 exp.Update, 615 exp.Where, 616 exp.With, 617 ) 618 619 # Expressions that should not have their comments generated in maybe_comment 620 EXCLUDE_COMMENTS: t.Tuple[t.Type[exp.Expression], ...] = ( 621 exp.Binary, 622 exp.SetOperation, 623 ) 624 625 # Expressions that can remain unwrapped when appearing in the context of an INTERVAL 626 UNWRAPPED_INTERVAL_VALUES: t.Tuple[t.Type[exp.Expression], ...] = ( 627 exp.Column, 628 exp.Literal, 629 exp.Neg, 630 exp.Paren, 631 ) 632 633 PARAMETERIZABLE_TEXT_TYPES = { 634 exp.DataType.Type.NVARCHAR, 635 exp.DataType.Type.VARCHAR, 636 exp.DataType.Type.CHAR, 637 exp.DataType.Type.NCHAR, 638 } 639 640 # Expressions that need to have all CTEs under them bubbled up to them 641 EXPRESSIONS_WITHOUT_NESTED_CTES: t.Set[t.Type[exp.Expression]] = set() 642 643 SENTINEL_LINE_BREAK = "__SQLGLOT__LB__" 644 645 __slots__ = ( 646 "pretty", 647 "identify", 648 "normalize", 649 "pad", 650 "_indent", 651 "normalize_functions", 652 "unsupported_level", 653 "max_unsupported", 654 "leading_comma", 655 "max_text_width", 656 "comments", 657 "dialect", 658 "unsupported_messages", 659 "_escaped_quote_end", 660 "_escaped_identifier_end", 661 "_next_name", 662 "_identifier_start", 663 "_identifier_end", 664 "_quote_json_path_key_using_brackets", 665 ) 666 667 def __init__( 668 self, 669 pretty: t.Optional[bool] = None, 670 identify: str | bool = False, 671 normalize: bool = False, 672 pad: int = 2, 673 indent: int = 2, 674 normalize_functions: t.Optional[str | bool] = None, 675 unsupported_level: ErrorLevel = ErrorLevel.WARN, 676 max_unsupported: int = 3, 677 leading_comma: bool = False, 678 max_text_width: int = 80, 679 comments: bool = True, 680 dialect: DialectType = None, 681 ): 682 import sqlglot 683 from sqlglot.dialects import Dialect 684 685 self.pretty = pretty if pretty is not None else sqlglot.pretty 686 self.identify = identify 687 self.normalize = normalize 688 self.pad = pad 689 self._indent = indent 690 self.unsupported_level = unsupported_level 691 self.max_unsupported = max_unsupported 692 self.leading_comma = leading_comma 693 self.max_text_width = max_text_width 694 self.comments = comments 695 self.dialect = Dialect.get_or_raise(dialect) 696 697 # This is both a Dialect property and a Generator argument, so we prioritize the latter 698 self.normalize_functions = ( 699 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 700 ) 701 702 self.unsupported_messages: t.List[str] = [] 703 self._escaped_quote_end: str = ( 704 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 705 ) 706 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 707 708 self._next_name = name_sequence("_t") 709 710 self._identifier_start = self.dialect.IDENTIFIER_START 711 self._identifier_end = self.dialect.IDENTIFIER_END 712 713 self._quote_json_path_key_using_brackets = True 714 715 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 716 """ 717 Generates the SQL string corresponding to the given syntax tree. 718 719 Args: 720 expression: The syntax tree. 721 copy: Whether to copy the expression. The generator performs mutations so 722 it is safer to copy. 723 724 Returns: 725 The SQL string corresponding to `expression`. 726 """ 727 if copy: 728 expression = expression.copy() 729 730 expression = self.preprocess(expression) 731 732 self.unsupported_messages = [] 733 sql = self.sql(expression).strip() 734 735 if self.pretty: 736 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 737 738 if self.unsupported_level == ErrorLevel.IGNORE: 739 return sql 740 741 if self.unsupported_level == ErrorLevel.WARN: 742 for msg in self.unsupported_messages: 743 logger.warning(msg) 744 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 745 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 746 747 return sql 748 749 def preprocess(self, expression: exp.Expression) -> exp.Expression: 750 """Apply generic preprocessing transformations to a given expression.""" 751 expression = self._move_ctes_to_top_level(expression) 752 753 if self.ENSURE_BOOLS: 754 from sqlglot.transforms import ensure_bools 755 756 expression = ensure_bools(expression) 757 758 return expression 759 760 def _move_ctes_to_top_level(self, expression: E) -> E: 761 if ( 762 not expression.parent 763 and type(expression) in self.EXPRESSIONS_WITHOUT_NESTED_CTES 764 and any(node.parent is not expression for node in expression.find_all(exp.With)) 765 ): 766 from sqlglot.transforms import move_ctes_to_top_level 767 768 expression = move_ctes_to_top_level(expression) 769 return expression 770 771 def unsupported(self, message: str) -> None: 772 if self.unsupported_level == ErrorLevel.IMMEDIATE: 773 raise UnsupportedError(message) 774 self.unsupported_messages.append(message) 775 776 def sep(self, sep: str = " ") -> str: 777 return f"{sep.strip()}\n" if self.pretty else sep 778 779 def seg(self, sql: str, sep: str = " ") -> str: 780 return f"{self.sep(sep)}{sql}" 781 782 def pad_comment(self, comment: str) -> str: 783 comment = " " + comment if comment[0].strip() else comment 784 comment = comment + " " if comment[-1].strip() else comment 785 return comment 786 787 def maybe_comment( 788 self, 789 sql: str, 790 expression: t.Optional[exp.Expression] = None, 791 comments: t.Optional[t.List[str]] = None, 792 separated: bool = False, 793 ) -> str: 794 comments = ( 795 ((expression and expression.comments) if comments is None else comments) # type: ignore 796 if self.comments 797 else None 798 ) 799 800 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 801 return sql 802 803 comments_sql = " ".join( 804 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 805 ) 806 807 if not comments_sql: 808 return sql 809 810 comments_sql = self._replace_line_breaks(comments_sql) 811 812 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 813 return ( 814 f"{self.sep()}{comments_sql}{sql}" 815 if not sql or sql[0].isspace() 816 else f"{comments_sql}{self.sep()}{sql}" 817 ) 818 819 return f"{sql} {comments_sql}" 820 821 def wrap(self, expression: exp.Expression | str) -> str: 822 this_sql = ( 823 self.sql(expression) 824 if isinstance(expression, exp.UNWRAPPED_QUERIES) 825 else self.sql(expression, "this") 826 ) 827 if not this_sql: 828 return "()" 829 830 this_sql = self.indent(this_sql, level=1, pad=0) 831 return f"({self.sep('')}{this_sql}{self.seg(')', sep='')}" 832 833 def no_identify(self, func: t.Callable[..., str], *args, **kwargs) -> str: 834 original = self.identify 835 self.identify = False 836 result = func(*args, **kwargs) 837 self.identify = original 838 return result 839 840 def normalize_func(self, name: str) -> str: 841 if self.normalize_functions == "upper" or self.normalize_functions is True: 842 return name.upper() 843 if self.normalize_functions == "lower": 844 return name.lower() 845 return name 846 847 def indent( 848 self, 849 sql: str, 850 level: int = 0, 851 pad: t.Optional[int] = None, 852 skip_first: bool = False, 853 skip_last: bool = False, 854 ) -> str: 855 if not self.pretty or not sql: 856 return sql 857 858 pad = self.pad if pad is None else pad 859 lines = sql.split("\n") 860 861 return "\n".join( 862 ( 863 line 864 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 865 else f"{' ' * (level * self._indent + pad)}{line}" 866 ) 867 for i, line in enumerate(lines) 868 ) 869 870 def sql( 871 self, 872 expression: t.Optional[str | exp.Expression], 873 key: t.Optional[str] = None, 874 comment: bool = True, 875 ) -> str: 876 if not expression: 877 return "" 878 879 if isinstance(expression, str): 880 return expression 881 882 if key: 883 value = expression.args.get(key) 884 if value: 885 return self.sql(value) 886 return "" 887 888 transform = self.TRANSFORMS.get(expression.__class__) 889 890 if callable(transform): 891 sql = transform(self, expression) 892 elif isinstance(expression, exp.Expression): 893 exp_handler_name = f"{expression.key}_sql" 894 895 if hasattr(self, exp_handler_name): 896 sql = getattr(self, exp_handler_name)(expression) 897 elif isinstance(expression, exp.Func): 898 sql = self.function_fallback_sql(expression) 899 elif isinstance(expression, exp.Property): 900 sql = self.property_sql(expression) 901 else: 902 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 903 else: 904 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 905 906 return self.maybe_comment(sql, expression) if self.comments and comment else sql 907 908 def uncache_sql(self, expression: exp.Uncache) -> str: 909 table = self.sql(expression, "this") 910 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 911 return f"UNCACHE TABLE{exists_sql} {table}" 912 913 def cache_sql(self, expression: exp.Cache) -> str: 914 lazy = " LAZY" if expression.args.get("lazy") else "" 915 table = self.sql(expression, "this") 916 options = expression.args.get("options") 917 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 918 sql = self.sql(expression, "expression") 919 sql = f" AS{self.sep()}{sql}" if sql else "" 920 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 921 return self.prepend_ctes(expression, sql) 922 923 def characterset_sql(self, expression: exp.CharacterSet) -> str: 924 if isinstance(expression.parent, exp.Cast): 925 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 926 default = "DEFAULT " if expression.args.get("default") else "" 927 return f"{default}CHARACTER SET={self.sql(expression, 'this')}" 928 929 def column_parts(self, expression: exp.Column) -> str: 930 return ".".join( 931 self.sql(part) 932 for part in ( 933 expression.args.get("catalog"), 934 expression.args.get("db"), 935 expression.args.get("table"), 936 expression.args.get("this"), 937 ) 938 if part 939 ) 940 941 def column_sql(self, expression: exp.Column) -> str: 942 join_mark = " (+)" if expression.args.get("join_mark") else "" 943 944 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 945 join_mark = "" 946 self.unsupported("Outer join syntax using the (+) operator is not supported.") 947 948 return f"{self.column_parts(expression)}{join_mark}" 949 950 def columnposition_sql(self, expression: exp.ColumnPosition) -> str: 951 this = self.sql(expression, "this") 952 this = f" {this}" if this else "" 953 position = self.sql(expression, "position") 954 return f"{position}{this}" 955 956 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 957 column = self.sql(expression, "this") 958 kind = self.sql(expression, "kind") 959 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 960 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 961 kind = f"{sep}{kind}" if kind else "" 962 constraints = f" {constraints}" if constraints else "" 963 position = self.sql(expression, "position") 964 position = f" {position}" if position else "" 965 966 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 967 kind = "" 968 969 return f"{exists}{column}{kind}{constraints}{position}" 970 971 def columnconstraint_sql(self, expression: exp.ColumnConstraint) -> str: 972 this = self.sql(expression, "this") 973 kind_sql = self.sql(expression, "kind").strip() 974 return f"CONSTRAINT {this} {kind_sql}" if this else kind_sql 975 976 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 977 this = self.sql(expression, "this") 978 if expression.args.get("not_null"): 979 persisted = " PERSISTED NOT NULL" 980 elif expression.args.get("persisted"): 981 persisted = " PERSISTED" 982 else: 983 persisted = "" 984 return f"AS {this}{persisted}" 985 986 def autoincrementcolumnconstraint_sql(self, _) -> str: 987 return self.token_sql(TokenType.AUTO_INCREMENT) 988 989 def compresscolumnconstraint_sql(self, expression: exp.CompressColumnConstraint) -> str: 990 if isinstance(expression.this, list): 991 this = self.wrap(self.expressions(expression, key="this", flat=True)) 992 else: 993 this = self.sql(expression, "this") 994 995 return f"COMPRESS {this}" 996 997 def generatedasidentitycolumnconstraint_sql( 998 self, expression: exp.GeneratedAsIdentityColumnConstraint 999 ) -> str: 1000 this = "" 1001 if expression.this is not None: 1002 on_null = " ON NULL" if expression.args.get("on_null") else "" 1003 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 1004 1005 start = expression.args.get("start") 1006 start = f"START WITH {start}" if start else "" 1007 increment = expression.args.get("increment") 1008 increment = f" INCREMENT BY {increment}" if increment else "" 1009 minvalue = expression.args.get("minvalue") 1010 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1011 maxvalue = expression.args.get("maxvalue") 1012 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1013 cycle = expression.args.get("cycle") 1014 cycle_sql = "" 1015 1016 if cycle is not None: 1017 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 1018 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 1019 1020 sequence_opts = "" 1021 if start or increment or cycle_sql: 1022 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 1023 sequence_opts = f" ({sequence_opts.strip()})" 1024 1025 expr = self.sql(expression, "expression") 1026 expr = f"({expr})" if expr else "IDENTITY" 1027 1028 return f"GENERATED{this} AS {expr}{sequence_opts}" 1029 1030 def generatedasrowcolumnconstraint_sql( 1031 self, expression: exp.GeneratedAsRowColumnConstraint 1032 ) -> str: 1033 start = "START" if expression.args.get("start") else "END" 1034 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1035 return f"GENERATED ALWAYS AS ROW {start}{hidden}" 1036 1037 def periodforsystemtimeconstraint_sql( 1038 self, expression: exp.PeriodForSystemTimeConstraint 1039 ) -> str: 1040 return f"PERIOD FOR SYSTEM_TIME ({self.sql(expression, 'this')}, {self.sql(expression, 'expression')})" 1041 1042 def notnullcolumnconstraint_sql(self, expression: exp.NotNullColumnConstraint) -> str: 1043 return f"{'' if expression.args.get('allow_null') else 'NOT '}NULL" 1044 1045 def transformcolumnconstraint_sql(self, expression: exp.TransformColumnConstraint) -> str: 1046 return f"AS {self.sql(expression, 'this')}" 1047 1048 def primarykeycolumnconstraint_sql(self, expression: exp.PrimaryKeyColumnConstraint) -> str: 1049 desc = expression.args.get("desc") 1050 if desc is not None: 1051 return f"PRIMARY KEY{' DESC' if desc else ' ASC'}" 1052 return "PRIMARY KEY" 1053 1054 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1055 this = self.sql(expression, "this") 1056 this = f" {this}" if this else "" 1057 index_type = expression.args.get("index_type") 1058 index_type = f" USING {index_type}" if index_type else "" 1059 on_conflict = self.sql(expression, "on_conflict") 1060 on_conflict = f" {on_conflict}" if on_conflict else "" 1061 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1062 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}" 1063 1064 def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str: 1065 return self.sql(expression, "this") 1066 1067 def create_sql(self, expression: exp.Create) -> str: 1068 kind = self.sql(expression, "kind") 1069 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1070 properties = expression.args.get("properties") 1071 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1072 1073 this = self.createable_sql(expression, properties_locs) 1074 1075 properties_sql = "" 1076 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1077 exp.Properties.Location.POST_WITH 1078 ): 1079 properties_sql = self.sql( 1080 exp.Properties( 1081 expressions=[ 1082 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1083 *properties_locs[exp.Properties.Location.POST_WITH], 1084 ] 1085 ) 1086 ) 1087 1088 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1089 properties_sql = self.sep() + properties_sql 1090 elif not self.pretty: 1091 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1092 properties_sql = f" {properties_sql}" 1093 1094 begin = " BEGIN" if expression.args.get("begin") else "" 1095 end = " END" if expression.args.get("end") else "" 1096 1097 expression_sql = self.sql(expression, "expression") 1098 if expression_sql: 1099 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1100 1101 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1102 postalias_props_sql = "" 1103 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1104 postalias_props_sql = self.properties( 1105 exp.Properties( 1106 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1107 ), 1108 wrapped=False, 1109 ) 1110 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1111 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1112 1113 postindex_props_sql = "" 1114 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1115 postindex_props_sql = self.properties( 1116 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1117 wrapped=False, 1118 prefix=" ", 1119 ) 1120 1121 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1122 indexes = f" {indexes}" if indexes else "" 1123 index_sql = indexes + postindex_props_sql 1124 1125 replace = " OR REPLACE" if expression.args.get("replace") else "" 1126 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1127 unique = " UNIQUE" if expression.args.get("unique") else "" 1128 1129 clustered = expression.args.get("clustered") 1130 if clustered is None: 1131 clustered_sql = "" 1132 elif clustered: 1133 clustered_sql = " CLUSTERED COLUMNSTORE" 1134 else: 1135 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1136 1137 postcreate_props_sql = "" 1138 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1139 postcreate_props_sql = self.properties( 1140 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1141 sep=" ", 1142 prefix=" ", 1143 wrapped=False, 1144 ) 1145 1146 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1147 1148 postexpression_props_sql = "" 1149 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1150 postexpression_props_sql = self.properties( 1151 exp.Properties( 1152 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1153 ), 1154 sep=" ", 1155 prefix=" ", 1156 wrapped=False, 1157 ) 1158 1159 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1160 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1161 no_schema_binding = ( 1162 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1163 ) 1164 1165 clone = self.sql(expression, "clone") 1166 clone = f" {clone}" if clone else "" 1167 1168 if kind in self.EXPRESSION_PRECEDES_PROPERTIES_CREATABLES: 1169 properties_expression = f"{expression_sql}{properties_sql}" 1170 else: 1171 properties_expression = f"{properties_sql}{expression_sql}" 1172 1173 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_expression}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1174 return self.prepend_ctes(expression, expression_sql) 1175 1176 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1177 start = self.sql(expression, "start") 1178 start = f"START WITH {start}" if start else "" 1179 increment = self.sql(expression, "increment") 1180 increment = f" INCREMENT BY {increment}" if increment else "" 1181 minvalue = self.sql(expression, "minvalue") 1182 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1183 maxvalue = self.sql(expression, "maxvalue") 1184 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1185 owned = self.sql(expression, "owned") 1186 owned = f" OWNED BY {owned}" if owned else "" 1187 1188 cache = expression.args.get("cache") 1189 if cache is None: 1190 cache_str = "" 1191 elif cache is True: 1192 cache_str = " CACHE" 1193 else: 1194 cache_str = f" CACHE {cache}" 1195 1196 options = self.expressions(expression, key="options", flat=True, sep=" ") 1197 options = f" {options}" if options else "" 1198 1199 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip() 1200 1201 def clone_sql(self, expression: exp.Clone) -> str: 1202 this = self.sql(expression, "this") 1203 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1204 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1205 return f"{shallow}{keyword} {this}" 1206 1207 def describe_sql(self, expression: exp.Describe) -> str: 1208 style = expression.args.get("style") 1209 style = f" {style}" if style else "" 1210 partition = self.sql(expression, "partition") 1211 partition = f" {partition}" if partition else "" 1212 format = self.sql(expression, "format") 1213 format = f" {format}" if format else "" 1214 1215 return f"DESCRIBE{style}{format} {self.sql(expression, 'this')}{partition}" 1216 1217 def heredoc_sql(self, expression: exp.Heredoc) -> str: 1218 tag = self.sql(expression, "tag") 1219 return f"${tag}${self.sql(expression, 'this')}${tag}$" 1220 1221 def prepend_ctes(self, expression: exp.Expression, sql: str) -> str: 1222 with_ = self.sql(expression, "with") 1223 if with_: 1224 sql = f"{with_}{self.sep()}{sql}" 1225 return sql 1226 1227 def with_sql(self, expression: exp.With) -> str: 1228 sql = self.expressions(expression, flat=True) 1229 recursive = ( 1230 "RECURSIVE " 1231 if self.CTE_RECURSIVE_KEYWORD_REQUIRED and expression.args.get("recursive") 1232 else "" 1233 ) 1234 1235 return f"WITH {recursive}{sql}" 1236 1237 def cte_sql(self, expression: exp.CTE) -> str: 1238 alias = expression.args.get("alias") 1239 if alias: 1240 alias.add_comments(expression.pop_comments()) 1241 1242 alias_sql = self.sql(expression, "alias") 1243 1244 materialized = expression.args.get("materialized") 1245 if materialized is False: 1246 materialized = "NOT MATERIALIZED " 1247 elif materialized: 1248 materialized = "MATERIALIZED " 1249 1250 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}" 1251 1252 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1253 alias = self.sql(expression, "this") 1254 columns = self.expressions(expression, key="columns", flat=True) 1255 columns = f"({columns})" if columns else "" 1256 1257 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1258 columns = "" 1259 self.unsupported("Named columns are not supported in table alias.") 1260 1261 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1262 alias = self._next_name() 1263 1264 return f"{alias}{columns}" 1265 1266 def bitstring_sql(self, expression: exp.BitString) -> str: 1267 this = self.sql(expression, "this") 1268 if self.dialect.BIT_START: 1269 return f"{self.dialect.BIT_START}{this}{self.dialect.BIT_END}" 1270 return f"{int(this, 2)}" 1271 1272 def hexstring_sql(self, expression: exp.HexString) -> str: 1273 this = self.sql(expression, "this") 1274 if self.dialect.HEX_START: 1275 return f"{self.dialect.HEX_START}{this}{self.dialect.HEX_END}" 1276 return f"{int(this, 16)}" 1277 1278 def bytestring_sql(self, expression: exp.ByteString) -> str: 1279 this = self.sql(expression, "this") 1280 if self.dialect.BYTE_START: 1281 return f"{self.dialect.BYTE_START}{this}{self.dialect.BYTE_END}" 1282 return this 1283 1284 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1285 this = self.sql(expression, "this") 1286 escape = expression.args.get("escape") 1287 1288 if self.dialect.UNICODE_START: 1289 escape_substitute = r"\\\1" 1290 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1291 else: 1292 escape_substitute = r"\\u\1" 1293 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1294 1295 if escape: 1296 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1297 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1298 else: 1299 escape_pattern = ESCAPED_UNICODE_RE 1300 escape_sql = "" 1301 1302 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1303 this = escape_pattern.sub(escape_substitute, this) 1304 1305 return f"{left_quote}{this}{right_quote}{escape_sql}" 1306 1307 def rawstring_sql(self, expression: exp.RawString) -> str: 1308 string = self.escape_str(expression.this.replace("\\", "\\\\"), escape_backslash=False) 1309 return f"{self.dialect.QUOTE_START}{string}{self.dialect.QUOTE_END}" 1310 1311 def datatypeparam_sql(self, expression: exp.DataTypeParam) -> str: 1312 this = self.sql(expression, "this") 1313 specifier = self.sql(expression, "expression") 1314 specifier = f" {specifier}" if specifier and self.DATA_TYPE_SPECIFIERS_ALLOWED else "" 1315 return f"{this}{specifier}" 1316 1317 def datatype_sql(self, expression: exp.DataType) -> str: 1318 nested = "" 1319 values = "" 1320 interior = self.expressions(expression, flat=True) 1321 1322 type_value = expression.this 1323 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1324 type_sql = self.sql(expression, "kind") 1325 else: 1326 type_sql = ( 1327 self.TYPE_MAPPING.get(type_value, type_value.value) 1328 if isinstance(type_value, exp.DataType.Type) 1329 else type_value 1330 ) 1331 1332 if interior: 1333 if expression.args.get("nested"): 1334 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1335 if expression.args.get("values") is not None: 1336 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1337 values = self.expressions(expression, key="values", flat=True) 1338 values = f"{delimiters[0]}{values}{delimiters[1]}" 1339 elif type_value == exp.DataType.Type.INTERVAL: 1340 nested = f" {interior}" 1341 else: 1342 nested = f"({interior})" 1343 1344 type_sql = f"{type_sql}{nested}{values}" 1345 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1346 exp.DataType.Type.TIMETZ, 1347 exp.DataType.Type.TIMESTAMPTZ, 1348 ): 1349 type_sql = f"{type_sql} WITH TIME ZONE" 1350 1351 return type_sql 1352 1353 def directory_sql(self, expression: exp.Directory) -> str: 1354 local = "LOCAL " if expression.args.get("local") else "" 1355 row_format = self.sql(expression, "row_format") 1356 row_format = f" {row_format}" if row_format else "" 1357 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}" 1358 1359 def delete_sql(self, expression: exp.Delete) -> str: 1360 this = self.sql(expression, "this") 1361 this = f" FROM {this}" if this else "" 1362 using = self.sql(expression, "using") 1363 using = f" USING {using}" if using else "" 1364 cluster = self.sql(expression, "cluster") 1365 cluster = f" {cluster}" if cluster else "" 1366 where = self.sql(expression, "where") 1367 returning = self.sql(expression, "returning") 1368 limit = self.sql(expression, "limit") 1369 tables = self.expressions(expression, key="tables") 1370 tables = f" {tables}" if tables else "" 1371 if self.RETURNING_END: 1372 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1373 else: 1374 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1375 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}") 1376 1377 def drop_sql(self, expression: exp.Drop) -> str: 1378 this = self.sql(expression, "this") 1379 expressions = self.expressions(expression, flat=True) 1380 expressions = f" ({expressions})" if expressions else "" 1381 kind = expression.args["kind"] 1382 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1383 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1384 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1385 on_cluster = self.sql(expression, "cluster") 1386 on_cluster = f" {on_cluster}" if on_cluster else "" 1387 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1388 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1389 cascade = " CASCADE" if expression.args.get("cascade") else "" 1390 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1391 purge = " PURGE" if expression.args.get("purge") else "" 1392 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}" 1393 1394 def set_operation(self, expression: exp.SetOperation) -> str: 1395 op_type = type(expression) 1396 op_name = op_type.key.upper() 1397 1398 distinct = expression.args.get("distinct") 1399 if ( 1400 distinct is False 1401 and op_type in (exp.Except, exp.Intersect) 1402 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1403 ): 1404 self.unsupported(f"{op_name} ALL is not supported") 1405 1406 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1407 1408 if distinct is None: 1409 distinct = default_distinct 1410 if distinct is None: 1411 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1412 1413 if distinct is default_distinct: 1414 kind = "" 1415 else: 1416 kind = " DISTINCT" if distinct else " ALL" 1417 1418 by_name = " BY NAME" if expression.args.get("by_name") else "" 1419 return f"{op_name}{kind}{by_name}" 1420 1421 def set_operations(self, expression: exp.SetOperation) -> str: 1422 if not self.SET_OP_MODIFIERS: 1423 limit = expression.args.get("limit") 1424 order = expression.args.get("order") 1425 1426 if limit or order: 1427 select = self._move_ctes_to_top_level( 1428 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1429 ) 1430 1431 if limit: 1432 select = select.limit(limit.pop(), copy=False) 1433 if order: 1434 select = select.order_by(order.pop(), copy=False) 1435 return self.sql(select) 1436 1437 sqls: t.List[str] = [] 1438 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1439 1440 while stack: 1441 node = stack.pop() 1442 1443 if isinstance(node, exp.SetOperation): 1444 stack.append(node.expression) 1445 stack.append( 1446 self.maybe_comment( 1447 self.set_operation(node), comments=node.comments, separated=True 1448 ) 1449 ) 1450 stack.append(node.this) 1451 else: 1452 sqls.append(self.sql(node)) 1453 1454 this = self.sep().join(sqls) 1455 this = self.query_modifiers(expression, this) 1456 return self.prepend_ctes(expression, this) 1457 1458 def fetch_sql(self, expression: exp.Fetch) -> str: 1459 direction = expression.args.get("direction") 1460 direction = f" {direction}" if direction else "" 1461 count = self.sql(expression, "count") 1462 count = f" {count}" if count else "" 1463 if expression.args.get("percent"): 1464 count = f"{count} PERCENT" 1465 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1466 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}" 1467 1468 def filter_sql(self, expression: exp.Filter) -> str: 1469 if self.AGGREGATE_FILTER_SUPPORTED: 1470 this = self.sql(expression, "this") 1471 where = self.sql(expression, "expression").strip() 1472 return f"{this} FILTER({where})" 1473 1474 agg = expression.this 1475 agg_arg = agg.this 1476 cond = expression.expression.this 1477 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1478 return self.sql(agg) 1479 1480 def hint_sql(self, expression: exp.Hint) -> str: 1481 if not self.QUERY_HINTS: 1482 self.unsupported("Hints are not supported") 1483 return "" 1484 1485 return f" /*+ {self.expressions(expression, sep=self.QUERY_HINT_SEP).strip()} */" 1486 1487 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1488 using = self.sql(expression, "using") 1489 using = f" USING {using}" if using else "" 1490 columns = self.expressions(expression, key="columns", flat=True) 1491 columns = f"({columns})" if columns else "" 1492 partition_by = self.expressions(expression, key="partition_by", flat=True) 1493 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1494 where = self.sql(expression, "where") 1495 include = self.expressions(expression, key="include", flat=True) 1496 if include: 1497 include = f" INCLUDE ({include})" 1498 with_storage = self.expressions(expression, key="with_storage", flat=True) 1499 with_storage = f" WITH ({with_storage})" if with_storage else "" 1500 tablespace = self.sql(expression, "tablespace") 1501 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1502 on = self.sql(expression, "on") 1503 on = f" ON {on}" if on else "" 1504 1505 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}" 1506 1507 def index_sql(self, expression: exp.Index) -> str: 1508 unique = "UNIQUE " if expression.args.get("unique") else "" 1509 primary = "PRIMARY " if expression.args.get("primary") else "" 1510 amp = "AMP " if expression.args.get("amp") else "" 1511 name = self.sql(expression, "this") 1512 name = f"{name} " if name else "" 1513 table = self.sql(expression, "table") 1514 table = f"{self.INDEX_ON} {table}" if table else "" 1515 1516 index = "INDEX " if not table else "" 1517 1518 params = self.sql(expression, "params") 1519 return f"{unique}{primary}{amp}{index}{name}{table}{params}" 1520 1521 def identifier_sql(self, expression: exp.Identifier) -> str: 1522 text = expression.name 1523 lower = text.lower() 1524 text = lower if self.normalize and not expression.quoted else text 1525 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1526 if ( 1527 expression.quoted 1528 or self.dialect.can_identify(text, self.identify) 1529 or lower in self.RESERVED_KEYWORDS 1530 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1531 ): 1532 text = f"{self._identifier_start}{text}{self._identifier_end}" 1533 return text 1534 1535 def hex_sql(self, expression: exp.Hex) -> str: 1536 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1537 if self.dialect.HEX_LOWERCASE: 1538 text = self.func("LOWER", text) 1539 1540 return text 1541 1542 def lowerhex_sql(self, expression: exp.LowerHex) -> str: 1543 text = self.func(self.HEX_FUNC, self.sql(expression, "this")) 1544 if not self.dialect.HEX_LOWERCASE: 1545 text = self.func("LOWER", text) 1546 return text 1547 1548 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1549 input_format = self.sql(expression, "input_format") 1550 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1551 output_format = self.sql(expression, "output_format") 1552 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1553 return self.sep().join((input_format, output_format)) 1554 1555 def national_sql(self, expression: exp.National, prefix: str = "N") -> str: 1556 string = self.sql(exp.Literal.string(expression.name)) 1557 return f"{prefix}{string}" 1558 1559 def partition_sql(self, expression: exp.Partition) -> str: 1560 return f"PARTITION({self.expressions(expression, flat=True)})" 1561 1562 def properties_sql(self, expression: exp.Properties) -> str: 1563 root_properties = [] 1564 with_properties = [] 1565 1566 for p in expression.expressions: 1567 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1568 if p_loc == exp.Properties.Location.POST_WITH: 1569 with_properties.append(p) 1570 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1571 root_properties.append(p) 1572 1573 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1574 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1575 1576 if root_props and with_props and not self.pretty: 1577 with_props = " " + with_props 1578 1579 return root_props + with_props 1580 1581 def root_properties(self, properties: exp.Properties) -> str: 1582 if properties.expressions: 1583 return self.expressions(properties, indent=False, sep=" ") 1584 return "" 1585 1586 def properties( 1587 self, 1588 properties: exp.Properties, 1589 prefix: str = "", 1590 sep: str = ", ", 1591 suffix: str = "", 1592 wrapped: bool = True, 1593 ) -> str: 1594 if properties.expressions: 1595 expressions = self.expressions(properties, sep=sep, indent=False) 1596 if expressions: 1597 expressions = self.wrap(expressions) if wrapped else expressions 1598 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1599 return "" 1600 1601 def with_properties(self, properties: exp.Properties) -> str: 1602 return self.properties(properties, prefix=self.seg(self.WITH_PROPERTIES_PREFIX, sep="")) 1603 1604 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1605 properties_locs = defaultdict(list) 1606 for p in properties.expressions: 1607 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1608 if p_loc != exp.Properties.Location.UNSUPPORTED: 1609 properties_locs[p_loc].append(p) 1610 else: 1611 self.unsupported(f"Unsupported property {p.key}") 1612 1613 return properties_locs 1614 1615 def property_name(self, expression: exp.Property, string_key: bool = False) -> str: 1616 if isinstance(expression.this, exp.Dot): 1617 return self.sql(expression, "this") 1618 return f"'{expression.name}'" if string_key else expression.name 1619 1620 def property_sql(self, expression: exp.Property) -> str: 1621 property_cls = expression.__class__ 1622 if property_cls == exp.Property: 1623 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1624 1625 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1626 if not property_name: 1627 self.unsupported(f"Unsupported property {expression.key}") 1628 1629 return f"{property_name}={self.sql(expression, 'this')}" 1630 1631 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1632 if self.SUPPORTS_CREATE_TABLE_LIKE: 1633 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1634 options = f" {options}" if options else "" 1635 1636 like = f"LIKE {self.sql(expression, 'this')}{options}" 1637 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1638 like = f"({like})" 1639 1640 return like 1641 1642 if expression.expressions: 1643 self.unsupported("Transpilation of LIKE property options is unsupported") 1644 1645 select = exp.select("*").from_(expression.this).limit(0) 1646 return f"AS {self.sql(select)}" 1647 1648 def fallbackproperty_sql(self, expression: exp.FallbackProperty) -> str: 1649 no = "NO " if expression.args.get("no") else "" 1650 protection = " PROTECTION" if expression.args.get("protection") else "" 1651 return f"{no}FALLBACK{protection}" 1652 1653 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1654 no = "NO " if expression.args.get("no") else "" 1655 local = expression.args.get("local") 1656 local = f"{local} " if local else "" 1657 dual = "DUAL " if expression.args.get("dual") else "" 1658 before = "BEFORE " if expression.args.get("before") else "" 1659 after = "AFTER " if expression.args.get("after") else "" 1660 return f"{no}{local}{dual}{before}{after}JOURNAL" 1661 1662 def freespaceproperty_sql(self, expression: exp.FreespaceProperty) -> str: 1663 freespace = self.sql(expression, "this") 1664 percent = " PERCENT" if expression.args.get("percent") else "" 1665 return f"FREESPACE={freespace}{percent}" 1666 1667 def checksumproperty_sql(self, expression: exp.ChecksumProperty) -> str: 1668 if expression.args.get("default"): 1669 property = "DEFAULT" 1670 elif expression.args.get("on"): 1671 property = "ON" 1672 else: 1673 property = "OFF" 1674 return f"CHECKSUM={property}" 1675 1676 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1677 if expression.args.get("no"): 1678 return "NO MERGEBLOCKRATIO" 1679 if expression.args.get("default"): 1680 return "DEFAULT MERGEBLOCKRATIO" 1681 1682 percent = " PERCENT" if expression.args.get("percent") else "" 1683 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}" 1684 1685 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1686 default = expression.args.get("default") 1687 minimum = expression.args.get("minimum") 1688 maximum = expression.args.get("maximum") 1689 if default or minimum or maximum: 1690 if default: 1691 prop = "DEFAULT" 1692 elif minimum: 1693 prop = "MINIMUM" 1694 else: 1695 prop = "MAXIMUM" 1696 return f"{prop} DATABLOCKSIZE" 1697 units = expression.args.get("units") 1698 units = f" {units}" if units else "" 1699 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}" 1700 1701 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1702 autotemp = expression.args.get("autotemp") 1703 always = expression.args.get("always") 1704 default = expression.args.get("default") 1705 manual = expression.args.get("manual") 1706 never = expression.args.get("never") 1707 1708 if autotemp is not None: 1709 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1710 elif always: 1711 prop = "ALWAYS" 1712 elif default: 1713 prop = "DEFAULT" 1714 elif manual: 1715 prop = "MANUAL" 1716 elif never: 1717 prop = "NEVER" 1718 return f"BLOCKCOMPRESSION={prop}" 1719 1720 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1721 no = expression.args.get("no") 1722 no = " NO" if no else "" 1723 concurrent = expression.args.get("concurrent") 1724 concurrent = " CONCURRENT" if concurrent else "" 1725 target = self.sql(expression, "target") 1726 target = f" {target}" if target else "" 1727 return f"WITH{no}{concurrent} ISOLATED LOADING{target}" 1728 1729 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1730 if isinstance(expression.this, list): 1731 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1732 if expression.this: 1733 modulus = self.sql(expression, "this") 1734 remainder = self.sql(expression, "expression") 1735 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1736 1737 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1738 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1739 return f"FROM ({from_expressions}) TO ({to_expressions})" 1740 1741 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1742 this = self.sql(expression, "this") 1743 1744 for_values_or_default = expression.expression 1745 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1746 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1747 else: 1748 for_values_or_default = " DEFAULT" 1749 1750 return f"PARTITION OF {this}{for_values_or_default}" 1751 1752 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1753 kind = expression.args.get("kind") 1754 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1755 for_or_in = expression.args.get("for_or_in") 1756 for_or_in = f" {for_or_in}" if for_or_in else "" 1757 lock_type = expression.args.get("lock_type") 1758 override = " OVERRIDE" if expression.args.get("override") else "" 1759 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}" 1760 1761 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1762 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1763 statistics = expression.args.get("statistics") 1764 statistics_sql = "" 1765 if statistics is not None: 1766 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1767 return f"{data_sql}{statistics_sql}" 1768 1769 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1770 this = self.sql(expression, "this") 1771 this = f"HISTORY_TABLE={this}" if this else "" 1772 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1773 data_consistency = ( 1774 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1775 ) 1776 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1777 retention_period = ( 1778 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1779 ) 1780 1781 if this: 1782 on_sql = self.func("ON", this, data_consistency, retention_period) 1783 else: 1784 on_sql = "ON" if expression.args.get("on") else "OFF" 1785 1786 sql = f"SYSTEM_VERSIONING={on_sql}" 1787 1788 return f"WITH({sql})" if expression.args.get("with") else sql 1789 1790 def insert_sql(self, expression: exp.Insert) -> str: 1791 hint = self.sql(expression, "hint") 1792 overwrite = expression.args.get("overwrite") 1793 1794 if isinstance(expression.this, exp.Directory): 1795 this = " OVERWRITE" if overwrite else " INTO" 1796 else: 1797 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1798 1799 stored = self.sql(expression, "stored") 1800 stored = f" {stored}" if stored else "" 1801 alternative = expression.args.get("alternative") 1802 alternative = f" OR {alternative}" if alternative else "" 1803 ignore = " IGNORE" if expression.args.get("ignore") else "" 1804 is_function = expression.args.get("is_function") 1805 if is_function: 1806 this = f"{this} FUNCTION" 1807 this = f"{this} {self.sql(expression, 'this')}" 1808 1809 exists = " IF EXISTS" if expression.args.get("exists") else "" 1810 where = self.sql(expression, "where") 1811 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1812 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1813 on_conflict = self.sql(expression, "conflict") 1814 on_conflict = f" {on_conflict}" if on_conflict else "" 1815 by_name = " BY NAME" if expression.args.get("by_name") else "" 1816 returning = self.sql(expression, "returning") 1817 1818 if self.RETURNING_END: 1819 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1820 else: 1821 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1822 1823 partition_by = self.sql(expression, "partition") 1824 partition_by = f" {partition_by}" if partition_by else "" 1825 settings = self.sql(expression, "settings") 1826 settings = f" {settings}" if settings else "" 1827 1828 source = self.sql(expression, "source") 1829 source = f"TABLE {source}" if source else "" 1830 1831 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1832 return self.prepend_ctes(expression, sql) 1833 1834 def introducer_sql(self, expression: exp.Introducer) -> str: 1835 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 1836 1837 def kill_sql(self, expression: exp.Kill) -> str: 1838 kind = self.sql(expression, "kind") 1839 kind = f" {kind}" if kind else "" 1840 this = self.sql(expression, "this") 1841 this = f" {this}" if this else "" 1842 return f"KILL{kind}{this}" 1843 1844 def pseudotype_sql(self, expression: exp.PseudoType) -> str: 1845 return expression.name 1846 1847 def objectidentifier_sql(self, expression: exp.ObjectIdentifier) -> str: 1848 return expression.name 1849 1850 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1851 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1852 1853 constraint = self.sql(expression, "constraint") 1854 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1855 1856 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1857 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1858 action = self.sql(expression, "action") 1859 1860 expressions = self.expressions(expression, flat=True) 1861 if expressions: 1862 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1863 expressions = f" {set_keyword}{expressions}" 1864 1865 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}" 1866 1867 def returning_sql(self, expression: exp.Returning) -> str: 1868 return f"{self.seg('RETURNING')} {self.expressions(expression, flat=True)}" 1869 1870 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1871 fields = self.sql(expression, "fields") 1872 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1873 escaped = self.sql(expression, "escaped") 1874 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1875 items = self.sql(expression, "collection_items") 1876 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1877 keys = self.sql(expression, "map_keys") 1878 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1879 lines = self.sql(expression, "lines") 1880 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1881 null = self.sql(expression, "null") 1882 null = f" NULL DEFINED AS {null}" if null else "" 1883 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}" 1884 1885 def withtablehint_sql(self, expression: exp.WithTableHint) -> str: 1886 return f"WITH ({self.expressions(expression, flat=True)})" 1887 1888 def indextablehint_sql(self, expression: exp.IndexTableHint) -> str: 1889 this = f"{self.sql(expression, 'this')} INDEX" 1890 target = self.sql(expression, "target") 1891 target = f" FOR {target}" if target else "" 1892 return f"{this}{target} ({self.expressions(expression, flat=True)})" 1893 1894 def historicaldata_sql(self, expression: exp.HistoricalData) -> str: 1895 this = self.sql(expression, "this") 1896 kind = self.sql(expression, "kind") 1897 expr = self.sql(expression, "expression") 1898 return f"{this} ({kind} => {expr})" 1899 1900 def table_parts(self, expression: exp.Table) -> str: 1901 return ".".join( 1902 self.sql(part) 1903 for part in ( 1904 expression.args.get("catalog"), 1905 expression.args.get("db"), 1906 expression.args.get("this"), 1907 ) 1908 if part is not None 1909 ) 1910 1911 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1912 table = self.table_parts(expression) 1913 only = "ONLY " if expression.args.get("only") else "" 1914 partition = self.sql(expression, "partition") 1915 partition = f" {partition}" if partition else "" 1916 version = self.sql(expression, "version") 1917 version = f" {version}" if version else "" 1918 alias = self.sql(expression, "alias") 1919 alias = f"{sep}{alias}" if alias else "" 1920 1921 sample = self.sql(expression, "sample") 1922 if self.dialect.ALIAS_POST_TABLESAMPLE: 1923 sample_pre_alias = sample 1924 sample_post_alias = "" 1925 else: 1926 sample_pre_alias = "" 1927 sample_post_alias = sample 1928 1929 hints = self.expressions(expression, key="hints", sep=" ") 1930 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1931 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1932 joins = self.indent( 1933 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1934 ) 1935 laterals = self.expressions(expression, key="laterals", sep="") 1936 1937 file_format = self.sql(expression, "format") 1938 if file_format: 1939 pattern = self.sql(expression, "pattern") 1940 pattern = f", PATTERN => {pattern}" if pattern else "" 1941 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1942 1943 ordinality = expression.args.get("ordinality") or "" 1944 if ordinality: 1945 ordinality = f" WITH ORDINALITY{alias}" 1946 alias = "" 1947 1948 when = self.sql(expression, "when") 1949 if when: 1950 table = f"{table} {when}" 1951 1952 changes = self.sql(expression, "changes") 1953 changes = f" {changes}" if changes else "" 1954 1955 rows_from = self.expressions(expression, key="rows_from") 1956 if rows_from: 1957 table = f"ROWS FROM {self.wrap(rows_from)}" 1958 1959 return f"{only}{table}{changes}{partition}{version}{file_format}{sample_pre_alias}{alias}{hints}{pivots}{sample_post_alias}{joins}{laterals}{ordinality}" 1960 1961 def tablesample_sql( 1962 self, 1963 expression: exp.TableSample, 1964 tablesample_keyword: t.Optional[str] = None, 1965 ) -> str: 1966 method = self.sql(expression, "method") 1967 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1968 numerator = self.sql(expression, "bucket_numerator") 1969 denominator = self.sql(expression, "bucket_denominator") 1970 field = self.sql(expression, "bucket_field") 1971 field = f" ON {field}" if field else "" 1972 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1973 seed = self.sql(expression, "seed") 1974 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1975 1976 size = self.sql(expression, "size") 1977 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1978 size = f"{size} ROWS" 1979 1980 percent = self.sql(expression, "percent") 1981 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1982 percent = f"{percent} PERCENT" 1983 1984 expr = f"{bucket}{percent}{size}" 1985 if self.TABLESAMPLE_REQUIRES_PARENS: 1986 expr = f"({expr})" 1987 1988 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}" 1989 1990 def pivot_sql(self, expression: exp.Pivot) -> str: 1991 expressions = self.expressions(expression, flat=True) 1992 1993 if expression.this: 1994 this = self.sql(expression, "this") 1995 if not expressions: 1996 return f"UNPIVOT {this}" 1997 1998 on = f"{self.seg('ON')} {expressions}" 1999 using = self.expressions(expression, key="using", flat=True) 2000 using = f"{self.seg('USING')} {using}" if using else "" 2001 group = self.sql(expression, "group") 2002 return f"PIVOT {this}{on}{using}{group}" 2003 2004 alias = self.sql(expression, "alias") 2005 alias = f" AS {alias}" if alias else "" 2006 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 2007 2008 field = self.sql(expression, "field") 2009 2010 include_nulls = expression.args.get("include_nulls") 2011 if include_nulls is not None: 2012 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 2013 else: 2014 nulls = "" 2015 2016 default_on_null = self.sql(expression, "default_on_null") 2017 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 2018 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}" 2019 2020 def version_sql(self, expression: exp.Version) -> str: 2021 this = f"FOR {expression.name}" 2022 kind = expression.text("kind") 2023 expr = self.sql(expression, "expression") 2024 return f"{this} {kind} {expr}" 2025 2026 def tuple_sql(self, expression: exp.Tuple) -> str: 2027 return f"({self.expressions(expression, dynamic=True, new_line=True, skip_first=True, skip_last=True)})" 2028 2029 def update_sql(self, expression: exp.Update) -> str: 2030 this = self.sql(expression, "this") 2031 set_sql = self.expressions(expression, flat=True) 2032 from_sql = self.sql(expression, "from") 2033 where_sql = self.sql(expression, "where") 2034 returning = self.sql(expression, "returning") 2035 order = self.sql(expression, "order") 2036 limit = self.sql(expression, "limit") 2037 if self.RETURNING_END: 2038 expression_sql = f"{from_sql}{where_sql}{returning}" 2039 else: 2040 expression_sql = f"{returning}{from_sql}{where_sql}" 2041 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2042 return self.prepend_ctes(expression, sql) 2043 2044 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2045 values_as_table = values_as_table and self.VALUES_AS_TABLE 2046 2047 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2048 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2049 args = self.expressions(expression) 2050 alias = self.sql(expression, "alias") 2051 values = f"VALUES{self.seg('')}{args}" 2052 values = ( 2053 f"({values})" 2054 if self.WRAP_DERIVED_VALUES 2055 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2056 else values 2057 ) 2058 return f"{values} AS {alias}" if alias else values 2059 2060 # Converts `VALUES...` expression into a series of select unions. 2061 alias_node = expression.args.get("alias") 2062 column_names = alias_node and alias_node.columns 2063 2064 selects: t.List[exp.Query] = [] 2065 2066 for i, tup in enumerate(expression.expressions): 2067 row = tup.expressions 2068 2069 if i == 0 and column_names: 2070 row = [ 2071 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2072 ] 2073 2074 selects.append(exp.Select(expressions=row)) 2075 2076 if self.pretty: 2077 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2078 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2079 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2080 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2081 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2082 2083 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2084 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2085 return f"({unions}){alias}" 2086 2087 def var_sql(self, expression: exp.Var) -> str: 2088 return self.sql(expression, "this") 2089 2090 @unsupported_args("expressions") 2091 def into_sql(self, expression: exp.Into) -> str: 2092 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2093 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2094 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}" 2095 2096 def from_sql(self, expression: exp.From) -> str: 2097 return f"{self.seg('FROM')} {self.sql(expression, 'this')}" 2098 2099 def groupingsets_sql(self, expression: exp.GroupingSets) -> str: 2100 grouping_sets = self.expressions(expression, indent=False) 2101 return f"GROUPING SETS {self.wrap(grouping_sets)}" 2102 2103 def rollup_sql(self, expression: exp.Rollup) -> str: 2104 expressions = self.expressions(expression, indent=False) 2105 return f"ROLLUP {self.wrap(expressions)}" if expressions else "WITH ROLLUP" 2106 2107 def cube_sql(self, expression: exp.Cube) -> str: 2108 expressions = self.expressions(expression, indent=False) 2109 return f"CUBE {self.wrap(expressions)}" if expressions else "WITH CUBE" 2110 2111 def group_sql(self, expression: exp.Group) -> str: 2112 group_by_all = expression.args.get("all") 2113 if group_by_all is True: 2114 modifier = " ALL" 2115 elif group_by_all is False: 2116 modifier = " DISTINCT" 2117 else: 2118 modifier = "" 2119 2120 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2121 2122 grouping_sets = self.expressions(expression, key="grouping_sets") 2123 cube = self.expressions(expression, key="cube") 2124 rollup = self.expressions(expression, key="rollup") 2125 2126 groupings = csv( 2127 self.seg(grouping_sets) if grouping_sets else "", 2128 self.seg(cube) if cube else "", 2129 self.seg(rollup) if rollup else "", 2130 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2131 sep=self.GROUPINGS_SEP, 2132 ) 2133 2134 if ( 2135 expression.expressions 2136 and groupings 2137 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2138 ): 2139 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2140 2141 return f"{group_by}{groupings}" 2142 2143 def having_sql(self, expression: exp.Having) -> str: 2144 this = self.indent(self.sql(expression, "this")) 2145 return f"{self.seg('HAVING')}{self.sep()}{this}" 2146 2147 def connect_sql(self, expression: exp.Connect) -> str: 2148 start = self.sql(expression, "start") 2149 start = self.seg(f"START WITH {start}") if start else "" 2150 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2151 connect = self.sql(expression, "connect") 2152 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2153 return start + connect 2154 2155 def prior_sql(self, expression: exp.Prior) -> str: 2156 return f"PRIOR {self.sql(expression, 'this')}" 2157 2158 def join_sql(self, expression: exp.Join) -> str: 2159 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2160 side = None 2161 else: 2162 side = expression.side 2163 2164 op_sql = " ".join( 2165 op 2166 for op in ( 2167 expression.method, 2168 "GLOBAL" if expression.args.get("global") else None, 2169 side, 2170 expression.kind, 2171 expression.hint if self.JOIN_HINTS else None, 2172 ) 2173 if op 2174 ) 2175 match_cond = self.sql(expression, "match_condition") 2176 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2177 on_sql = self.sql(expression, "on") 2178 using = expression.args.get("using") 2179 2180 if not on_sql and using: 2181 on_sql = csv(*(self.sql(column) for column in using)) 2182 2183 this = expression.this 2184 this_sql = self.sql(this) 2185 2186 exprs = self.expressions(expression) 2187 if exprs: 2188 this_sql = f"{this_sql},{self.seg(exprs)}" 2189 2190 if on_sql: 2191 on_sql = self.indent(on_sql, skip_first=True) 2192 space = self.seg(" " * self.pad) if self.pretty else " " 2193 if using: 2194 on_sql = f"{space}USING ({on_sql})" 2195 else: 2196 on_sql = f"{space}ON {on_sql}" 2197 elif not op_sql: 2198 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2199 return f" {this_sql}" 2200 2201 return f", {this_sql}" 2202 2203 if op_sql != "STRAIGHT_JOIN": 2204 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2205 2206 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}" 2207 2208 def lambda_sql(self, expression: exp.Lambda, arrow_sep: str = "->") -> str: 2209 args = self.expressions(expression, flat=True) 2210 args = f"({args})" if len(args.split(",")) > 1 else args 2211 return f"{args} {arrow_sep} {self.sql(expression, 'this')}" 2212 2213 def lateral_op(self, expression: exp.Lateral) -> str: 2214 cross_apply = expression.args.get("cross_apply") 2215 2216 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2217 if cross_apply is True: 2218 op = "INNER JOIN " 2219 elif cross_apply is False: 2220 op = "LEFT JOIN " 2221 else: 2222 op = "" 2223 2224 return f"{op}LATERAL" 2225 2226 def lateral_sql(self, expression: exp.Lateral) -> str: 2227 this = self.sql(expression, "this") 2228 2229 if expression.args.get("view"): 2230 alias = expression.args["alias"] 2231 columns = self.expressions(alias, key="columns", flat=True) 2232 table = f" {alias.name}" if alias.name else "" 2233 columns = f" AS {columns}" if columns else "" 2234 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2235 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2236 2237 alias = self.sql(expression, "alias") 2238 alias = f" AS {alias}" if alias else "" 2239 return f"{self.lateral_op(expression)} {this}{alias}" 2240 2241 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2242 this = self.sql(expression, "this") 2243 2244 args = [ 2245 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2246 for e in (expression.args.get(k) for k in ("offset", "expression")) 2247 if e 2248 ] 2249 2250 args_sql = ", ".join(self.sql(e) for e in args) 2251 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2252 expressions = self.expressions(expression, flat=True) 2253 expressions = f" BY {expressions}" if expressions else "" 2254 2255 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}" 2256 2257 def offset_sql(self, expression: exp.Offset) -> str: 2258 this = self.sql(expression, "this") 2259 value = expression.expression 2260 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2261 expressions = self.expressions(expression, flat=True) 2262 expressions = f" BY {expressions}" if expressions else "" 2263 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}" 2264 2265 def setitem_sql(self, expression: exp.SetItem) -> str: 2266 kind = self.sql(expression, "kind") 2267 kind = f"{kind} " if kind else "" 2268 this = self.sql(expression, "this") 2269 expressions = self.expressions(expression) 2270 collate = self.sql(expression, "collate") 2271 collate = f" COLLATE {collate}" if collate else "" 2272 global_ = "GLOBAL " if expression.args.get("global") else "" 2273 return f"{global_}{kind}{this}{expressions}{collate}" 2274 2275 def set_sql(self, expression: exp.Set) -> str: 2276 expressions = ( 2277 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2278 ) 2279 tag = " TAG" if expression.args.get("tag") else "" 2280 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}" 2281 2282 def pragma_sql(self, expression: exp.Pragma) -> str: 2283 return f"PRAGMA {self.sql(expression, 'this')}" 2284 2285 def lock_sql(self, expression: exp.Lock) -> str: 2286 if not self.LOCKING_READS_SUPPORTED: 2287 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2288 return "" 2289 2290 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2291 expressions = self.expressions(expression, flat=True) 2292 expressions = f" OF {expressions}" if expressions else "" 2293 wait = expression.args.get("wait") 2294 2295 if wait is not None: 2296 if isinstance(wait, exp.Literal): 2297 wait = f" WAIT {self.sql(wait)}" 2298 else: 2299 wait = " NOWAIT" if wait else " SKIP LOCKED" 2300 2301 return f"{lock_type}{expressions}{wait or ''}" 2302 2303 def literal_sql(self, expression: exp.Literal) -> str: 2304 text = expression.this or "" 2305 if expression.is_string: 2306 text = f"{self.dialect.QUOTE_START}{self.escape_str(text)}{self.dialect.QUOTE_END}" 2307 return text 2308 2309 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2310 if self.dialect.ESCAPED_SEQUENCES: 2311 to_escaped = self.dialect.ESCAPED_SEQUENCES 2312 text = "".join( 2313 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2314 ) 2315 2316 return self._replace_line_breaks(text).replace( 2317 self.dialect.QUOTE_END, self._escaped_quote_end 2318 ) 2319 2320 def loaddata_sql(self, expression: exp.LoadData) -> str: 2321 local = " LOCAL" if expression.args.get("local") else "" 2322 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2323 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2324 this = f" INTO TABLE {self.sql(expression, 'this')}" 2325 partition = self.sql(expression, "partition") 2326 partition = f" {partition}" if partition else "" 2327 input_format = self.sql(expression, "input_format") 2328 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2329 serde = self.sql(expression, "serde") 2330 serde = f" SERDE {serde}" if serde else "" 2331 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}" 2332 2333 def null_sql(self, *_) -> str: 2334 return "NULL" 2335 2336 def boolean_sql(self, expression: exp.Boolean) -> str: 2337 return "TRUE" if expression.this else "FALSE" 2338 2339 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2340 this = self.sql(expression, "this") 2341 this = f"{this} " if this else this 2342 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2343 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore 2344 2345 def withfill_sql(self, expression: exp.WithFill) -> str: 2346 from_sql = self.sql(expression, "from") 2347 from_sql = f" FROM {from_sql}" if from_sql else "" 2348 to_sql = self.sql(expression, "to") 2349 to_sql = f" TO {to_sql}" if to_sql else "" 2350 step_sql = self.sql(expression, "step") 2351 step_sql = f" STEP {step_sql}" if step_sql else "" 2352 interpolated_values = [ 2353 f"{self.sql(e, 'alias')} AS {self.sql(e, 'this')}" 2354 if isinstance(e, exp.Alias) 2355 else self.sql(e, "this") 2356 for e in expression.args.get("interpolate") or [] 2357 ] 2358 interpolate = ( 2359 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2360 ) 2361 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}" 2362 2363 def cluster_sql(self, expression: exp.Cluster) -> str: 2364 return self.op_expressions("CLUSTER BY", expression) 2365 2366 def distribute_sql(self, expression: exp.Distribute) -> str: 2367 return self.op_expressions("DISTRIBUTE BY", expression) 2368 2369 def sort_sql(self, expression: exp.Sort) -> str: 2370 return self.op_expressions("SORT BY", expression) 2371 2372 def ordered_sql(self, expression: exp.Ordered) -> str: 2373 desc = expression.args.get("desc") 2374 asc = not desc 2375 2376 nulls_first = expression.args.get("nulls_first") 2377 nulls_last = not nulls_first 2378 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2379 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2380 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2381 2382 this = self.sql(expression, "this") 2383 2384 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2385 nulls_sort_change = "" 2386 if nulls_first and ( 2387 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2388 ): 2389 nulls_sort_change = " NULLS FIRST" 2390 elif ( 2391 nulls_last 2392 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2393 and not nulls_are_last 2394 ): 2395 nulls_sort_change = " NULLS LAST" 2396 2397 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2398 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2399 window = expression.find_ancestor(exp.Window, exp.Select) 2400 if isinstance(window, exp.Window) and window.args.get("spec"): 2401 self.unsupported( 2402 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2403 ) 2404 nulls_sort_change = "" 2405 elif self.NULL_ORDERING_SUPPORTED is False and ( 2406 (asc and nulls_sort_change == " NULLS LAST") 2407 or (desc and nulls_sort_change == " NULLS FIRST") 2408 ): 2409 # BigQuery does not allow these ordering/nulls combinations when used under 2410 # an aggregation func or under a window containing one 2411 ancestor = expression.find_ancestor(exp.AggFunc, exp.Window, exp.Select) 2412 2413 if isinstance(ancestor, exp.Window): 2414 ancestor = ancestor.this 2415 if isinstance(ancestor, exp.AggFunc): 2416 self.unsupported( 2417 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2418 ) 2419 nulls_sort_change = "" 2420 elif self.NULL_ORDERING_SUPPORTED is None: 2421 if expression.this.is_int: 2422 self.unsupported( 2423 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2424 ) 2425 elif not isinstance(expression.this, exp.Rand): 2426 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2427 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2428 nulls_sort_change = "" 2429 2430 with_fill = self.sql(expression, "with_fill") 2431 with_fill = f" {with_fill}" if with_fill else "" 2432 2433 return f"{this}{sort_order}{nulls_sort_change}{with_fill}" 2434 2435 def matchrecognizemeasure_sql(self, expression: exp.MatchRecognizeMeasure) -> str: 2436 window_frame = self.sql(expression, "window_frame") 2437 window_frame = f"{window_frame} " if window_frame else "" 2438 2439 this = self.sql(expression, "this") 2440 2441 return f"{window_frame}{this}" 2442 2443 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2444 partition = self.partition_by_sql(expression) 2445 order = self.sql(expression, "order") 2446 measures = self.expressions(expression, key="measures") 2447 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2448 rows = self.sql(expression, "rows") 2449 rows = self.seg(rows) if rows else "" 2450 after = self.sql(expression, "after") 2451 after = self.seg(after) if after else "" 2452 pattern = self.sql(expression, "pattern") 2453 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2454 definition_sqls = [ 2455 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2456 for definition in expression.args.get("define", []) 2457 ] 2458 definitions = self.expressions(sqls=definition_sqls) 2459 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2460 body = "".join( 2461 ( 2462 partition, 2463 order, 2464 measures, 2465 rows, 2466 after, 2467 pattern, 2468 define, 2469 ) 2470 ) 2471 alias = self.sql(expression, "alias") 2472 alias = f" {alias}" if alias else "" 2473 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}" 2474 2475 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2476 limit = expression.args.get("limit") 2477 2478 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2479 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2480 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2481 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2482 2483 return csv( 2484 *sqls, 2485 *[self.sql(join) for join in expression.args.get("joins") or []], 2486 self.sql(expression, "connect"), 2487 self.sql(expression, "match"), 2488 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2489 self.sql(expression, "prewhere"), 2490 self.sql(expression, "where"), 2491 self.sql(expression, "group"), 2492 self.sql(expression, "having"), 2493 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2494 self.sql(expression, "order"), 2495 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2496 *self.after_limit_modifiers(expression), 2497 self.options_modifier(expression), 2498 sep="", 2499 ) 2500 2501 def options_modifier(self, expression: exp.Expression) -> str: 2502 options = self.expressions(expression, key="options") 2503 return f" {options}" if options else "" 2504 2505 def queryoption_sql(self, expression: exp.QueryOption) -> str: 2506 return "" 2507 2508 def offset_limit_modifiers( 2509 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2510 ) -> t.List[str]: 2511 return [ 2512 self.sql(expression, "offset") if fetch else self.sql(limit), 2513 self.sql(limit) if fetch else self.sql(expression, "offset"), 2514 ] 2515 2516 def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]: 2517 locks = self.expressions(expression, key="locks", sep=" ") 2518 locks = f" {locks}" if locks else "" 2519 return [locks, self.sql(expression, "sample")] 2520 2521 def select_sql(self, expression: exp.Select) -> str: 2522 into = expression.args.get("into") 2523 if not self.SUPPORTS_SELECT_INTO and into: 2524 into.pop() 2525 2526 hint = self.sql(expression, "hint") 2527 distinct = self.sql(expression, "distinct") 2528 distinct = f" {distinct}" if distinct else "" 2529 kind = self.sql(expression, "kind") 2530 2531 limit = expression.args.get("limit") 2532 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2533 top = self.limit_sql(limit, top=True) 2534 limit.pop() 2535 else: 2536 top = "" 2537 2538 expressions = self.expressions(expression) 2539 2540 if kind: 2541 if kind in self.SELECT_KINDS: 2542 kind = f" AS {kind}" 2543 else: 2544 if kind == "STRUCT": 2545 expressions = self.expressions( 2546 sqls=[ 2547 self.sql( 2548 exp.Struct( 2549 expressions=[ 2550 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2551 if isinstance(e, exp.Alias) 2552 else e 2553 for e in expression.expressions 2554 ] 2555 ) 2556 ) 2557 ] 2558 ) 2559 kind = "" 2560 2561 operation_modifiers = self.expressions(expression, key="operation_modifiers", sep=" ") 2562 operation_modifiers = f"{self.sep()}{operation_modifiers}" if operation_modifiers else "" 2563 2564 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2565 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2566 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2567 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2568 sql = self.query_modifiers( 2569 expression, 2570 f"SELECT{top_distinct}{operation_modifiers}{kind}{expressions}", 2571 self.sql(expression, "into", comment=False), 2572 self.sql(expression, "from", comment=False), 2573 ) 2574 2575 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2576 if expression.args.get("with"): 2577 sql = self.maybe_comment(sql, expression) 2578 expression.pop_comments() 2579 2580 sql = self.prepend_ctes(expression, sql) 2581 2582 if not self.SUPPORTS_SELECT_INTO and into: 2583 if into.args.get("temporary"): 2584 table_kind = " TEMPORARY" 2585 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2586 table_kind = " UNLOGGED" 2587 else: 2588 table_kind = "" 2589 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2590 2591 return sql 2592 2593 def schema_sql(self, expression: exp.Schema) -> str: 2594 this = self.sql(expression, "this") 2595 sql = self.schema_columns_sql(expression) 2596 return f"{this} {sql}" if this and sql else this or sql 2597 2598 def schema_columns_sql(self, expression: exp.Schema) -> str: 2599 if expression.expressions: 2600 return f"({self.sep('')}{self.expressions(expression)}{self.seg(')', sep='')}" 2601 return "" 2602 2603 def star_sql(self, expression: exp.Star) -> str: 2604 except_ = self.expressions(expression, key="except", flat=True) 2605 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2606 replace = self.expressions(expression, key="replace", flat=True) 2607 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2608 rename = self.expressions(expression, key="rename", flat=True) 2609 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2610 return f"*{except_}{replace}{rename}" 2611 2612 def parameter_sql(self, expression: exp.Parameter) -> str: 2613 this = self.sql(expression, "this") 2614 return f"{self.PARAMETER_TOKEN}{this}" 2615 2616 def sessionparameter_sql(self, expression: exp.SessionParameter) -> str: 2617 this = self.sql(expression, "this") 2618 kind = expression.text("kind") 2619 if kind: 2620 kind = f"{kind}." 2621 return f"@@{kind}{this}" 2622 2623 def placeholder_sql(self, expression: exp.Placeholder) -> str: 2624 return f"{self.NAMED_PLACEHOLDER_TOKEN}{expression.name}" if expression.this else "?" 2625 2626 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2627 alias = self.sql(expression, "alias") 2628 alias = f"{sep}{alias}" if alias else "" 2629 sample = self.sql(expression, "sample") 2630 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2631 alias = f"{sample}{alias}" 2632 2633 # Set to None so it's not generated again by self.query_modifiers() 2634 expression.set("sample", None) 2635 2636 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2637 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2638 return self.prepend_ctes(expression, sql) 2639 2640 def qualify_sql(self, expression: exp.Qualify) -> str: 2641 this = self.indent(self.sql(expression, "this")) 2642 return f"{self.seg('QUALIFY')}{self.sep()}{this}" 2643 2644 def unnest_sql(self, expression: exp.Unnest) -> str: 2645 args = self.expressions(expression, flat=True) 2646 2647 alias = expression.args.get("alias") 2648 offset = expression.args.get("offset") 2649 2650 if self.UNNEST_WITH_ORDINALITY: 2651 if alias and isinstance(offset, exp.Expression): 2652 alias.append("columns", offset) 2653 2654 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2655 columns = alias.columns 2656 alias = self.sql(columns[0]) if columns else "" 2657 else: 2658 alias = self.sql(alias) 2659 2660 alias = f" AS {alias}" if alias else alias 2661 if self.UNNEST_WITH_ORDINALITY: 2662 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2663 else: 2664 if isinstance(offset, exp.Expression): 2665 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2666 elif offset: 2667 suffix = f"{alias} WITH OFFSET" 2668 else: 2669 suffix = alias 2670 2671 return f"UNNEST({args}){suffix}" 2672 2673 def prewhere_sql(self, expression: exp.PreWhere) -> str: 2674 return "" 2675 2676 def where_sql(self, expression: exp.Where) -> str: 2677 this = self.indent(self.sql(expression, "this")) 2678 return f"{self.seg('WHERE')}{self.sep()}{this}" 2679 2680 def window_sql(self, expression: exp.Window) -> str: 2681 this = self.sql(expression, "this") 2682 partition = self.partition_by_sql(expression) 2683 order = expression.args.get("order") 2684 order = self.order_sql(order, flat=True) if order else "" 2685 spec = self.sql(expression, "spec") 2686 alias = self.sql(expression, "alias") 2687 over = self.sql(expression, "over") or "OVER" 2688 2689 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2690 2691 first = expression.args.get("first") 2692 if first is None: 2693 first = "" 2694 else: 2695 first = "FIRST" if first else "LAST" 2696 2697 if not partition and not order and not spec and alias: 2698 return f"{this} {alias}" 2699 2700 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2701 return f"{this} ({args})" 2702 2703 def partition_by_sql(self, expression: exp.Window | exp.MatchRecognize) -> str: 2704 partition = self.expressions(expression, key="partition_by", flat=True) 2705 return f"PARTITION BY {partition}" if partition else "" 2706 2707 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2708 kind = self.sql(expression, "kind") 2709 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2710 end = ( 2711 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2712 or "CURRENT ROW" 2713 ) 2714 return f"{kind} BETWEEN {start} AND {end}" 2715 2716 def withingroup_sql(self, expression: exp.WithinGroup) -> str: 2717 this = self.sql(expression, "this") 2718 expression_sql = self.sql(expression, "expression")[1:] # order has a leading space 2719 return f"{this} WITHIN GROUP ({expression_sql})" 2720 2721 def between_sql(self, expression: exp.Between) -> str: 2722 this = self.sql(expression, "this") 2723 low = self.sql(expression, "low") 2724 high = self.sql(expression, "high") 2725 return f"{this} BETWEEN {low} AND {high}" 2726 2727 def bracket_offset_expressions( 2728 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2729 ) -> t.List[exp.Expression]: 2730 return apply_index_offset( 2731 expression.this, 2732 expression.expressions, 2733 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2734 ) 2735 2736 def bracket_sql(self, expression: exp.Bracket) -> str: 2737 expressions = self.bracket_offset_expressions(expression) 2738 expressions_sql = ", ".join(self.sql(e) for e in expressions) 2739 return f"{self.sql(expression, 'this')}[{expressions_sql}]" 2740 2741 def all_sql(self, expression: exp.All) -> str: 2742 return f"ALL {self.wrap(expression)}" 2743 2744 def any_sql(self, expression: exp.Any) -> str: 2745 this = self.sql(expression, "this") 2746 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2747 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2748 this = self.wrap(this) 2749 return f"ANY{this}" 2750 return f"ANY {this}" 2751 2752 def exists_sql(self, expression: exp.Exists) -> str: 2753 return f"EXISTS{self.wrap(expression)}" 2754 2755 def case_sql(self, expression: exp.Case) -> str: 2756 this = self.sql(expression, "this") 2757 statements = [f"CASE {this}" if this else "CASE"] 2758 2759 for e in expression.args["ifs"]: 2760 statements.append(f"WHEN {self.sql(e, 'this')}") 2761 statements.append(f"THEN {self.sql(e, 'true')}") 2762 2763 default = self.sql(expression, "default") 2764 2765 if default: 2766 statements.append(f"ELSE {default}") 2767 2768 statements.append("END") 2769 2770 if self.pretty and self.too_wide(statements): 2771 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2772 2773 return " ".join(statements) 2774 2775 def constraint_sql(self, expression: exp.Constraint) -> str: 2776 this = self.sql(expression, "this") 2777 expressions = self.expressions(expression, flat=True) 2778 return f"CONSTRAINT {this} {expressions}" 2779 2780 def nextvaluefor_sql(self, expression: exp.NextValueFor) -> str: 2781 order = expression.args.get("order") 2782 order = f" OVER ({self.order_sql(order, flat=True)})" if order else "" 2783 return f"NEXT VALUE FOR {self.sql(expression, 'this')}{order}" 2784 2785 def extract_sql(self, expression: exp.Extract) -> str: 2786 this = self.sql(expression, "this") if self.EXTRACT_ALLOWS_QUOTES else expression.this.name 2787 expression_sql = self.sql(expression, "expression") 2788 return f"EXTRACT({this} FROM {expression_sql})" 2789 2790 def trim_sql(self, expression: exp.Trim) -> str: 2791 trim_type = self.sql(expression, "position") 2792 2793 if trim_type == "LEADING": 2794 func_name = "LTRIM" 2795 elif trim_type == "TRAILING": 2796 func_name = "RTRIM" 2797 else: 2798 func_name = "TRIM" 2799 2800 return self.func(func_name, expression.this, expression.expression) 2801 2802 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2803 args = expression.expressions 2804 if isinstance(expression, exp.ConcatWs): 2805 args = args[1:] # Skip the delimiter 2806 2807 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2808 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2809 2810 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2811 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2812 2813 return args 2814 2815 def concat_sql(self, expression: exp.Concat) -> str: 2816 expressions = self.convert_concat_args(expression) 2817 2818 # Some dialects don't allow a single-argument CONCAT call 2819 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2820 return self.sql(expressions[0]) 2821 2822 return self.func("CONCAT", *expressions) 2823 2824 def concatws_sql(self, expression: exp.ConcatWs) -> str: 2825 return self.func( 2826 "CONCAT_WS", seq_get(expression.expressions, 0), *self.convert_concat_args(expression) 2827 ) 2828 2829 def check_sql(self, expression: exp.Check) -> str: 2830 this = self.sql(expression, key="this") 2831 return f"CHECK ({this})" 2832 2833 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2834 expressions = self.expressions(expression, flat=True) 2835 expressions = f" ({expressions})" if expressions else "" 2836 reference = self.sql(expression, "reference") 2837 reference = f" {reference}" if reference else "" 2838 delete = self.sql(expression, "delete") 2839 delete = f" ON DELETE {delete}" if delete else "" 2840 update = self.sql(expression, "update") 2841 update = f" ON UPDATE {update}" if update else "" 2842 return f"FOREIGN KEY{expressions}{reference}{delete}{update}" 2843 2844 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2845 expressions = self.expressions(expression, flat=True) 2846 options = self.expressions(expression, key="options", flat=True, sep=" ") 2847 options = f" {options}" if options else "" 2848 return f"PRIMARY KEY ({expressions}){options}" 2849 2850 def if_sql(self, expression: exp.If) -> str: 2851 return self.case_sql(exp.Case(ifs=[expression], default=expression.args.get("false"))) 2852 2853 def matchagainst_sql(self, expression: exp.MatchAgainst) -> str: 2854 modifier = expression.args.get("modifier") 2855 modifier = f" {modifier}" if modifier else "" 2856 return f"{self.func('MATCH', *expression.expressions)} AGAINST({self.sql(expression, 'this')}{modifier})" 2857 2858 def jsonkeyvalue_sql(self, expression: exp.JSONKeyValue) -> str: 2859 return f"{self.sql(expression, 'this')}{self.JSON_KEY_VALUE_PAIR_SEP} {self.sql(expression, 'expression')}" 2860 2861 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2862 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2863 2864 if expression.args.get("escape"): 2865 path = self.escape_str(path) 2866 2867 if self.QUOTE_JSON_PATH: 2868 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2869 2870 return path 2871 2872 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2873 if isinstance(expression, exp.JSONPathPart): 2874 transform = self.TRANSFORMS.get(expression.__class__) 2875 if not callable(transform): 2876 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2877 return "" 2878 2879 return transform(self, expression) 2880 2881 if isinstance(expression, int): 2882 return str(expression) 2883 2884 if self._quote_json_path_key_using_brackets and self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2885 escaped = expression.replace("'", "\\'") 2886 escaped = f"\\'{expression}\\'" 2887 else: 2888 escaped = expression.replace('"', '\\"') 2889 escaped = f'"{escaped}"' 2890 2891 return escaped 2892 2893 def formatjson_sql(self, expression: exp.FormatJson) -> str: 2894 return f"{self.sql(expression, 'this')} FORMAT JSON" 2895 2896 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2897 null_handling = expression.args.get("null_handling") 2898 null_handling = f" {null_handling}" if null_handling else "" 2899 2900 unique_keys = expression.args.get("unique_keys") 2901 if unique_keys is not None: 2902 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2903 else: 2904 unique_keys = "" 2905 2906 return_type = self.sql(expression, "return_type") 2907 return_type = f" RETURNING {return_type}" if return_type else "" 2908 encoding = self.sql(expression, "encoding") 2909 encoding = f" ENCODING {encoding}" if encoding else "" 2910 2911 return self.func( 2912 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2913 *expression.expressions, 2914 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2915 ) 2916 2917 def jsonobjectagg_sql(self, expression: exp.JSONObjectAgg) -> str: 2918 return self.jsonobject_sql(expression) 2919 2920 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2921 null_handling = expression.args.get("null_handling") 2922 null_handling = f" {null_handling}" if null_handling else "" 2923 return_type = self.sql(expression, "return_type") 2924 return_type = f" RETURNING {return_type}" if return_type else "" 2925 strict = " STRICT" if expression.args.get("strict") else "" 2926 return self.func( 2927 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2928 ) 2929 2930 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2931 this = self.sql(expression, "this") 2932 order = self.sql(expression, "order") 2933 null_handling = expression.args.get("null_handling") 2934 null_handling = f" {null_handling}" if null_handling else "" 2935 return_type = self.sql(expression, "return_type") 2936 return_type = f" RETURNING {return_type}" if return_type else "" 2937 strict = " STRICT" if expression.args.get("strict") else "" 2938 return self.func( 2939 "JSON_ARRAYAGG", 2940 this, 2941 suffix=f"{order}{null_handling}{return_type}{strict})", 2942 ) 2943 2944 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2945 path = self.sql(expression, "path") 2946 path = f" PATH {path}" if path else "" 2947 nested_schema = self.sql(expression, "nested_schema") 2948 2949 if nested_schema: 2950 return f"NESTED{path} {nested_schema}" 2951 2952 this = self.sql(expression, "this") 2953 kind = self.sql(expression, "kind") 2954 kind = f" {kind}" if kind else "" 2955 return f"{this}{kind}{path}" 2956 2957 def jsonschema_sql(self, expression: exp.JSONSchema) -> str: 2958 return self.func("COLUMNS", *expression.expressions) 2959 2960 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2961 this = self.sql(expression, "this") 2962 path = self.sql(expression, "path") 2963 path = f", {path}" if path else "" 2964 error_handling = expression.args.get("error_handling") 2965 error_handling = f" {error_handling}" if error_handling else "" 2966 empty_handling = expression.args.get("empty_handling") 2967 empty_handling = f" {empty_handling}" if empty_handling else "" 2968 schema = self.sql(expression, "schema") 2969 return self.func( 2970 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2971 ) 2972 2973 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2974 this = self.sql(expression, "this") 2975 kind = self.sql(expression, "kind") 2976 path = self.sql(expression, "path") 2977 path = f" {path}" if path else "" 2978 as_json = " AS JSON" if expression.args.get("as_json") else "" 2979 return f"{this} {kind}{path}{as_json}" 2980 2981 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2982 this = self.sql(expression, "this") 2983 path = self.sql(expression, "path") 2984 path = f", {path}" if path else "" 2985 expressions = self.expressions(expression) 2986 with_ = ( 2987 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2988 if expressions 2989 else "" 2990 ) 2991 return f"OPENJSON({this}{path}){with_}" 2992 2993 def in_sql(self, expression: exp.In) -> str: 2994 query = expression.args.get("query") 2995 unnest = expression.args.get("unnest") 2996 field = expression.args.get("field") 2997 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2998 2999 if query: 3000 in_sql = self.sql(query) 3001 elif unnest: 3002 in_sql = self.in_unnest_op(unnest) 3003 elif field: 3004 in_sql = self.sql(field) 3005 else: 3006 in_sql = f"({self.expressions(expression, flat=True)})" 3007 3008 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}" 3009 3010 def in_unnest_op(self, unnest: exp.Unnest) -> str: 3011 return f"(SELECT {self.sql(unnest)})" 3012 3013 def interval_sql(self, expression: exp.Interval) -> str: 3014 unit = self.sql(expression, "unit") 3015 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 3016 unit = self.TIME_PART_SINGULARS.get(unit, unit) 3017 unit = f" {unit}" if unit else "" 3018 3019 if self.SINGLE_STRING_INTERVAL: 3020 this = expression.this.name if expression.this else "" 3021 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 3022 3023 this = self.sql(expression, "this") 3024 if this: 3025 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 3026 this = f" {this}" if unwrapped else f" ({this})" 3027 3028 return f"INTERVAL{this}{unit}" 3029 3030 def return_sql(self, expression: exp.Return) -> str: 3031 return f"RETURN {self.sql(expression, 'this')}" 3032 3033 def reference_sql(self, expression: exp.Reference) -> str: 3034 this = self.sql(expression, "this") 3035 expressions = self.expressions(expression, flat=True) 3036 expressions = f"({expressions})" if expressions else "" 3037 options = self.expressions(expression, key="options", flat=True, sep=" ") 3038 options = f" {options}" if options else "" 3039 return f"REFERENCES {this}{expressions}{options}" 3040 3041 def anonymous_sql(self, expression: exp.Anonymous) -> str: 3042 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 3043 parent = expression.parent 3044 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 3045 return self.func( 3046 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 3047 ) 3048 3049 def paren_sql(self, expression: exp.Paren) -> str: 3050 sql = self.seg(self.indent(self.sql(expression, "this")), sep="") 3051 return f"({sql}{self.seg(')', sep='')}" 3052 3053 def neg_sql(self, expression: exp.Neg) -> str: 3054 # This makes sure we don't convert "- - 5" to "--5", which is a comment 3055 this_sql = self.sql(expression, "this") 3056 sep = " " if this_sql[0] == "-" else "" 3057 return f"-{sep}{this_sql}" 3058 3059 def not_sql(self, expression: exp.Not) -> str: 3060 return f"NOT {self.sql(expression, 'this')}" 3061 3062 def alias_sql(self, expression: exp.Alias) -> str: 3063 alias = self.sql(expression, "alias") 3064 alias = f" AS {alias}" if alias else "" 3065 return f"{self.sql(expression, 'this')}{alias}" 3066 3067 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3068 alias = expression.args["alias"] 3069 3070 identifier_alias = isinstance(alias, exp.Identifier) 3071 literal_alias = isinstance(alias, exp.Literal) 3072 3073 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3074 alias.replace(exp.Literal.string(alias.output_name)) 3075 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3076 alias.replace(exp.to_identifier(alias.output_name)) 3077 3078 return self.alias_sql(expression) 3079 3080 def aliases_sql(self, expression: exp.Aliases) -> str: 3081 return f"{self.sql(expression, 'this')} AS ({self.expressions(expression, flat=True)})" 3082 3083 def atindex_sql(self, expression: exp.AtTimeZone) -> str: 3084 this = self.sql(expression, "this") 3085 index = self.sql(expression, "expression") 3086 return f"{this} AT {index}" 3087 3088 def attimezone_sql(self, expression: exp.AtTimeZone) -> str: 3089 this = self.sql(expression, "this") 3090 zone = self.sql(expression, "zone") 3091 return f"{this} AT TIME ZONE {zone}" 3092 3093 def fromtimezone_sql(self, expression: exp.FromTimeZone) -> str: 3094 this = self.sql(expression, "this") 3095 zone = self.sql(expression, "zone") 3096 return f"{this} AT TIME ZONE {zone} AT TIME ZONE 'UTC'" 3097 3098 def add_sql(self, expression: exp.Add) -> str: 3099 return self.binary(expression, "+") 3100 3101 def and_sql( 3102 self, expression: exp.And, stack: t.Optional[t.List[str | exp.Expression]] = None 3103 ) -> str: 3104 return self.connector_sql(expression, "AND", stack) 3105 3106 def or_sql( 3107 self, expression: exp.Or, stack: t.Optional[t.List[str | exp.Expression]] = None 3108 ) -> str: 3109 return self.connector_sql(expression, "OR", stack) 3110 3111 def xor_sql( 3112 self, expression: exp.Xor, stack: t.Optional[t.List[str | exp.Expression]] = None 3113 ) -> str: 3114 return self.connector_sql(expression, "XOR", stack) 3115 3116 def connector_sql( 3117 self, 3118 expression: exp.Connector, 3119 op: str, 3120 stack: t.Optional[t.List[str | exp.Expression]] = None, 3121 ) -> str: 3122 if stack is not None: 3123 if expression.expressions: 3124 stack.append(self.expressions(expression, sep=f" {op} ")) 3125 else: 3126 stack.append(expression.right) 3127 if expression.comments and self.comments: 3128 for comment in expression.comments: 3129 if comment: 3130 op += f" /*{self.pad_comment(comment)}*/" 3131 stack.extend((op, expression.left)) 3132 return op 3133 3134 stack = [expression] 3135 sqls: t.List[str] = [] 3136 ops = set() 3137 3138 while stack: 3139 node = stack.pop() 3140 if isinstance(node, exp.Connector): 3141 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3142 else: 3143 sql = self.sql(node) 3144 if sqls and sqls[-1] in ops: 3145 sqls[-1] += f" {sql}" 3146 else: 3147 sqls.append(sql) 3148 3149 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3150 return sep.join(sqls) 3151 3152 def bitwiseand_sql(self, expression: exp.BitwiseAnd) -> str: 3153 return self.binary(expression, "&") 3154 3155 def bitwiseleftshift_sql(self, expression: exp.BitwiseLeftShift) -> str: 3156 return self.binary(expression, "<<") 3157 3158 def bitwisenot_sql(self, expression: exp.BitwiseNot) -> str: 3159 return f"~{self.sql(expression, 'this')}" 3160 3161 def bitwiseor_sql(self, expression: exp.BitwiseOr) -> str: 3162 return self.binary(expression, "|") 3163 3164 def bitwiserightshift_sql(self, expression: exp.BitwiseRightShift) -> str: 3165 return self.binary(expression, ">>") 3166 3167 def bitwisexor_sql(self, expression: exp.BitwiseXor) -> str: 3168 return self.binary(expression, "^") 3169 3170 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3171 format_sql = self.sql(expression, "format") 3172 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3173 to_sql = self.sql(expression, "to") 3174 to_sql = f" {to_sql}" if to_sql else "" 3175 action = self.sql(expression, "action") 3176 action = f" {action}" if action else "" 3177 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})" 3178 3179 def currentdate_sql(self, expression: exp.CurrentDate) -> str: 3180 zone = self.sql(expression, "this") 3181 return f"CURRENT_DATE({zone})" if zone else "CURRENT_DATE" 3182 3183 def collate_sql(self, expression: exp.Collate) -> str: 3184 if self.COLLATE_IS_FUNC: 3185 return self.function_fallback_sql(expression) 3186 return self.binary(expression, "COLLATE") 3187 3188 def command_sql(self, expression: exp.Command) -> str: 3189 return f"{self.sql(expression, 'this')} {expression.text('expression').strip()}" 3190 3191 def comment_sql(self, expression: exp.Comment) -> str: 3192 this = self.sql(expression, "this") 3193 kind = expression.args["kind"] 3194 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3195 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3196 expression_sql = self.sql(expression, "expression") 3197 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}" 3198 3199 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3200 this = self.sql(expression, "this") 3201 delete = " DELETE" if expression.args.get("delete") else "" 3202 recompress = self.sql(expression, "recompress") 3203 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3204 to_disk = self.sql(expression, "to_disk") 3205 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3206 to_volume = self.sql(expression, "to_volume") 3207 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3208 return f"{this}{delete}{recompress}{to_disk}{to_volume}" 3209 3210 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3211 where = self.sql(expression, "where") 3212 group = self.sql(expression, "group") 3213 aggregates = self.expressions(expression, key="aggregates") 3214 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3215 3216 if not (where or group or aggregates) and len(expression.expressions) == 1: 3217 return f"TTL {self.expressions(expression, flat=True)}" 3218 3219 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}" 3220 3221 def transaction_sql(self, expression: exp.Transaction) -> str: 3222 return "BEGIN" 3223 3224 def commit_sql(self, expression: exp.Commit) -> str: 3225 chain = expression.args.get("chain") 3226 if chain is not None: 3227 chain = " AND CHAIN" if chain else " AND NO CHAIN" 3228 3229 return f"COMMIT{chain or ''}" 3230 3231 def rollback_sql(self, expression: exp.Rollback) -> str: 3232 savepoint = expression.args.get("savepoint") 3233 savepoint = f" TO {savepoint}" if savepoint else "" 3234 return f"ROLLBACK{savepoint}" 3235 3236 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3237 this = self.sql(expression, "this") 3238 3239 dtype = self.sql(expression, "dtype") 3240 if dtype: 3241 collate = self.sql(expression, "collate") 3242 collate = f" COLLATE {collate}" if collate else "" 3243 using = self.sql(expression, "using") 3244 using = f" USING {using}" if using else "" 3245 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3246 3247 default = self.sql(expression, "default") 3248 if default: 3249 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3250 3251 comment = self.sql(expression, "comment") 3252 if comment: 3253 return f"ALTER COLUMN {this} COMMENT {comment}" 3254 3255 allow_null = expression.args.get("allow_null") 3256 drop = expression.args.get("drop") 3257 3258 if not drop and not allow_null: 3259 self.unsupported("Unsupported ALTER COLUMN syntax") 3260 3261 if allow_null is not None: 3262 keyword = "DROP" if drop else "SET" 3263 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3264 3265 return f"ALTER COLUMN {this} DROP DEFAULT" 3266 3267 def alterdiststyle_sql(self, expression: exp.AlterDistStyle) -> str: 3268 this = self.sql(expression, "this") 3269 if not isinstance(expression.this, exp.Var): 3270 this = f"KEY DISTKEY {this}" 3271 return f"ALTER DISTSTYLE {this}" 3272 3273 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3274 compound = " COMPOUND" if expression.args.get("compound") else "" 3275 this = self.sql(expression, "this") 3276 expressions = self.expressions(expression, flat=True) 3277 expressions = f"({expressions})" if expressions else "" 3278 return f"ALTER{compound} SORTKEY {this or expressions}" 3279 3280 def alterrename_sql(self, expression: exp.AlterRename) -> str: 3281 if not self.RENAME_TABLE_WITH_DB: 3282 # Remove db from tables 3283 expression = expression.transform( 3284 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3285 ).assert_is(exp.AlterRename) 3286 this = self.sql(expression, "this") 3287 return f"RENAME TO {this}" 3288 3289 def renamecolumn_sql(self, expression: exp.RenameColumn) -> str: 3290 exists = " IF EXISTS" if expression.args.get("exists") else "" 3291 old_column = self.sql(expression, "this") 3292 new_column = self.sql(expression, "to") 3293 return f"RENAME COLUMN{exists} {old_column} TO {new_column}" 3294 3295 def alterset_sql(self, expression: exp.AlterSet) -> str: 3296 exprs = self.expressions(expression, flat=True) 3297 return f"SET {exprs}" 3298 3299 def alter_sql(self, expression: exp.Alter) -> str: 3300 actions = expression.args["actions"] 3301 3302 if isinstance(actions[0], exp.ColumnDef): 3303 actions = self.add_column_sql(expression) 3304 elif isinstance(actions[0], exp.Schema): 3305 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3306 elif isinstance(actions[0], exp.Delete): 3307 actions = self.expressions(expression, key="actions", flat=True) 3308 elif isinstance(actions[0], exp.Query): 3309 actions = "AS " + self.expressions(expression, key="actions") 3310 else: 3311 actions = self.expressions(expression, key="actions", flat=True) 3312 3313 exists = " IF EXISTS" if expression.args.get("exists") else "" 3314 on_cluster = self.sql(expression, "cluster") 3315 on_cluster = f" {on_cluster}" if on_cluster else "" 3316 only = " ONLY" if expression.args.get("only") else "" 3317 options = self.expressions(expression, key="options") 3318 options = f", {options}" if options else "" 3319 kind = self.sql(expression, "kind") 3320 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3321 3322 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}" 3323 3324 def add_column_sql(self, expression: exp.Alter) -> str: 3325 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3326 return self.expressions( 3327 expression, 3328 key="actions", 3329 prefix="ADD COLUMN ", 3330 skip_first=True, 3331 ) 3332 return f"ADD {self.expressions(expression, key='actions', flat=True)}" 3333 3334 def droppartition_sql(self, expression: exp.DropPartition) -> str: 3335 expressions = self.expressions(expression) 3336 exists = " IF EXISTS " if expression.args.get("exists") else " " 3337 return f"DROP{exists}{expressions}" 3338 3339 def addconstraint_sql(self, expression: exp.AddConstraint) -> str: 3340 return f"ADD {self.expressions(expression)}" 3341 3342 def distinct_sql(self, expression: exp.Distinct) -> str: 3343 this = self.expressions(expression, flat=True) 3344 3345 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3346 case = exp.case() 3347 for arg in expression.expressions: 3348 case = case.when(arg.is_(exp.null()), exp.null()) 3349 this = self.sql(case.else_(f"({this})")) 3350 3351 this = f" {this}" if this else "" 3352 3353 on = self.sql(expression, "on") 3354 on = f" ON {on}" if on else "" 3355 return f"DISTINCT{this}{on}" 3356 3357 def ignorenulls_sql(self, expression: exp.IgnoreNulls) -> str: 3358 return self._embed_ignore_nulls(expression, "IGNORE NULLS") 3359 3360 def respectnulls_sql(self, expression: exp.RespectNulls) -> str: 3361 return self._embed_ignore_nulls(expression, "RESPECT NULLS") 3362 3363 def havingmax_sql(self, expression: exp.HavingMax) -> str: 3364 this_sql = self.sql(expression, "this") 3365 expression_sql = self.sql(expression, "expression") 3366 kind = "MAX" if expression.args.get("max") else "MIN" 3367 return f"{this_sql} HAVING {kind} {expression_sql}" 3368 3369 def intdiv_sql(self, expression: exp.IntDiv) -> str: 3370 return self.sql( 3371 exp.Cast( 3372 this=exp.Div(this=expression.this, expression=expression.expression), 3373 to=exp.DataType(this=exp.DataType.Type.INT), 3374 ) 3375 ) 3376 3377 def dpipe_sql(self, expression: exp.DPipe) -> str: 3378 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 3379 return self.func( 3380 "CONCAT", *(exp.cast(e, exp.DataType.Type.TEXT) for e in expression.flatten()) 3381 ) 3382 return self.binary(expression, "||") 3383 3384 def div_sql(self, expression: exp.Div) -> str: 3385 l, r = expression.left, expression.right 3386 3387 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3388 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3389 3390 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3391 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3392 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3393 3394 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3395 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3396 return self.sql( 3397 exp.cast( 3398 l / r, 3399 to=exp.DataType.Type.BIGINT, 3400 ) 3401 ) 3402 3403 return self.binary(expression, "/") 3404 3405 def overlaps_sql(self, expression: exp.Overlaps) -> str: 3406 return self.binary(expression, "OVERLAPS") 3407 3408 def distance_sql(self, expression: exp.Distance) -> str: 3409 return self.binary(expression, "<->") 3410 3411 def dot_sql(self, expression: exp.Dot) -> str: 3412 return f"{self.sql(expression, 'this')}.{self.sql(expression, 'expression')}" 3413 3414 def eq_sql(self, expression: exp.EQ) -> str: 3415 return self.binary(expression, "=") 3416 3417 def propertyeq_sql(self, expression: exp.PropertyEQ) -> str: 3418 return self.binary(expression, ":=") 3419 3420 def escape_sql(self, expression: exp.Escape) -> str: 3421 return self.binary(expression, "ESCAPE") 3422 3423 def glob_sql(self, expression: exp.Glob) -> str: 3424 return self.binary(expression, "GLOB") 3425 3426 def gt_sql(self, expression: exp.GT) -> str: 3427 return self.binary(expression, ">") 3428 3429 def gte_sql(self, expression: exp.GTE) -> str: 3430 return self.binary(expression, ">=") 3431 3432 def ilike_sql(self, expression: exp.ILike) -> str: 3433 return self.binary(expression, "ILIKE") 3434 3435 def ilikeany_sql(self, expression: exp.ILikeAny) -> str: 3436 return self.binary(expression, "ILIKE ANY") 3437 3438 def is_sql(self, expression: exp.Is) -> str: 3439 if not self.IS_BOOL_ALLOWED and isinstance(expression.expression, exp.Boolean): 3440 return self.sql( 3441 expression.this if expression.expression.this else exp.not_(expression.this) 3442 ) 3443 return self.binary(expression, "IS") 3444 3445 def like_sql(self, expression: exp.Like) -> str: 3446 return self.binary(expression, "LIKE") 3447 3448 def likeany_sql(self, expression: exp.LikeAny) -> str: 3449 return self.binary(expression, "LIKE ANY") 3450 3451 def similarto_sql(self, expression: exp.SimilarTo) -> str: 3452 return self.binary(expression, "SIMILAR TO") 3453 3454 def lt_sql(self, expression: exp.LT) -> str: 3455 return self.binary(expression, "<") 3456 3457 def lte_sql(self, expression: exp.LTE) -> str: 3458 return self.binary(expression, "<=") 3459 3460 def mod_sql(self, expression: exp.Mod) -> str: 3461 return self.binary(expression, "%") 3462 3463 def mul_sql(self, expression: exp.Mul) -> str: 3464 return self.binary(expression, "*") 3465 3466 def neq_sql(self, expression: exp.NEQ) -> str: 3467 return self.binary(expression, "<>") 3468 3469 def nullsafeeq_sql(self, expression: exp.NullSafeEQ) -> str: 3470 return self.binary(expression, "IS NOT DISTINCT FROM") 3471 3472 def nullsafeneq_sql(self, expression: exp.NullSafeNEQ) -> str: 3473 return self.binary(expression, "IS DISTINCT FROM") 3474 3475 def slice_sql(self, expression: exp.Slice) -> str: 3476 return self.binary(expression, ":") 3477 3478 def sub_sql(self, expression: exp.Sub) -> str: 3479 return self.binary(expression, "-") 3480 3481 def trycast_sql(self, expression: exp.TryCast) -> str: 3482 return self.cast_sql(expression, safe_prefix="TRY_") 3483 3484 def try_sql(self, expression: exp.Try) -> str: 3485 if not self.TRY_SUPPORTED: 3486 self.unsupported("Unsupported TRY function") 3487 return self.sql(expression, "this") 3488 3489 return self.func("TRY", expression.this) 3490 3491 def log_sql(self, expression: exp.Log) -> str: 3492 this = expression.this 3493 expr = expression.expression 3494 3495 if self.dialect.LOG_BASE_FIRST is False: 3496 this, expr = expr, this 3497 elif self.dialect.LOG_BASE_FIRST is None and expr: 3498 if this.name in ("2", "10"): 3499 return self.func(f"LOG{this.name}", expr) 3500 3501 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3502 3503 return self.func("LOG", this, expr) 3504 3505 def use_sql(self, expression: exp.Use) -> str: 3506 kind = self.sql(expression, "kind") 3507 kind = f" {kind}" if kind else "" 3508 this = self.sql(expression, "this") 3509 this = f" {this}" if this else "" 3510 return f"USE{kind}{this}" 3511 3512 def binary(self, expression: exp.Binary, op: str) -> str: 3513 sqls: t.List[str] = [] 3514 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3515 binary_type = type(expression) 3516 3517 while stack: 3518 node = stack.pop() 3519 3520 if type(node) is binary_type: 3521 op_func = node.args.get("operator") 3522 if op_func: 3523 op = f"OPERATOR({self.sql(op_func)})" 3524 3525 stack.append(node.right) 3526 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3527 stack.append(node.left) 3528 else: 3529 sqls.append(self.sql(node)) 3530 3531 return "".join(sqls) 3532 3533 def function_fallback_sql(self, expression: exp.Func) -> str: 3534 args = [] 3535 3536 for key in expression.arg_types: 3537 arg_value = expression.args.get(key) 3538 3539 if isinstance(arg_value, list): 3540 for value in arg_value: 3541 args.append(value) 3542 elif arg_value is not None: 3543 args.append(arg_value) 3544 3545 if self.dialect.PRESERVE_ORIGINAL_NAMES: 3546 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3547 else: 3548 name = expression.sql_name() 3549 3550 return self.func(name, *args) 3551 3552 def func( 3553 self, 3554 name: str, 3555 *args: t.Optional[exp.Expression | str], 3556 prefix: str = "(", 3557 suffix: str = ")", 3558 normalize: bool = True, 3559 ) -> str: 3560 name = self.normalize_func(name) if normalize else name 3561 return f"{name}{prefix}{self.format_args(*args)}{suffix}" 3562 3563 def format_args(self, *args: t.Optional[str | exp.Expression], sep: str = ", ") -> str: 3564 arg_sqls = tuple( 3565 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3566 ) 3567 if self.pretty and self.too_wide(arg_sqls): 3568 return self.indent( 3569 "\n" + f"{sep.strip()}\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True 3570 ) 3571 return sep.join(arg_sqls) 3572 3573 def too_wide(self, args: t.Iterable) -> bool: 3574 return sum(len(arg) for arg in args) > self.max_text_width 3575 3576 def format_time( 3577 self, 3578 expression: exp.Expression, 3579 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3580 inverse_time_trie: t.Optional[t.Dict] = None, 3581 ) -> t.Optional[str]: 3582 return format_time( 3583 self.sql(expression, "format"), 3584 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3585 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3586 ) 3587 3588 def expressions( 3589 self, 3590 expression: t.Optional[exp.Expression] = None, 3591 key: t.Optional[str] = None, 3592 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3593 flat: bool = False, 3594 indent: bool = True, 3595 skip_first: bool = False, 3596 skip_last: bool = False, 3597 sep: str = ", ", 3598 prefix: str = "", 3599 dynamic: bool = False, 3600 new_line: bool = False, 3601 ) -> str: 3602 expressions = expression.args.get(key or "expressions") if expression else sqls 3603 3604 if not expressions: 3605 return "" 3606 3607 if flat: 3608 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3609 3610 num_sqls = len(expressions) 3611 result_sqls = [] 3612 3613 for i, e in enumerate(expressions): 3614 sql = self.sql(e, comment=False) 3615 if not sql: 3616 continue 3617 3618 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3619 3620 if self.pretty: 3621 if self.leading_comma: 3622 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3623 else: 3624 result_sqls.append( 3625 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3626 ) 3627 else: 3628 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3629 3630 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3631 if new_line: 3632 result_sqls.insert(0, "") 3633 result_sqls.append("") 3634 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3635 else: 3636 result_sql = "".join(result_sqls) 3637 3638 return ( 3639 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3640 if indent 3641 else result_sql 3642 ) 3643 3644 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3645 flat = flat or isinstance(expression.parent, exp.Properties) 3646 expressions_sql = self.expressions(expression, flat=flat) 3647 if flat: 3648 return f"{op} {expressions_sql}" 3649 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}" 3650 3651 def naked_property(self, expression: exp.Property) -> str: 3652 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3653 if not property_name: 3654 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3655 return f"{property_name} {self.sql(expression, 'this')}" 3656 3657 def tag_sql(self, expression: exp.Tag) -> str: 3658 return f"{expression.args.get('prefix')}{self.sql(expression.this)}{expression.args.get('postfix')}" 3659 3660 def token_sql(self, token_type: TokenType) -> str: 3661 return self.TOKEN_MAPPING.get(token_type, token_type.name) 3662 3663 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3664 this = self.sql(expression, "this") 3665 expressions = self.no_identify(self.expressions, expression) 3666 expressions = ( 3667 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3668 ) 3669 return f"{this}{expressions}" if expressions.strip() != "" else this 3670 3671 def joinhint_sql(self, expression: exp.JoinHint) -> str: 3672 this = self.sql(expression, "this") 3673 expressions = self.expressions(expression, flat=True) 3674 return f"{this}({expressions})" 3675 3676 def kwarg_sql(self, expression: exp.Kwarg) -> str: 3677 return self.binary(expression, "=>") 3678 3679 def when_sql(self, expression: exp.When) -> str: 3680 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3681 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3682 condition = self.sql(expression, "condition") 3683 condition = f" AND {condition}" if condition else "" 3684 3685 then_expression = expression.args.get("then") 3686 if isinstance(then_expression, exp.Insert): 3687 this = self.sql(then_expression, "this") 3688 this = f"INSERT {this}" if this else "INSERT" 3689 then = self.sql(then_expression, "expression") 3690 then = f"{this} VALUES {then}" if then else this 3691 elif isinstance(then_expression, exp.Update): 3692 if isinstance(then_expression.args.get("expressions"), exp.Star): 3693 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3694 else: 3695 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3696 else: 3697 then = self.sql(then_expression) 3698 return f"WHEN {matched}{source}{condition} THEN {then}" 3699 3700 def whens_sql(self, expression: exp.Whens) -> str: 3701 return self.expressions(expression, sep=" ", indent=False) 3702 3703 def merge_sql(self, expression: exp.Merge) -> str: 3704 table = expression.this 3705 table_alias = "" 3706 3707 hints = table.args.get("hints") 3708 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3709 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3710 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3711 3712 this = self.sql(table) 3713 using = f"USING {self.sql(expression, 'using')}" 3714 on = f"ON {self.sql(expression, 'on')}" 3715 whens = self.sql(expression, "whens") 3716 3717 returning = self.sql(expression, "returning") 3718 if returning: 3719 whens = f"{whens}{returning}" 3720 3721 sep = self.sep() 3722 3723 return self.prepend_ctes( 3724 expression, 3725 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{whens}", 3726 ) 3727 3728 @unsupported_args("format") 3729 def tochar_sql(self, expression: exp.ToChar) -> str: 3730 return self.sql(exp.cast(expression.this, exp.DataType.Type.TEXT)) 3731 3732 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3733 if not self.SUPPORTS_TO_NUMBER: 3734 self.unsupported("Unsupported TO_NUMBER function") 3735 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3736 3737 fmt = expression.args.get("format") 3738 if not fmt: 3739 self.unsupported("Conversion format is required for TO_NUMBER") 3740 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3741 3742 return self.func("TO_NUMBER", expression.this, fmt) 3743 3744 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3745 this = self.sql(expression, "this") 3746 kind = self.sql(expression, "kind") 3747 settings_sql = self.expressions(expression, key="settings", sep=" ") 3748 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3749 return f"{this}({kind}{args})" 3750 3751 def dictrange_sql(self, expression: exp.DictRange) -> str: 3752 this = self.sql(expression, "this") 3753 max = self.sql(expression, "max") 3754 min = self.sql(expression, "min") 3755 return f"{this}(MIN {min} MAX {max})" 3756 3757 def dictsubproperty_sql(self, expression: exp.DictSubProperty) -> str: 3758 return f"{self.sql(expression, 'this')} {self.sql(expression, 'value')}" 3759 3760 def duplicatekeyproperty_sql(self, expression: exp.DuplicateKeyProperty) -> str: 3761 return f"DUPLICATE KEY ({self.expressions(expression, flat=True)})" 3762 3763 # https://docs.starrocks.io/docs/sql-reference/sql-statements/table_bucket_part_index/CREATE_TABLE/ 3764 def uniquekeyproperty_sql(self, expression: exp.UniqueKeyProperty) -> str: 3765 return f"UNIQUE KEY ({self.expressions(expression, flat=True)})" 3766 3767 # https://docs.starrocks.io/docs/sql-reference/sql-statements/data-definition/CREATE_TABLE/#distribution_desc 3768 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3769 expressions = self.expressions(expression, flat=True) 3770 expressions = f" {self.wrap(expressions)}" if expressions else "" 3771 buckets = self.sql(expression, "buckets") 3772 kind = self.sql(expression, "kind") 3773 buckets = f" BUCKETS {buckets}" if buckets else "" 3774 order = self.sql(expression, "order") 3775 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}" 3776 3777 def oncluster_sql(self, expression: exp.OnCluster) -> str: 3778 return "" 3779 3780 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3781 expressions = self.expressions(expression, key="expressions", flat=True) 3782 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3783 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3784 buckets = self.sql(expression, "buckets") 3785 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS" 3786 3787 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3788 this = self.sql(expression, "this") 3789 having = self.sql(expression, "having") 3790 3791 if having: 3792 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3793 3794 return self.func("ANY_VALUE", this) 3795 3796 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3797 transform = self.func("TRANSFORM", *expression.expressions) 3798 row_format_before = self.sql(expression, "row_format_before") 3799 row_format_before = f" {row_format_before}" if row_format_before else "" 3800 record_writer = self.sql(expression, "record_writer") 3801 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3802 using = f" USING {self.sql(expression, 'command_script')}" 3803 schema = self.sql(expression, "schema") 3804 schema = f" AS {schema}" if schema else "" 3805 row_format_after = self.sql(expression, "row_format_after") 3806 row_format_after = f" {row_format_after}" if row_format_after else "" 3807 record_reader = self.sql(expression, "record_reader") 3808 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3809 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}" 3810 3811 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3812 key_block_size = self.sql(expression, "key_block_size") 3813 if key_block_size: 3814 return f"KEY_BLOCK_SIZE = {key_block_size}" 3815 3816 using = self.sql(expression, "using") 3817 if using: 3818 return f"USING {using}" 3819 3820 parser = self.sql(expression, "parser") 3821 if parser: 3822 return f"WITH PARSER {parser}" 3823 3824 comment = self.sql(expression, "comment") 3825 if comment: 3826 return f"COMMENT {comment}" 3827 3828 visible = expression.args.get("visible") 3829 if visible is not None: 3830 return "VISIBLE" if visible else "INVISIBLE" 3831 3832 engine_attr = self.sql(expression, "engine_attr") 3833 if engine_attr: 3834 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3835 3836 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3837 if secondary_engine_attr: 3838 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3839 3840 self.unsupported("Unsupported index constraint option.") 3841 return "" 3842 3843 def checkcolumnconstraint_sql(self, expression: exp.CheckColumnConstraint) -> str: 3844 enforced = " ENFORCED" if expression.args.get("enforced") else "" 3845 return f"CHECK ({self.sql(expression, 'this')}){enforced}" 3846 3847 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3848 kind = self.sql(expression, "kind") 3849 kind = f"{kind} INDEX" if kind else "INDEX" 3850 this = self.sql(expression, "this") 3851 this = f" {this}" if this else "" 3852 index_type = self.sql(expression, "index_type") 3853 index_type = f" USING {index_type}" if index_type else "" 3854 expressions = self.expressions(expression, flat=True) 3855 expressions = f" ({expressions})" if expressions else "" 3856 options = self.expressions(expression, key="options", sep=" ") 3857 options = f" {options}" if options else "" 3858 return f"{kind}{this}{index_type}{expressions}{options}" 3859 3860 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3861 if self.NVL2_SUPPORTED: 3862 return self.function_fallback_sql(expression) 3863 3864 case = exp.Case().when( 3865 expression.this.is_(exp.null()).not_(copy=False), 3866 expression.args["true"], 3867 copy=False, 3868 ) 3869 else_cond = expression.args.get("false") 3870 if else_cond: 3871 case.else_(else_cond, copy=False) 3872 3873 return self.sql(case) 3874 3875 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3876 this = self.sql(expression, "this") 3877 expr = self.sql(expression, "expression") 3878 iterator = self.sql(expression, "iterator") 3879 condition = self.sql(expression, "condition") 3880 condition = f" IF {condition}" if condition else "" 3881 return f"{this} FOR {expr} IN {iterator}{condition}" 3882 3883 def columnprefix_sql(self, expression: exp.ColumnPrefix) -> str: 3884 return f"{self.sql(expression, 'this')}({self.sql(expression, 'expression')})" 3885 3886 def opclass_sql(self, expression: exp.Opclass) -> str: 3887 return f"{self.sql(expression, 'this')} {self.sql(expression, 'expression')}" 3888 3889 def predict_sql(self, expression: exp.Predict) -> str: 3890 model = self.sql(expression, "this") 3891 model = f"MODEL {model}" 3892 table = self.sql(expression, "expression") 3893 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3894 parameters = self.sql(expression, "params_struct") 3895 return self.func("PREDICT", model, table, parameters or None) 3896 3897 def forin_sql(self, expression: exp.ForIn) -> str: 3898 this = self.sql(expression, "this") 3899 expression_sql = self.sql(expression, "expression") 3900 return f"FOR {this} DO {expression_sql}" 3901 3902 def refresh_sql(self, expression: exp.Refresh) -> str: 3903 this = self.sql(expression, "this") 3904 table = "" if isinstance(expression.this, exp.Literal) else "TABLE " 3905 return f"REFRESH {table}{this}" 3906 3907 def toarray_sql(self, expression: exp.ToArray) -> str: 3908 arg = expression.this 3909 if not arg.type: 3910 from sqlglot.optimizer.annotate_types import annotate_types 3911 3912 arg = annotate_types(arg) 3913 3914 if arg.is_type(exp.DataType.Type.ARRAY): 3915 return self.sql(arg) 3916 3917 cond_for_null = arg.is_(exp.null()) 3918 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False))) 3919 3920 def tsordstotime_sql(self, expression: exp.TsOrDsToTime) -> str: 3921 this = expression.this 3922 if isinstance(this, exp.TsOrDsToTime) or this.is_type(exp.DataType.Type.TIME): 3923 return self.sql(this) 3924 3925 return self.sql(exp.cast(this, exp.DataType.Type.TIME)) 3926 3927 def tsordstotimestamp_sql(self, expression: exp.TsOrDsToTimestamp) -> str: 3928 this = expression.this 3929 if isinstance(this, exp.TsOrDsToTimestamp) or this.is_type(exp.DataType.Type.TIMESTAMP): 3930 return self.sql(this) 3931 3932 return self.sql(exp.cast(this, exp.DataType.Type.TIMESTAMP, dialect=self.dialect)) 3933 3934 def tsordstodatetime_sql(self, expression: exp.TsOrDsToDatetime) -> str: 3935 this = expression.this 3936 if isinstance(this, exp.TsOrDsToDatetime) or this.is_type(exp.DataType.Type.DATETIME): 3937 return self.sql(this) 3938 3939 return self.sql(exp.cast(this, exp.DataType.Type.DATETIME, dialect=self.dialect)) 3940 3941 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3942 this = expression.this 3943 time_format = self.format_time(expression) 3944 3945 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3946 return self.sql( 3947 exp.cast( 3948 exp.StrToTime(this=this, format=expression.args["format"]), 3949 exp.DataType.Type.DATE, 3950 ) 3951 ) 3952 3953 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3954 return self.sql(this) 3955 3956 return self.sql(exp.cast(this, exp.DataType.Type.DATE)) 3957 3958 def unixdate_sql(self, expression: exp.UnixDate) -> str: 3959 return self.sql( 3960 exp.func( 3961 "DATEDIFF", 3962 expression.this, 3963 exp.cast(exp.Literal.string("1970-01-01"), exp.DataType.Type.DATE), 3964 "day", 3965 ) 3966 ) 3967 3968 def lastday_sql(self, expression: exp.LastDay) -> str: 3969 if self.LAST_DAY_SUPPORTS_DATE_PART: 3970 return self.function_fallback_sql(expression) 3971 3972 unit = expression.text("unit") 3973 if unit and unit != "MONTH": 3974 self.unsupported("Date parts are not supported in LAST_DAY.") 3975 3976 return self.func("LAST_DAY", expression.this) 3977 3978 def dateadd_sql(self, expression: exp.DateAdd) -> str: 3979 from sqlglot.dialects.dialect import unit_to_str 3980 3981 return self.func( 3982 "DATE_ADD", expression.this, expression.expression, unit_to_str(expression) 3983 ) 3984 3985 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3986 if self.CAN_IMPLEMENT_ARRAY_ANY: 3987 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3988 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3989 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3990 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3991 3992 from sqlglot.dialects import Dialect 3993 3994 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3995 if self.dialect.__class__ != Dialect: 3996 self.unsupported("ARRAY_ANY is unsupported") 3997 3998 return self.function_fallback_sql(expression) 3999 4000 def struct_sql(self, expression: exp.Struct) -> str: 4001 expression.set( 4002 "expressions", 4003 [ 4004 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 4005 if isinstance(e, exp.PropertyEQ) 4006 else e 4007 for e in expression.expressions 4008 ], 4009 ) 4010 4011 return self.function_fallback_sql(expression) 4012 4013 def partitionrange_sql(self, expression: exp.PartitionRange) -> str: 4014 low = self.sql(expression, "this") 4015 high = self.sql(expression, "expression") 4016 4017 return f"{low} TO {high}" 4018 4019 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 4020 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 4021 tables = f" {self.expressions(expression)}" 4022 4023 exists = " IF EXISTS" if expression.args.get("exists") else "" 4024 4025 on_cluster = self.sql(expression, "cluster") 4026 on_cluster = f" {on_cluster}" if on_cluster else "" 4027 4028 identity = self.sql(expression, "identity") 4029 identity = f" {identity} IDENTITY" if identity else "" 4030 4031 option = self.sql(expression, "option") 4032 option = f" {option}" if option else "" 4033 4034 partition = self.sql(expression, "partition") 4035 partition = f" {partition}" if partition else "" 4036 4037 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}" 4038 4039 # This transpiles T-SQL's CONVERT function 4040 # https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16 4041 def convert_sql(self, expression: exp.Convert) -> str: 4042 to = expression.this 4043 value = expression.expression 4044 style = expression.args.get("style") 4045 safe = expression.args.get("safe") 4046 strict = expression.args.get("strict") 4047 4048 if not to or not value: 4049 return "" 4050 4051 # Retrieve length of datatype and override to default if not specified 4052 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4053 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 4054 4055 transformed: t.Optional[exp.Expression] = None 4056 cast = exp.Cast if strict else exp.TryCast 4057 4058 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 4059 if isinstance(style, exp.Literal) and style.is_int: 4060 from sqlglot.dialects.tsql import TSQL 4061 4062 style_value = style.name 4063 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 4064 if not converted_style: 4065 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 4066 4067 fmt = exp.Literal.string(converted_style) 4068 4069 if to.this == exp.DataType.Type.DATE: 4070 transformed = exp.StrToDate(this=value, format=fmt) 4071 elif to.this in (exp.DataType.Type.DATETIME, exp.DataType.Type.DATETIME2): 4072 transformed = exp.StrToTime(this=value, format=fmt) 4073 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4074 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4075 elif to.this == exp.DataType.Type.TEXT: 4076 transformed = exp.TimeToStr(this=value, format=fmt) 4077 4078 if not transformed: 4079 transformed = cast(this=value, to=to, safe=safe) 4080 4081 return self.sql(transformed) 4082 4083 def _jsonpathkey_sql(self, expression: exp.JSONPathKey) -> str: 4084 this = expression.this 4085 if isinstance(this, exp.JSONPathWildcard): 4086 this = self.json_path_part(this) 4087 return f".{this}" if this else "" 4088 4089 if exp.SAFE_IDENTIFIER_RE.match(this): 4090 return f".{this}" 4091 4092 this = self.json_path_part(this) 4093 return ( 4094 f"[{this}]" 4095 if self._quote_json_path_key_using_brackets and self.JSON_PATH_BRACKETED_KEY_SUPPORTED 4096 else f".{this}" 4097 ) 4098 4099 def _jsonpathsubscript_sql(self, expression: exp.JSONPathSubscript) -> str: 4100 this = self.json_path_part(expression.this) 4101 return f"[{this}]" if this else "" 4102 4103 def _simplify_unless_literal(self, expression: E) -> E: 4104 if not isinstance(expression, exp.Literal): 4105 from sqlglot.optimizer.simplify import simplify 4106 4107 expression = simplify(expression, dialect=self.dialect) 4108 4109 return expression 4110 4111 def _embed_ignore_nulls(self, expression: exp.IgnoreNulls | exp.RespectNulls, text: str) -> str: 4112 if self.IGNORE_NULLS_IN_FUNC and not expression.meta.get("inline"): 4113 # The first modifier here will be the one closest to the AggFunc's arg 4114 mods = sorted( 4115 expression.find_all(exp.HavingMax, exp.Order, exp.Limit), 4116 key=lambda x: 0 4117 if isinstance(x, exp.HavingMax) 4118 else (1 if isinstance(x, exp.Order) else 2), 4119 ) 4120 4121 if mods: 4122 mod = mods[0] 4123 this = expression.__class__(this=mod.this.copy()) 4124 this.meta["inline"] = True 4125 mod.this.replace(this) 4126 return self.sql(expression.this) 4127 4128 agg_func = expression.find(exp.AggFunc) 4129 4130 if agg_func: 4131 return self.sql(agg_func)[:-1] + f" {text})" 4132 4133 return f"{self.sql(expression, 'this')} {text}" 4134 4135 def _replace_line_breaks(self, string: str) -> str: 4136 """We don't want to extra indent line breaks so we temporarily replace them with sentinels.""" 4137 if self.pretty: 4138 return string.replace("\n", self.SENTINEL_LINE_BREAK) 4139 return string 4140 4141 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4142 option = self.sql(expression, "this") 4143 4144 if expression.expressions: 4145 upper = option.upper() 4146 4147 # Snowflake FILE_FORMAT options are separated by whitespace 4148 sep = " " if upper == "FILE_FORMAT" else ", " 4149 4150 # Databricks copy/format options do not set their list of values with EQ 4151 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4152 values = self.expressions(expression, flat=True, sep=sep) 4153 return f"{option}{op}({values})" 4154 4155 value = self.sql(expression, "expression") 4156 4157 if not value: 4158 return option 4159 4160 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4161 4162 return f"{option}{op}{value}" 4163 4164 def credentials_sql(self, expression: exp.Credentials) -> str: 4165 cred_expr = expression.args.get("credentials") 4166 if isinstance(cred_expr, exp.Literal): 4167 # Redshift case: CREDENTIALS <string> 4168 credentials = self.sql(expression, "credentials") 4169 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4170 else: 4171 # Snowflake case: CREDENTIALS = (...) 4172 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4173 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4174 4175 storage = self.sql(expression, "storage") 4176 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4177 4178 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4179 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4180 4181 iam_role = self.sql(expression, "iam_role") 4182 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4183 4184 region = self.sql(expression, "region") 4185 region = f" REGION {region}" if region else "" 4186 4187 return f"{credentials}{storage}{encryption}{iam_role}{region}" 4188 4189 def copy_sql(self, expression: exp.Copy) -> str: 4190 this = self.sql(expression, "this") 4191 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4192 4193 credentials = self.sql(expression, "credentials") 4194 credentials = self.seg(credentials) if credentials else "" 4195 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4196 files = self.expressions(expression, key="files", flat=True) 4197 4198 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4199 params = self.expressions( 4200 expression, 4201 key="params", 4202 sep=sep, 4203 new_line=True, 4204 skip_last=True, 4205 skip_first=True, 4206 indent=self.COPY_PARAMS_ARE_WRAPPED, 4207 ) 4208 4209 if params: 4210 if self.COPY_PARAMS_ARE_WRAPPED: 4211 params = f" WITH ({params})" 4212 elif not self.pretty: 4213 params = f" {params}" 4214 4215 return f"COPY{this}{kind} {files}{credentials}{params}" 4216 4217 def semicolon_sql(self, expression: exp.Semicolon) -> str: 4218 return "" 4219 4220 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4221 on_sql = "ON" if expression.args.get("on") else "OFF" 4222 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4223 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4224 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4225 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4226 4227 if filter_col or retention_period: 4228 on_sql = self.func("ON", filter_col, retention_period) 4229 4230 return f"DATA_DELETION={on_sql}" 4231 4232 def maskingpolicycolumnconstraint_sql( 4233 self, expression: exp.MaskingPolicyColumnConstraint 4234 ) -> str: 4235 this = self.sql(expression, "this") 4236 expressions = self.expressions(expression, flat=True) 4237 expressions = f" USING ({expressions})" if expressions else "" 4238 return f"MASKING POLICY {this}{expressions}" 4239 4240 def gapfill_sql(self, expression: exp.GapFill) -> str: 4241 this = self.sql(expression, "this") 4242 this = f"TABLE {this}" 4243 return self.func("GAP_FILL", this, *[v for k, v in expression.args.items() if k != "this"]) 4244 4245 def scope_resolution(self, rhs: str, scope_name: str) -> str: 4246 return self.func("SCOPE_RESOLUTION", scope_name or None, rhs) 4247 4248 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4249 this = self.sql(expression, "this") 4250 expr = expression.expression 4251 4252 if isinstance(expr, exp.Func): 4253 # T-SQL's CLR functions are case sensitive 4254 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4255 else: 4256 expr = self.sql(expression, "expression") 4257 4258 return self.scope_resolution(expr, this) 4259 4260 def parsejson_sql(self, expression: exp.ParseJSON) -> str: 4261 if self.PARSE_JSON_NAME is None: 4262 return self.sql(expression.this) 4263 4264 return self.func(self.PARSE_JSON_NAME, expression.this, expression.expression) 4265 4266 def rand_sql(self, expression: exp.Rand) -> str: 4267 lower = self.sql(expression, "lower") 4268 upper = self.sql(expression, "upper") 4269 4270 if lower and upper: 4271 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4272 return self.func("RAND", expression.this) 4273 4274 def changes_sql(self, expression: exp.Changes) -> str: 4275 information = self.sql(expression, "information") 4276 information = f"INFORMATION => {information}" 4277 at_before = self.sql(expression, "at_before") 4278 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4279 end = self.sql(expression, "end") 4280 end = f"{self.seg('')}{end}" if end else "" 4281 4282 return f"CHANGES ({information}){at_before}{end}" 4283 4284 def pad_sql(self, expression: exp.Pad) -> str: 4285 prefix = "L" if expression.args.get("is_left") else "R" 4286 4287 fill_pattern = self.sql(expression, "fill_pattern") or None 4288 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4289 fill_pattern = "' '" 4290 4291 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern) 4292 4293 def summarize_sql(self, expression: exp.Summarize) -> str: 4294 table = " TABLE" if expression.args.get("table") else "" 4295 return f"SUMMARIZE{table} {self.sql(expression.this)}" 4296 4297 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4298 generate_series = exp.GenerateSeries(**expression.args) 4299 4300 parent = expression.parent 4301 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4302 parent = parent.parent 4303 4304 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4305 return self.sql(exp.Unnest(expressions=[generate_series])) 4306 4307 if isinstance(parent, exp.Select): 4308 self.unsupported("GenerateSeries projection unnesting is not supported.") 4309 4310 return self.sql(generate_series) 4311 4312 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4313 exprs = expression.expressions 4314 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4315 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4316 else: 4317 rhs = self.expressions(expression) 4318 4319 return self.func(name, expression.this, rhs or None) 4320 4321 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4322 if self.SUPPORTS_CONVERT_TIMEZONE: 4323 return self.function_fallback_sql(expression) 4324 4325 source_tz = expression.args.get("source_tz") 4326 target_tz = expression.args.get("target_tz") 4327 timestamp = expression.args.get("timestamp") 4328 4329 if source_tz and timestamp: 4330 timestamp = exp.AtTimeZone( 4331 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4332 ) 4333 4334 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4335 4336 return self.sql(expr) 4337 4338 def json_sql(self, expression: exp.JSON) -> str: 4339 this = self.sql(expression, "this") 4340 this = f" {this}" if this else "" 4341 4342 _with = expression.args.get("with") 4343 4344 if _with is None: 4345 with_sql = "" 4346 elif not _with: 4347 with_sql = " WITHOUT" 4348 else: 4349 with_sql = " WITH" 4350 4351 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4352 4353 return f"JSON{this}{with_sql}{unique_sql}" 4354 4355 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4356 def _generate_on_options(arg: t.Any) -> str: 4357 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4358 4359 path = self.sql(expression, "path") 4360 returning = self.sql(expression, "returning") 4361 returning = f" RETURNING {returning}" if returning else "" 4362 4363 on_condition = self.sql(expression, "on_condition") 4364 on_condition = f" {on_condition}" if on_condition else "" 4365 4366 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}") 4367 4368 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4369 else_ = "ELSE " if expression.args.get("else_") else "" 4370 condition = self.sql(expression, "expression") 4371 condition = f"WHEN {condition} THEN " if condition else else_ 4372 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4373 return f"{condition}{insert}" 4374 4375 def multitableinserts_sql(self, expression: exp.MultitableInserts) -> str: 4376 kind = self.sql(expression, "kind") 4377 expressions = self.seg(self.expressions(expression, sep=" ")) 4378 res = f"INSERT {kind}{expressions}{self.seg(self.sql(expression, 'source'))}" 4379 return res 4380 4381 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4382 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4383 empty = expression.args.get("empty") 4384 empty = ( 4385 f"DEFAULT {empty} ON EMPTY" 4386 if isinstance(empty, exp.Expression) 4387 else self.sql(expression, "empty") 4388 ) 4389 4390 error = expression.args.get("error") 4391 error = ( 4392 f"DEFAULT {error} ON ERROR" 4393 if isinstance(error, exp.Expression) 4394 else self.sql(expression, "error") 4395 ) 4396 4397 if error and empty: 4398 error = ( 4399 f"{empty} {error}" 4400 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4401 else f"{error} {empty}" 4402 ) 4403 empty = "" 4404 4405 null = self.sql(expression, "null") 4406 4407 return f"{empty}{error}{null}" 4408 4409 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4410 this = self.sql(expression, "this") 4411 path = self.sql(expression, "path") 4412 4413 passing = self.expressions(expression, "passing") 4414 passing = f" PASSING {passing}" if passing else "" 4415 4416 on_condition = self.sql(expression, "on_condition") 4417 on_condition = f" {on_condition}" if on_condition else "" 4418 4419 path = f"{path}{passing}{on_condition}" 4420 4421 return self.func("JSON_EXISTS", this, path) 4422 4423 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4424 array_agg = self.function_fallback_sql(expression) 4425 4426 # Add a NULL FILTER on the column to mimic the results going from a dialect that excludes nulls 4427 # on ARRAY_AGG (e.g Spark) to one that doesn't (e.g. DuckDB) 4428 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4429 parent = expression.parent 4430 if isinstance(parent, exp.Filter): 4431 parent_cond = parent.expression.this 4432 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4433 else: 4434 this = expression.this 4435 # Do not add the filter if the input is not a column (e.g. literal, struct etc) 4436 if this.find(exp.Column): 4437 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4438 this_sql = ( 4439 self.expressions(this) 4440 if isinstance(this, exp.Distinct) 4441 else self.sql(expression, "this") 4442 ) 4443 4444 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4445 4446 return array_agg 4447 4448 def apply_sql(self, expression: exp.Apply) -> str: 4449 this = self.sql(expression, "this") 4450 expr = self.sql(expression, "expression") 4451 4452 return f"{this} APPLY({expr})" 4453 4454 def grant_sql(self, expression: exp.Grant) -> str: 4455 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4456 4457 kind = self.sql(expression, "kind") 4458 kind = f" {kind}" if kind else "" 4459 4460 securable = self.sql(expression, "securable") 4461 securable = f" {securable}" if securable else "" 4462 4463 principals = self.expressions(expression, key="principals", flat=True) 4464 4465 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4466 4467 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}" 4468 4469 def grantprivilege_sql(self, expression: exp.GrantPrivilege): 4470 this = self.sql(expression, "this") 4471 columns = self.expressions(expression, flat=True) 4472 columns = f"({columns})" if columns else "" 4473 4474 return f"{this}{columns}" 4475 4476 def grantprincipal_sql(self, expression: exp.GrantPrincipal): 4477 this = self.sql(expression, "this") 4478 4479 kind = self.sql(expression, "kind") 4480 kind = f"{kind} " if kind else "" 4481 4482 return f"{kind}{this}" 4483 4484 def columns_sql(self, expression: exp.Columns): 4485 func = self.function_fallback_sql(expression) 4486 if expression.args.get("unpack"): 4487 func = f"*{func}" 4488 4489 return func 4490 4491 def overlay_sql(self, expression: exp.Overlay): 4492 this = self.sql(expression, "this") 4493 expr = self.sql(expression, "expression") 4494 from_sql = self.sql(expression, "from") 4495 for_sql = self.sql(expression, "for") 4496 for_sql = f" FOR {for_sql}" if for_sql else "" 4497 4498 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})" 4499 4500 @unsupported_args("format") 4501 def todouble_sql(self, expression: exp.ToDouble) -> str: 4502 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 4503 4504 def string_sql(self, expression: exp.String) -> str: 4505 this = expression.this 4506 zone = expression.args.get("zone") 4507 4508 if zone: 4509 # This is a BigQuery specific argument for STRING(<timestamp_expr>, <time_zone>) 4510 # BigQuery stores timestamps internally as UTC, so ConvertTimezone is used with UTC 4511 # set for source_tz to transpile the time conversion before the STRING cast 4512 this = exp.ConvertTimezone( 4513 source_tz=exp.Literal.string("UTC"), target_tz=zone, timestamp=this 4514 ) 4515 4516 return self.sql(exp.cast(this, exp.DataType.Type.VARCHAR)) 4517 4518 def median_sql(self, expression: exp.Median): 4519 if not self.SUPPORTS_MEDIAN: 4520 return self.sql( 4521 exp.PercentileCont(this=expression.this, expression=exp.Literal.number(0.5)) 4522 ) 4523 4524 return self.function_fallback_sql(expression) 4525 4526 def overflowtruncatebehavior_sql(self, expression: exp.OverflowTruncateBehavior) -> str: 4527 filler = self.sql(expression, "this") 4528 filler = f" {filler}" if filler else "" 4529 with_count = "WITH COUNT" if expression.args.get("with_count") else "WITHOUT COUNT" 4530 return f"TRUNCATE{filler} {with_count}" 4531 4532 def unixseconds_sql(self, expression: exp.UnixSeconds) -> str: 4533 if self.SUPPORTS_UNIX_SECONDS: 4534 return self.function_fallback_sql(expression) 4535 4536 start_ts = exp.cast( 4537 exp.Literal.string("1970-01-01 00:00:00+00"), to=exp.DataType.Type.TIMESTAMPTZ 4538 ) 4539 4540 return self.sql( 4541 exp.TimestampDiff(this=expression.this, expression=start_ts, unit=exp.var("SECONDS")) 4542 ) 4543 4544 def arraysize_sql(self, expression: exp.ArraySize) -> str: 4545 dim = expression.expression 4546 4547 # For dialects that don't support the dimension arg, we can safely transpile it's default value (1st dimension) 4548 if dim and self.ARRAY_SIZE_DIM_REQUIRED is None: 4549 if not (dim.is_int and dim.name == "1"): 4550 self.unsupported("Cannot transpile dimension argument for ARRAY_LENGTH") 4551 dim = None 4552 4553 # If dimension is required but not specified, default initialize it 4554 if self.ARRAY_SIZE_DIM_REQUIRED and not dim: 4555 dim = exp.Literal.number(1) 4556 4557 return self.func(self.ARRAY_SIZE_NAME, expression.this, dim) 4558 4559 def attach_sql(self, expression: exp.Attach) -> str: 4560 this = self.sql(expression, "this") 4561 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 4562 expressions = self.expressions(expression) 4563 expressions = f" ({expressions})" if expressions else "" 4564 4565 return f"ATTACH{exists_sql} {this}{expressions}" 4566 4567 def detach_sql(self, expression: exp.Detach) -> str: 4568 this = self.sql(expression, "this") 4569 exists_sql = " IF EXISTS" if expression.args.get("exists") else "" 4570 4571 return f"DETACH{exists_sql} {this}" 4572 4573 def attachoption_sql(self, expression: exp.AttachOption) -> str: 4574 this = self.sql(expression, "this") 4575 value = self.sql(expression, "expression") 4576 value = f" {value}" if value else "" 4577 return f"{this}{value}" 4578 4579 def featuresattime_sql(self, expression: exp.FeaturesAtTime) -> str: 4580 this_sql = self.sql(expression, "this") 4581 if isinstance(expression.this, exp.Table): 4582 this_sql = f"TABLE {this_sql}" 4583 4584 return self.func( 4585 "FEATURES_AT_TIME", 4586 this_sql, 4587 expression.args.get("time"), 4588 expression.args.get("num_rows"), 4589 expression.args.get("ignore_feature_nulls"), 4590 ) 4591 4592 def watermarkcolumnconstraint_sql(self, expression: exp.WatermarkColumnConstraint) -> str: 4593 return ( 4594 f"WATERMARK FOR {self.sql(expression, 'this')} AS {self.sql(expression, 'expression')}" 4595 ) 4596 4597 def encodeproperty_sql(self, expression: exp.EncodeProperty) -> str: 4598 encode = "KEY ENCODE" if expression.args.get("key") else "ENCODE" 4599 encode = f"{encode} {self.sql(expression, 'this')}" 4600 4601 properties = expression.args.get("properties") 4602 if properties: 4603 encode = f"{encode} {self.properties(properties)}" 4604 4605 return encode 4606 4607 def includeproperty_sql(self, expression: exp.IncludeProperty) -> str: 4608 this = self.sql(expression, "this") 4609 include = f"INCLUDE {this}" 4610 4611 column_def = self.sql(expression, "column_def") 4612 if column_def: 4613 include = f"{include} {column_def}" 4614 4615 alias = self.sql(expression, "alias") 4616 if alias: 4617 include = f"{include} AS {alias}" 4618 4619 return include 4620 4621 def xmlelement_sql(self, expression: exp.XMLElement) -> str: 4622 name = f"NAME {self.sql(expression, 'this')}" 4623 return self.func("XMLELEMENT", name, *expression.expressions) 4624 4625 def partitionbyrangeproperty_sql(self, expression: exp.PartitionByRangeProperty) -> str: 4626 partitions = self.expressions(expression, "partition_expressions") 4627 create = self.expressions(expression, "create_expressions") 4628 return f"PARTITION BY RANGE {self.wrap(partitions)} {self.wrap(create)}" 4629 4630 def partitionbyrangepropertydynamic_sql( 4631 self, expression: exp.PartitionByRangePropertyDynamic 4632 ) -> str: 4633 start = self.sql(expression, "start") 4634 end = self.sql(expression, "end") 4635 4636 every = expression.args["every"] 4637 if isinstance(every, exp.Interval) and every.this.is_string: 4638 every.this.replace(exp.Literal.number(every.name)) 4639 4640 return f"START {self.wrap(start)} END {self.wrap(end)} EVERY {self.wrap(self.sql(every))}"
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)
667 def __init__( 668 self, 669 pretty: t.Optional[bool] = None, 670 identify: str | bool = False, 671 normalize: bool = False, 672 pad: int = 2, 673 indent: int = 2, 674 normalize_functions: t.Optional[str | bool] = None, 675 unsupported_level: ErrorLevel = ErrorLevel.WARN, 676 max_unsupported: int = 3, 677 leading_comma: bool = False, 678 max_text_width: int = 80, 679 comments: bool = True, 680 dialect: DialectType = None, 681 ): 682 import sqlglot 683 from sqlglot.dialects import Dialect 684 685 self.pretty = pretty if pretty is not None else sqlglot.pretty 686 self.identify = identify 687 self.normalize = normalize 688 self.pad = pad 689 self._indent = indent 690 self.unsupported_level = unsupported_level 691 self.max_unsupported = max_unsupported 692 self.leading_comma = leading_comma 693 self.max_text_width = max_text_width 694 self.comments = comments 695 self.dialect = Dialect.get_or_raise(dialect) 696 697 # This is both a Dialect property and a Generator argument, so we prioritize the latter 698 self.normalize_functions = ( 699 self.dialect.NORMALIZE_FUNCTIONS if normalize_functions is None else normalize_functions 700 ) 701 702 self.unsupported_messages: t.List[str] = [] 703 self._escaped_quote_end: str = ( 704 self.dialect.tokenizer_class.STRING_ESCAPES[0] + self.dialect.QUOTE_END 705 ) 706 self._escaped_identifier_end = self.dialect.IDENTIFIER_END * 2 707 708 self._next_name = name_sequence("_t") 709 710 self._identifier_start = self.dialect.IDENTIFIER_START 711 self._identifier_end = self.dialect.IDENTIFIER_END 712 713 self._quote_json_path_key_using_brackets = True
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.Int64'>: <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.SwapTable'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TemporaryProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.Tags'>: <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.WithProcedureOptions'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithSchemaBindingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithOperator'>: <function Generator.<lambda>>}
SUPPORTED_JSON_PATH_PARTS =
{<class 'sqlglot.expressions.JSONPathScript'>, <class 'sqlglot.expressions.JSONPathRoot'>, <class 'sqlglot.expressions.JSONPathRecursive'>, <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'>}
TYPE_MAPPING =
{<Type.DATETIME2: 'DATETIME2'>: 'TIMESTAMP', <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', <Type.SMALLDATETIME: 'SMALLDATETIME'>: 'TIMESTAMP'}
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.EncodeProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <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.IncludeProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <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.Tags'>: <Location.POST_WITH: 'POST_WITH'>, <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.WithProcedureOptions'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <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.Describe'>, <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.VARCHAR: 'VARCHAR'>, <Type.NVARCHAR: 'NVARCHAR'>, <Type.NCHAR: 'NCHAR'>, <Type.CHAR: 'CHAR'>}
715 def generate(self, expression: exp.Expression, copy: bool = True) -> str: 716 """ 717 Generates the SQL string corresponding to the given syntax tree. 718 719 Args: 720 expression: The syntax tree. 721 copy: Whether to copy the expression. The generator performs mutations so 722 it is safer to copy. 723 724 Returns: 725 The SQL string corresponding to `expression`. 726 """ 727 if copy: 728 expression = expression.copy() 729 730 expression = self.preprocess(expression) 731 732 self.unsupported_messages = [] 733 sql = self.sql(expression).strip() 734 735 if self.pretty: 736 sql = sql.replace(self.SENTINEL_LINE_BREAK, "\n") 737 738 if self.unsupported_level == ErrorLevel.IGNORE: 739 return sql 740 741 if self.unsupported_level == ErrorLevel.WARN: 742 for msg in self.unsupported_messages: 743 logger.warning(msg) 744 elif self.unsupported_level == ErrorLevel.RAISE and self.unsupported_messages: 745 raise UnsupportedError(concat_messages(self.unsupported_messages, self.max_unsupported)) 746 747 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:
749 def preprocess(self, expression: exp.Expression) -> exp.Expression: 750 """Apply generic preprocessing transformations to a given expression.""" 751 expression = self._move_ctes_to_top_level(expression) 752 753 if self.ENSURE_BOOLS: 754 from sqlglot.transforms import ensure_bools 755 756 expression = ensure_bools(expression) 757 758 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:
787 def maybe_comment( 788 self, 789 sql: str, 790 expression: t.Optional[exp.Expression] = None, 791 comments: t.Optional[t.List[str]] = None, 792 separated: bool = False, 793 ) -> str: 794 comments = ( 795 ((expression and expression.comments) if comments is None else comments) # type: ignore 796 if self.comments 797 else None 798 ) 799 800 if not comments or isinstance(expression, self.EXCLUDE_COMMENTS): 801 return sql 802 803 comments_sql = " ".join( 804 f"/*{self.pad_comment(comment)}*/" for comment in comments if comment 805 ) 806 807 if not comments_sql: 808 return sql 809 810 comments_sql = self._replace_line_breaks(comments_sql) 811 812 if separated or isinstance(expression, self.WITH_SEPARATED_COMMENTS): 813 return ( 814 f"{self.sep()}{comments_sql}{sql}" 815 if not sql or sql[0].isspace() 816 else f"{comments_sql}{self.sep()}{sql}" 817 ) 818 819 return f"{sql} {comments_sql}"
821 def wrap(self, expression: exp.Expression | str) -> str: 822 this_sql = ( 823 self.sql(expression) 824 if isinstance(expression, exp.UNWRAPPED_QUERIES) 825 else self.sql(expression, "this") 826 ) 827 if not this_sql: 828 return "()" 829 830 this_sql = self.indent(this_sql, level=1, pad=0) 831 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:
847 def indent( 848 self, 849 sql: str, 850 level: int = 0, 851 pad: t.Optional[int] = None, 852 skip_first: bool = False, 853 skip_last: bool = False, 854 ) -> str: 855 if not self.pretty or not sql: 856 return sql 857 858 pad = self.pad if pad is None else pad 859 lines = sql.split("\n") 860 861 return "\n".join( 862 ( 863 line 864 if (skip_first and i == 0) or (skip_last and i == len(lines) - 1) 865 else f"{' ' * (level * self._indent + pad)}{line}" 866 ) 867 for i, line in enumerate(lines) 868 )
def
sql( self, expression: Union[str, sqlglot.expressions.Expression, NoneType], key: Optional[str] = None, comment: bool = True) -> str:
870 def sql( 871 self, 872 expression: t.Optional[str | exp.Expression], 873 key: t.Optional[str] = None, 874 comment: bool = True, 875 ) -> str: 876 if not expression: 877 return "" 878 879 if isinstance(expression, str): 880 return expression 881 882 if key: 883 value = expression.args.get(key) 884 if value: 885 return self.sql(value) 886 return "" 887 888 transform = self.TRANSFORMS.get(expression.__class__) 889 890 if callable(transform): 891 sql = transform(self, expression) 892 elif isinstance(expression, exp.Expression): 893 exp_handler_name = f"{expression.key}_sql" 894 895 if hasattr(self, exp_handler_name): 896 sql = getattr(self, exp_handler_name)(expression) 897 elif isinstance(expression, exp.Func): 898 sql = self.function_fallback_sql(expression) 899 elif isinstance(expression, exp.Property): 900 sql = self.property_sql(expression) 901 else: 902 raise ValueError(f"Unsupported expression type {expression.__class__.__name__}") 903 else: 904 raise ValueError(f"Expected an Expression. Received {type(expression)}: {expression}") 905 906 return self.maybe_comment(sql, expression) if self.comments and comment else sql
913 def cache_sql(self, expression: exp.Cache) -> str: 914 lazy = " LAZY" if expression.args.get("lazy") else "" 915 table = self.sql(expression, "this") 916 options = expression.args.get("options") 917 options = f" OPTIONS({self.sql(options[0])} = {self.sql(options[1])})" if options else "" 918 sql = self.sql(expression, "expression") 919 sql = f" AS{self.sep()}{sql}" if sql else "" 920 sql = f"CACHE{lazy} TABLE {table}{options}{sql}" 921 return self.prepend_ctes(expression, sql)
923 def characterset_sql(self, expression: exp.CharacterSet) -> str: 924 if isinstance(expression.parent, exp.Cast): 925 return f"CHAR CHARACTER SET {self.sql(expression, 'this')}" 926 default = "DEFAULT " if expression.args.get("default") else "" 927 return f"{default}CHARACTER SET={self.sql(expression, 'this')}"
941 def column_sql(self, expression: exp.Column) -> str: 942 join_mark = " (+)" if expression.args.get("join_mark") else "" 943 944 if join_mark and not self.dialect.SUPPORTS_COLUMN_JOIN_MARKS: 945 join_mark = "" 946 self.unsupported("Outer join syntax using the (+) operator is not supported.") 947 948 return f"{self.column_parts(expression)}{join_mark}"
956 def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str: 957 column = self.sql(expression, "this") 958 kind = self.sql(expression, "kind") 959 constraints = self.expressions(expression, key="constraints", sep=" ", flat=True) 960 exists = "IF NOT EXISTS " if expression.args.get("exists") else "" 961 kind = f"{sep}{kind}" if kind else "" 962 constraints = f" {constraints}" if constraints else "" 963 position = self.sql(expression, "position") 964 position = f" {position}" if position else "" 965 966 if expression.find(exp.ComputedColumnConstraint) and not self.COMPUTED_COLUMN_WITH_TYPE: 967 kind = "" 968 969 return f"{exists}{column}{kind}{constraints}{position}"
def
computedcolumnconstraint_sql(self, expression: sqlglot.expressions.ComputedColumnConstraint) -> str:
976 def computedcolumnconstraint_sql(self, expression: exp.ComputedColumnConstraint) -> str: 977 this = self.sql(expression, "this") 978 if expression.args.get("not_null"): 979 persisted = " PERSISTED NOT NULL" 980 elif expression.args.get("persisted"): 981 persisted = " PERSISTED" 982 else: 983 persisted = "" 984 return f"AS {this}{persisted}"
def
compresscolumnconstraint_sql(self, expression: sqlglot.expressions.CompressColumnConstraint) -> str:
def
generatedasidentitycolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsIdentityColumnConstraint) -> str:
997 def generatedasidentitycolumnconstraint_sql( 998 self, expression: exp.GeneratedAsIdentityColumnConstraint 999 ) -> str: 1000 this = "" 1001 if expression.this is not None: 1002 on_null = " ON NULL" if expression.args.get("on_null") else "" 1003 this = " ALWAYS" if expression.this else f" BY DEFAULT{on_null}" 1004 1005 start = expression.args.get("start") 1006 start = f"START WITH {start}" if start else "" 1007 increment = expression.args.get("increment") 1008 increment = f" INCREMENT BY {increment}" if increment else "" 1009 minvalue = expression.args.get("minvalue") 1010 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1011 maxvalue = expression.args.get("maxvalue") 1012 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1013 cycle = expression.args.get("cycle") 1014 cycle_sql = "" 1015 1016 if cycle is not None: 1017 cycle_sql = f"{' NO' if not cycle else ''} CYCLE" 1018 cycle_sql = cycle_sql.strip() if not start and not increment else cycle_sql 1019 1020 sequence_opts = "" 1021 if start or increment or cycle_sql: 1022 sequence_opts = f"{start}{increment}{minvalue}{maxvalue}{cycle_sql}" 1023 sequence_opts = f" ({sequence_opts.strip()})" 1024 1025 expr = self.sql(expression, "expression") 1026 expr = f"({expr})" if expr else "IDENTITY" 1027 1028 return f"GENERATED{this} AS {expr}{sequence_opts}"
def
generatedasrowcolumnconstraint_sql( self, expression: sqlglot.expressions.GeneratedAsRowColumnConstraint) -> str:
1030 def generatedasrowcolumnconstraint_sql( 1031 self, expression: exp.GeneratedAsRowColumnConstraint 1032 ) -> str: 1033 start = "START" if expression.args.get("start") else "END" 1034 hidden = " HIDDEN" if expression.args.get("hidden") else "" 1035 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:
1054 def uniquecolumnconstraint_sql(self, expression: exp.UniqueColumnConstraint) -> str: 1055 this = self.sql(expression, "this") 1056 this = f" {this}" if this else "" 1057 index_type = expression.args.get("index_type") 1058 index_type = f" USING {index_type}" if index_type else "" 1059 on_conflict = self.sql(expression, "on_conflict") 1060 on_conflict = f" {on_conflict}" if on_conflict else "" 1061 nulls_sql = " NULLS NOT DISTINCT" if expression.args.get("nulls") else "" 1062 return f"UNIQUE{nulls_sql}{this}{index_type}{on_conflict}"
1067 def create_sql(self, expression: exp.Create) -> str: 1068 kind = self.sql(expression, "kind") 1069 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1070 properties = expression.args.get("properties") 1071 properties_locs = self.locate_properties(properties) if properties else defaultdict() 1072 1073 this = self.createable_sql(expression, properties_locs) 1074 1075 properties_sql = "" 1076 if properties_locs.get(exp.Properties.Location.POST_SCHEMA) or properties_locs.get( 1077 exp.Properties.Location.POST_WITH 1078 ): 1079 properties_sql = self.sql( 1080 exp.Properties( 1081 expressions=[ 1082 *properties_locs[exp.Properties.Location.POST_SCHEMA], 1083 *properties_locs[exp.Properties.Location.POST_WITH], 1084 ] 1085 ) 1086 ) 1087 1088 if properties_locs.get(exp.Properties.Location.POST_SCHEMA): 1089 properties_sql = self.sep() + properties_sql 1090 elif not self.pretty: 1091 # Standalone POST_WITH properties need a leading whitespace in non-pretty mode 1092 properties_sql = f" {properties_sql}" 1093 1094 begin = " BEGIN" if expression.args.get("begin") else "" 1095 end = " END" if expression.args.get("end") else "" 1096 1097 expression_sql = self.sql(expression, "expression") 1098 if expression_sql: 1099 expression_sql = f"{begin}{self.sep()}{expression_sql}{end}" 1100 1101 if self.CREATE_FUNCTION_RETURN_AS or not isinstance(expression.expression, exp.Return): 1102 postalias_props_sql = "" 1103 if properties_locs.get(exp.Properties.Location.POST_ALIAS): 1104 postalias_props_sql = self.properties( 1105 exp.Properties( 1106 expressions=properties_locs[exp.Properties.Location.POST_ALIAS] 1107 ), 1108 wrapped=False, 1109 ) 1110 postalias_props_sql = f" {postalias_props_sql}" if postalias_props_sql else "" 1111 expression_sql = f" AS{postalias_props_sql}{expression_sql}" 1112 1113 postindex_props_sql = "" 1114 if properties_locs.get(exp.Properties.Location.POST_INDEX): 1115 postindex_props_sql = self.properties( 1116 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_INDEX]), 1117 wrapped=False, 1118 prefix=" ", 1119 ) 1120 1121 indexes = self.expressions(expression, key="indexes", indent=False, sep=" ") 1122 indexes = f" {indexes}" if indexes else "" 1123 index_sql = indexes + postindex_props_sql 1124 1125 replace = " OR REPLACE" if expression.args.get("replace") else "" 1126 refresh = " OR REFRESH" if expression.args.get("refresh") else "" 1127 unique = " UNIQUE" if expression.args.get("unique") else "" 1128 1129 clustered = expression.args.get("clustered") 1130 if clustered is None: 1131 clustered_sql = "" 1132 elif clustered: 1133 clustered_sql = " CLUSTERED COLUMNSTORE" 1134 else: 1135 clustered_sql = " NONCLUSTERED COLUMNSTORE" 1136 1137 postcreate_props_sql = "" 1138 if properties_locs.get(exp.Properties.Location.POST_CREATE): 1139 postcreate_props_sql = self.properties( 1140 exp.Properties(expressions=properties_locs[exp.Properties.Location.POST_CREATE]), 1141 sep=" ", 1142 prefix=" ", 1143 wrapped=False, 1144 ) 1145 1146 modifiers = "".join((clustered_sql, replace, refresh, unique, postcreate_props_sql)) 1147 1148 postexpression_props_sql = "" 1149 if properties_locs.get(exp.Properties.Location.POST_EXPRESSION): 1150 postexpression_props_sql = self.properties( 1151 exp.Properties( 1152 expressions=properties_locs[exp.Properties.Location.POST_EXPRESSION] 1153 ), 1154 sep=" ", 1155 prefix=" ", 1156 wrapped=False, 1157 ) 1158 1159 concurrently = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1160 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 1161 no_schema_binding = ( 1162 " WITH NO SCHEMA BINDING" if expression.args.get("no_schema_binding") else "" 1163 ) 1164 1165 clone = self.sql(expression, "clone") 1166 clone = f" {clone}" if clone else "" 1167 1168 if kind in self.EXPRESSION_PRECEDES_PROPERTIES_CREATABLES: 1169 properties_expression = f"{expression_sql}{properties_sql}" 1170 else: 1171 properties_expression = f"{properties_sql}{expression_sql}" 1172 1173 expression_sql = f"CREATE{modifiers} {kind}{concurrently}{exists_sql} {this}{properties_expression}{postexpression_props_sql}{index_sql}{no_schema_binding}{clone}" 1174 return self.prepend_ctes(expression, expression_sql)
1176 def sequenceproperties_sql(self, expression: exp.SequenceProperties) -> str: 1177 start = self.sql(expression, "start") 1178 start = f"START WITH {start}" if start else "" 1179 increment = self.sql(expression, "increment") 1180 increment = f" INCREMENT BY {increment}" if increment else "" 1181 minvalue = self.sql(expression, "minvalue") 1182 minvalue = f" MINVALUE {minvalue}" if minvalue else "" 1183 maxvalue = self.sql(expression, "maxvalue") 1184 maxvalue = f" MAXVALUE {maxvalue}" if maxvalue else "" 1185 owned = self.sql(expression, "owned") 1186 owned = f" OWNED BY {owned}" if owned else "" 1187 1188 cache = expression.args.get("cache") 1189 if cache is None: 1190 cache_str = "" 1191 elif cache is True: 1192 cache_str = " CACHE" 1193 else: 1194 cache_str = f" CACHE {cache}" 1195 1196 options = self.expressions(expression, key="options", flat=True, sep=" ") 1197 options = f" {options}" if options else "" 1198 1199 return f"{start}{increment}{minvalue}{maxvalue}{cache_str}{options}{owned}".lstrip()
1201 def clone_sql(self, expression: exp.Clone) -> str: 1202 this = self.sql(expression, "this") 1203 shallow = "SHALLOW " if expression.args.get("shallow") else "" 1204 keyword = "COPY" if expression.args.get("copy") and self.SUPPORTS_TABLE_COPY else "CLONE" 1205 return f"{shallow}{keyword} {this}"
1207 def describe_sql(self, expression: exp.Describe) -> str: 1208 style = expression.args.get("style") 1209 style = f" {style}" if style else "" 1210 partition = self.sql(expression, "partition") 1211 partition = f" {partition}" if partition else "" 1212 format = self.sql(expression, "format") 1213 format = f" {format}" if format else "" 1214 1215 return f"DESCRIBE{style}{format} {self.sql(expression, 'this')}{partition}"
1237 def cte_sql(self, expression: exp.CTE) -> str: 1238 alias = expression.args.get("alias") 1239 if alias: 1240 alias.add_comments(expression.pop_comments()) 1241 1242 alias_sql = self.sql(expression, "alias") 1243 1244 materialized = expression.args.get("materialized") 1245 if materialized is False: 1246 materialized = "NOT MATERIALIZED " 1247 elif materialized: 1248 materialized = "MATERIALIZED " 1249 1250 return f"{alias_sql} AS {materialized or ''}{self.wrap(expression)}"
1252 def tablealias_sql(self, expression: exp.TableAlias) -> str: 1253 alias = self.sql(expression, "this") 1254 columns = self.expressions(expression, key="columns", flat=True) 1255 columns = f"({columns})" if columns else "" 1256 1257 if columns and not self.SUPPORTS_TABLE_ALIAS_COLUMNS: 1258 columns = "" 1259 self.unsupported("Named columns are not supported in table alias.") 1260 1261 if not alias and not self.dialect.UNNEST_COLUMN_ONLY: 1262 alias = self._next_name() 1263 1264 return f"{alias}{columns}"
1284 def unicodestring_sql(self, expression: exp.UnicodeString) -> str: 1285 this = self.sql(expression, "this") 1286 escape = expression.args.get("escape") 1287 1288 if self.dialect.UNICODE_START: 1289 escape_substitute = r"\\\1" 1290 left_quote, right_quote = self.dialect.UNICODE_START, self.dialect.UNICODE_END 1291 else: 1292 escape_substitute = r"\\u\1" 1293 left_quote, right_quote = self.dialect.QUOTE_START, self.dialect.QUOTE_END 1294 1295 if escape: 1296 escape_pattern = re.compile(rf"{escape.name}(\d+)") 1297 escape_sql = f" UESCAPE {self.sql(escape)}" if self.SUPPORTS_UESCAPE else "" 1298 else: 1299 escape_pattern = ESCAPED_UNICODE_RE 1300 escape_sql = "" 1301 1302 if not self.dialect.UNICODE_START or (escape and not self.SUPPORTS_UESCAPE): 1303 this = escape_pattern.sub(escape_substitute, this) 1304 1305 return f"{left_quote}{this}{right_quote}{escape_sql}"
1317 def datatype_sql(self, expression: exp.DataType) -> str: 1318 nested = "" 1319 values = "" 1320 interior = self.expressions(expression, flat=True) 1321 1322 type_value = expression.this 1323 if type_value == exp.DataType.Type.USERDEFINED and expression.args.get("kind"): 1324 type_sql = self.sql(expression, "kind") 1325 else: 1326 type_sql = ( 1327 self.TYPE_MAPPING.get(type_value, type_value.value) 1328 if isinstance(type_value, exp.DataType.Type) 1329 else type_value 1330 ) 1331 1332 if interior: 1333 if expression.args.get("nested"): 1334 nested = f"{self.STRUCT_DELIMITER[0]}{interior}{self.STRUCT_DELIMITER[1]}" 1335 if expression.args.get("values") is not None: 1336 delimiters = ("[", "]") if type_value == exp.DataType.Type.ARRAY else ("(", ")") 1337 values = self.expressions(expression, key="values", flat=True) 1338 values = f"{delimiters[0]}{values}{delimiters[1]}" 1339 elif type_value == exp.DataType.Type.INTERVAL: 1340 nested = f" {interior}" 1341 else: 1342 nested = f"({interior})" 1343 1344 type_sql = f"{type_sql}{nested}{values}" 1345 if self.TZ_TO_WITH_TIME_ZONE and type_value in ( 1346 exp.DataType.Type.TIMETZ, 1347 exp.DataType.Type.TIMESTAMPTZ, 1348 ): 1349 type_sql = f"{type_sql} WITH TIME ZONE" 1350 1351 return type_sql
1353 def directory_sql(self, expression: exp.Directory) -> str: 1354 local = "LOCAL " if expression.args.get("local") else "" 1355 row_format = self.sql(expression, "row_format") 1356 row_format = f" {row_format}" if row_format else "" 1357 return f"{local}DIRECTORY {self.sql(expression, 'this')}{row_format}"
1359 def delete_sql(self, expression: exp.Delete) -> str: 1360 this = self.sql(expression, "this") 1361 this = f" FROM {this}" if this else "" 1362 using = self.sql(expression, "using") 1363 using = f" USING {using}" if using else "" 1364 cluster = self.sql(expression, "cluster") 1365 cluster = f" {cluster}" if cluster else "" 1366 where = self.sql(expression, "where") 1367 returning = self.sql(expression, "returning") 1368 limit = self.sql(expression, "limit") 1369 tables = self.expressions(expression, key="tables") 1370 tables = f" {tables}" if tables else "" 1371 if self.RETURNING_END: 1372 expression_sql = f"{this}{using}{cluster}{where}{returning}{limit}" 1373 else: 1374 expression_sql = f"{returning}{this}{using}{cluster}{where}{limit}" 1375 return self.prepend_ctes(expression, f"DELETE{tables}{expression_sql}")
1377 def drop_sql(self, expression: exp.Drop) -> str: 1378 this = self.sql(expression, "this") 1379 expressions = self.expressions(expression, flat=True) 1380 expressions = f" ({expressions})" if expressions else "" 1381 kind = expression.args["kind"] 1382 kind = self.dialect.INVERSE_CREATABLE_KIND_MAPPING.get(kind) or kind 1383 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 1384 concurrently_sql = " CONCURRENTLY" if expression.args.get("concurrently") else "" 1385 on_cluster = self.sql(expression, "cluster") 1386 on_cluster = f" {on_cluster}" if on_cluster else "" 1387 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 1388 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 1389 cascade = " CASCADE" if expression.args.get("cascade") else "" 1390 constraints = " CONSTRAINTS" if expression.args.get("constraints") else "" 1391 purge = " PURGE" if expression.args.get("purge") else "" 1392 return f"DROP{temporary}{materialized} {kind}{concurrently_sql}{exists_sql}{this}{on_cluster}{expressions}{cascade}{constraints}{purge}"
1394 def set_operation(self, expression: exp.SetOperation) -> str: 1395 op_type = type(expression) 1396 op_name = op_type.key.upper() 1397 1398 distinct = expression.args.get("distinct") 1399 if ( 1400 distinct is False 1401 and op_type in (exp.Except, exp.Intersect) 1402 and not self.EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE 1403 ): 1404 self.unsupported(f"{op_name} ALL is not supported") 1405 1406 default_distinct = self.dialect.SET_OP_DISTINCT_BY_DEFAULT[op_type] 1407 1408 if distinct is None: 1409 distinct = default_distinct 1410 if distinct is None: 1411 self.unsupported(f"{op_name} requires DISTINCT or ALL to be specified") 1412 1413 if distinct is default_distinct: 1414 kind = "" 1415 else: 1416 kind = " DISTINCT" if distinct else " ALL" 1417 1418 by_name = " BY NAME" if expression.args.get("by_name") else "" 1419 return f"{op_name}{kind}{by_name}"
1421 def set_operations(self, expression: exp.SetOperation) -> str: 1422 if not self.SET_OP_MODIFIERS: 1423 limit = expression.args.get("limit") 1424 order = expression.args.get("order") 1425 1426 if limit or order: 1427 select = self._move_ctes_to_top_level( 1428 exp.subquery(expression, "_l_0", copy=False).select("*", copy=False) 1429 ) 1430 1431 if limit: 1432 select = select.limit(limit.pop(), copy=False) 1433 if order: 1434 select = select.order_by(order.pop(), copy=False) 1435 return self.sql(select) 1436 1437 sqls: t.List[str] = [] 1438 stack: t.List[t.Union[str, exp.Expression]] = [expression] 1439 1440 while stack: 1441 node = stack.pop() 1442 1443 if isinstance(node, exp.SetOperation): 1444 stack.append(node.expression) 1445 stack.append( 1446 self.maybe_comment( 1447 self.set_operation(node), comments=node.comments, separated=True 1448 ) 1449 ) 1450 stack.append(node.this) 1451 else: 1452 sqls.append(self.sql(node)) 1453 1454 this = self.sep().join(sqls) 1455 this = self.query_modifiers(expression, this) 1456 return self.prepend_ctes(expression, this)
1458 def fetch_sql(self, expression: exp.Fetch) -> str: 1459 direction = expression.args.get("direction") 1460 direction = f" {direction}" if direction else "" 1461 count = self.sql(expression, "count") 1462 count = f" {count}" if count else "" 1463 if expression.args.get("percent"): 1464 count = f"{count} PERCENT" 1465 with_ties_or_only = "WITH TIES" if expression.args.get("with_ties") else "ONLY" 1466 return f"{self.seg('FETCH')}{direction}{count} ROWS {with_ties_or_only}"
1468 def filter_sql(self, expression: exp.Filter) -> str: 1469 if self.AGGREGATE_FILTER_SUPPORTED: 1470 this = self.sql(expression, "this") 1471 where = self.sql(expression, "expression").strip() 1472 return f"{this} FILTER({where})" 1473 1474 agg = expression.this 1475 agg_arg = agg.this 1476 cond = expression.expression.this 1477 agg_arg.replace(exp.If(this=cond.copy(), true=agg_arg.copy())) 1478 return self.sql(agg)
1487 def indexparameters_sql(self, expression: exp.IndexParameters) -> str: 1488 using = self.sql(expression, "using") 1489 using = f" USING {using}" if using else "" 1490 columns = self.expressions(expression, key="columns", flat=True) 1491 columns = f"({columns})" if columns else "" 1492 partition_by = self.expressions(expression, key="partition_by", flat=True) 1493 partition_by = f" PARTITION BY {partition_by}" if partition_by else "" 1494 where = self.sql(expression, "where") 1495 include = self.expressions(expression, key="include", flat=True) 1496 if include: 1497 include = f" INCLUDE ({include})" 1498 with_storage = self.expressions(expression, key="with_storage", flat=True) 1499 with_storage = f" WITH ({with_storage})" if with_storage else "" 1500 tablespace = self.sql(expression, "tablespace") 1501 tablespace = f" USING INDEX TABLESPACE {tablespace}" if tablespace else "" 1502 on = self.sql(expression, "on") 1503 on = f" ON {on}" if on else "" 1504 1505 return f"{using}{columns}{include}{with_storage}{tablespace}{partition_by}{where}{on}"
1507 def index_sql(self, expression: exp.Index) -> str: 1508 unique = "UNIQUE " if expression.args.get("unique") else "" 1509 primary = "PRIMARY " if expression.args.get("primary") else "" 1510 amp = "AMP " if expression.args.get("amp") else "" 1511 name = self.sql(expression, "this") 1512 name = f"{name} " if name else "" 1513 table = self.sql(expression, "table") 1514 table = f"{self.INDEX_ON} {table}" if table else "" 1515 1516 index = "INDEX " if not table else "" 1517 1518 params = self.sql(expression, "params") 1519 return f"{unique}{primary}{amp}{index}{name}{table}{params}"
1521 def identifier_sql(self, expression: exp.Identifier) -> str: 1522 text = expression.name 1523 lower = text.lower() 1524 text = lower if self.normalize and not expression.quoted else text 1525 text = text.replace(self._identifier_end, self._escaped_identifier_end) 1526 if ( 1527 expression.quoted 1528 or self.dialect.can_identify(text, self.identify) 1529 or lower in self.RESERVED_KEYWORDS 1530 or (not self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT and text[:1].isdigit()) 1531 ): 1532 text = f"{self._identifier_start}{text}{self._identifier_end}" 1533 return text
1548 def inputoutputformat_sql(self, expression: exp.InputOutputFormat) -> str: 1549 input_format = self.sql(expression, "input_format") 1550 input_format = f"INPUTFORMAT {input_format}" if input_format else "" 1551 output_format = self.sql(expression, "output_format") 1552 output_format = f"OUTPUTFORMAT {output_format}" if output_format else "" 1553 return self.sep().join((input_format, output_format))
1562 def properties_sql(self, expression: exp.Properties) -> str: 1563 root_properties = [] 1564 with_properties = [] 1565 1566 for p in expression.expressions: 1567 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1568 if p_loc == exp.Properties.Location.POST_WITH: 1569 with_properties.append(p) 1570 elif p_loc == exp.Properties.Location.POST_SCHEMA: 1571 root_properties.append(p) 1572 1573 root_props = self.root_properties(exp.Properties(expressions=root_properties)) 1574 with_props = self.with_properties(exp.Properties(expressions=with_properties)) 1575 1576 if root_props and with_props and not self.pretty: 1577 with_props = " " + with_props 1578 1579 return root_props + with_props
def
properties( self, properties: sqlglot.expressions.Properties, prefix: str = '', sep: str = ', ', suffix: str = '', wrapped: bool = True) -> str:
1586 def properties( 1587 self, 1588 properties: exp.Properties, 1589 prefix: str = "", 1590 sep: str = ", ", 1591 suffix: str = "", 1592 wrapped: bool = True, 1593 ) -> str: 1594 if properties.expressions: 1595 expressions = self.expressions(properties, sep=sep, indent=False) 1596 if expressions: 1597 expressions = self.wrap(expressions) if wrapped else expressions 1598 return f"{prefix}{' ' if prefix.strip() else ''}{expressions}{suffix}" 1599 return ""
1604 def locate_properties(self, properties: exp.Properties) -> t.DefaultDict: 1605 properties_locs = defaultdict(list) 1606 for p in properties.expressions: 1607 p_loc = self.PROPERTIES_LOCATION[p.__class__] 1608 if p_loc != exp.Properties.Location.UNSUPPORTED: 1609 properties_locs[p_loc].append(p) 1610 else: 1611 self.unsupported(f"Unsupported property {p.key}") 1612 1613 return properties_locs
def
property_name( self, expression: sqlglot.expressions.Property, string_key: bool = False) -> str:
1620 def property_sql(self, expression: exp.Property) -> str: 1621 property_cls = expression.__class__ 1622 if property_cls == exp.Property: 1623 return f"{self.property_name(expression)}={self.sql(expression, 'value')}" 1624 1625 property_name = exp.Properties.PROPERTY_TO_NAME.get(property_cls) 1626 if not property_name: 1627 self.unsupported(f"Unsupported property {expression.key}") 1628 1629 return f"{property_name}={self.sql(expression, 'this')}"
1631 def likeproperty_sql(self, expression: exp.LikeProperty) -> str: 1632 if self.SUPPORTS_CREATE_TABLE_LIKE: 1633 options = " ".join(f"{e.name} {self.sql(e, 'value')}" for e in expression.expressions) 1634 options = f" {options}" if options else "" 1635 1636 like = f"LIKE {self.sql(expression, 'this')}{options}" 1637 if self.LIKE_PROPERTY_INSIDE_SCHEMA and not isinstance(expression.parent, exp.Schema): 1638 like = f"({like})" 1639 1640 return like 1641 1642 if expression.expressions: 1643 self.unsupported("Transpilation of LIKE property options is unsupported") 1644 1645 select = exp.select("*").from_(expression.this).limit(0) 1646 return f"AS {self.sql(select)}"
1653 def journalproperty_sql(self, expression: exp.JournalProperty) -> str: 1654 no = "NO " if expression.args.get("no") else "" 1655 local = expression.args.get("local") 1656 local = f"{local} " if local else "" 1657 dual = "DUAL " if expression.args.get("dual") else "" 1658 before = "BEFORE " if expression.args.get("before") else "" 1659 after = "AFTER " if expression.args.get("after") else "" 1660 return f"{no}{local}{dual}{before}{after}JOURNAL"
def
mergeblockratioproperty_sql(self, expression: sqlglot.expressions.MergeBlockRatioProperty) -> str:
1676 def mergeblockratioproperty_sql(self, expression: exp.MergeBlockRatioProperty) -> str: 1677 if expression.args.get("no"): 1678 return "NO MERGEBLOCKRATIO" 1679 if expression.args.get("default"): 1680 return "DEFAULT MERGEBLOCKRATIO" 1681 1682 percent = " PERCENT" if expression.args.get("percent") else "" 1683 return f"MERGEBLOCKRATIO={self.sql(expression, 'this')}{percent}"
1685 def datablocksizeproperty_sql(self, expression: exp.DataBlocksizeProperty) -> str: 1686 default = expression.args.get("default") 1687 minimum = expression.args.get("minimum") 1688 maximum = expression.args.get("maximum") 1689 if default or minimum or maximum: 1690 if default: 1691 prop = "DEFAULT" 1692 elif minimum: 1693 prop = "MINIMUM" 1694 else: 1695 prop = "MAXIMUM" 1696 return f"{prop} DATABLOCKSIZE" 1697 units = expression.args.get("units") 1698 units = f" {units}" if units else "" 1699 return f"DATABLOCKSIZE={self.sql(expression, 'size')}{units}"
def
blockcompressionproperty_sql(self, expression: sqlglot.expressions.BlockCompressionProperty) -> str:
1701 def blockcompressionproperty_sql(self, expression: exp.BlockCompressionProperty) -> str: 1702 autotemp = expression.args.get("autotemp") 1703 always = expression.args.get("always") 1704 default = expression.args.get("default") 1705 manual = expression.args.get("manual") 1706 never = expression.args.get("never") 1707 1708 if autotemp is not None: 1709 prop = f"AUTOTEMP({self.expressions(autotemp)})" 1710 elif always: 1711 prop = "ALWAYS" 1712 elif default: 1713 prop = "DEFAULT" 1714 elif manual: 1715 prop = "MANUAL" 1716 elif never: 1717 prop = "NEVER" 1718 return f"BLOCKCOMPRESSION={prop}"
def
isolatedloadingproperty_sql(self, expression: sqlglot.expressions.IsolatedLoadingProperty) -> str:
1720 def isolatedloadingproperty_sql(self, expression: exp.IsolatedLoadingProperty) -> str: 1721 no = expression.args.get("no") 1722 no = " NO" if no else "" 1723 concurrent = expression.args.get("concurrent") 1724 concurrent = " CONCURRENT" if concurrent else "" 1725 target = self.sql(expression, "target") 1726 target = f" {target}" if target else "" 1727 return f"WITH{no}{concurrent} ISOLATED LOADING{target}"
1729 def partitionboundspec_sql(self, expression: exp.PartitionBoundSpec) -> str: 1730 if isinstance(expression.this, list): 1731 return f"IN ({self.expressions(expression, key='this', flat=True)})" 1732 if expression.this: 1733 modulus = self.sql(expression, "this") 1734 remainder = self.sql(expression, "expression") 1735 return f"WITH (MODULUS {modulus}, REMAINDER {remainder})" 1736 1737 from_expressions = self.expressions(expression, key="from_expressions", flat=True) 1738 to_expressions = self.expressions(expression, key="to_expressions", flat=True) 1739 return f"FROM ({from_expressions}) TO ({to_expressions})"
1741 def partitionedofproperty_sql(self, expression: exp.PartitionedOfProperty) -> str: 1742 this = self.sql(expression, "this") 1743 1744 for_values_or_default = expression.expression 1745 if isinstance(for_values_or_default, exp.PartitionBoundSpec): 1746 for_values_or_default = f" FOR VALUES {self.sql(for_values_or_default)}" 1747 else: 1748 for_values_or_default = " DEFAULT" 1749 1750 return f"PARTITION OF {this}{for_values_or_default}"
1752 def lockingproperty_sql(self, expression: exp.LockingProperty) -> str: 1753 kind = expression.args.get("kind") 1754 this = f" {self.sql(expression, 'this')}" if expression.this else "" 1755 for_or_in = expression.args.get("for_or_in") 1756 for_or_in = f" {for_or_in}" if for_or_in else "" 1757 lock_type = expression.args.get("lock_type") 1758 override = " OVERRIDE" if expression.args.get("override") else "" 1759 return f"LOCKING {kind}{this}{for_or_in} {lock_type}{override}"
1761 def withdataproperty_sql(self, expression: exp.WithDataProperty) -> str: 1762 data_sql = f"WITH {'NO ' if expression.args.get('no') else ''}DATA" 1763 statistics = expression.args.get("statistics") 1764 statistics_sql = "" 1765 if statistics is not None: 1766 statistics_sql = f" AND {'NO ' if not statistics else ''}STATISTICS" 1767 return f"{data_sql}{statistics_sql}"
def
withsystemversioningproperty_sql( self, expression: sqlglot.expressions.WithSystemVersioningProperty) -> str:
1769 def withsystemversioningproperty_sql(self, expression: exp.WithSystemVersioningProperty) -> str: 1770 this = self.sql(expression, "this") 1771 this = f"HISTORY_TABLE={this}" if this else "" 1772 data_consistency: t.Optional[str] = self.sql(expression, "data_consistency") 1773 data_consistency = ( 1774 f"DATA_CONSISTENCY_CHECK={data_consistency}" if data_consistency else None 1775 ) 1776 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 1777 retention_period = ( 1778 f"HISTORY_RETENTION_PERIOD={retention_period}" if retention_period else None 1779 ) 1780 1781 if this: 1782 on_sql = self.func("ON", this, data_consistency, retention_period) 1783 else: 1784 on_sql = "ON" if expression.args.get("on") else "OFF" 1785 1786 sql = f"SYSTEM_VERSIONING={on_sql}" 1787 1788 return f"WITH({sql})" if expression.args.get("with") else sql
1790 def insert_sql(self, expression: exp.Insert) -> str: 1791 hint = self.sql(expression, "hint") 1792 overwrite = expression.args.get("overwrite") 1793 1794 if isinstance(expression.this, exp.Directory): 1795 this = " OVERWRITE" if overwrite else " INTO" 1796 else: 1797 this = self.INSERT_OVERWRITE if overwrite else " INTO" 1798 1799 stored = self.sql(expression, "stored") 1800 stored = f" {stored}" if stored else "" 1801 alternative = expression.args.get("alternative") 1802 alternative = f" OR {alternative}" if alternative else "" 1803 ignore = " IGNORE" if expression.args.get("ignore") else "" 1804 is_function = expression.args.get("is_function") 1805 if is_function: 1806 this = f"{this} FUNCTION" 1807 this = f"{this} {self.sql(expression, 'this')}" 1808 1809 exists = " IF EXISTS" if expression.args.get("exists") else "" 1810 where = self.sql(expression, "where") 1811 where = f"{self.sep()}REPLACE WHERE {where}" if where else "" 1812 expression_sql = f"{self.sep()}{self.sql(expression, 'expression')}" 1813 on_conflict = self.sql(expression, "conflict") 1814 on_conflict = f" {on_conflict}" if on_conflict else "" 1815 by_name = " BY NAME" if expression.args.get("by_name") else "" 1816 returning = self.sql(expression, "returning") 1817 1818 if self.RETURNING_END: 1819 expression_sql = f"{expression_sql}{on_conflict}{returning}" 1820 else: 1821 expression_sql = f"{returning}{expression_sql}{on_conflict}" 1822 1823 partition_by = self.sql(expression, "partition") 1824 partition_by = f" {partition_by}" if partition_by else "" 1825 settings = self.sql(expression, "settings") 1826 settings = f" {settings}" if settings else "" 1827 1828 source = self.sql(expression, "source") 1829 source = f"TABLE {source}" if source else "" 1830 1831 sql = f"INSERT{hint}{alternative}{ignore}{this}{stored}{by_name}{exists}{partition_by}{settings}{where}{expression_sql}{source}" 1832 return self.prepend_ctes(expression, sql)
1850 def onconflict_sql(self, expression: exp.OnConflict) -> str: 1851 conflict = "ON DUPLICATE KEY" if expression.args.get("duplicate") else "ON CONFLICT" 1852 1853 constraint = self.sql(expression, "constraint") 1854 constraint = f" ON CONSTRAINT {constraint}" if constraint else "" 1855 1856 conflict_keys = self.expressions(expression, key="conflict_keys", flat=True) 1857 conflict_keys = f"({conflict_keys}) " if conflict_keys else " " 1858 action = self.sql(expression, "action") 1859 1860 expressions = self.expressions(expression, flat=True) 1861 if expressions: 1862 set_keyword = "SET " if self.DUPLICATE_KEY_UPDATE_WITH_SET else "" 1863 expressions = f" {set_keyword}{expressions}" 1864 1865 return f"{conflict}{constraint}{conflict_keys}{action}{expressions}"
def
rowformatdelimitedproperty_sql(self, expression: sqlglot.expressions.RowFormatDelimitedProperty) -> str:
1870 def rowformatdelimitedproperty_sql(self, expression: exp.RowFormatDelimitedProperty) -> str: 1871 fields = self.sql(expression, "fields") 1872 fields = f" FIELDS TERMINATED BY {fields}" if fields else "" 1873 escaped = self.sql(expression, "escaped") 1874 escaped = f" ESCAPED BY {escaped}" if escaped else "" 1875 items = self.sql(expression, "collection_items") 1876 items = f" COLLECTION ITEMS TERMINATED BY {items}" if items else "" 1877 keys = self.sql(expression, "map_keys") 1878 keys = f" MAP KEYS TERMINATED BY {keys}" if keys else "" 1879 lines = self.sql(expression, "lines") 1880 lines = f" LINES TERMINATED BY {lines}" if lines else "" 1881 null = self.sql(expression, "null") 1882 null = f" NULL DEFINED AS {null}" if null else "" 1883 return f"ROW FORMAT DELIMITED{fields}{escaped}{items}{keys}{lines}{null}"
1911 def table_sql(self, expression: exp.Table, sep: str = " AS ") -> str: 1912 table = self.table_parts(expression) 1913 only = "ONLY " if expression.args.get("only") else "" 1914 partition = self.sql(expression, "partition") 1915 partition = f" {partition}" if partition else "" 1916 version = self.sql(expression, "version") 1917 version = f" {version}" if version else "" 1918 alias = self.sql(expression, "alias") 1919 alias = f"{sep}{alias}" if alias else "" 1920 1921 sample = self.sql(expression, "sample") 1922 if self.dialect.ALIAS_POST_TABLESAMPLE: 1923 sample_pre_alias = sample 1924 sample_post_alias = "" 1925 else: 1926 sample_pre_alias = "" 1927 sample_post_alias = sample 1928 1929 hints = self.expressions(expression, key="hints", sep=" ") 1930 hints = f" {hints}" if hints and self.TABLE_HINTS else "" 1931 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 1932 joins = self.indent( 1933 self.expressions(expression, key="joins", sep="", flat=True), skip_first=True 1934 ) 1935 laterals = self.expressions(expression, key="laterals", sep="") 1936 1937 file_format = self.sql(expression, "format") 1938 if file_format: 1939 pattern = self.sql(expression, "pattern") 1940 pattern = f", PATTERN => {pattern}" if pattern else "" 1941 file_format = f" (FILE_FORMAT => {file_format}{pattern})" 1942 1943 ordinality = expression.args.get("ordinality") or "" 1944 if ordinality: 1945 ordinality = f" WITH ORDINALITY{alias}" 1946 alias = "" 1947 1948 when = self.sql(expression, "when") 1949 if when: 1950 table = f"{table} {when}" 1951 1952 changes = self.sql(expression, "changes") 1953 changes = f" {changes}" if changes else "" 1954 1955 rows_from = self.expressions(expression, key="rows_from") 1956 if rows_from: 1957 table = f"ROWS FROM {self.wrap(rows_from)}" 1958 1959 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:
1961 def tablesample_sql( 1962 self, 1963 expression: exp.TableSample, 1964 tablesample_keyword: t.Optional[str] = None, 1965 ) -> str: 1966 method = self.sql(expression, "method") 1967 method = f"{method} " if method and self.TABLESAMPLE_WITH_METHOD else "" 1968 numerator = self.sql(expression, "bucket_numerator") 1969 denominator = self.sql(expression, "bucket_denominator") 1970 field = self.sql(expression, "bucket_field") 1971 field = f" ON {field}" if field else "" 1972 bucket = f"BUCKET {numerator} OUT OF {denominator}{field}" if numerator else "" 1973 seed = self.sql(expression, "seed") 1974 seed = f" {self.TABLESAMPLE_SEED_KEYWORD} ({seed})" if seed else "" 1975 1976 size = self.sql(expression, "size") 1977 if size and self.TABLESAMPLE_SIZE_IS_ROWS: 1978 size = f"{size} ROWS" 1979 1980 percent = self.sql(expression, "percent") 1981 if percent and not self.dialect.TABLESAMPLE_SIZE_IS_PERCENT: 1982 percent = f"{percent} PERCENT" 1983 1984 expr = f"{bucket}{percent}{size}" 1985 if self.TABLESAMPLE_REQUIRES_PARENS: 1986 expr = f"({expr})" 1987 1988 return f" {tablesample_keyword or self.TABLESAMPLE_KEYWORDS} {method}{expr}{seed}"
1990 def pivot_sql(self, expression: exp.Pivot) -> str: 1991 expressions = self.expressions(expression, flat=True) 1992 1993 if expression.this: 1994 this = self.sql(expression, "this") 1995 if not expressions: 1996 return f"UNPIVOT {this}" 1997 1998 on = f"{self.seg('ON')} {expressions}" 1999 using = self.expressions(expression, key="using", flat=True) 2000 using = f"{self.seg('USING')} {using}" if using else "" 2001 group = self.sql(expression, "group") 2002 return f"PIVOT {this}{on}{using}{group}" 2003 2004 alias = self.sql(expression, "alias") 2005 alias = f" AS {alias}" if alias else "" 2006 direction = self.seg("UNPIVOT" if expression.unpivot else "PIVOT") 2007 2008 field = self.sql(expression, "field") 2009 2010 include_nulls = expression.args.get("include_nulls") 2011 if include_nulls is not None: 2012 nulls = " INCLUDE NULLS " if include_nulls else " EXCLUDE NULLS " 2013 else: 2014 nulls = "" 2015 2016 default_on_null = self.sql(expression, "default_on_null") 2017 default_on_null = f" DEFAULT ON NULL ({default_on_null})" if default_on_null else "" 2018 return f"{direction}{nulls}({expressions} FOR {field}{default_on_null}){alias}"
2029 def update_sql(self, expression: exp.Update) -> str: 2030 this = self.sql(expression, "this") 2031 set_sql = self.expressions(expression, flat=True) 2032 from_sql = self.sql(expression, "from") 2033 where_sql = self.sql(expression, "where") 2034 returning = self.sql(expression, "returning") 2035 order = self.sql(expression, "order") 2036 limit = self.sql(expression, "limit") 2037 if self.RETURNING_END: 2038 expression_sql = f"{from_sql}{where_sql}{returning}" 2039 else: 2040 expression_sql = f"{returning}{from_sql}{where_sql}" 2041 sql = f"UPDATE {this} SET {set_sql}{expression_sql}{order}{limit}" 2042 return self.prepend_ctes(expression, sql)
2044 def values_sql(self, expression: exp.Values, values_as_table: bool = True) -> str: 2045 values_as_table = values_as_table and self.VALUES_AS_TABLE 2046 2047 # The VALUES clause is still valid in an `INSERT INTO ..` statement, for example 2048 if values_as_table or not expression.find_ancestor(exp.From, exp.Join): 2049 args = self.expressions(expression) 2050 alias = self.sql(expression, "alias") 2051 values = f"VALUES{self.seg('')}{args}" 2052 values = ( 2053 f"({values})" 2054 if self.WRAP_DERIVED_VALUES 2055 and (alias or isinstance(expression.parent, (exp.From, exp.Table))) 2056 else values 2057 ) 2058 return f"{values} AS {alias}" if alias else values 2059 2060 # Converts `VALUES...` expression into a series of select unions. 2061 alias_node = expression.args.get("alias") 2062 column_names = alias_node and alias_node.columns 2063 2064 selects: t.List[exp.Query] = [] 2065 2066 for i, tup in enumerate(expression.expressions): 2067 row = tup.expressions 2068 2069 if i == 0 and column_names: 2070 row = [ 2071 exp.alias_(value, column_name) for value, column_name in zip(row, column_names) 2072 ] 2073 2074 selects.append(exp.Select(expressions=row)) 2075 2076 if self.pretty: 2077 # This may result in poor performance for large-cardinality `VALUES` tables, due to 2078 # the deep nesting of the resulting exp.Unions. If this is a problem, either increase 2079 # `sys.setrecursionlimit` to avoid RecursionErrors, or don't set `pretty`. 2080 query = reduce(lambda x, y: exp.union(x, y, distinct=False, copy=False), selects) 2081 return self.subquery_sql(query.subquery(alias_node and alias_node.this, copy=False)) 2082 2083 alias = f" AS {self.sql(alias_node, 'this')}" if alias_node else "" 2084 unions = " UNION ALL ".join(self.sql(select) for select in selects) 2085 return f"({unions}){alias}"
2090 @unsupported_args("expressions") 2091 def into_sql(self, expression: exp.Into) -> str: 2092 temporary = " TEMPORARY" if expression.args.get("temporary") else "" 2093 unlogged = " UNLOGGED" if expression.args.get("unlogged") else "" 2094 return f"{self.seg('INTO')}{temporary or unlogged} {self.sql(expression, 'this')}"
2111 def group_sql(self, expression: exp.Group) -> str: 2112 group_by_all = expression.args.get("all") 2113 if group_by_all is True: 2114 modifier = " ALL" 2115 elif group_by_all is False: 2116 modifier = " DISTINCT" 2117 else: 2118 modifier = "" 2119 2120 group_by = self.op_expressions(f"GROUP BY{modifier}", expression) 2121 2122 grouping_sets = self.expressions(expression, key="grouping_sets") 2123 cube = self.expressions(expression, key="cube") 2124 rollup = self.expressions(expression, key="rollup") 2125 2126 groupings = csv( 2127 self.seg(grouping_sets) if grouping_sets else "", 2128 self.seg(cube) if cube else "", 2129 self.seg(rollup) if rollup else "", 2130 self.seg("WITH TOTALS") if expression.args.get("totals") else "", 2131 sep=self.GROUPINGS_SEP, 2132 ) 2133 2134 if ( 2135 expression.expressions 2136 and groupings 2137 and groupings.strip() not in ("WITH CUBE", "WITH ROLLUP") 2138 ): 2139 group_by = f"{group_by}{self.GROUPINGS_SEP}" 2140 2141 return f"{group_by}{groupings}"
2147 def connect_sql(self, expression: exp.Connect) -> str: 2148 start = self.sql(expression, "start") 2149 start = self.seg(f"START WITH {start}") if start else "" 2150 nocycle = " NOCYCLE" if expression.args.get("nocycle") else "" 2151 connect = self.sql(expression, "connect") 2152 connect = self.seg(f"CONNECT BY{nocycle} {connect}") 2153 return start + connect
2158 def join_sql(self, expression: exp.Join) -> str: 2159 if not self.SEMI_ANTI_JOIN_WITH_SIDE and expression.kind in ("SEMI", "ANTI"): 2160 side = None 2161 else: 2162 side = expression.side 2163 2164 op_sql = " ".join( 2165 op 2166 for op in ( 2167 expression.method, 2168 "GLOBAL" if expression.args.get("global") else None, 2169 side, 2170 expression.kind, 2171 expression.hint if self.JOIN_HINTS else None, 2172 ) 2173 if op 2174 ) 2175 match_cond = self.sql(expression, "match_condition") 2176 match_cond = f" MATCH_CONDITION ({match_cond})" if match_cond else "" 2177 on_sql = self.sql(expression, "on") 2178 using = expression.args.get("using") 2179 2180 if not on_sql and using: 2181 on_sql = csv(*(self.sql(column) for column in using)) 2182 2183 this = expression.this 2184 this_sql = self.sql(this) 2185 2186 exprs = self.expressions(expression) 2187 if exprs: 2188 this_sql = f"{this_sql},{self.seg(exprs)}" 2189 2190 if on_sql: 2191 on_sql = self.indent(on_sql, skip_first=True) 2192 space = self.seg(" " * self.pad) if self.pretty else " " 2193 if using: 2194 on_sql = f"{space}USING ({on_sql})" 2195 else: 2196 on_sql = f"{space}ON {on_sql}" 2197 elif not op_sql: 2198 if isinstance(this, exp.Lateral) and this.args.get("cross_apply") is not None: 2199 return f" {this_sql}" 2200 2201 return f", {this_sql}" 2202 2203 if op_sql != "STRAIGHT_JOIN": 2204 op_sql = f"{op_sql} JOIN" if op_sql else "JOIN" 2205 2206 return f"{self.seg(op_sql)} {this_sql}{match_cond}{on_sql}"
2213 def lateral_op(self, expression: exp.Lateral) -> str: 2214 cross_apply = expression.args.get("cross_apply") 2215 2216 # https://www.mssqltips.com/sqlservertip/1958/sql-server-cross-apply-and-outer-apply/ 2217 if cross_apply is True: 2218 op = "INNER JOIN " 2219 elif cross_apply is False: 2220 op = "LEFT JOIN " 2221 else: 2222 op = "" 2223 2224 return f"{op}LATERAL"
2226 def lateral_sql(self, expression: exp.Lateral) -> str: 2227 this = self.sql(expression, "this") 2228 2229 if expression.args.get("view"): 2230 alias = expression.args["alias"] 2231 columns = self.expressions(alias, key="columns", flat=True) 2232 table = f" {alias.name}" if alias.name else "" 2233 columns = f" AS {columns}" if columns else "" 2234 op_sql = self.seg(f"LATERAL VIEW{' OUTER' if expression.args.get('outer') else ''}") 2235 return f"{op_sql}{self.sep()}{this}{table}{columns}" 2236 2237 alias = self.sql(expression, "alias") 2238 alias = f" AS {alias}" if alias else "" 2239 return f"{self.lateral_op(expression)} {this}{alias}"
2241 def limit_sql(self, expression: exp.Limit, top: bool = False) -> str: 2242 this = self.sql(expression, "this") 2243 2244 args = [ 2245 self._simplify_unless_literal(e) if self.LIMIT_ONLY_LITERALS else e 2246 for e in (expression.args.get(k) for k in ("offset", "expression")) 2247 if e 2248 ] 2249 2250 args_sql = ", ".join(self.sql(e) for e in args) 2251 args_sql = f"({args_sql})" if top and any(not e.is_number for e in args) else args_sql 2252 expressions = self.expressions(expression, flat=True) 2253 expressions = f" BY {expressions}" if expressions else "" 2254 2255 return f"{this}{self.seg('TOP' if top else 'LIMIT')} {args_sql}{expressions}"
2257 def offset_sql(self, expression: exp.Offset) -> str: 2258 this = self.sql(expression, "this") 2259 value = expression.expression 2260 value = self._simplify_unless_literal(value) if self.LIMIT_ONLY_LITERALS else value 2261 expressions = self.expressions(expression, flat=True) 2262 expressions = f" BY {expressions}" if expressions else "" 2263 return f"{this}{self.seg('OFFSET')} {self.sql(value)}{expressions}"
2265 def setitem_sql(self, expression: exp.SetItem) -> str: 2266 kind = self.sql(expression, "kind") 2267 kind = f"{kind} " if kind else "" 2268 this = self.sql(expression, "this") 2269 expressions = self.expressions(expression) 2270 collate = self.sql(expression, "collate") 2271 collate = f" COLLATE {collate}" if collate else "" 2272 global_ = "GLOBAL " if expression.args.get("global") else "" 2273 return f"{global_}{kind}{this}{expressions}{collate}"
2275 def set_sql(self, expression: exp.Set) -> str: 2276 expressions = ( 2277 f" {self.expressions(expression, flat=True)}" if expression.expressions else "" 2278 ) 2279 tag = " TAG" if expression.args.get("tag") else "" 2280 return f"{'UNSET' if expression.args.get('unset') else 'SET'}{tag}{expressions}"
2285 def lock_sql(self, expression: exp.Lock) -> str: 2286 if not self.LOCKING_READS_SUPPORTED: 2287 self.unsupported("Locking reads using 'FOR UPDATE/SHARE' are not supported") 2288 return "" 2289 2290 lock_type = "FOR UPDATE" if expression.args["update"] else "FOR SHARE" 2291 expressions = self.expressions(expression, flat=True) 2292 expressions = f" OF {expressions}" if expressions else "" 2293 wait = expression.args.get("wait") 2294 2295 if wait is not None: 2296 if isinstance(wait, exp.Literal): 2297 wait = f" WAIT {self.sql(wait)}" 2298 else: 2299 wait = " NOWAIT" if wait else " SKIP LOCKED" 2300 2301 return f"{lock_type}{expressions}{wait or ''}"
def
escape_str(self, text: str, escape_backslash: bool = True) -> str:
2309 def escape_str(self, text: str, escape_backslash: bool = True) -> str: 2310 if self.dialect.ESCAPED_SEQUENCES: 2311 to_escaped = self.dialect.ESCAPED_SEQUENCES 2312 text = "".join( 2313 to_escaped.get(ch, ch) if escape_backslash or ch != "\\" else ch for ch in text 2314 ) 2315 2316 return self._replace_line_breaks(text).replace( 2317 self.dialect.QUOTE_END, self._escaped_quote_end 2318 )
2320 def loaddata_sql(self, expression: exp.LoadData) -> str: 2321 local = " LOCAL" if expression.args.get("local") else "" 2322 inpath = f" INPATH {self.sql(expression, 'inpath')}" 2323 overwrite = " OVERWRITE" if expression.args.get("overwrite") else "" 2324 this = f" INTO TABLE {self.sql(expression, 'this')}" 2325 partition = self.sql(expression, "partition") 2326 partition = f" {partition}" if partition else "" 2327 input_format = self.sql(expression, "input_format") 2328 input_format = f" INPUTFORMAT {input_format}" if input_format else "" 2329 serde = self.sql(expression, "serde") 2330 serde = f" SERDE {serde}" if serde else "" 2331 return f"LOAD DATA{local}{inpath}{overwrite}{this}{partition}{input_format}{serde}"
2339 def order_sql(self, expression: exp.Order, flat: bool = False) -> str: 2340 this = self.sql(expression, "this") 2341 this = f"{this} " if this else this 2342 siblings = "SIBLINGS " if expression.args.get("siblings") else "" 2343 return self.op_expressions(f"{this}ORDER {siblings}BY", expression, flat=this or flat) # type: ignore
2345 def withfill_sql(self, expression: exp.WithFill) -> str: 2346 from_sql = self.sql(expression, "from") 2347 from_sql = f" FROM {from_sql}" if from_sql else "" 2348 to_sql = self.sql(expression, "to") 2349 to_sql = f" TO {to_sql}" if to_sql else "" 2350 step_sql = self.sql(expression, "step") 2351 step_sql = f" STEP {step_sql}" if step_sql else "" 2352 interpolated_values = [ 2353 f"{self.sql(e, 'alias')} AS {self.sql(e, 'this')}" 2354 if isinstance(e, exp.Alias) 2355 else self.sql(e, "this") 2356 for e in expression.args.get("interpolate") or [] 2357 ] 2358 interpolate = ( 2359 f" INTERPOLATE ({', '.join(interpolated_values)})" if interpolated_values else "" 2360 ) 2361 return f"WITH FILL{from_sql}{to_sql}{step_sql}{interpolate}"
2372 def ordered_sql(self, expression: exp.Ordered) -> str: 2373 desc = expression.args.get("desc") 2374 asc = not desc 2375 2376 nulls_first = expression.args.get("nulls_first") 2377 nulls_last = not nulls_first 2378 nulls_are_large = self.dialect.NULL_ORDERING == "nulls_are_large" 2379 nulls_are_small = self.dialect.NULL_ORDERING == "nulls_are_small" 2380 nulls_are_last = self.dialect.NULL_ORDERING == "nulls_are_last" 2381 2382 this = self.sql(expression, "this") 2383 2384 sort_order = " DESC" if desc else (" ASC" if desc is False else "") 2385 nulls_sort_change = "" 2386 if nulls_first and ( 2387 (asc and nulls_are_large) or (desc and nulls_are_small) or nulls_are_last 2388 ): 2389 nulls_sort_change = " NULLS FIRST" 2390 elif ( 2391 nulls_last 2392 and ((asc and nulls_are_small) or (desc and nulls_are_large)) 2393 and not nulls_are_last 2394 ): 2395 nulls_sort_change = " NULLS LAST" 2396 2397 # If the NULLS FIRST/LAST clause is unsupported, we add another sort key to simulate it 2398 if nulls_sort_change and not self.NULL_ORDERING_SUPPORTED: 2399 window = expression.find_ancestor(exp.Window, exp.Select) 2400 if isinstance(window, exp.Window) and window.args.get("spec"): 2401 self.unsupported( 2402 f"'{nulls_sort_change.strip()}' translation not supported in window functions" 2403 ) 2404 nulls_sort_change = "" 2405 elif self.NULL_ORDERING_SUPPORTED is False and ( 2406 (asc and nulls_sort_change == " NULLS LAST") 2407 or (desc and nulls_sort_change == " NULLS FIRST") 2408 ): 2409 # BigQuery does not allow these ordering/nulls combinations when used under 2410 # an aggregation func or under a window containing one 2411 ancestor = expression.find_ancestor(exp.AggFunc, exp.Window, exp.Select) 2412 2413 if isinstance(ancestor, exp.Window): 2414 ancestor = ancestor.this 2415 if isinstance(ancestor, exp.AggFunc): 2416 self.unsupported( 2417 f"'{nulls_sort_change.strip()}' translation not supported for aggregate functions with {sort_order} sort order" 2418 ) 2419 nulls_sort_change = "" 2420 elif self.NULL_ORDERING_SUPPORTED is None: 2421 if expression.this.is_int: 2422 self.unsupported( 2423 f"'{nulls_sort_change.strip()}' translation not supported with positional ordering" 2424 ) 2425 elif not isinstance(expression.this, exp.Rand): 2426 null_sort_order = " DESC" if nulls_sort_change == " NULLS FIRST" else "" 2427 this = f"CASE WHEN {this} IS NULL THEN 1 ELSE 0 END{null_sort_order}, {this}" 2428 nulls_sort_change = "" 2429 2430 with_fill = self.sql(expression, "with_fill") 2431 with_fill = f" {with_fill}" if with_fill else "" 2432 2433 return f"{this}{sort_order}{nulls_sort_change}{with_fill}"
2443 def matchrecognize_sql(self, expression: exp.MatchRecognize) -> str: 2444 partition = self.partition_by_sql(expression) 2445 order = self.sql(expression, "order") 2446 measures = self.expressions(expression, key="measures") 2447 measures = self.seg(f"MEASURES{self.seg(measures)}") if measures else "" 2448 rows = self.sql(expression, "rows") 2449 rows = self.seg(rows) if rows else "" 2450 after = self.sql(expression, "after") 2451 after = self.seg(after) if after else "" 2452 pattern = self.sql(expression, "pattern") 2453 pattern = self.seg(f"PATTERN ({pattern})") if pattern else "" 2454 definition_sqls = [ 2455 f"{self.sql(definition, 'alias')} AS {self.sql(definition, 'this')}" 2456 for definition in expression.args.get("define", []) 2457 ] 2458 definitions = self.expressions(sqls=definition_sqls) 2459 define = self.seg(f"DEFINE{self.seg(definitions)}") if definitions else "" 2460 body = "".join( 2461 ( 2462 partition, 2463 order, 2464 measures, 2465 rows, 2466 after, 2467 pattern, 2468 define, 2469 ) 2470 ) 2471 alias = self.sql(expression, "alias") 2472 alias = f" {alias}" if alias else "" 2473 return f"{self.seg('MATCH_RECOGNIZE')} {self.wrap(body)}{alias}"
2475 def query_modifiers(self, expression: exp.Expression, *sqls: str) -> str: 2476 limit = expression.args.get("limit") 2477 2478 if self.LIMIT_FETCH == "LIMIT" and isinstance(limit, exp.Fetch): 2479 limit = exp.Limit(expression=exp.maybe_copy(limit.args.get("count"))) 2480 elif self.LIMIT_FETCH == "FETCH" and isinstance(limit, exp.Limit): 2481 limit = exp.Fetch(direction="FIRST", count=exp.maybe_copy(limit.expression)) 2482 2483 return csv( 2484 *sqls, 2485 *[self.sql(join) for join in expression.args.get("joins") or []], 2486 self.sql(expression, "connect"), 2487 self.sql(expression, "match"), 2488 *[self.sql(lateral) for lateral in expression.args.get("laterals") or []], 2489 self.sql(expression, "prewhere"), 2490 self.sql(expression, "where"), 2491 self.sql(expression, "group"), 2492 self.sql(expression, "having"), 2493 *[gen(self, expression) for gen in self.AFTER_HAVING_MODIFIER_TRANSFORMS.values()], 2494 self.sql(expression, "order"), 2495 *self.offset_limit_modifiers(expression, isinstance(limit, exp.Fetch), limit), 2496 *self.after_limit_modifiers(expression), 2497 self.options_modifier(expression), 2498 sep="", 2499 )
def
offset_limit_modifiers( self, expression: sqlglot.expressions.Expression, fetch: bool, limit: Union[sqlglot.expressions.Fetch, sqlglot.expressions.Limit, NoneType]) -> List[str]:
2508 def offset_limit_modifiers( 2509 self, expression: exp.Expression, fetch: bool, limit: t.Optional[exp.Fetch | exp.Limit] 2510 ) -> t.List[str]: 2511 return [ 2512 self.sql(expression, "offset") if fetch else self.sql(limit), 2513 self.sql(limit) if fetch else self.sql(expression, "offset"), 2514 ]
2521 def select_sql(self, expression: exp.Select) -> str: 2522 into = expression.args.get("into") 2523 if not self.SUPPORTS_SELECT_INTO and into: 2524 into.pop() 2525 2526 hint = self.sql(expression, "hint") 2527 distinct = self.sql(expression, "distinct") 2528 distinct = f" {distinct}" if distinct else "" 2529 kind = self.sql(expression, "kind") 2530 2531 limit = expression.args.get("limit") 2532 if isinstance(limit, exp.Limit) and self.LIMIT_IS_TOP: 2533 top = self.limit_sql(limit, top=True) 2534 limit.pop() 2535 else: 2536 top = "" 2537 2538 expressions = self.expressions(expression) 2539 2540 if kind: 2541 if kind in self.SELECT_KINDS: 2542 kind = f" AS {kind}" 2543 else: 2544 if kind == "STRUCT": 2545 expressions = self.expressions( 2546 sqls=[ 2547 self.sql( 2548 exp.Struct( 2549 expressions=[ 2550 exp.PropertyEQ(this=e.args.get("alias"), expression=e.this) 2551 if isinstance(e, exp.Alias) 2552 else e 2553 for e in expression.expressions 2554 ] 2555 ) 2556 ) 2557 ] 2558 ) 2559 kind = "" 2560 2561 operation_modifiers = self.expressions(expression, key="operation_modifiers", sep=" ") 2562 operation_modifiers = f"{self.sep()}{operation_modifiers}" if operation_modifiers else "" 2563 2564 # We use LIMIT_IS_TOP as a proxy for whether DISTINCT should go first because tsql and Teradata 2565 # are the only dialects that use LIMIT_IS_TOP and both place DISTINCT first. 2566 top_distinct = f"{distinct}{hint}{top}" if self.LIMIT_IS_TOP else f"{top}{hint}{distinct}" 2567 expressions = f"{self.sep()}{expressions}" if expressions else expressions 2568 sql = self.query_modifiers( 2569 expression, 2570 f"SELECT{top_distinct}{operation_modifiers}{kind}{expressions}", 2571 self.sql(expression, "into", comment=False), 2572 self.sql(expression, "from", comment=False), 2573 ) 2574 2575 # If both the CTE and SELECT clauses have comments, generate the latter earlier 2576 if expression.args.get("with"): 2577 sql = self.maybe_comment(sql, expression) 2578 expression.pop_comments() 2579 2580 sql = self.prepend_ctes(expression, sql) 2581 2582 if not self.SUPPORTS_SELECT_INTO and into: 2583 if into.args.get("temporary"): 2584 table_kind = " TEMPORARY" 2585 elif self.SUPPORTS_UNLOGGED_TABLES and into.args.get("unlogged"): 2586 table_kind = " UNLOGGED" 2587 else: 2588 table_kind = "" 2589 sql = f"CREATE{table_kind} TABLE {self.sql(into.this)} AS {sql}" 2590 2591 return sql
2603 def star_sql(self, expression: exp.Star) -> str: 2604 except_ = self.expressions(expression, key="except", flat=True) 2605 except_ = f"{self.seg(self.STAR_EXCEPT)} ({except_})" if except_ else "" 2606 replace = self.expressions(expression, key="replace", flat=True) 2607 replace = f"{self.seg('REPLACE')} ({replace})" if replace else "" 2608 rename = self.expressions(expression, key="rename", flat=True) 2609 rename = f"{self.seg('RENAME')} ({rename})" if rename else "" 2610 return f"*{except_}{replace}{rename}"
2626 def subquery_sql(self, expression: exp.Subquery, sep: str = " AS ") -> str: 2627 alias = self.sql(expression, "alias") 2628 alias = f"{sep}{alias}" if alias else "" 2629 sample = self.sql(expression, "sample") 2630 if self.dialect.ALIAS_POST_TABLESAMPLE and sample: 2631 alias = f"{sample}{alias}" 2632 2633 # Set to None so it's not generated again by self.query_modifiers() 2634 expression.set("sample", None) 2635 2636 pivots = self.expressions(expression, key="pivots", sep="", flat=True) 2637 sql = self.query_modifiers(expression, self.wrap(expression), alias, pivots) 2638 return self.prepend_ctes(expression, sql)
2644 def unnest_sql(self, expression: exp.Unnest) -> str: 2645 args = self.expressions(expression, flat=True) 2646 2647 alias = expression.args.get("alias") 2648 offset = expression.args.get("offset") 2649 2650 if self.UNNEST_WITH_ORDINALITY: 2651 if alias and isinstance(offset, exp.Expression): 2652 alias.append("columns", offset) 2653 2654 if alias and self.dialect.UNNEST_COLUMN_ONLY: 2655 columns = alias.columns 2656 alias = self.sql(columns[0]) if columns else "" 2657 else: 2658 alias = self.sql(alias) 2659 2660 alias = f" AS {alias}" if alias else alias 2661 if self.UNNEST_WITH_ORDINALITY: 2662 suffix = f" WITH ORDINALITY{alias}" if offset else alias 2663 else: 2664 if isinstance(offset, exp.Expression): 2665 suffix = f"{alias} WITH OFFSET AS {self.sql(offset)}" 2666 elif offset: 2667 suffix = f"{alias} WITH OFFSET" 2668 else: 2669 suffix = alias 2670 2671 return f"UNNEST({args}){suffix}"
2680 def window_sql(self, expression: exp.Window) -> str: 2681 this = self.sql(expression, "this") 2682 partition = self.partition_by_sql(expression) 2683 order = expression.args.get("order") 2684 order = self.order_sql(order, flat=True) if order else "" 2685 spec = self.sql(expression, "spec") 2686 alias = self.sql(expression, "alias") 2687 over = self.sql(expression, "over") or "OVER" 2688 2689 this = f"{this} {'AS' if expression.arg_key == 'windows' else over}" 2690 2691 first = expression.args.get("first") 2692 if first is None: 2693 first = "" 2694 else: 2695 first = "FIRST" if first else "LAST" 2696 2697 if not partition and not order and not spec and alias: 2698 return f"{this} {alias}" 2699 2700 args = " ".join(arg for arg in (alias, first, partition, order, spec) if arg) 2701 return f"{this} ({args})"
def
partition_by_sql( self, expression: sqlglot.expressions.Window | sqlglot.expressions.MatchRecognize) -> str:
2707 def windowspec_sql(self, expression: exp.WindowSpec) -> str: 2708 kind = self.sql(expression, "kind") 2709 start = csv(self.sql(expression, "start"), self.sql(expression, "start_side"), sep=" ") 2710 end = ( 2711 csv(self.sql(expression, "end"), self.sql(expression, "end_side"), sep=" ") 2712 or "CURRENT ROW" 2713 ) 2714 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]:
2727 def bracket_offset_expressions( 2728 self, expression: exp.Bracket, index_offset: t.Optional[int] = None 2729 ) -> t.List[exp.Expression]: 2730 return apply_index_offset( 2731 expression.this, 2732 expression.expressions, 2733 (index_offset or self.dialect.INDEX_OFFSET) - expression.args.get("offset", 0), 2734 )
2744 def any_sql(self, expression: exp.Any) -> str: 2745 this = self.sql(expression, "this") 2746 if isinstance(expression.this, (*exp.UNWRAPPED_QUERIES, exp.Paren)): 2747 if isinstance(expression.this, exp.UNWRAPPED_QUERIES): 2748 this = self.wrap(this) 2749 return f"ANY{this}" 2750 return f"ANY {this}"
2755 def case_sql(self, expression: exp.Case) -> str: 2756 this = self.sql(expression, "this") 2757 statements = [f"CASE {this}" if this else "CASE"] 2758 2759 for e in expression.args["ifs"]: 2760 statements.append(f"WHEN {self.sql(e, 'this')}") 2761 statements.append(f"THEN {self.sql(e, 'true')}") 2762 2763 default = self.sql(expression, "default") 2764 2765 if default: 2766 statements.append(f"ELSE {default}") 2767 2768 statements.append("END") 2769 2770 if self.pretty and self.too_wide(statements): 2771 return self.indent("\n".join(statements), skip_first=True, skip_last=True) 2772 2773 return " ".join(statements)
2790 def trim_sql(self, expression: exp.Trim) -> str: 2791 trim_type = self.sql(expression, "position") 2792 2793 if trim_type == "LEADING": 2794 func_name = "LTRIM" 2795 elif trim_type == "TRAILING": 2796 func_name = "RTRIM" 2797 else: 2798 func_name = "TRIM" 2799 2800 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]:
2802 def convert_concat_args(self, expression: exp.Concat | exp.ConcatWs) -> t.List[exp.Expression]: 2803 args = expression.expressions 2804 if isinstance(expression, exp.ConcatWs): 2805 args = args[1:] # Skip the delimiter 2806 2807 if self.dialect.STRICT_STRING_CONCAT and expression.args.get("safe"): 2808 args = [exp.cast(e, exp.DataType.Type.TEXT) for e in args] 2809 2810 if not self.dialect.CONCAT_COALESCE and expression.args.get("coalesce"): 2811 args = [exp.func("coalesce", e, exp.Literal.string("")) for e in args] 2812 2813 return args
2815 def concat_sql(self, expression: exp.Concat) -> str: 2816 expressions = self.convert_concat_args(expression) 2817 2818 # Some dialects don't allow a single-argument CONCAT call 2819 if not self.SUPPORTS_SINGLE_ARG_CONCAT and len(expressions) == 1: 2820 return self.sql(expressions[0]) 2821 2822 return self.func("CONCAT", *expressions)
2833 def foreignkey_sql(self, expression: exp.ForeignKey) -> str: 2834 expressions = self.expressions(expression, flat=True) 2835 expressions = f" ({expressions})" if expressions else "" 2836 reference = self.sql(expression, "reference") 2837 reference = f" {reference}" if reference else "" 2838 delete = self.sql(expression, "delete") 2839 delete = f" ON DELETE {delete}" if delete else "" 2840 update = self.sql(expression, "update") 2841 update = f" ON UPDATE {update}" if update else "" 2842 return f"FOREIGN KEY{expressions}{reference}{delete}{update}"
2844 def primarykey_sql(self, expression: exp.ForeignKey) -> str: 2845 expressions = self.expressions(expression, flat=True) 2846 options = self.expressions(expression, key="options", flat=True, sep=" ") 2847 options = f" {options}" if options else "" 2848 return f"PRIMARY KEY ({expressions}){options}"
2861 def jsonpath_sql(self, expression: exp.JSONPath) -> str: 2862 path = self.expressions(expression, sep="", flat=True).lstrip(".") 2863 2864 if expression.args.get("escape"): 2865 path = self.escape_str(path) 2866 2867 if self.QUOTE_JSON_PATH: 2868 path = f"{self.dialect.QUOTE_START}{path}{self.dialect.QUOTE_END}" 2869 2870 return path
2872 def json_path_part(self, expression: int | str | exp.JSONPathPart) -> str: 2873 if isinstance(expression, exp.JSONPathPart): 2874 transform = self.TRANSFORMS.get(expression.__class__) 2875 if not callable(transform): 2876 self.unsupported(f"Unsupported JSONPathPart type {expression.__class__.__name__}") 2877 return "" 2878 2879 return transform(self, expression) 2880 2881 if isinstance(expression, int): 2882 return str(expression) 2883 2884 if self._quote_json_path_key_using_brackets and self.JSON_PATH_SINGLE_QUOTE_ESCAPE: 2885 escaped = expression.replace("'", "\\'") 2886 escaped = f"\\'{expression}\\'" 2887 else: 2888 escaped = expression.replace('"', '\\"') 2889 escaped = f'"{escaped}"' 2890 2891 return escaped
def
jsonobject_sql( self, expression: sqlglot.expressions.JSONObject | sqlglot.expressions.JSONObjectAgg) -> str:
2896 def jsonobject_sql(self, expression: exp.JSONObject | exp.JSONObjectAgg) -> str: 2897 null_handling = expression.args.get("null_handling") 2898 null_handling = f" {null_handling}" if null_handling else "" 2899 2900 unique_keys = expression.args.get("unique_keys") 2901 if unique_keys is not None: 2902 unique_keys = f" {'WITH' if unique_keys else 'WITHOUT'} UNIQUE KEYS" 2903 else: 2904 unique_keys = "" 2905 2906 return_type = self.sql(expression, "return_type") 2907 return_type = f" RETURNING {return_type}" if return_type else "" 2908 encoding = self.sql(expression, "encoding") 2909 encoding = f" ENCODING {encoding}" if encoding else "" 2910 2911 return self.func( 2912 "JSON_OBJECT" if isinstance(expression, exp.JSONObject) else "JSON_OBJECTAGG", 2913 *expression.expressions, 2914 suffix=f"{null_handling}{unique_keys}{return_type}{encoding})", 2915 )
2920 def jsonarray_sql(self, expression: exp.JSONArray) -> str: 2921 null_handling = expression.args.get("null_handling") 2922 null_handling = f" {null_handling}" if null_handling else "" 2923 return_type = self.sql(expression, "return_type") 2924 return_type = f" RETURNING {return_type}" if return_type else "" 2925 strict = " STRICT" if expression.args.get("strict") else "" 2926 return self.func( 2927 "JSON_ARRAY", *expression.expressions, suffix=f"{null_handling}{return_type}{strict})" 2928 )
2930 def jsonarrayagg_sql(self, expression: exp.JSONArrayAgg) -> str: 2931 this = self.sql(expression, "this") 2932 order = self.sql(expression, "order") 2933 null_handling = expression.args.get("null_handling") 2934 null_handling = f" {null_handling}" if null_handling else "" 2935 return_type = self.sql(expression, "return_type") 2936 return_type = f" RETURNING {return_type}" if return_type else "" 2937 strict = " STRICT" if expression.args.get("strict") else "" 2938 return self.func( 2939 "JSON_ARRAYAGG", 2940 this, 2941 suffix=f"{order}{null_handling}{return_type}{strict})", 2942 )
2944 def jsoncolumndef_sql(self, expression: exp.JSONColumnDef) -> str: 2945 path = self.sql(expression, "path") 2946 path = f" PATH {path}" if path else "" 2947 nested_schema = self.sql(expression, "nested_schema") 2948 2949 if nested_schema: 2950 return f"NESTED{path} {nested_schema}" 2951 2952 this = self.sql(expression, "this") 2953 kind = self.sql(expression, "kind") 2954 kind = f" {kind}" if kind else "" 2955 return f"{this}{kind}{path}"
2960 def jsontable_sql(self, expression: exp.JSONTable) -> str: 2961 this = self.sql(expression, "this") 2962 path = self.sql(expression, "path") 2963 path = f", {path}" if path else "" 2964 error_handling = expression.args.get("error_handling") 2965 error_handling = f" {error_handling}" if error_handling else "" 2966 empty_handling = expression.args.get("empty_handling") 2967 empty_handling = f" {empty_handling}" if empty_handling else "" 2968 schema = self.sql(expression, "schema") 2969 return self.func( 2970 "JSON_TABLE", this, suffix=f"{path}{error_handling}{empty_handling} {schema})" 2971 )
2973 def openjsoncolumndef_sql(self, expression: exp.OpenJSONColumnDef) -> str: 2974 this = self.sql(expression, "this") 2975 kind = self.sql(expression, "kind") 2976 path = self.sql(expression, "path") 2977 path = f" {path}" if path else "" 2978 as_json = " AS JSON" if expression.args.get("as_json") else "" 2979 return f"{this} {kind}{path}{as_json}"
2981 def openjson_sql(self, expression: exp.OpenJSON) -> str: 2982 this = self.sql(expression, "this") 2983 path = self.sql(expression, "path") 2984 path = f", {path}" if path else "" 2985 expressions = self.expressions(expression) 2986 with_ = ( 2987 f" WITH ({self.seg(self.indent(expressions), sep='')}{self.seg(')', sep='')}" 2988 if expressions 2989 else "" 2990 ) 2991 return f"OPENJSON({this}{path}){with_}"
2993 def in_sql(self, expression: exp.In) -> str: 2994 query = expression.args.get("query") 2995 unnest = expression.args.get("unnest") 2996 field = expression.args.get("field") 2997 is_global = " GLOBAL" if expression.args.get("is_global") else "" 2998 2999 if query: 3000 in_sql = self.sql(query) 3001 elif unnest: 3002 in_sql = self.in_unnest_op(unnest) 3003 elif field: 3004 in_sql = self.sql(field) 3005 else: 3006 in_sql = f"({self.expressions(expression, flat=True)})" 3007 3008 return f"{self.sql(expression, 'this')}{is_global} IN {in_sql}"
3013 def interval_sql(self, expression: exp.Interval) -> str: 3014 unit = self.sql(expression, "unit") 3015 if not self.INTERVAL_ALLOWS_PLURAL_FORM: 3016 unit = self.TIME_PART_SINGULARS.get(unit, unit) 3017 unit = f" {unit}" if unit else "" 3018 3019 if self.SINGLE_STRING_INTERVAL: 3020 this = expression.this.name if expression.this else "" 3021 return f"INTERVAL '{this}{unit}'" if this else f"INTERVAL{unit}" 3022 3023 this = self.sql(expression, "this") 3024 if this: 3025 unwrapped = isinstance(expression.this, self.UNWRAPPED_INTERVAL_VALUES) 3026 this = f" {this}" if unwrapped else f" ({this})" 3027 3028 return f"INTERVAL{this}{unit}"
3033 def reference_sql(self, expression: exp.Reference) -> str: 3034 this = self.sql(expression, "this") 3035 expressions = self.expressions(expression, flat=True) 3036 expressions = f"({expressions})" if expressions else "" 3037 options = self.expressions(expression, key="options", flat=True, sep=" ") 3038 options = f" {options}" if options else "" 3039 return f"REFERENCES {this}{expressions}{options}"
3041 def anonymous_sql(self, expression: exp.Anonymous) -> str: 3042 # We don't normalize qualified functions such as a.b.foo(), because they can be case-sensitive 3043 parent = expression.parent 3044 is_qualified = isinstance(parent, exp.Dot) and expression is parent.expression 3045 return self.func( 3046 self.sql(expression, "this"), *expression.expressions, normalize=not is_qualified 3047 )
3067 def pivotalias_sql(self, expression: exp.PivotAlias) -> str: 3068 alias = expression.args["alias"] 3069 3070 identifier_alias = isinstance(alias, exp.Identifier) 3071 literal_alias = isinstance(alias, exp.Literal) 3072 3073 if identifier_alias and not self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3074 alias.replace(exp.Literal.string(alias.output_name)) 3075 elif not identifier_alias and literal_alias and self.UNPIVOT_ALIASES_ARE_IDENTIFIERS: 3076 alias.replace(exp.to_identifier(alias.output_name)) 3077 3078 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:
3116 def connector_sql( 3117 self, 3118 expression: exp.Connector, 3119 op: str, 3120 stack: t.Optional[t.List[str | exp.Expression]] = None, 3121 ) -> str: 3122 if stack is not None: 3123 if expression.expressions: 3124 stack.append(self.expressions(expression, sep=f" {op} ")) 3125 else: 3126 stack.append(expression.right) 3127 if expression.comments and self.comments: 3128 for comment in expression.comments: 3129 if comment: 3130 op += f" /*{self.pad_comment(comment)}*/" 3131 stack.extend((op, expression.left)) 3132 return op 3133 3134 stack = [expression] 3135 sqls: t.List[str] = [] 3136 ops = set() 3137 3138 while stack: 3139 node = stack.pop() 3140 if isinstance(node, exp.Connector): 3141 ops.add(getattr(self, f"{node.key}_sql")(node, stack)) 3142 else: 3143 sql = self.sql(node) 3144 if sqls and sqls[-1] in ops: 3145 sqls[-1] += f" {sql}" 3146 else: 3147 sqls.append(sql) 3148 3149 sep = "\n" if self.pretty and self.too_wide(sqls) else " " 3150 return sep.join(sqls)
def
cast_sql( self, expression: sqlglot.expressions.Cast, safe_prefix: Optional[str] = None) -> str:
3170 def cast_sql(self, expression: exp.Cast, safe_prefix: t.Optional[str] = None) -> str: 3171 format_sql = self.sql(expression, "format") 3172 format_sql = f" FORMAT {format_sql}" if format_sql else "" 3173 to_sql = self.sql(expression, "to") 3174 to_sql = f" {to_sql}" if to_sql else "" 3175 action = self.sql(expression, "action") 3176 action = f" {action}" if action else "" 3177 return f"{safe_prefix or ''}CAST({self.sql(expression, 'this')} AS{to_sql}{format_sql}{action})"
3191 def comment_sql(self, expression: exp.Comment) -> str: 3192 this = self.sql(expression, "this") 3193 kind = expression.args["kind"] 3194 materialized = " MATERIALIZED" if expression.args.get("materialized") else "" 3195 exists_sql = " IF EXISTS " if expression.args.get("exists") else " " 3196 expression_sql = self.sql(expression, "expression") 3197 return f"COMMENT{exists_sql}ON{materialized} {kind} {this} IS {expression_sql}"
3199 def mergetreettlaction_sql(self, expression: exp.MergeTreeTTLAction) -> str: 3200 this = self.sql(expression, "this") 3201 delete = " DELETE" if expression.args.get("delete") else "" 3202 recompress = self.sql(expression, "recompress") 3203 recompress = f" RECOMPRESS {recompress}" if recompress else "" 3204 to_disk = self.sql(expression, "to_disk") 3205 to_disk = f" TO DISK {to_disk}" if to_disk else "" 3206 to_volume = self.sql(expression, "to_volume") 3207 to_volume = f" TO VOLUME {to_volume}" if to_volume else "" 3208 return f"{this}{delete}{recompress}{to_disk}{to_volume}"
3210 def mergetreettl_sql(self, expression: exp.MergeTreeTTL) -> str: 3211 where = self.sql(expression, "where") 3212 group = self.sql(expression, "group") 3213 aggregates = self.expressions(expression, key="aggregates") 3214 aggregates = self.seg("SET") + self.seg(aggregates) if aggregates else "" 3215 3216 if not (where or group or aggregates) and len(expression.expressions) == 1: 3217 return f"TTL {self.expressions(expression, flat=True)}" 3218 3219 return f"TTL{self.seg(self.expressions(expression))}{where}{group}{aggregates}"
3236 def altercolumn_sql(self, expression: exp.AlterColumn) -> str: 3237 this = self.sql(expression, "this") 3238 3239 dtype = self.sql(expression, "dtype") 3240 if dtype: 3241 collate = self.sql(expression, "collate") 3242 collate = f" COLLATE {collate}" if collate else "" 3243 using = self.sql(expression, "using") 3244 using = f" USING {using}" if using else "" 3245 return f"ALTER COLUMN {this} SET DATA TYPE {dtype}{collate}{using}" 3246 3247 default = self.sql(expression, "default") 3248 if default: 3249 return f"ALTER COLUMN {this} SET DEFAULT {default}" 3250 3251 comment = self.sql(expression, "comment") 3252 if comment: 3253 return f"ALTER COLUMN {this} COMMENT {comment}" 3254 3255 allow_null = expression.args.get("allow_null") 3256 drop = expression.args.get("drop") 3257 3258 if not drop and not allow_null: 3259 self.unsupported("Unsupported ALTER COLUMN syntax") 3260 3261 if allow_null is not None: 3262 keyword = "DROP" if drop else "SET" 3263 return f"ALTER COLUMN {this} {keyword} NOT NULL" 3264 3265 return f"ALTER COLUMN {this} DROP DEFAULT"
3273 def altersortkey_sql(self, expression: exp.AlterSortKey) -> str: 3274 compound = " COMPOUND" if expression.args.get("compound") else "" 3275 this = self.sql(expression, "this") 3276 expressions = self.expressions(expression, flat=True) 3277 expressions = f"({expressions})" if expressions else "" 3278 return f"ALTER{compound} SORTKEY {this or expressions}"
3280 def alterrename_sql(self, expression: exp.AlterRename) -> str: 3281 if not self.RENAME_TABLE_WITH_DB: 3282 # Remove db from tables 3283 expression = expression.transform( 3284 lambda n: exp.table_(n.this) if isinstance(n, exp.Table) else n 3285 ).assert_is(exp.AlterRename) 3286 this = self.sql(expression, "this") 3287 return f"RENAME TO {this}"
3299 def alter_sql(self, expression: exp.Alter) -> str: 3300 actions = expression.args["actions"] 3301 3302 if isinstance(actions[0], exp.ColumnDef): 3303 actions = self.add_column_sql(expression) 3304 elif isinstance(actions[0], exp.Schema): 3305 actions = self.expressions(expression, key="actions", prefix="ADD COLUMNS ") 3306 elif isinstance(actions[0], exp.Delete): 3307 actions = self.expressions(expression, key="actions", flat=True) 3308 elif isinstance(actions[0], exp.Query): 3309 actions = "AS " + self.expressions(expression, key="actions") 3310 else: 3311 actions = self.expressions(expression, key="actions", flat=True) 3312 3313 exists = " IF EXISTS" if expression.args.get("exists") else "" 3314 on_cluster = self.sql(expression, "cluster") 3315 on_cluster = f" {on_cluster}" if on_cluster else "" 3316 only = " ONLY" if expression.args.get("only") else "" 3317 options = self.expressions(expression, key="options") 3318 options = f", {options}" if options else "" 3319 kind = self.sql(expression, "kind") 3320 not_valid = " NOT VALID" if expression.args.get("not_valid") else "" 3321 3322 return f"ALTER {kind}{exists}{only} {self.sql(expression, 'this')}{on_cluster} {actions}{not_valid}{options}"
3324 def add_column_sql(self, expression: exp.Alter) -> str: 3325 if self.ALTER_TABLE_INCLUDE_COLUMN_KEYWORD: 3326 return self.expressions( 3327 expression, 3328 key="actions", 3329 prefix="ADD COLUMN ", 3330 skip_first=True, 3331 ) 3332 return f"ADD {self.expressions(expression, key='actions', flat=True)}"
3342 def distinct_sql(self, expression: exp.Distinct) -> str: 3343 this = self.expressions(expression, flat=True) 3344 3345 if not self.MULTI_ARG_DISTINCT and len(expression.expressions) > 1: 3346 case = exp.case() 3347 for arg in expression.expressions: 3348 case = case.when(arg.is_(exp.null()), exp.null()) 3349 this = self.sql(case.else_(f"({this})")) 3350 3351 this = f" {this}" if this else "" 3352 3353 on = self.sql(expression, "on") 3354 on = f" ON {on}" if on else "" 3355 return f"DISTINCT{this}{on}"
3384 def div_sql(self, expression: exp.Div) -> str: 3385 l, r = expression.left, expression.right 3386 3387 if not self.dialect.SAFE_DIVISION and expression.args.get("safe"): 3388 r.replace(exp.Nullif(this=r.copy(), expression=exp.Literal.number(0))) 3389 3390 if self.dialect.TYPED_DIVISION and not expression.args.get("typed"): 3391 if not l.is_type(*exp.DataType.REAL_TYPES) and not r.is_type(*exp.DataType.REAL_TYPES): 3392 l.replace(exp.cast(l.copy(), to=exp.DataType.Type.DOUBLE)) 3393 3394 elif not self.dialect.TYPED_DIVISION and expression.args.get("typed"): 3395 if l.is_type(*exp.DataType.INTEGER_TYPES) and r.is_type(*exp.DataType.INTEGER_TYPES): 3396 return self.sql( 3397 exp.cast( 3398 l / r, 3399 to=exp.DataType.Type.BIGINT, 3400 ) 3401 ) 3402 3403 return self.binary(expression, "/")
3491 def log_sql(self, expression: exp.Log) -> str: 3492 this = expression.this 3493 expr = expression.expression 3494 3495 if self.dialect.LOG_BASE_FIRST is False: 3496 this, expr = expr, this 3497 elif self.dialect.LOG_BASE_FIRST is None and expr: 3498 if this.name in ("2", "10"): 3499 return self.func(f"LOG{this.name}", expr) 3500 3501 self.unsupported(f"Unsupported logarithm with base {self.sql(this)}") 3502 3503 return self.func("LOG", this, expr)
3512 def binary(self, expression: exp.Binary, op: str) -> str: 3513 sqls: t.List[str] = [] 3514 stack: t.List[t.Union[str, exp.Expression]] = [expression] 3515 binary_type = type(expression) 3516 3517 while stack: 3518 node = stack.pop() 3519 3520 if type(node) is binary_type: 3521 op_func = node.args.get("operator") 3522 if op_func: 3523 op = f"OPERATOR({self.sql(op_func)})" 3524 3525 stack.append(node.right) 3526 stack.append(f" {self.maybe_comment(op, comments=node.comments)} ") 3527 stack.append(node.left) 3528 else: 3529 sqls.append(self.sql(node)) 3530 3531 return "".join(sqls)
3533 def function_fallback_sql(self, expression: exp.Func) -> str: 3534 args = [] 3535 3536 for key in expression.arg_types: 3537 arg_value = expression.args.get(key) 3538 3539 if isinstance(arg_value, list): 3540 for value in arg_value: 3541 args.append(value) 3542 elif arg_value is not None: 3543 args.append(arg_value) 3544 3545 if self.dialect.PRESERVE_ORIGINAL_NAMES: 3546 name = (expression._meta and expression.meta.get("name")) or expression.sql_name() 3547 else: 3548 name = expression.sql_name() 3549 3550 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:
3552 def func( 3553 self, 3554 name: str, 3555 *args: t.Optional[exp.Expression | str], 3556 prefix: str = "(", 3557 suffix: str = ")", 3558 normalize: bool = True, 3559 ) -> str: 3560 name = self.normalize_func(name) if normalize else name 3561 return f"{name}{prefix}{self.format_args(*args)}{suffix}"
def
format_args( self, *args: Union[str, sqlglot.expressions.Expression, NoneType], sep: str = ', ') -> str:
3563 def format_args(self, *args: t.Optional[str | exp.Expression], sep: str = ", ") -> str: 3564 arg_sqls = tuple( 3565 self.sql(arg) for arg in args if arg is not None and not isinstance(arg, bool) 3566 ) 3567 if self.pretty and self.too_wide(arg_sqls): 3568 return self.indent( 3569 "\n" + f"{sep.strip()}\n".join(arg_sqls) + "\n", skip_first=True, skip_last=True 3570 ) 3571 return sep.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]:
3576 def format_time( 3577 self, 3578 expression: exp.Expression, 3579 inverse_time_mapping: t.Optional[t.Dict[str, str]] = None, 3580 inverse_time_trie: t.Optional[t.Dict] = None, 3581 ) -> t.Optional[str]: 3582 return format_time( 3583 self.sql(expression, "format"), 3584 inverse_time_mapping or self.dialect.INVERSE_TIME_MAPPING, 3585 inverse_time_trie or self.dialect.INVERSE_TIME_TRIE, 3586 )
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:
3588 def expressions( 3589 self, 3590 expression: t.Optional[exp.Expression] = None, 3591 key: t.Optional[str] = None, 3592 sqls: t.Optional[t.Collection[str | exp.Expression]] = None, 3593 flat: bool = False, 3594 indent: bool = True, 3595 skip_first: bool = False, 3596 skip_last: bool = False, 3597 sep: str = ", ", 3598 prefix: str = "", 3599 dynamic: bool = False, 3600 new_line: bool = False, 3601 ) -> str: 3602 expressions = expression.args.get(key or "expressions") if expression else sqls 3603 3604 if not expressions: 3605 return "" 3606 3607 if flat: 3608 return sep.join(sql for sql in (self.sql(e) for e in expressions) if sql) 3609 3610 num_sqls = len(expressions) 3611 result_sqls = [] 3612 3613 for i, e in enumerate(expressions): 3614 sql = self.sql(e, comment=False) 3615 if not sql: 3616 continue 3617 3618 comments = self.maybe_comment("", e) if isinstance(e, exp.Expression) else "" 3619 3620 if self.pretty: 3621 if self.leading_comma: 3622 result_sqls.append(f"{sep if i > 0 else ''}{prefix}{sql}{comments}") 3623 else: 3624 result_sqls.append( 3625 f"{prefix}{sql}{(sep.rstrip() if comments else sep) if i + 1 < num_sqls else ''}{comments}" 3626 ) 3627 else: 3628 result_sqls.append(f"{prefix}{sql}{comments}{sep if i + 1 < num_sqls else ''}") 3629 3630 if self.pretty and (not dynamic or self.too_wide(result_sqls)): 3631 if new_line: 3632 result_sqls.insert(0, "") 3633 result_sqls.append("") 3634 result_sql = "\n".join(s.rstrip() for s in result_sqls) 3635 else: 3636 result_sql = "".join(result_sqls) 3637 3638 return ( 3639 self.indent(result_sql, skip_first=skip_first, skip_last=skip_last) 3640 if indent 3641 else result_sql 3642 )
def
op_expressions( self, op: str, expression: sqlglot.expressions.Expression, flat: bool = False) -> str:
3644 def op_expressions(self, op: str, expression: exp.Expression, flat: bool = False) -> str: 3645 flat = flat or isinstance(expression.parent, exp.Properties) 3646 expressions_sql = self.expressions(expression, flat=flat) 3647 if flat: 3648 return f"{op} {expressions_sql}" 3649 return f"{self.seg(op)}{self.sep() if expressions_sql else ''}{expressions_sql}"
3651 def naked_property(self, expression: exp.Property) -> str: 3652 property_name = exp.Properties.PROPERTY_TO_NAME.get(expression.__class__) 3653 if not property_name: 3654 self.unsupported(f"Unsupported property {expression.__class__.__name__}") 3655 return f"{property_name} {self.sql(expression, 'this')}"
3663 def userdefinedfunction_sql(self, expression: exp.UserDefinedFunction) -> str: 3664 this = self.sql(expression, "this") 3665 expressions = self.no_identify(self.expressions, expression) 3666 expressions = ( 3667 self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}" 3668 ) 3669 return f"{this}{expressions}" if expressions.strip() != "" else this
3679 def when_sql(self, expression: exp.When) -> str: 3680 matched = "MATCHED" if expression.args["matched"] else "NOT MATCHED" 3681 source = " BY SOURCE" if self.MATCHED_BY_SOURCE and expression.args.get("source") else "" 3682 condition = self.sql(expression, "condition") 3683 condition = f" AND {condition}" if condition else "" 3684 3685 then_expression = expression.args.get("then") 3686 if isinstance(then_expression, exp.Insert): 3687 this = self.sql(then_expression, "this") 3688 this = f"INSERT {this}" if this else "INSERT" 3689 then = self.sql(then_expression, "expression") 3690 then = f"{this} VALUES {then}" if then else this 3691 elif isinstance(then_expression, exp.Update): 3692 if isinstance(then_expression.args.get("expressions"), exp.Star): 3693 then = f"UPDATE {self.sql(then_expression, 'expressions')}" 3694 else: 3695 then = f"UPDATE SET {self.expressions(then_expression, flat=True)}" 3696 else: 3697 then = self.sql(then_expression) 3698 return f"WHEN {matched}{source}{condition} THEN {then}"
3703 def merge_sql(self, expression: exp.Merge) -> str: 3704 table = expression.this 3705 table_alias = "" 3706 3707 hints = table.args.get("hints") 3708 if hints and table.alias and isinstance(hints[0], exp.WithTableHint): 3709 # T-SQL syntax is MERGE ... <target_table> [WITH (<merge_hint>)] [[AS] table_alias] 3710 table_alias = f" AS {self.sql(table.args['alias'].pop())}" 3711 3712 this = self.sql(table) 3713 using = f"USING {self.sql(expression, 'using')}" 3714 on = f"ON {self.sql(expression, 'on')}" 3715 whens = self.sql(expression, "whens") 3716 3717 returning = self.sql(expression, "returning") 3718 if returning: 3719 whens = f"{whens}{returning}" 3720 3721 sep = self.sep() 3722 3723 return self.prepend_ctes( 3724 expression, 3725 f"MERGE INTO {this}{table_alias}{sep}{using}{sep}{on}{sep}{whens}", 3726 )
3732 def tonumber_sql(self, expression: exp.ToNumber) -> str: 3733 if not self.SUPPORTS_TO_NUMBER: 3734 self.unsupported("Unsupported TO_NUMBER function") 3735 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3736 3737 fmt = expression.args.get("format") 3738 if not fmt: 3739 self.unsupported("Conversion format is required for TO_NUMBER") 3740 return self.sql(exp.cast(expression.this, exp.DataType.Type.DOUBLE)) 3741 3742 return self.func("TO_NUMBER", expression.this, fmt)
3744 def dictproperty_sql(self, expression: exp.DictProperty) -> str: 3745 this = self.sql(expression, "this") 3746 kind = self.sql(expression, "kind") 3747 settings_sql = self.expressions(expression, key="settings", sep=" ") 3748 args = f"({self.sep('')}{settings_sql}{self.seg(')', sep='')}" if settings_sql else "()" 3749 return f"{this}({kind}{args})"
3768 def distributedbyproperty_sql(self, expression: exp.DistributedByProperty) -> str: 3769 expressions = self.expressions(expression, flat=True) 3770 expressions = f" {self.wrap(expressions)}" if expressions else "" 3771 buckets = self.sql(expression, "buckets") 3772 kind = self.sql(expression, "kind") 3773 buckets = f" BUCKETS {buckets}" if buckets else "" 3774 order = self.sql(expression, "order") 3775 return f"DISTRIBUTED BY {kind}{expressions}{buckets}{order}"
3780 def clusteredbyproperty_sql(self, expression: exp.ClusteredByProperty) -> str: 3781 expressions = self.expressions(expression, key="expressions", flat=True) 3782 sorted_by = self.expressions(expression, key="sorted_by", flat=True) 3783 sorted_by = f" SORTED BY ({sorted_by})" if sorted_by else "" 3784 buckets = self.sql(expression, "buckets") 3785 return f"CLUSTERED BY ({expressions}){sorted_by} INTO {buckets} BUCKETS"
3787 def anyvalue_sql(self, expression: exp.AnyValue) -> str: 3788 this = self.sql(expression, "this") 3789 having = self.sql(expression, "having") 3790 3791 if having: 3792 this = f"{this} HAVING {'MAX' if expression.args.get('max') else 'MIN'} {having}" 3793 3794 return self.func("ANY_VALUE", this)
3796 def querytransform_sql(self, expression: exp.QueryTransform) -> str: 3797 transform = self.func("TRANSFORM", *expression.expressions) 3798 row_format_before = self.sql(expression, "row_format_before") 3799 row_format_before = f" {row_format_before}" if row_format_before else "" 3800 record_writer = self.sql(expression, "record_writer") 3801 record_writer = f" RECORDWRITER {record_writer}" if record_writer else "" 3802 using = f" USING {self.sql(expression, 'command_script')}" 3803 schema = self.sql(expression, "schema") 3804 schema = f" AS {schema}" if schema else "" 3805 row_format_after = self.sql(expression, "row_format_after") 3806 row_format_after = f" {row_format_after}" if row_format_after else "" 3807 record_reader = self.sql(expression, "record_reader") 3808 record_reader = f" RECORDREADER {record_reader}" if record_reader else "" 3809 return f"{transform}{row_format_before}{record_writer}{using}{schema}{row_format_after}{record_reader}"
3811 def indexconstraintoption_sql(self, expression: exp.IndexConstraintOption) -> str: 3812 key_block_size = self.sql(expression, "key_block_size") 3813 if key_block_size: 3814 return f"KEY_BLOCK_SIZE = {key_block_size}" 3815 3816 using = self.sql(expression, "using") 3817 if using: 3818 return f"USING {using}" 3819 3820 parser = self.sql(expression, "parser") 3821 if parser: 3822 return f"WITH PARSER {parser}" 3823 3824 comment = self.sql(expression, "comment") 3825 if comment: 3826 return f"COMMENT {comment}" 3827 3828 visible = expression.args.get("visible") 3829 if visible is not None: 3830 return "VISIBLE" if visible else "INVISIBLE" 3831 3832 engine_attr = self.sql(expression, "engine_attr") 3833 if engine_attr: 3834 return f"ENGINE_ATTRIBUTE = {engine_attr}" 3835 3836 secondary_engine_attr = self.sql(expression, "secondary_engine_attr") 3837 if secondary_engine_attr: 3838 return f"SECONDARY_ENGINE_ATTRIBUTE = {secondary_engine_attr}" 3839 3840 self.unsupported("Unsupported index constraint option.") 3841 return ""
3847 def indexcolumnconstraint_sql(self, expression: exp.IndexColumnConstraint) -> str: 3848 kind = self.sql(expression, "kind") 3849 kind = f"{kind} INDEX" if kind else "INDEX" 3850 this = self.sql(expression, "this") 3851 this = f" {this}" if this else "" 3852 index_type = self.sql(expression, "index_type") 3853 index_type = f" USING {index_type}" if index_type else "" 3854 expressions = self.expressions(expression, flat=True) 3855 expressions = f" ({expressions})" if expressions else "" 3856 options = self.expressions(expression, key="options", sep=" ") 3857 options = f" {options}" if options else "" 3858 return f"{kind}{this}{index_type}{expressions}{options}"
3860 def nvl2_sql(self, expression: exp.Nvl2) -> str: 3861 if self.NVL2_SUPPORTED: 3862 return self.function_fallback_sql(expression) 3863 3864 case = exp.Case().when( 3865 expression.this.is_(exp.null()).not_(copy=False), 3866 expression.args["true"], 3867 copy=False, 3868 ) 3869 else_cond = expression.args.get("false") 3870 if else_cond: 3871 case.else_(else_cond, copy=False) 3872 3873 return self.sql(case)
3875 def comprehension_sql(self, expression: exp.Comprehension) -> str: 3876 this = self.sql(expression, "this") 3877 expr = self.sql(expression, "expression") 3878 iterator = self.sql(expression, "iterator") 3879 condition = self.sql(expression, "condition") 3880 condition = f" IF {condition}" if condition else "" 3881 return f"{this} FOR {expr} IN {iterator}{condition}"
3889 def predict_sql(self, expression: exp.Predict) -> str: 3890 model = self.sql(expression, "this") 3891 model = f"MODEL {model}" 3892 table = self.sql(expression, "expression") 3893 table = f"TABLE {table}" if not isinstance(expression.expression, exp.Subquery) else table 3894 parameters = self.sql(expression, "params_struct") 3895 return self.func("PREDICT", model, table, parameters or None)
3907 def toarray_sql(self, expression: exp.ToArray) -> str: 3908 arg = expression.this 3909 if not arg.type: 3910 from sqlglot.optimizer.annotate_types import annotate_types 3911 3912 arg = annotate_types(arg) 3913 3914 if arg.is_type(exp.DataType.Type.ARRAY): 3915 return self.sql(arg) 3916 3917 cond_for_null = arg.is_(exp.null()) 3918 return self.sql(exp.func("IF", cond_for_null, exp.null(), exp.array(arg, copy=False)))
3927 def tsordstotimestamp_sql(self, expression: exp.TsOrDsToTimestamp) -> str: 3928 this = expression.this 3929 if isinstance(this, exp.TsOrDsToTimestamp) or this.is_type(exp.DataType.Type.TIMESTAMP): 3930 return self.sql(this) 3931 3932 return self.sql(exp.cast(this, exp.DataType.Type.TIMESTAMP, dialect=self.dialect))
3934 def tsordstodatetime_sql(self, expression: exp.TsOrDsToDatetime) -> str: 3935 this = expression.this 3936 if isinstance(this, exp.TsOrDsToDatetime) or this.is_type(exp.DataType.Type.DATETIME): 3937 return self.sql(this) 3938 3939 return self.sql(exp.cast(this, exp.DataType.Type.DATETIME, dialect=self.dialect))
3941 def tsordstodate_sql(self, expression: exp.TsOrDsToDate) -> str: 3942 this = expression.this 3943 time_format = self.format_time(expression) 3944 3945 if time_format and time_format not in (self.dialect.TIME_FORMAT, self.dialect.DATE_FORMAT): 3946 return self.sql( 3947 exp.cast( 3948 exp.StrToTime(this=this, format=expression.args["format"]), 3949 exp.DataType.Type.DATE, 3950 ) 3951 ) 3952 3953 if isinstance(this, exp.TsOrDsToDate) or this.is_type(exp.DataType.Type.DATE): 3954 return self.sql(this) 3955 3956 return self.sql(exp.cast(this, exp.DataType.Type.DATE))
3968 def lastday_sql(self, expression: exp.LastDay) -> str: 3969 if self.LAST_DAY_SUPPORTS_DATE_PART: 3970 return self.function_fallback_sql(expression) 3971 3972 unit = expression.text("unit") 3973 if unit and unit != "MONTH": 3974 self.unsupported("Date parts are not supported in LAST_DAY.") 3975 3976 return self.func("LAST_DAY", expression.this)
3985 def arrayany_sql(self, expression: exp.ArrayAny) -> str: 3986 if self.CAN_IMPLEMENT_ARRAY_ANY: 3987 filtered = exp.ArrayFilter(this=expression.this, expression=expression.expression) 3988 filtered_not_empty = exp.ArraySize(this=filtered).neq(0) 3989 original_is_empty = exp.ArraySize(this=expression.this).eq(0) 3990 return self.sql(exp.paren(original_is_empty.or_(filtered_not_empty))) 3991 3992 from sqlglot.dialects import Dialect 3993 3994 # SQLGlot's executor supports ARRAY_ANY, so we don't wanna warn for the SQLGlot dialect 3995 if self.dialect.__class__ != Dialect: 3996 self.unsupported("ARRAY_ANY is unsupported") 3997 3998 return self.function_fallback_sql(expression)
4000 def struct_sql(self, expression: exp.Struct) -> str: 4001 expression.set( 4002 "expressions", 4003 [ 4004 exp.alias_(e.expression, e.name if e.this.is_string else e.this) 4005 if isinstance(e, exp.PropertyEQ) 4006 else e 4007 for e in expression.expressions 4008 ], 4009 ) 4010 4011 return self.function_fallback_sql(expression)
4019 def truncatetable_sql(self, expression: exp.TruncateTable) -> str: 4020 target = "DATABASE" if expression.args.get("is_database") else "TABLE" 4021 tables = f" {self.expressions(expression)}" 4022 4023 exists = " IF EXISTS" if expression.args.get("exists") else "" 4024 4025 on_cluster = self.sql(expression, "cluster") 4026 on_cluster = f" {on_cluster}" if on_cluster else "" 4027 4028 identity = self.sql(expression, "identity") 4029 identity = f" {identity} IDENTITY" if identity else "" 4030 4031 option = self.sql(expression, "option") 4032 option = f" {option}" if option else "" 4033 4034 partition = self.sql(expression, "partition") 4035 partition = f" {partition}" if partition else "" 4036 4037 return f"TRUNCATE {target}{exists}{tables}{on_cluster}{identity}{option}{partition}"
4041 def convert_sql(self, expression: exp.Convert) -> str: 4042 to = expression.this 4043 value = expression.expression 4044 style = expression.args.get("style") 4045 safe = expression.args.get("safe") 4046 strict = expression.args.get("strict") 4047 4048 if not to or not value: 4049 return "" 4050 4051 # Retrieve length of datatype and override to default if not specified 4052 if not seq_get(to.expressions, 0) and to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4053 to = exp.DataType.build(to.this, expressions=[exp.Literal.number(30)], nested=False) 4054 4055 transformed: t.Optional[exp.Expression] = None 4056 cast = exp.Cast if strict else exp.TryCast 4057 4058 # Check whether a conversion with format (T-SQL calls this 'style') is applicable 4059 if isinstance(style, exp.Literal) and style.is_int: 4060 from sqlglot.dialects.tsql import TSQL 4061 4062 style_value = style.name 4063 converted_style = TSQL.CONVERT_FORMAT_MAPPING.get(style_value) 4064 if not converted_style: 4065 self.unsupported(f"Unsupported T-SQL 'style' value: {style_value}") 4066 4067 fmt = exp.Literal.string(converted_style) 4068 4069 if to.this == exp.DataType.Type.DATE: 4070 transformed = exp.StrToDate(this=value, format=fmt) 4071 elif to.this in (exp.DataType.Type.DATETIME, exp.DataType.Type.DATETIME2): 4072 transformed = exp.StrToTime(this=value, format=fmt) 4073 elif to.this in self.PARAMETERIZABLE_TEXT_TYPES: 4074 transformed = cast(this=exp.TimeToStr(this=value, format=fmt), to=to, safe=safe) 4075 elif to.this == exp.DataType.Type.TEXT: 4076 transformed = exp.TimeToStr(this=value, format=fmt) 4077 4078 if not transformed: 4079 transformed = cast(this=value, to=to, safe=safe) 4080 4081 return self.sql(transformed)
4141 def copyparameter_sql(self, expression: exp.CopyParameter) -> str: 4142 option = self.sql(expression, "this") 4143 4144 if expression.expressions: 4145 upper = option.upper() 4146 4147 # Snowflake FILE_FORMAT options are separated by whitespace 4148 sep = " " if upper == "FILE_FORMAT" else ", " 4149 4150 # Databricks copy/format options do not set their list of values with EQ 4151 op = " " if upper in ("COPY_OPTIONS", "FORMAT_OPTIONS") else " = " 4152 values = self.expressions(expression, flat=True, sep=sep) 4153 return f"{option}{op}({values})" 4154 4155 value = self.sql(expression, "expression") 4156 4157 if not value: 4158 return option 4159 4160 op = " = " if self.COPY_PARAMS_EQ_REQUIRED else " " 4161 4162 return f"{option}{op}{value}"
4164 def credentials_sql(self, expression: exp.Credentials) -> str: 4165 cred_expr = expression.args.get("credentials") 4166 if isinstance(cred_expr, exp.Literal): 4167 # Redshift case: CREDENTIALS <string> 4168 credentials = self.sql(expression, "credentials") 4169 credentials = f"CREDENTIALS {credentials}" if credentials else "" 4170 else: 4171 # Snowflake case: CREDENTIALS = (...) 4172 credentials = self.expressions(expression, key="credentials", flat=True, sep=" ") 4173 credentials = f"CREDENTIALS = ({credentials})" if cred_expr is not None else "" 4174 4175 storage = self.sql(expression, "storage") 4176 storage = f"STORAGE_INTEGRATION = {storage}" if storage else "" 4177 4178 encryption = self.expressions(expression, key="encryption", flat=True, sep=" ") 4179 encryption = f" ENCRYPTION = ({encryption})" if encryption else "" 4180 4181 iam_role = self.sql(expression, "iam_role") 4182 iam_role = f"IAM_ROLE {iam_role}" if iam_role else "" 4183 4184 region = self.sql(expression, "region") 4185 region = f" REGION {region}" if region else "" 4186 4187 return f"{credentials}{storage}{encryption}{iam_role}{region}"
4189 def copy_sql(self, expression: exp.Copy) -> str: 4190 this = self.sql(expression, "this") 4191 this = f" INTO {this}" if self.COPY_HAS_INTO_KEYWORD else f" {this}" 4192 4193 credentials = self.sql(expression, "credentials") 4194 credentials = self.seg(credentials) if credentials else "" 4195 kind = self.seg("FROM" if expression.args.get("kind") else "TO") 4196 files = self.expressions(expression, key="files", flat=True) 4197 4198 sep = ", " if self.dialect.COPY_PARAMS_ARE_CSV else " " 4199 params = self.expressions( 4200 expression, 4201 key="params", 4202 sep=sep, 4203 new_line=True, 4204 skip_last=True, 4205 skip_first=True, 4206 indent=self.COPY_PARAMS_ARE_WRAPPED, 4207 ) 4208 4209 if params: 4210 if self.COPY_PARAMS_ARE_WRAPPED: 4211 params = f" WITH ({params})" 4212 elif not self.pretty: 4213 params = f" {params}" 4214 4215 return f"COPY{this}{kind} {files}{credentials}{params}"
4220 def datadeletionproperty_sql(self, expression: exp.DataDeletionProperty) -> str: 4221 on_sql = "ON" if expression.args.get("on") else "OFF" 4222 filter_col: t.Optional[str] = self.sql(expression, "filter_column") 4223 filter_col = f"FILTER_COLUMN={filter_col}" if filter_col else None 4224 retention_period: t.Optional[str] = self.sql(expression, "retention_period") 4225 retention_period = f"RETENTION_PERIOD={retention_period}" if retention_period else None 4226 4227 if filter_col or retention_period: 4228 on_sql = self.func("ON", filter_col, retention_period) 4229 4230 return f"DATA_DELETION={on_sql}"
def
maskingpolicycolumnconstraint_sql( self, expression: sqlglot.expressions.MaskingPolicyColumnConstraint) -> str:
4232 def maskingpolicycolumnconstraint_sql( 4233 self, expression: exp.MaskingPolicyColumnConstraint 4234 ) -> str: 4235 this = self.sql(expression, "this") 4236 expressions = self.expressions(expression, flat=True) 4237 expressions = f" USING ({expressions})" if expressions else "" 4238 return f"MASKING POLICY {this}{expressions}"
4248 def scoperesolution_sql(self, expression: exp.ScopeResolution) -> str: 4249 this = self.sql(expression, "this") 4250 expr = expression.expression 4251 4252 if isinstance(expr, exp.Func): 4253 # T-SQL's CLR functions are case sensitive 4254 expr = f"{self.sql(expr, 'this')}({self.format_args(*expr.expressions)})" 4255 else: 4256 expr = self.sql(expression, "expression") 4257 4258 return self.scope_resolution(expr, this)
4266 def rand_sql(self, expression: exp.Rand) -> str: 4267 lower = self.sql(expression, "lower") 4268 upper = self.sql(expression, "upper") 4269 4270 if lower and upper: 4271 return f"({upper} - {lower}) * {self.func('RAND', expression.this)} + {lower}" 4272 return self.func("RAND", expression.this)
4274 def changes_sql(self, expression: exp.Changes) -> str: 4275 information = self.sql(expression, "information") 4276 information = f"INFORMATION => {information}" 4277 at_before = self.sql(expression, "at_before") 4278 at_before = f"{self.seg('')}{at_before}" if at_before else "" 4279 end = self.sql(expression, "end") 4280 end = f"{self.seg('')}{end}" if end else "" 4281 4282 return f"CHANGES ({information}){at_before}{end}"
4284 def pad_sql(self, expression: exp.Pad) -> str: 4285 prefix = "L" if expression.args.get("is_left") else "R" 4286 4287 fill_pattern = self.sql(expression, "fill_pattern") or None 4288 if not fill_pattern and self.PAD_FILL_PATTERN_IS_REQUIRED: 4289 fill_pattern = "' '" 4290 4291 return self.func(f"{prefix}PAD", expression.this, expression.expression, fill_pattern)
def
explodinggenerateseries_sql(self, expression: sqlglot.expressions.ExplodingGenerateSeries) -> str:
4297 def explodinggenerateseries_sql(self, expression: exp.ExplodingGenerateSeries) -> str: 4298 generate_series = exp.GenerateSeries(**expression.args) 4299 4300 parent = expression.parent 4301 if isinstance(parent, (exp.Alias, exp.TableAlias)): 4302 parent = parent.parent 4303 4304 if self.SUPPORTS_EXPLODING_PROJECTIONS and not isinstance(parent, (exp.Table, exp.Unnest)): 4305 return self.sql(exp.Unnest(expressions=[generate_series])) 4306 4307 if isinstance(parent, exp.Select): 4308 self.unsupported("GenerateSeries projection unnesting is not supported.") 4309 4310 return self.sql(generate_series)
def
arrayconcat_sql( self, expression: sqlglot.expressions.ArrayConcat, name: str = 'ARRAY_CONCAT') -> str:
4312 def arrayconcat_sql(self, expression: exp.ArrayConcat, name: str = "ARRAY_CONCAT") -> str: 4313 exprs = expression.expressions 4314 if not self.ARRAY_CONCAT_IS_VAR_LEN: 4315 rhs = reduce(lambda x, y: exp.ArrayConcat(this=x, expressions=[y]), exprs) 4316 else: 4317 rhs = self.expressions(expression) 4318 4319 return self.func(name, expression.this, rhs or None)
4321 def converttimezone_sql(self, expression: exp.ConvertTimezone) -> str: 4322 if self.SUPPORTS_CONVERT_TIMEZONE: 4323 return self.function_fallback_sql(expression) 4324 4325 source_tz = expression.args.get("source_tz") 4326 target_tz = expression.args.get("target_tz") 4327 timestamp = expression.args.get("timestamp") 4328 4329 if source_tz and timestamp: 4330 timestamp = exp.AtTimeZone( 4331 this=exp.cast(timestamp, exp.DataType.Type.TIMESTAMPNTZ), zone=source_tz 4332 ) 4333 4334 expr = exp.AtTimeZone(this=timestamp, zone=target_tz) 4335 4336 return self.sql(expr)
4338 def json_sql(self, expression: exp.JSON) -> str: 4339 this = self.sql(expression, "this") 4340 this = f" {this}" if this else "" 4341 4342 _with = expression.args.get("with") 4343 4344 if _with is None: 4345 with_sql = "" 4346 elif not _with: 4347 with_sql = " WITHOUT" 4348 else: 4349 with_sql = " WITH" 4350 4351 unique_sql = " UNIQUE KEYS" if expression.args.get("unique") else "" 4352 4353 return f"JSON{this}{with_sql}{unique_sql}"
4355 def jsonvalue_sql(self, expression: exp.JSONValue) -> str: 4356 def _generate_on_options(arg: t.Any) -> str: 4357 return arg if isinstance(arg, str) else f"DEFAULT {self.sql(arg)}" 4358 4359 path = self.sql(expression, "path") 4360 returning = self.sql(expression, "returning") 4361 returning = f" RETURNING {returning}" if returning else "" 4362 4363 on_condition = self.sql(expression, "on_condition") 4364 on_condition = f" {on_condition}" if on_condition else "" 4365 4366 return self.func("JSON_VALUE", expression.this, f"{path}{returning}{on_condition}")
4368 def conditionalinsert_sql(self, expression: exp.ConditionalInsert) -> str: 4369 else_ = "ELSE " if expression.args.get("else_") else "" 4370 condition = self.sql(expression, "expression") 4371 condition = f"WHEN {condition} THEN " if condition else else_ 4372 insert = self.sql(expression, "this")[len("INSERT") :].strip() 4373 return f"{condition}{insert}"
4381 def oncondition_sql(self, expression: exp.OnCondition) -> str: 4382 # Static options like "NULL ON ERROR" are stored as strings, in contrast to "DEFAULT <expr> ON ERROR" 4383 empty = expression.args.get("empty") 4384 empty = ( 4385 f"DEFAULT {empty} ON EMPTY" 4386 if isinstance(empty, exp.Expression) 4387 else self.sql(expression, "empty") 4388 ) 4389 4390 error = expression.args.get("error") 4391 error = ( 4392 f"DEFAULT {error} ON ERROR" 4393 if isinstance(error, exp.Expression) 4394 else self.sql(expression, "error") 4395 ) 4396 4397 if error and empty: 4398 error = ( 4399 f"{empty} {error}" 4400 if self.dialect.ON_CONDITION_EMPTY_BEFORE_ERROR 4401 else f"{error} {empty}" 4402 ) 4403 empty = "" 4404 4405 null = self.sql(expression, "null") 4406 4407 return f"{empty}{error}{null}"
4409 def jsonexists_sql(self, expression: exp.JSONExists) -> str: 4410 this = self.sql(expression, "this") 4411 path = self.sql(expression, "path") 4412 4413 passing = self.expressions(expression, "passing") 4414 passing = f" PASSING {passing}" if passing else "" 4415 4416 on_condition = self.sql(expression, "on_condition") 4417 on_condition = f" {on_condition}" if on_condition else "" 4418 4419 path = f"{path}{passing}{on_condition}" 4420 4421 return self.func("JSON_EXISTS", this, path)
4423 def arrayagg_sql(self, expression: exp.ArrayAgg) -> str: 4424 array_agg = self.function_fallback_sql(expression) 4425 4426 # Add a NULL FILTER on the column to mimic the results going from a dialect that excludes nulls 4427 # on ARRAY_AGG (e.g Spark) to one that doesn't (e.g. DuckDB) 4428 if self.dialect.ARRAY_AGG_INCLUDES_NULLS and expression.args.get("nulls_excluded"): 4429 parent = expression.parent 4430 if isinstance(parent, exp.Filter): 4431 parent_cond = parent.expression.this 4432 parent_cond.replace(parent_cond.and_(expression.this.is_(exp.null()).not_())) 4433 else: 4434 this = expression.this 4435 # Do not add the filter if the input is not a column (e.g. literal, struct etc) 4436 if this.find(exp.Column): 4437 # DISTINCT is already present in the agg function, do not propagate it to FILTER as well 4438 this_sql = ( 4439 self.expressions(this) 4440 if isinstance(this, exp.Distinct) 4441 else self.sql(expression, "this") 4442 ) 4443 4444 array_agg = f"{array_agg} FILTER(WHERE {this_sql} IS NOT NULL)" 4445 4446 return array_agg
4454 def grant_sql(self, expression: exp.Grant) -> str: 4455 privileges_sql = self.expressions(expression, key="privileges", flat=True) 4456 4457 kind = self.sql(expression, "kind") 4458 kind = f" {kind}" if kind else "" 4459 4460 securable = self.sql(expression, "securable") 4461 securable = f" {securable}" if securable else "" 4462 4463 principals = self.expressions(expression, key="principals", flat=True) 4464 4465 grant_option = " WITH GRANT OPTION" if expression.args.get("grant_option") else "" 4466 4467 return f"GRANT {privileges_sql} ON{kind}{securable} TO {principals}{grant_option}"
4491 def overlay_sql(self, expression: exp.Overlay): 4492 this = self.sql(expression, "this") 4493 expr = self.sql(expression, "expression") 4494 from_sql = self.sql(expression, "from") 4495 for_sql = self.sql(expression, "for") 4496 for_sql = f" FOR {for_sql}" if for_sql else "" 4497 4498 return f"OVERLAY({this} PLACING {expr} FROM {from_sql}{for_sql})"
@unsupported_args('format')
def
todouble_sql(self, expression: sqlglot.expressions.ToDouble) -> str:
4504 def string_sql(self, expression: exp.String) -> str: 4505 this = expression.this 4506 zone = expression.args.get("zone") 4507 4508 if zone: 4509 # This is a BigQuery specific argument for STRING(<timestamp_expr>, <time_zone>) 4510 # BigQuery stores timestamps internally as UTC, so ConvertTimezone is used with UTC 4511 # set for source_tz to transpile the time conversion before the STRING cast 4512 this = exp.ConvertTimezone( 4513 source_tz=exp.Literal.string("UTC"), target_tz=zone, timestamp=this 4514 ) 4515 4516 return self.sql(exp.cast(this, exp.DataType.Type.VARCHAR))
def
overflowtruncatebehavior_sql(self, expression: sqlglot.expressions.OverflowTruncateBehavior) -> str:
4526 def overflowtruncatebehavior_sql(self, expression: exp.OverflowTruncateBehavior) -> str: 4527 filler = self.sql(expression, "this") 4528 filler = f" {filler}" if filler else "" 4529 with_count = "WITH COUNT" if expression.args.get("with_count") else "WITHOUT COUNT" 4530 return f"TRUNCATE{filler} {with_count}"
4532 def unixseconds_sql(self, expression: exp.UnixSeconds) -> str: 4533 if self.SUPPORTS_UNIX_SECONDS: 4534 return self.function_fallback_sql(expression) 4535 4536 start_ts = exp.cast( 4537 exp.Literal.string("1970-01-01 00:00:00+00"), to=exp.DataType.Type.TIMESTAMPTZ 4538 ) 4539 4540 return self.sql( 4541 exp.TimestampDiff(this=expression.this, expression=start_ts, unit=exp.var("SECONDS")) 4542 )
4544 def arraysize_sql(self, expression: exp.ArraySize) -> str: 4545 dim = expression.expression 4546 4547 # For dialects that don't support the dimension arg, we can safely transpile it's default value (1st dimension) 4548 if dim and self.ARRAY_SIZE_DIM_REQUIRED is None: 4549 if not (dim.is_int and dim.name == "1"): 4550 self.unsupported("Cannot transpile dimension argument for ARRAY_LENGTH") 4551 dim = None 4552 4553 # If dimension is required but not specified, default initialize it 4554 if self.ARRAY_SIZE_DIM_REQUIRED and not dim: 4555 dim = exp.Literal.number(1) 4556 4557 return self.func(self.ARRAY_SIZE_NAME, expression.this, dim)
4559 def attach_sql(self, expression: exp.Attach) -> str: 4560 this = self.sql(expression, "this") 4561 exists_sql = " IF NOT EXISTS" if expression.args.get("exists") else "" 4562 expressions = self.expressions(expression) 4563 expressions = f" ({expressions})" if expressions else "" 4564 4565 return f"ATTACH{exists_sql} {this}{expressions}"
4579 def featuresattime_sql(self, expression: exp.FeaturesAtTime) -> str: 4580 this_sql = self.sql(expression, "this") 4581 if isinstance(expression.this, exp.Table): 4582 this_sql = f"TABLE {this_sql}" 4583 4584 return self.func( 4585 "FEATURES_AT_TIME", 4586 this_sql, 4587 expression.args.get("time"), 4588 expression.args.get("num_rows"), 4589 expression.args.get("ignore_feature_nulls"), 4590 )
def
watermarkcolumnconstraint_sql(self, expression: sqlglot.expressions.WatermarkColumnConstraint) -> str:
4597 def encodeproperty_sql(self, expression: exp.EncodeProperty) -> str: 4598 encode = "KEY ENCODE" if expression.args.get("key") else "ENCODE" 4599 encode = f"{encode} {self.sql(expression, 'this')}" 4600 4601 properties = expression.args.get("properties") 4602 if properties: 4603 encode = f"{encode} {self.properties(properties)}" 4604 4605 return encode
4607 def includeproperty_sql(self, expression: exp.IncludeProperty) -> str: 4608 this = self.sql(expression, "this") 4609 include = f"INCLUDE {this}" 4610 4611 column_def = self.sql(expression, "column_def") 4612 if column_def: 4613 include = f"{include} {column_def}" 4614 4615 alias = self.sql(expression, "alias") 4616 if alias: 4617 include = f"{include} AS {alias}" 4618 4619 return include
def
partitionbyrangeproperty_sql(self, expression: sqlglot.expressions.PartitionByRangeProperty) -> str:
4625 def partitionbyrangeproperty_sql(self, expression: exp.PartitionByRangeProperty) -> str: 4626 partitions = self.expressions(expression, "partition_expressions") 4627 create = self.expressions(expression, "create_expressions") 4628 return f"PARTITION BY RANGE {self.wrap(partitions)} {self.wrap(create)}"
def
partitionbyrangepropertydynamic_sql( self, expression: sqlglot.expressions.PartitionByRangePropertyDynamic) -> str:
4630 def partitionbyrangepropertydynamic_sql( 4631 self, expression: exp.PartitionByRangePropertyDynamic 4632 ) -> str: 4633 start = self.sql(expression, "start") 4634 end = self.sql(expression, "end") 4635 4636 every = expression.args["every"] 4637 if isinstance(every, exp.Interval) and every.this.is_string: 4638 every.this.replace(exp.Literal.number(every.name)) 4639 4640 return f"START {self.wrap(start)} END {self.wrap(end)} EVERY {self.wrap(self.sql(every))}"