Edit on GitHub

sqlglot.generators.tsql

  1from __future__ import annotations
  2
  3from functools import reduce
  4
  5from sqlglot import exp, generator, transforms
  6from sqlglot.dialects.dialect import (
  7    any_value_to_max_sql,
  8    date_delta_sql,
  9    datestrtodate_sql,
 10    generatedasidentitycolumnconstraint_sql,
 11    max_or_greatest,
 12    min_or_least,
 13    rename_func,
 14    strposition_sql,
 15    timestrtotime_sql,
 16    trim_sql,
 17)
 18from sqlglot.helper import seq_get
 19from sqlglot.parsers.tsql import OPTIONS_THAT_REQUIRE_EQUAL
 20from sqlglot.time import format_time
 21from collections import defaultdict
 22
 23DATE_PART_UNMAPPING = {
 24    "WEEKISO": "ISO_WEEK",
 25    "DAYOFWEEK": "WEEKDAY",
 26    "TIMEZONE_MINUTE": "TZOFFSET",
 27}
 28
 29BIT_TYPES = {exp.EQ, exp.NEQ, exp.Is, exp.In, exp.Select, exp.Alias}
 30
 31
 32def _format_sql(self: TSQLGenerator, expression: exp.NumberToStr | exp.TimeToStr) -> str:
 33    fmt = expression.args["format"]
 34
 35    if not isinstance(expression, exp.NumberToStr):
 36        if fmt.is_string:
 37            from sqlglot.dialects.tsql import TSQL
 38
 39            mapped_fmt = format_time(fmt.name, TSQL.INVERSE_TIME_MAPPING)
 40            fmt_sql = self.sql(exp.Literal.string(mapped_fmt))
 41        else:
 42            fmt_sql = self.format_time(expression) or self.sql(fmt)
 43    else:
 44        fmt_sql = self.sql(fmt)
 45
 46    return self.func("FORMAT", expression.this, fmt_sql, expression.args.get("culture"))
 47
 48
 49def _string_agg_sql(self: TSQLGenerator, expression: exp.GroupConcat) -> str:
 50    this = expression.this
 51    distinct = expression.find(exp.Distinct)
 52    if distinct:
 53        # exp.Distinct can appear below an exp.Order or an exp.GroupConcat expression
 54        self.unsupported("T-SQL STRING_AGG doesn't support DISTINCT.")
 55        this = distinct.pop().expressions[0]
 56
 57    order = ""
 58    if isinstance(expression.this, exp.Order):
 59        if expression.this.this:
 60            this = expression.this.this.pop()
 61        # Order has a leading space
 62        order = f" WITHIN GROUP ({self.sql(expression.this)[1:]})"
 63
 64    separator = expression.args.get("separator") or exp.Literal.string(",")
 65    return f"STRING_AGG({self.format_args(this, separator)}){order}"
 66
 67
 68def qualify_derived_table_outputs(expression: exp.Expr) -> exp.Expr:
 69    """Ensures all (unnamed) output columns are aliased for CTEs and Subqueries."""
 70    alias = expression.args.get("alias")
 71
 72    if (
 73        isinstance(expression, (exp.CTE, exp.Subquery))
 74        and isinstance(alias, exp.TableAlias)
 75        and not alias.columns
 76    ):
 77        from sqlglot.optimizer.qualify_columns import qualify_outputs
 78
 79        # We keep track of the unaliased column projection indexes instead of the expressions
 80        # themselves, because the latter are going to be replaced by new nodes when the aliases
 81        # are added and hence we won't be able to reach these newly added Alias parents
 82        query = expression.this
 83        unaliased_column_indexes = (
 84            i for i, c in enumerate(query.selects) if isinstance(c, exp.Column) and not c.alias
 85        )
 86
 87        qualify_outputs(query)
 88
 89        # Preserve the quoting information of columns for newly added Alias nodes
 90        query_selects = query.selects
 91        for select_index in unaliased_column_indexes:
 92            alias = query_selects[select_index]
 93            column = alias.this
 94            if isinstance(column.this, exp.Identifier):
 95                alias.args["alias"].set("quoted", column.this.quoted)
 96
 97    return expression
 98
 99
100def _json_extract_sql(
101    self: TSQLGenerator, expression: exp.JSONExtract | exp.JSONExtractScalar
102) -> str:
103    json_query = self.func("JSON_QUERY", expression.this, expression.expression)
104    json_value = self.func("JSON_VALUE", expression.this, expression.expression)
105    return self.func("ISNULL", json_query, json_value)
106
107
108def _timestrtotime_sql(self: TSQLGenerator, expression: exp.TimeStrToTime):
109    sql = timestrtotime_sql(self, expression)
110    if expression.args.get("zone"):
111        # If there is a timezone, produce an expression like:
112        # CAST('2020-01-01 12:13:14-08:00' AS DATETIMEOFFSET) AT TIME ZONE 'UTC'
113        # If you dont have AT TIME ZONE 'UTC', wrapping that expression in another cast back to DATETIME2 just drops the timezone information
114        return self.sql(exp.AtTimeZone(this=sql, zone=exp.Literal.string("UTC")))
115    return sql
116
117
118class TSQLGenerator(generator.Generator):
119    SELECT_KINDS: tuple[str, ...] = ()
120    TRY_SUPPORTED = False
121    SUPPORTS_UESCAPE = False
122    SUPPORTS_DECODE_CASE = False
123
124    AFTER_HAVING_MODIFIER_TRANSFORMS = generator.AFTER_HAVING_MODIFIER_TRANSFORMS
125
126    LIMIT_IS_TOP = True
127    QUERY_HINTS = False
128    RETURNING_END = False
129    NVL2_SUPPORTED = False
130    ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = False
131    LIMIT_FETCH = "FETCH"
132    COMPUTED_COLUMN_WITH_TYPE = False
133    CTE_RECURSIVE_KEYWORD_REQUIRED = False
134    ENSURE_BOOLS = True
135    NULL_ORDERING_SUPPORTED: bool | None = None
136    SUPPORTS_SINGLE_ARG_CONCAT = False
137    TABLESAMPLE_SEED_KEYWORD = "REPEATABLE"
138    SUPPORTS_SELECT_INTO = True
139    JSON_PATH_BRACKETED_KEY_SUPPORTED = False
140    SUPPORTS_TO_NUMBER = False
141    SET_OP_MODIFIERS = False
142    COPY_PARAMS_EQ_REQUIRED = True
143    PARSE_JSON_NAME: str | None = None
144    EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = False
145    ALTER_SET_WRAPPED = True
146    ALTER_SET_TYPE = ""
147
148    EXPRESSIONS_WITHOUT_NESTED_CTES = {
149        exp.Create,
150        exp.Delete,
151        exp.Insert,
152        exp.Intersect,
153        exp.Except,
154        exp.Merge,
155        exp.Select,
156        exp.Subquery,
157        exp.Union,
158        exp.Update,
159    }
160
161    SUPPORTED_JSON_PATH_PARTS = {
162        exp.JSONPathKey,
163        exp.JSONPathRoot,
164        exp.JSONPathSubscript,
165    }
166
167    TYPE_MAPPING = {
168        **{
169            k: v
170            for k, v in generator.Generator.TYPE_MAPPING.items()
171            if k not in (exp.DType.NCHAR, exp.DType.NVARCHAR)
172        },
173        exp.DType.BOOLEAN: "BIT",
174        exp.DType.DATETIME2: "DATETIME2",
175        exp.DType.DECIMAL: "NUMERIC",
176        exp.DType.DOUBLE: "FLOAT",
177        exp.DType.INT: "INTEGER",
178        exp.DType.ROWVERSION: "ROWVERSION",
179        exp.DType.TEXT: "VARCHAR(MAX)",
180        exp.DType.TIMESTAMP: "DATETIME2",
181        exp.DType.TIMESTAMPNTZ: "DATETIME2",
182        exp.DType.TIMESTAMPTZ: "DATETIMEOFFSET",
183        exp.DType.SMALLDATETIME: "SMALLDATETIME",
184        exp.DType.UTINYINT: "TINYINT",
185        exp.DType.VARIANT: "SQL_VARIANT",
186        exp.DType.UUID: "UNIQUEIDENTIFIER",
187    }
188
189    TRANSFORMS = {
190        **{k: v for k, v in generator.Generator.TRANSFORMS.items() if k != exp.ReturnsProperty},
191        exp.AnyValue: any_value_to_max_sql,
192        exp.Atan2: rename_func("ATN2"),
193        exp.ArrayToString: rename_func("STRING_AGG"),
194        exp.AutoIncrementColumnConstraint: lambda *_: "IDENTITY",
195        exp.Ceil: rename_func("CEILING"),
196        exp.Chr: rename_func("CHAR"),
197        exp.DateAdd: date_delta_sql("DATEADD"),
198        exp.CTE: transforms.preprocess([qualify_derived_table_outputs]),
199        exp.CurrentDate: rename_func("GETDATE"),
200        exp.CurrentTimestamp: rename_func("GETDATE"),
201        exp.CurrentTimestampLTZ: rename_func("SYSDATETIMEOFFSET"),
202        exp.DateStrToDate: datestrtodate_sql,
203        exp.GeneratedAsIdentityColumnConstraint: generatedasidentitycolumnconstraint_sql,
204        exp.GroupConcat: _string_agg_sql,
205        exp.If: rename_func("IIF"),
206        exp.JSONExtract: _json_extract_sql,
207        exp.JSONExtractScalar: _json_extract_sql,
208        exp.LastDay: lambda self, e: self.func("EOMONTH", e.this),
209        exp.Ln: rename_func("LOG"),
210        exp.Max: max_or_greatest,
211        exp.MD5: lambda self, e: self.func("HASHBYTES", exp.Literal.string("MD5"), e.this),
212        exp.Min: min_or_least,
213        exp.NumberToStr: _format_sql,
214        exp.Repeat: rename_func("REPLICATE"),
215        exp.CurrentSchema: rename_func("SCHEMA_NAME"),
216        exp.Select: transforms.preprocess(
217            [
218                transforms.eliminate_distinct_on,
219                transforms.eliminate_semi_and_anti_joins,
220                transforms.eliminate_qualify,
221                transforms.unnest_generate_date_array_using_recursive_cte,
222            ]
223        ),
224        exp.Stddev: rename_func("STDEV"),
225        exp.StrPosition: lambda self, e: strposition_sql(
226            self, e, func_name="CHARINDEX", supports_position=True
227        ),
228        exp.Subquery: transforms.preprocess([qualify_derived_table_outputs]),
229        exp.SHA: lambda self, e: self.func("HASHBYTES", exp.Literal.string("SHA1"), e.this),
230        exp.SHA1Digest: lambda self, e: self.func("HASHBYTES", exp.Literal.string("SHA1"), e.this),
231        exp.SHA2: lambda self, e: self.func(
232            "HASHBYTES", exp.Literal.string(f"SHA2_{e.args.get('length', 256)}"), e.this
233        ),
234        exp.TemporaryProperty: lambda self, e: "",
235        exp.TimeStrToTime: _timestrtotime_sql,
236        exp.TimeToStr: _format_sql,
237        exp.Trim: trim_sql,
238        exp.TsOrDsAdd: date_delta_sql("DATEADD", cast=True),
239        exp.TsOrDsDiff: date_delta_sql("DATEDIFF"),
240        exp.TimestampTrunc: lambda self, e: self.func("DATETRUNC", e.unit, e.this),
241        exp.Trunc: lambda self, e: self.func(
242            "ROUND",
243            e.this,
244            e.args.get("decimals") or exp.Literal.number(0),
245            exp.Literal.number(1),
246        ),
247        exp.Uuid: lambda *_: "NEWID()",
248        exp.DateFromParts: rename_func("DATEFROMPARTS"),
249    }
250
251    PROPERTIES_LOCATION = {
252        **generator.Generator.PROPERTIES_LOCATION,
253        exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
254    }
255
256    def scope_resolution(self, rhs: str, scope_name: str) -> str:
257        return f"{scope_name}::{rhs}"
258
259    def select_sql(self, expression: exp.Select) -> str:
260        limit = expression.args.get("limit")
261        offset = expression.args.get("offset")
262
263        if isinstance(limit, exp.Fetch) and not offset:
264            # Dialects like Oracle can FETCH directly from a row set but
265            # T-SQL requires an ORDER BY + OFFSET clause in order to FETCH
266            offset = exp.Offset(expression=exp.Literal.number(0))
267            expression.set("offset", offset)
268
269        if offset:
270            if not expression.args.get("order"):
271                # ORDER BY is required in order to use OFFSET in a query, so we use
272                # a noop order by, since we don't really care about the order.
273                # See: https://www.microsoftpressstore.com/articles/article.aspx?p=2314819
274                expression.order_by(exp.select(exp.null()).subquery(), copy=False)
275
276            if isinstance(limit, exp.Limit):
277                # TOP and OFFSET can't be combined, we need use FETCH instead of TOP
278                # we replace here because otherwise TOP would be generated in select_sql
279                limit.replace(exp.Fetch(direction="FIRST", count=limit.expression))
280
281        return super().select_sql(expression)
282
283    def convert_sql(self, expression: exp.Convert) -> str:
284        name = "TRY_CONVERT" if expression.args.get("safe") else "CONVERT"
285        return self.func(name, expression.this, expression.expression, expression.args.get("style"))
286
287    def queryoption_sql(self, expression: exp.QueryOption) -> str:
288        option = self.sql(expression, "this")
289        value = self.sql(expression, "expression")
290        if value:
291            optional_equal_sign = "= " if option in OPTIONS_THAT_REQUIRE_EQUAL else ""
292            return f"{option} {optional_equal_sign}{value}"
293        return option
294
295    def lateral_op(self, expression: exp.Lateral) -> str:
296        cross_apply = expression.args.get("cross_apply")
297        if cross_apply is True:
298            return "CROSS APPLY"
299        if cross_apply is False:
300            return "OUTER APPLY"
301
302        # TODO: perhaps we can check if the parent is a Join and transpile it appropriately
303        self.unsupported("LATERAL clause is not supported.")
304        return "LATERAL"
305
306    def splitpart_sql(self, expression: exp.SplitPart) -> str:
307        this = expression.this
308        split_count = len(this.name.split("."))
309        delimiter = expression.args.get("delimiter")
310        part_index = expression.args.get("part_index")
311
312        if (
313            not all(isinstance(arg, exp.Literal) for arg in (this, delimiter, part_index))
314            or (delimiter and delimiter.name != ".")
315            or not part_index
316            or split_count > 4
317        ):
318            self.unsupported(
319                "SPLIT_PART can be transpiled to PARSENAME only for '.' delimiter and literal values"
320            )
321            return ""
322
323        return self.func(
324            "PARSENAME", this, exp.Literal.number(split_count + 1 - part_index.to_py())
325        )
326
327    def extract_sql(self, expression: exp.Extract) -> str:
328        part = expression.this
329        name = DATE_PART_UNMAPPING.get(part.name.upper()) or part
330
331        return self.func("DATEPART", name, expression.expression)
332
333    def timefromparts_sql(self, expression: exp.TimeFromParts) -> str:
334        nano = expression.args.get("nano")
335        if nano is not None:
336            nano.pop()
337            self.unsupported("Specifying nanoseconds is not supported in TIMEFROMPARTS.")
338
339        if expression.args.get("fractions") is None:
340            expression.set("fractions", exp.Literal.number(0))
341        if expression.args.get("precision") is None:
342            expression.set("precision", exp.Literal.number(0))
343
344        return rename_func("TIMEFROMPARTS")(self, expression)
345
346    def timestampfromparts_sql(self, expression: exp.TimestampFromParts) -> str:
347        zone = expression.args.get("zone")
348        if zone is not None:
349            zone.pop()
350            self.unsupported("Time zone is not supported in DATETIMEFROMPARTS.")
351
352        nano = expression.args.get("nano")
353        if nano is not None:
354            nano.pop()
355            self.unsupported("Specifying nanoseconds is not supported in DATETIMEFROMPARTS.")
356
357        if expression.args.get("milli") is None:
358            expression.set("milli", exp.Literal.number(0))
359
360        return rename_func("DATETIMEFROMPARTS")(self, expression)
361
362    def setitem_sql(self, expression: exp.SetItem) -> str:
363        this = expression.this
364        if isinstance(this, exp.EQ) and not isinstance(this.left, exp.Parameter):
365            # T-SQL does not use '=' in SET command, except when the LHS is a variable.
366            return f"{self.sql(this.left)} {self.sql(this.right)}"
367
368        return super().setitem_sql(expression)
369
370    def boolean_sql(self, expression: exp.Boolean) -> str:
371        if type(expression.parent) in BIT_TYPES or isinstance(
372            expression.find_ancestor(exp.Values, exp.Select), exp.Values
373        ):
374            return "1" if expression.this else "0"
375
376        return "(1 = 1)" if expression.this else "(1 = 0)"
377
378    def is_sql(self, expression: exp.Is) -> str:
379        if isinstance(expression.expression, exp.Boolean):
380            return self.binary(expression, "=")
381        return self.binary(expression, "IS")
382
383    def createable_sql(self, expression: exp.Create, locations: defaultdict) -> str:
384        sql = self.sql(expression, "this")
385        properties = expression.args.get("properties")
386
387        if sql[:1] != "#" and any(
388            isinstance(prop, exp.TemporaryProperty)
389            for prop in (properties.expressions if properties else [])
390        ):
391            sql = f"[#{sql[1:]}" if sql.startswith("[") else f"#{sql}"
392
393        return sql
394
395    def create_sql(self, expression: exp.Create) -> str:
396        kind = expression.kind
397        exists = expression.args.get("exists")
398        expression.set("exists", None)
399
400        like_property = expression.find(exp.LikeProperty)
401        if like_property:
402            ctas_expression = like_property.this
403        else:
404            ctas_expression = expression.expression
405
406        if kind == "VIEW":
407            expression.this.set("catalog", None)
408            with_ = expression.args.get("with_")
409            if ctas_expression and with_:
410                # We've already preprocessed the Create expression to bubble up any nested CTEs,
411                # but CREATE VIEW actually requires the WITH clause to come after it so we need
412                # to amend the AST by moving the CTEs to the CREATE VIEW statement's query.
413                ctas_expression.set("with_", with_.pop())
414
415        table = expression.find(exp.Table)
416
417        # Convert CTAS statement to SELECT .. INTO ..
418        if kind == "TABLE" and ctas_expression:
419            if isinstance(ctas_expression, exp.UNWRAPPED_QUERIES):
420                ctas_expression = ctas_expression.subquery()
421
422            properties = expression.args.get("properties") or exp.Properties()
423            is_temp = any(isinstance(p, exp.TemporaryProperty) for p in properties.expressions)
424
425            select_into = exp.select("*").from_(exp.alias_(ctas_expression, "temp", table=True))
426            select_into.set("into", exp.Into(this=table, temporary=is_temp))
427
428            if like_property:
429                select_into.limit(0, copy=False)
430
431            sql = self.sql(select_into)
432        else:
433            sql = super().create_sql(expression)
434
435        if exists:
436            identifier = self.sql(exp.Literal.string(exp.table_name(table) if table else ""))
437            sql_with_ctes = self.prepend_ctes(expression, sql)
438            sql_literal = self.sql(exp.Literal.string(sql_with_ctes))
439            if kind == "SCHEMA":
440                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = {identifier}) EXEC({sql_literal})"""
441            elif kind == "TABLE":
442                assert table
443                where = exp.and_(
444                    exp.column("TABLE_NAME").eq(table.name),
445                    exp.column("TABLE_SCHEMA").eq(table.db) if table.db else None,
446                    exp.column("TABLE_CATALOG").eq(table.catalog) if table.catalog else None,
447                )
448                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE {where}) EXEC({sql_literal})"""
449            elif kind == "INDEX":
450                index = self.sql(exp.Literal.string(expression.this.text("this")))
451                return f"""IF NOT EXISTS (SELECT * FROM sys.indexes WHERE object_id = object_id({identifier}) AND name = {index}) EXEC({sql_literal})"""
452        elif expression.args.get("replace"):
453            sql = sql.replace("CREATE OR REPLACE ", "CREATE OR ALTER ", 1)
454
455        return self.prepend_ctes(expression, sql)
456
457    @generator.unsupported_args("unlogged", "expressions")
458    def into_sql(self, expression: exp.Into) -> str:
459        if expression.args.get("temporary"):
460            # If the Into expression has a temporary property, push this down to the Identifier
461            table = expression.find(exp.Table)
462            if table and isinstance(table.this, exp.Identifier):
463                table.this.set("temporary", True)
464
465        return f"{self.seg('INTO')} {self.sql(expression, 'this')}"
466
467    def count_sql(self, expression: exp.Count) -> str:
468        func_name = "COUNT_BIG" if expression.args.get("big_int") else "COUNT"
469        return rename_func(func_name)(self, expression)
470
471    def datediff_sql(self, expression: exp.DateDiff) -> str:
472        func_name = "DATEDIFF_BIG" if expression.args.get("big_int") else "DATEDIFF"
473        return date_delta_sql(func_name)(self, expression)
474
475    def offset_sql(self, expression: exp.Offset) -> str:
476        return f"{super().offset_sql(expression)} ROWS"
477
478    def version_sql(self, expression: exp.Version) -> str:
479        name = "SYSTEM_TIME" if expression.name == "TIMESTAMP" else expression.name
480        this = f"FOR {name}"
481        expr = expression.expression
482        kind = expression.text("kind")
483        if kind in ("FROM", "BETWEEN"):
484            args = expr.expressions
485            sep = "TO" if kind == "FROM" else "AND"
486            expr_sql = f"{self.sql(seq_get(args, 0))} {sep} {self.sql(seq_get(args, 1))}"
487        else:
488            expr_sql = self.sql(expr)
489
490        expr_sql = f" {expr_sql}" if expr_sql else ""
491        return f"{this} {kind}{expr_sql}"
492
493    def returnsproperty_sql(self, expression: exp.ReturnsProperty) -> str:
494        table = expression.args.get("table")
495        table = f"{table} " if table else ""
496        return f"RETURNS {table}{self.sql(expression, 'this')}"
497
498    def returning_sql(self, expression: exp.Returning) -> str:
499        into = self.sql(expression, "into")
500        into = self.seg(f"INTO {into}") if into else ""
501        return f"{self.seg('OUTPUT')} {self.expressions(expression, flat=True)}{into}"
502
503    def transaction_sql(self, expression: exp.Transaction) -> str:
504        this = self.sql(expression, "this")
505        this = f" {this}" if this else ""
506        mark = self.sql(expression, "mark")
507        mark = f" WITH MARK {mark}" if mark else ""
508        return f"BEGIN TRANSACTION{this}{mark}"
509
510    def commit_sql(self, expression: exp.Commit) -> str:
511        this = self.sql(expression, "this")
512        this = f" {this}" if this else ""
513        durability = expression.args.get("durability")
514        durability = (
515            f" WITH (DELAYED_DURABILITY = {'ON' if durability else 'OFF'})"
516            if durability is not None
517            else ""
518        )
519        return f"COMMIT TRANSACTION{this}{durability}"
520
521    def rollback_sql(self, expression: exp.Rollback) -> str:
522        this = self.sql(expression, "this")
523        this = f" {this}" if this else ""
524        return f"ROLLBACK TRANSACTION{this}"
525
526    def identifier_sql(self, expression: exp.Identifier) -> str:
527        identifier = super().identifier_sql(expression)
528
529        if expression.args.get("global_"):
530            identifier = f"##{identifier}"
531        elif expression.args.get("temporary"):
532            identifier = f"#{identifier}"
533
534        return identifier
535
536    def constraint_sql(self, expression: exp.Constraint) -> str:
537        this = self.sql(expression, "this")
538        expressions = self.expressions(expression, flat=True, sep=" ")
539        return f"CONSTRAINT {this} {expressions}"
540
541    def length_sql(self, expression: exp.Length) -> str:
542        return self._uncast_text(expression, "LEN")
543
544    def right_sql(self, expression: exp.Right) -> str:
545        return self._uncast_text(expression, "RIGHT")
546
547    def left_sql(self, expression: exp.Left) -> str:
548        return self._uncast_text(expression, "LEFT")
549
550    def _uncast_text(self, expression: exp.Expr, name: str) -> str:
551        this = expression.this
552        if isinstance(this, exp.Cast) and this.is_type(exp.DType.TEXT):
553            this_sql = self.sql(this, "this")
554        else:
555            this_sql = self.sql(this)
556        expression_sql = self.sql(expression, "expression")
557        return self.func(name, this_sql, expression_sql if expression_sql else None)
558
559    def partition_sql(self, expression: exp.Partition) -> str:
560        return f"WITH (PARTITIONS({self.expressions(expression, flat=True)}))"
561
562    def alter_sql(self, expression: exp.Alter) -> str:
563        action = seq_get(expression.args.get("actions") or [], 0)
564        if isinstance(action, exp.AlterRename):
565            return f"EXEC sp_rename '{self.sql(expression.this)}', '{action.this.name}'"
566        return super().alter_sql(expression)
567
568    def drop_sql(self, expression: exp.Drop) -> str:
569        if expression.args["kind"] == "VIEW":
570            expression.this.set("catalog", None)
571        return super().drop_sql(expression)
572
573    def options_modifier(self, expression: exp.Expr) -> str:
574        options = self.expressions(expression, key="options")
575        return f" OPTION{self.wrap(options)}" if options else ""
576
577    def dpipe_sql(self, expression: exp.DPipe) -> str:
578        return self.sql(reduce(lambda x, y: exp.Add(this=x, expression=y), expression.flatten()))
579
580    def isascii_sql(self, expression: exp.IsAscii) -> str:
581        return f"(PATINDEX(CONVERT(VARCHAR(MAX), 0x255b5e002d7f5d25) COLLATE Latin1_General_BIN, {self.sql(expression.this)}) = 0)"
582
583    def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str:
584        this = super().columndef_sql(expression, sep)
585        default = self.sql(expression, "default")
586        default = f" = {default}" if default else ""
587        output = self.sql(expression, "output")
588        output = f" {output}" if output else ""
589        return f"{this}{default}{output}"
590
591    def coalesce_sql(self, expression: exp.Coalesce) -> str:
592        func_name = "ISNULL" if expression.args.get("is_null") else "COALESCE"
593        return rename_func(func_name)(self, expression)
594
595    def storedprocedure_sql(self, expression: exp.StoredProcedure) -> str:
596        this = self.sql(expression, "this")
597        expressions = self.expressions(expression)
598        expressions = (
599            self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}"
600        )
601        return f"{this}{expressions}" if expressions.strip() != "" else this
602
603    def ifblock_sql(self, expression: exp.IfBlock) -> str:
604        this = self.sql(expression, "this")
605        true = self.sql(expression, "true")
606        true = f" {true}" if true else " "
607        false = self.sql(expression, "false")
608        false = f"; ELSE BEGIN {false}" if false else ""
609        return f"IF {this} BEGIN{true}{false}"
610
611    def whileblock_sql(self, expression: exp.WhileBlock) -> str:
612        this = self.sql(expression, "this")
613        body = self.sql(expression, "body")
614        body = f" {body}" if body else " "
615        return f"WHILE {this} BEGIN{body}"
616
617    def execute_sql(self, expression: exp.Execute) -> str:
618        this = self.sql(expression, "this")
619        expressions = self.expressions(expression)
620        expressions = f" {expressions}" if expressions else ""
621        return f"EXECUTE {this}{expressions}"
622
623    def executesql_sql(self, expression: exp.ExecuteSql) -> str:
624        return self.execute_sql(expression)
DATE_PART_UNMAPPING = {'WEEKISO': 'ISO_WEEK', 'DAYOFWEEK': 'WEEKDAY', 'TIMEZONE_MINUTE': 'TZOFFSET'}
def qualify_derived_table_outputs( expression: sqlglot.expressions.core.Expr) -> sqlglot.expressions.core.Expr:
69def qualify_derived_table_outputs(expression: exp.Expr) -> exp.Expr:
70    """Ensures all (unnamed) output columns are aliased for CTEs and Subqueries."""
71    alias = expression.args.get("alias")
72
73    if (
74        isinstance(expression, (exp.CTE, exp.Subquery))
75        and isinstance(alias, exp.TableAlias)
76        and not alias.columns
77    ):
78        from sqlglot.optimizer.qualify_columns import qualify_outputs
79
80        # We keep track of the unaliased column projection indexes instead of the expressions
81        # themselves, because the latter are going to be replaced by new nodes when the aliases
82        # are added and hence we won't be able to reach these newly added Alias parents
83        query = expression.this
84        unaliased_column_indexes = (
85            i for i, c in enumerate(query.selects) if isinstance(c, exp.Column) and not c.alias
86        )
87
88        qualify_outputs(query)
89
90        # Preserve the quoting information of columns for newly added Alias nodes
91        query_selects = query.selects
92        for select_index in unaliased_column_indexes:
93            alias = query_selects[select_index]
94            column = alias.this
95            if isinstance(column.this, exp.Identifier):
96                alias.args["alias"].set("quoted", column.this.quoted)
97
98    return expression

Ensures all (unnamed) output columns are aliased for CTEs and Subqueries.

class TSQLGenerator(sqlglot.generator.Generator):
119class TSQLGenerator(generator.Generator):
120    SELECT_KINDS: tuple[str, ...] = ()
121    TRY_SUPPORTED = False
122    SUPPORTS_UESCAPE = False
123    SUPPORTS_DECODE_CASE = False
124
125    AFTER_HAVING_MODIFIER_TRANSFORMS = generator.AFTER_HAVING_MODIFIER_TRANSFORMS
126
127    LIMIT_IS_TOP = True
128    QUERY_HINTS = False
129    RETURNING_END = False
130    NVL2_SUPPORTED = False
131    ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = False
132    LIMIT_FETCH = "FETCH"
133    COMPUTED_COLUMN_WITH_TYPE = False
134    CTE_RECURSIVE_KEYWORD_REQUIRED = False
135    ENSURE_BOOLS = True
136    NULL_ORDERING_SUPPORTED: bool | None = None
137    SUPPORTS_SINGLE_ARG_CONCAT = False
138    TABLESAMPLE_SEED_KEYWORD = "REPEATABLE"
139    SUPPORTS_SELECT_INTO = True
140    JSON_PATH_BRACKETED_KEY_SUPPORTED = False
141    SUPPORTS_TO_NUMBER = False
142    SET_OP_MODIFIERS = False
143    COPY_PARAMS_EQ_REQUIRED = True
144    PARSE_JSON_NAME: str | None = None
145    EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = False
146    ALTER_SET_WRAPPED = True
147    ALTER_SET_TYPE = ""
148
149    EXPRESSIONS_WITHOUT_NESTED_CTES = {
150        exp.Create,
151        exp.Delete,
152        exp.Insert,
153        exp.Intersect,
154        exp.Except,
155        exp.Merge,
156        exp.Select,
157        exp.Subquery,
158        exp.Union,
159        exp.Update,
160    }
161
162    SUPPORTED_JSON_PATH_PARTS = {
163        exp.JSONPathKey,
164        exp.JSONPathRoot,
165        exp.JSONPathSubscript,
166    }
167
168    TYPE_MAPPING = {
169        **{
170            k: v
171            for k, v in generator.Generator.TYPE_MAPPING.items()
172            if k not in (exp.DType.NCHAR, exp.DType.NVARCHAR)
173        },
174        exp.DType.BOOLEAN: "BIT",
175        exp.DType.DATETIME2: "DATETIME2",
176        exp.DType.DECIMAL: "NUMERIC",
177        exp.DType.DOUBLE: "FLOAT",
178        exp.DType.INT: "INTEGER",
179        exp.DType.ROWVERSION: "ROWVERSION",
180        exp.DType.TEXT: "VARCHAR(MAX)",
181        exp.DType.TIMESTAMP: "DATETIME2",
182        exp.DType.TIMESTAMPNTZ: "DATETIME2",
183        exp.DType.TIMESTAMPTZ: "DATETIMEOFFSET",
184        exp.DType.SMALLDATETIME: "SMALLDATETIME",
185        exp.DType.UTINYINT: "TINYINT",
186        exp.DType.VARIANT: "SQL_VARIANT",
187        exp.DType.UUID: "UNIQUEIDENTIFIER",
188    }
189
190    TRANSFORMS = {
191        **{k: v for k, v in generator.Generator.TRANSFORMS.items() if k != exp.ReturnsProperty},
192        exp.AnyValue: any_value_to_max_sql,
193        exp.Atan2: rename_func("ATN2"),
194        exp.ArrayToString: rename_func("STRING_AGG"),
195        exp.AutoIncrementColumnConstraint: lambda *_: "IDENTITY",
196        exp.Ceil: rename_func("CEILING"),
197        exp.Chr: rename_func("CHAR"),
198        exp.DateAdd: date_delta_sql("DATEADD"),
199        exp.CTE: transforms.preprocess([qualify_derived_table_outputs]),
200        exp.CurrentDate: rename_func("GETDATE"),
201        exp.CurrentTimestamp: rename_func("GETDATE"),
202        exp.CurrentTimestampLTZ: rename_func("SYSDATETIMEOFFSET"),
203        exp.DateStrToDate: datestrtodate_sql,
204        exp.GeneratedAsIdentityColumnConstraint: generatedasidentitycolumnconstraint_sql,
205        exp.GroupConcat: _string_agg_sql,
206        exp.If: rename_func("IIF"),
207        exp.JSONExtract: _json_extract_sql,
208        exp.JSONExtractScalar: _json_extract_sql,
209        exp.LastDay: lambda self, e: self.func("EOMONTH", e.this),
210        exp.Ln: rename_func("LOG"),
211        exp.Max: max_or_greatest,
212        exp.MD5: lambda self, e: self.func("HASHBYTES", exp.Literal.string("MD5"), e.this),
213        exp.Min: min_or_least,
214        exp.NumberToStr: _format_sql,
215        exp.Repeat: rename_func("REPLICATE"),
216        exp.CurrentSchema: rename_func("SCHEMA_NAME"),
217        exp.Select: transforms.preprocess(
218            [
219                transforms.eliminate_distinct_on,
220                transforms.eliminate_semi_and_anti_joins,
221                transforms.eliminate_qualify,
222                transforms.unnest_generate_date_array_using_recursive_cte,
223            ]
224        ),
225        exp.Stddev: rename_func("STDEV"),
226        exp.StrPosition: lambda self, e: strposition_sql(
227            self, e, func_name="CHARINDEX", supports_position=True
228        ),
229        exp.Subquery: transforms.preprocess([qualify_derived_table_outputs]),
230        exp.SHA: lambda self, e: self.func("HASHBYTES", exp.Literal.string("SHA1"), e.this),
231        exp.SHA1Digest: lambda self, e: self.func("HASHBYTES", exp.Literal.string("SHA1"), e.this),
232        exp.SHA2: lambda self, e: self.func(
233            "HASHBYTES", exp.Literal.string(f"SHA2_{e.args.get('length', 256)}"), e.this
234        ),
235        exp.TemporaryProperty: lambda self, e: "",
236        exp.TimeStrToTime: _timestrtotime_sql,
237        exp.TimeToStr: _format_sql,
238        exp.Trim: trim_sql,
239        exp.TsOrDsAdd: date_delta_sql("DATEADD", cast=True),
240        exp.TsOrDsDiff: date_delta_sql("DATEDIFF"),
241        exp.TimestampTrunc: lambda self, e: self.func("DATETRUNC", e.unit, e.this),
242        exp.Trunc: lambda self, e: self.func(
243            "ROUND",
244            e.this,
245            e.args.get("decimals") or exp.Literal.number(0),
246            exp.Literal.number(1),
247        ),
248        exp.Uuid: lambda *_: "NEWID()",
249        exp.DateFromParts: rename_func("DATEFROMPARTS"),
250    }
251
252    PROPERTIES_LOCATION = {
253        **generator.Generator.PROPERTIES_LOCATION,
254        exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
255    }
256
257    def scope_resolution(self, rhs: str, scope_name: str) -> str:
258        return f"{scope_name}::{rhs}"
259
260    def select_sql(self, expression: exp.Select) -> str:
261        limit = expression.args.get("limit")
262        offset = expression.args.get("offset")
263
264        if isinstance(limit, exp.Fetch) and not offset:
265            # Dialects like Oracle can FETCH directly from a row set but
266            # T-SQL requires an ORDER BY + OFFSET clause in order to FETCH
267            offset = exp.Offset(expression=exp.Literal.number(0))
268            expression.set("offset", offset)
269
270        if offset:
271            if not expression.args.get("order"):
272                # ORDER BY is required in order to use OFFSET in a query, so we use
273                # a noop order by, since we don't really care about the order.
274                # See: https://www.microsoftpressstore.com/articles/article.aspx?p=2314819
275                expression.order_by(exp.select(exp.null()).subquery(), copy=False)
276
277            if isinstance(limit, exp.Limit):
278                # TOP and OFFSET can't be combined, we need use FETCH instead of TOP
279                # we replace here because otherwise TOP would be generated in select_sql
280                limit.replace(exp.Fetch(direction="FIRST", count=limit.expression))
281
282        return super().select_sql(expression)
283
284    def convert_sql(self, expression: exp.Convert) -> str:
285        name = "TRY_CONVERT" if expression.args.get("safe") else "CONVERT"
286        return self.func(name, expression.this, expression.expression, expression.args.get("style"))
287
288    def queryoption_sql(self, expression: exp.QueryOption) -> str:
289        option = self.sql(expression, "this")
290        value = self.sql(expression, "expression")
291        if value:
292            optional_equal_sign = "= " if option in OPTIONS_THAT_REQUIRE_EQUAL else ""
293            return f"{option} {optional_equal_sign}{value}"
294        return option
295
296    def lateral_op(self, expression: exp.Lateral) -> str:
297        cross_apply = expression.args.get("cross_apply")
298        if cross_apply is True:
299            return "CROSS APPLY"
300        if cross_apply is False:
301            return "OUTER APPLY"
302
303        # TODO: perhaps we can check if the parent is a Join and transpile it appropriately
304        self.unsupported("LATERAL clause is not supported.")
305        return "LATERAL"
306
307    def splitpart_sql(self, expression: exp.SplitPart) -> str:
308        this = expression.this
309        split_count = len(this.name.split("."))
310        delimiter = expression.args.get("delimiter")
311        part_index = expression.args.get("part_index")
312
313        if (
314            not all(isinstance(arg, exp.Literal) for arg in (this, delimiter, part_index))
315            or (delimiter and delimiter.name != ".")
316            or not part_index
317            or split_count > 4
318        ):
319            self.unsupported(
320                "SPLIT_PART can be transpiled to PARSENAME only for '.' delimiter and literal values"
321            )
322            return ""
323
324        return self.func(
325            "PARSENAME", this, exp.Literal.number(split_count + 1 - part_index.to_py())
326        )
327
328    def extract_sql(self, expression: exp.Extract) -> str:
329        part = expression.this
330        name = DATE_PART_UNMAPPING.get(part.name.upper()) or part
331
332        return self.func("DATEPART", name, expression.expression)
333
334    def timefromparts_sql(self, expression: exp.TimeFromParts) -> str:
335        nano = expression.args.get("nano")
336        if nano is not None:
337            nano.pop()
338            self.unsupported("Specifying nanoseconds is not supported in TIMEFROMPARTS.")
339
340        if expression.args.get("fractions") is None:
341            expression.set("fractions", exp.Literal.number(0))
342        if expression.args.get("precision") is None:
343            expression.set("precision", exp.Literal.number(0))
344
345        return rename_func("TIMEFROMPARTS")(self, expression)
346
347    def timestampfromparts_sql(self, expression: exp.TimestampFromParts) -> str:
348        zone = expression.args.get("zone")
349        if zone is not None:
350            zone.pop()
351            self.unsupported("Time zone is not supported in DATETIMEFROMPARTS.")
352
353        nano = expression.args.get("nano")
354        if nano is not None:
355            nano.pop()
356            self.unsupported("Specifying nanoseconds is not supported in DATETIMEFROMPARTS.")
357
358        if expression.args.get("milli") is None:
359            expression.set("milli", exp.Literal.number(0))
360
361        return rename_func("DATETIMEFROMPARTS")(self, expression)
362
363    def setitem_sql(self, expression: exp.SetItem) -> str:
364        this = expression.this
365        if isinstance(this, exp.EQ) and not isinstance(this.left, exp.Parameter):
366            # T-SQL does not use '=' in SET command, except when the LHS is a variable.
367            return f"{self.sql(this.left)} {self.sql(this.right)}"
368
369        return super().setitem_sql(expression)
370
371    def boolean_sql(self, expression: exp.Boolean) -> str:
372        if type(expression.parent) in BIT_TYPES or isinstance(
373            expression.find_ancestor(exp.Values, exp.Select), exp.Values
374        ):
375            return "1" if expression.this else "0"
376
377        return "(1 = 1)" if expression.this else "(1 = 0)"
378
379    def is_sql(self, expression: exp.Is) -> str:
380        if isinstance(expression.expression, exp.Boolean):
381            return self.binary(expression, "=")
382        return self.binary(expression, "IS")
383
384    def createable_sql(self, expression: exp.Create, locations: defaultdict) -> str:
385        sql = self.sql(expression, "this")
386        properties = expression.args.get("properties")
387
388        if sql[:1] != "#" and any(
389            isinstance(prop, exp.TemporaryProperty)
390            for prop in (properties.expressions if properties else [])
391        ):
392            sql = f"[#{sql[1:]}" if sql.startswith("[") else f"#{sql}"
393
394        return sql
395
396    def create_sql(self, expression: exp.Create) -> str:
397        kind = expression.kind
398        exists = expression.args.get("exists")
399        expression.set("exists", None)
400
401        like_property = expression.find(exp.LikeProperty)
402        if like_property:
403            ctas_expression = like_property.this
404        else:
405            ctas_expression = expression.expression
406
407        if kind == "VIEW":
408            expression.this.set("catalog", None)
409            with_ = expression.args.get("with_")
410            if ctas_expression and with_:
411                # We've already preprocessed the Create expression to bubble up any nested CTEs,
412                # but CREATE VIEW actually requires the WITH clause to come after it so we need
413                # to amend the AST by moving the CTEs to the CREATE VIEW statement's query.
414                ctas_expression.set("with_", with_.pop())
415
416        table = expression.find(exp.Table)
417
418        # Convert CTAS statement to SELECT .. INTO ..
419        if kind == "TABLE" and ctas_expression:
420            if isinstance(ctas_expression, exp.UNWRAPPED_QUERIES):
421                ctas_expression = ctas_expression.subquery()
422
423            properties = expression.args.get("properties") or exp.Properties()
424            is_temp = any(isinstance(p, exp.TemporaryProperty) for p in properties.expressions)
425
426            select_into = exp.select("*").from_(exp.alias_(ctas_expression, "temp", table=True))
427            select_into.set("into", exp.Into(this=table, temporary=is_temp))
428
429            if like_property:
430                select_into.limit(0, copy=False)
431
432            sql = self.sql(select_into)
433        else:
434            sql = super().create_sql(expression)
435
436        if exists:
437            identifier = self.sql(exp.Literal.string(exp.table_name(table) if table else ""))
438            sql_with_ctes = self.prepend_ctes(expression, sql)
439            sql_literal = self.sql(exp.Literal.string(sql_with_ctes))
440            if kind == "SCHEMA":
441                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = {identifier}) EXEC({sql_literal})"""
442            elif kind == "TABLE":
443                assert table
444                where = exp.and_(
445                    exp.column("TABLE_NAME").eq(table.name),
446                    exp.column("TABLE_SCHEMA").eq(table.db) if table.db else None,
447                    exp.column("TABLE_CATALOG").eq(table.catalog) if table.catalog else None,
448                )
449                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE {where}) EXEC({sql_literal})"""
450            elif kind == "INDEX":
451                index = self.sql(exp.Literal.string(expression.this.text("this")))
452                return f"""IF NOT EXISTS (SELECT * FROM sys.indexes WHERE object_id = object_id({identifier}) AND name = {index}) EXEC({sql_literal})"""
453        elif expression.args.get("replace"):
454            sql = sql.replace("CREATE OR REPLACE ", "CREATE OR ALTER ", 1)
455
456        return self.prepend_ctes(expression, sql)
457
458    @generator.unsupported_args("unlogged", "expressions")
459    def into_sql(self, expression: exp.Into) -> str:
460        if expression.args.get("temporary"):
461            # If the Into expression has a temporary property, push this down to the Identifier
462            table = expression.find(exp.Table)
463            if table and isinstance(table.this, exp.Identifier):
464                table.this.set("temporary", True)
465
466        return f"{self.seg('INTO')} {self.sql(expression, 'this')}"
467
468    def count_sql(self, expression: exp.Count) -> str:
469        func_name = "COUNT_BIG" if expression.args.get("big_int") else "COUNT"
470        return rename_func(func_name)(self, expression)
471
472    def datediff_sql(self, expression: exp.DateDiff) -> str:
473        func_name = "DATEDIFF_BIG" if expression.args.get("big_int") else "DATEDIFF"
474        return date_delta_sql(func_name)(self, expression)
475
476    def offset_sql(self, expression: exp.Offset) -> str:
477        return f"{super().offset_sql(expression)} ROWS"
478
479    def version_sql(self, expression: exp.Version) -> str:
480        name = "SYSTEM_TIME" if expression.name == "TIMESTAMP" else expression.name
481        this = f"FOR {name}"
482        expr = expression.expression
483        kind = expression.text("kind")
484        if kind in ("FROM", "BETWEEN"):
485            args = expr.expressions
486            sep = "TO" if kind == "FROM" else "AND"
487            expr_sql = f"{self.sql(seq_get(args, 0))} {sep} {self.sql(seq_get(args, 1))}"
488        else:
489            expr_sql = self.sql(expr)
490
491        expr_sql = f" {expr_sql}" if expr_sql else ""
492        return f"{this} {kind}{expr_sql}"
493
494    def returnsproperty_sql(self, expression: exp.ReturnsProperty) -> str:
495        table = expression.args.get("table")
496        table = f"{table} " if table else ""
497        return f"RETURNS {table}{self.sql(expression, 'this')}"
498
499    def returning_sql(self, expression: exp.Returning) -> str:
500        into = self.sql(expression, "into")
501        into = self.seg(f"INTO {into}") if into else ""
502        return f"{self.seg('OUTPUT')} {self.expressions(expression, flat=True)}{into}"
503
504    def transaction_sql(self, expression: exp.Transaction) -> str:
505        this = self.sql(expression, "this")
506        this = f" {this}" if this else ""
507        mark = self.sql(expression, "mark")
508        mark = f" WITH MARK {mark}" if mark else ""
509        return f"BEGIN TRANSACTION{this}{mark}"
510
511    def commit_sql(self, expression: exp.Commit) -> str:
512        this = self.sql(expression, "this")
513        this = f" {this}" if this else ""
514        durability = expression.args.get("durability")
515        durability = (
516            f" WITH (DELAYED_DURABILITY = {'ON' if durability else 'OFF'})"
517            if durability is not None
518            else ""
519        )
520        return f"COMMIT TRANSACTION{this}{durability}"
521
522    def rollback_sql(self, expression: exp.Rollback) -> str:
523        this = self.sql(expression, "this")
524        this = f" {this}" if this else ""
525        return f"ROLLBACK TRANSACTION{this}"
526
527    def identifier_sql(self, expression: exp.Identifier) -> str:
528        identifier = super().identifier_sql(expression)
529
530        if expression.args.get("global_"):
531            identifier = f"##{identifier}"
532        elif expression.args.get("temporary"):
533            identifier = f"#{identifier}"
534
535        return identifier
536
537    def constraint_sql(self, expression: exp.Constraint) -> str:
538        this = self.sql(expression, "this")
539        expressions = self.expressions(expression, flat=True, sep=" ")
540        return f"CONSTRAINT {this} {expressions}"
541
542    def length_sql(self, expression: exp.Length) -> str:
543        return self._uncast_text(expression, "LEN")
544
545    def right_sql(self, expression: exp.Right) -> str:
546        return self._uncast_text(expression, "RIGHT")
547
548    def left_sql(self, expression: exp.Left) -> str:
549        return self._uncast_text(expression, "LEFT")
550
551    def _uncast_text(self, expression: exp.Expr, name: str) -> str:
552        this = expression.this
553        if isinstance(this, exp.Cast) and this.is_type(exp.DType.TEXT):
554            this_sql = self.sql(this, "this")
555        else:
556            this_sql = self.sql(this)
557        expression_sql = self.sql(expression, "expression")
558        return self.func(name, this_sql, expression_sql if expression_sql else None)
559
560    def partition_sql(self, expression: exp.Partition) -> str:
561        return f"WITH (PARTITIONS({self.expressions(expression, flat=True)}))"
562
563    def alter_sql(self, expression: exp.Alter) -> str:
564        action = seq_get(expression.args.get("actions") or [], 0)
565        if isinstance(action, exp.AlterRename):
566            return f"EXEC sp_rename '{self.sql(expression.this)}', '{action.this.name}'"
567        return super().alter_sql(expression)
568
569    def drop_sql(self, expression: exp.Drop) -> str:
570        if expression.args["kind"] == "VIEW":
571            expression.this.set("catalog", None)
572        return super().drop_sql(expression)
573
574    def options_modifier(self, expression: exp.Expr) -> str:
575        options = self.expressions(expression, key="options")
576        return f" OPTION{self.wrap(options)}" if options else ""
577
578    def dpipe_sql(self, expression: exp.DPipe) -> str:
579        return self.sql(reduce(lambda x, y: exp.Add(this=x, expression=y), expression.flatten()))
580
581    def isascii_sql(self, expression: exp.IsAscii) -> str:
582        return f"(PATINDEX(CONVERT(VARCHAR(MAX), 0x255b5e002d7f5d25) COLLATE Latin1_General_BIN, {self.sql(expression.this)}) = 0)"
583
584    def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str:
585        this = super().columndef_sql(expression, sep)
586        default = self.sql(expression, "default")
587        default = f" = {default}" if default else ""
588        output = self.sql(expression, "output")
589        output = f" {output}" if output else ""
590        return f"{this}{default}{output}"
591
592    def coalesce_sql(self, expression: exp.Coalesce) -> str:
593        func_name = "ISNULL" if expression.args.get("is_null") else "COALESCE"
594        return rename_func(func_name)(self, expression)
595
596    def storedprocedure_sql(self, expression: exp.StoredProcedure) -> str:
597        this = self.sql(expression, "this")
598        expressions = self.expressions(expression)
599        expressions = (
600            self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}"
601        )
602        return f"{this}{expressions}" if expressions.strip() != "" else this
603
604    def ifblock_sql(self, expression: exp.IfBlock) -> str:
605        this = self.sql(expression, "this")
606        true = self.sql(expression, "true")
607        true = f" {true}" if true else " "
608        false = self.sql(expression, "false")
609        false = f"; ELSE BEGIN {false}" if false else ""
610        return f"IF {this} BEGIN{true}{false}"
611
612    def whileblock_sql(self, expression: exp.WhileBlock) -> str:
613        this = self.sql(expression, "this")
614        body = self.sql(expression, "body")
615        body = f" {body}" if body else " "
616        return f"WHILE {this} BEGIN{body}"
617
618    def execute_sql(self, expression: exp.Execute) -> str:
619        this = self.sql(expression, "this")
620        expressions = self.expressions(expression)
621        expressions = f" {expressions}" if expressions else ""
622        return f"EXECUTE {this}{expressions}"
623
624    def executesql_sql(self, expression: exp.ExecuteSql) -> str:
625        return self.execute_sql(expression)

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: Always quote except for specials cases. '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
SELECT_KINDS: tuple[str, ...] = ()
TRY_SUPPORTED = False
SUPPORTS_UESCAPE = False
SUPPORTS_DECODE_CASE = False
AFTER_HAVING_MODIFIER_TRANSFORMS = {'windows': <function <lambda>>, 'qualify': <function <lambda>>}
LIMIT_IS_TOP = True
QUERY_HINTS = False
RETURNING_END = False
NVL2_SUPPORTED = False
ALTER_TABLE_INCLUDE_COLUMN_KEYWORD = False
LIMIT_FETCH = 'FETCH'
COMPUTED_COLUMN_WITH_TYPE = False
CTE_RECURSIVE_KEYWORD_REQUIRED = False
ENSURE_BOOLS = True
NULL_ORDERING_SUPPORTED: bool | None = None
SUPPORTS_SINGLE_ARG_CONCAT = False
TABLESAMPLE_SEED_KEYWORD = 'REPEATABLE'
SUPPORTS_SELECT_INTO = True
JSON_PATH_BRACKETED_KEY_SUPPORTED = False
SUPPORTS_TO_NUMBER = False
SET_OP_MODIFIERS = False
COPY_PARAMS_EQ_REQUIRED = True
PARSE_JSON_NAME: str | None = None
EXCEPT_INTERSECT_SUPPORT_ALL_CLAUSE = False
ALTER_SET_WRAPPED = True
ALTER_SET_TYPE = ''
TYPE_MAPPING = {<DType.DATETIME2: 'DATETIME2'>: 'DATETIME2', <DType.MEDIUMTEXT: 'MEDIUMTEXT'>: 'TEXT', <DType.LONGTEXT: 'LONGTEXT'>: 'TEXT', <DType.TINYTEXT: 'TINYTEXT'>: 'TEXT', <DType.BLOB: 'BLOB'>: 'VARBINARY', <DType.MEDIUMBLOB: 'MEDIUMBLOB'>: 'BLOB', <DType.LONGBLOB: 'LONGBLOB'>: 'BLOB', <DType.TINYBLOB: 'TINYBLOB'>: 'BLOB', <DType.INET: 'INET'>: 'INET', <DType.ROWVERSION: 'ROWVERSION'>: 'ROWVERSION', <DType.SMALLDATETIME: 'SMALLDATETIME'>: 'SMALLDATETIME', <DType.BOOLEAN: 'BOOLEAN'>: 'BIT', <DType.DECIMAL: 'DECIMAL'>: 'NUMERIC', <DType.DOUBLE: 'DOUBLE'>: 'FLOAT', <DType.INT: 'INT'>: 'INTEGER', <DType.TEXT: 'TEXT'>: 'VARCHAR(MAX)', <DType.TIMESTAMP: 'TIMESTAMP'>: 'DATETIME2', <DType.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>: 'DATETIME2', <DType.TIMESTAMPTZ: 'TIMESTAMPTZ'>: 'DATETIMEOFFSET', <DType.UTINYINT: 'UTINYINT'>: 'TINYINT', <DType.VARIANT: 'VARIANT'>: 'SQL_VARIANT', <DType.UUID: 'UUID'>: 'UNIQUEIDENTIFIER'}
TRANSFORMS = {<class 'sqlglot.expressions.query.JSONPathKey'>: <function <lambda>>, <class 'sqlglot.expressions.query.JSONPathRoot'>: <function <lambda>>, <class 'sqlglot.expressions.query.JSONPathSubscript'>: <function <lambda>>, <class 'sqlglot.expressions.core.Adjacent'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.AllowedValuesProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.AnalyzeColumns'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.AnalyzeWith'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.array.ArrayContainsAll'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.array.ArrayOverlaps'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.AssumeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.AutoRefreshProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.BackupProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.CaseSpecificColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.math.Ceil'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.constraints.CharacterSetColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.CharacterSetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.ClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.CollateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.CommentColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.functions.ConnectByRoot'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.string.ConvertToCharset'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.CopyGrantsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.CredentialsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.functions.CurrentCatalog'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.functions.SessionUser'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.DateFormatColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.DefaultColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ApiProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ApplicationProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.CatalogProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ComputeProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.DatabaseProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.DynamicProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.EmptyProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.EncodeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.EndStatement'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.EnviromentProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.HandlerProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ParameterStyleProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.EphemeralColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.ExcludeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ExecuteAsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Except'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ExternalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.math.Floor'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Get'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.GlobalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.HeapProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.HybridProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.IcebergProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.InheritsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.InlineLengthColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.InputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Intersect'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.datatypes.IntervalSpan'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.functions.Int64'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.json.JSONBContainsAnyTopKeys'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.json.JSONBContainsAllTopKeys'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.json.JSONBDeleteAtPath'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.json.JSONObject'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.json.JSONObjectAgg'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.LanguageProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.LocationProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.LogProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.MaskingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.MaterializedProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.functions.NetFunc'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.NetworkProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.NonClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.NoPrimaryIndexProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.NotForReplicationColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.OnCommitProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.OnProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.OnUpdateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.core.Operator'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.OutputModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.core.ExtendsLeft'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.core.ExtendsRight'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.PathColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.PartitionedByBucket'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.PartitionByTruncate'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.core.PivotAny'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.array.PositionalColumn'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.ProjectionPolicyColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.InvisibleColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.ZeroFillColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Put'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.RemoteWithConnectionModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.RowAccessProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.core.SafeFunc'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SampleProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SecureProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SecurityIntegrationProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SetConfigProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SettingsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SharingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SqlReadWriteProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.SqlSecurityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.StabilityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Stream'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.StreamingTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.StrictProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ddl.SwapTable'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.TableColumn'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.Tags'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.TemporaryProperty'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.constraints.TitleColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.array.ToMap'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ToTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.TransformModelProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.TransientProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.VirtualProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ddl.TriggerExecute'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Union'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.UnloggedProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.UsingTemplateProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.UsingData'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.UppercaseColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.temporal.UtcDate'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.temporal.UtcTime'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.temporal.UtcTimestamp'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.query.Variadic'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.array.VarMap'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ViewAttributeProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.VolatileProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.WithJournalTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.WithProcedureOptions'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.WithSchemaBindingProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.constraints.WithOperator'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.properties.ForceProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.aggregate.AnyValue'>: <function any_value_to_max_sql>, <class 'sqlglot.expressions.math.Atan2'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.array.ArrayToString'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.constraints.AutoIncrementColumnConstraint'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.string.Chr'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.temporal.DateAdd'>: <function date_delta_sql.<locals>._delta_sql>, <class 'sqlglot.expressions.query.CTE'>: <function preprocess.<locals>._to_sql>, <class 'sqlglot.expressions.temporal.CurrentDate'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.temporal.CurrentTimestamp'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.temporal.CurrentTimestampLTZ'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.temporal.DateStrToDate'>: <function datestrtodate_sql>, <class 'sqlglot.expressions.constraints.GeneratedAsIdentityColumnConstraint'>: <function generatedasidentitycolumnconstraint_sql>, <class 'sqlglot.expressions.aggregate.GroupConcat'>: <function _string_agg_sql>, <class 'sqlglot.expressions.functions.If'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.json.JSONExtract'>: <function _json_extract_sql>, <class 'sqlglot.expressions.json.JSONExtractScalar'>: <function _json_extract_sql>, <class 'sqlglot.expressions.temporal.LastDay'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.math.Ln'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.aggregate.Max'>: <function max_or_greatest>, <class 'sqlglot.expressions.string.MD5'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.aggregate.Min'>: <function min_or_least>, <class 'sqlglot.expressions.string.NumberToStr'>: <function _format_sql>, <class 'sqlglot.expressions.string.Repeat'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.functions.CurrentSchema'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.query.Select'>: <function preprocess.<locals>._to_sql>, <class 'sqlglot.expressions.aggregate.Stddev'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.string.StrPosition'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.query.Subquery'>: <function preprocess.<locals>._to_sql>, <class 'sqlglot.expressions.string.SHA'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.string.SHA1Digest'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.string.SHA2'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.temporal.TimeStrToTime'>: <function _timestrtotime_sql>, <class 'sqlglot.expressions.temporal.TimeToStr'>: <function _format_sql>, <class 'sqlglot.expressions.string.Trim'>: <function trim_sql>, <class 'sqlglot.expressions.temporal.TsOrDsAdd'>: <function date_delta_sql.<locals>._delta_sql>, <class 'sqlglot.expressions.temporal.TsOrDsDiff'>: <function date_delta_sql.<locals>._delta_sql>, <class 'sqlglot.expressions.temporal.TimestampTrunc'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.math.Trunc'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.functions.Uuid'>: <function TSQLGenerator.<lambda>>, <class 'sqlglot.expressions.temporal.DateFromParts'>: <function rename_func.<locals>.<lambda>>}
PROPERTIES_LOCATION = {<class 'sqlglot.expressions.properties.AllowedValuesProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.AlgorithmProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.ApiProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.ApplicationProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.AutoIncrementProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.AutoRefreshProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.BackupProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.BlockCompressionProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.CatalogProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.CharacterSetProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ChecksumProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.CollateProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ComputeProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.CopyGrantsProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.query.Cluster'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ClusteredByProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DistributedByProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DuplicateKeyProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DataBlocksizeProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.DatabaseProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.DataDeletionProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DefinerProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.DictRange'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DictProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DynamicProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.DistKeyProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.DistStyleProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.EmptyProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.EncodeProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.properties.EngineProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.EnviromentProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.HandlerProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ParameterStyleProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ExecuteAsProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ExternalProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.FallbackProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.FileFormatProperty'>: <PropertiesLocation.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.properties.FreespaceProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.GlobalProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.HeapProperty'>: <PropertiesLocation.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.properties.HybridProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.InheritsProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.IcebergProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.IncludeProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.InputModelProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.IsolatedLoadingProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.JournalProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.LanguageProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.LikeProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.LocationProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.LockProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.LockingProperty'>: <PropertiesLocation.POST_ALIAS: 'POST_ALIAS'>, <class 'sqlglot.expressions.properties.LogProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.MaskingProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.MaterializedProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.MergeBlockRatioProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.ModuleProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.NetworkProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.NoPrimaryIndexProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.properties.OnProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.OnCommitProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.query.Order'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.OutputModelProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.PartitionedByProperty'>: <PropertiesLocation.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.properties.PartitionedOfProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.constraints.PrimaryKey'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.Property'>: <PropertiesLocation.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.properties.RefreshTriggerProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.RemoteWithConnectionModelProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ReturnsProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.RollupProperty'>: <PropertiesLocation.UNSUPPORTED: 'UNSUPPORTED'>, <class 'sqlglot.expressions.properties.RowAccessProperty'>: <PropertiesLocation.UNSUPPORTED: 'UNSUPPORTED'>, <class 'sqlglot.expressions.properties.RowFormatProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.RowFormatDelimitedProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.RowFormatSerdeProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SampleProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SchemaCommentProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SecureProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.SecurityIntegrationProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.SerdeProperties'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ddl.Set'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SettingsProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SetProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.SetConfigProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SharingProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.ddl.SequenceProperties'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.ddl.TriggerProperties'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.properties.SortKeyProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SqlReadWriteProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.SqlSecurityProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.StabilityProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.StorageHandlerProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.StreamingTableProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.StrictProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.Tags'>: <PropertiesLocation.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.properties.TemporaryProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.ToTableProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.TransientProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.TransformModelProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ddl.MergeTreeTTL'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.UnloggedProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.UsingProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.properties.UsingTemplateProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ViewAttributeProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.VirtualProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.properties.VolatileProperty'>: <PropertiesLocation.UNSUPPORTED: 'UNSUPPORTED'>, <class 'sqlglot.expressions.properties.WithDataProperty'>: <PropertiesLocation.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.properties.WithJournalTableProperty'>: <PropertiesLocation.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.properties.WithProcedureOptions'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.WithSchemaBindingProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.WithSystemVersioningProperty'>: <PropertiesLocation.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.properties.ForceProperty'>: <PropertiesLocation.POST_CREATE: 'POST_CREATE'>}
def scope_resolution(self, rhs: str, scope_name: str) -> str:
257    def scope_resolution(self, rhs: str, scope_name: str) -> str:
258        return f"{scope_name}::{rhs}"
def select_sql(self, expression: sqlglot.expressions.query.Select) -> str:
260    def select_sql(self, expression: exp.Select) -> str:
261        limit = expression.args.get("limit")
262        offset = expression.args.get("offset")
263
264        if isinstance(limit, exp.Fetch) and not offset:
265            # Dialects like Oracle can FETCH directly from a row set but
266            # T-SQL requires an ORDER BY + OFFSET clause in order to FETCH
267            offset = exp.Offset(expression=exp.Literal.number(0))
268            expression.set("offset", offset)
269
270        if offset:
271            if not expression.args.get("order"):
272                # ORDER BY is required in order to use OFFSET in a query, so we use
273                # a noop order by, since we don't really care about the order.
274                # See: https://www.microsoftpressstore.com/articles/article.aspx?p=2314819
275                expression.order_by(exp.select(exp.null()).subquery(), copy=False)
276
277            if isinstance(limit, exp.Limit):
278                # TOP and OFFSET can't be combined, we need use FETCH instead of TOP
279                # we replace here because otherwise TOP would be generated in select_sql
280                limit.replace(exp.Fetch(direction="FIRST", count=limit.expression))
281
282        return super().select_sql(expression)
def convert_sql(self, expression: sqlglot.expressions.functions.Convert) -> str:
284    def convert_sql(self, expression: exp.Convert) -> str:
285        name = "TRY_CONVERT" if expression.args.get("safe") else "CONVERT"
286        return self.func(name, expression.this, expression.expression, expression.args.get("style"))
def queryoption_sql(self, expression: sqlglot.expressions.query.QueryOption) -> str:
288    def queryoption_sql(self, expression: exp.QueryOption) -> str:
289        option = self.sql(expression, "this")
290        value = self.sql(expression, "expression")
291        if value:
292            optional_equal_sign = "= " if option in OPTIONS_THAT_REQUIRE_EQUAL else ""
293            return f"{option} {optional_equal_sign}{value}"
294        return option
def lateral_op(self, expression: sqlglot.expressions.query.Lateral) -> str:
296    def lateral_op(self, expression: exp.Lateral) -> str:
297        cross_apply = expression.args.get("cross_apply")
298        if cross_apply is True:
299            return "CROSS APPLY"
300        if cross_apply is False:
301            return "OUTER APPLY"
302
303        # TODO: perhaps we can check if the parent is a Join and transpile it appropriately
304        self.unsupported("LATERAL clause is not supported.")
305        return "LATERAL"
def splitpart_sql(self, expression: sqlglot.expressions.string.SplitPart) -> str:
307    def splitpart_sql(self, expression: exp.SplitPart) -> str:
308        this = expression.this
309        split_count = len(this.name.split("."))
310        delimiter = expression.args.get("delimiter")
311        part_index = expression.args.get("part_index")
312
313        if (
314            not all(isinstance(arg, exp.Literal) for arg in (this, delimiter, part_index))
315            or (delimiter and delimiter.name != ".")
316            or not part_index
317            or split_count > 4
318        ):
319            self.unsupported(
320                "SPLIT_PART can be transpiled to PARSENAME only for '.' delimiter and literal values"
321            )
322            return ""
323
324        return self.func(
325            "PARSENAME", this, exp.Literal.number(split_count + 1 - part_index.to_py())
326        )
def extract_sql(self, expression: sqlglot.expressions.temporal.Extract) -> str:
328    def extract_sql(self, expression: exp.Extract) -> str:
329        part = expression.this
330        name = DATE_PART_UNMAPPING.get(part.name.upper()) or part
331
332        return self.func("DATEPART", name, expression.expression)
def timefromparts_sql(self, expression: sqlglot.expressions.temporal.TimeFromParts) -> str:
334    def timefromparts_sql(self, expression: exp.TimeFromParts) -> str:
335        nano = expression.args.get("nano")
336        if nano is not None:
337            nano.pop()
338            self.unsupported("Specifying nanoseconds is not supported in TIMEFROMPARTS.")
339
340        if expression.args.get("fractions") is None:
341            expression.set("fractions", exp.Literal.number(0))
342        if expression.args.get("precision") is None:
343            expression.set("precision", exp.Literal.number(0))
344
345        return rename_func("TIMEFROMPARTS")(self, expression)
def timestampfromparts_sql(self, expression: sqlglot.expressions.temporal.TimestampFromParts) -> str:
347    def timestampfromparts_sql(self, expression: exp.TimestampFromParts) -> str:
348        zone = expression.args.get("zone")
349        if zone is not None:
350            zone.pop()
351            self.unsupported("Time zone is not supported in DATETIMEFROMPARTS.")
352
353        nano = expression.args.get("nano")
354        if nano is not None:
355            nano.pop()
356            self.unsupported("Specifying nanoseconds is not supported in DATETIMEFROMPARTS.")
357
358        if expression.args.get("milli") is None:
359            expression.set("milli", exp.Literal.number(0))
360
361        return rename_func("DATETIMEFROMPARTS")(self, expression)
def setitem_sql(self, expression: sqlglot.expressions.ddl.SetItem) -> str:
363    def setitem_sql(self, expression: exp.SetItem) -> str:
364        this = expression.this
365        if isinstance(this, exp.EQ) and not isinstance(this.left, exp.Parameter):
366            # T-SQL does not use '=' in SET command, except when the LHS is a variable.
367            return f"{self.sql(this.left)} {self.sql(this.right)}"
368
369        return super().setitem_sql(expression)
def boolean_sql(self, expression: sqlglot.expressions.core.Boolean) -> str:
371    def boolean_sql(self, expression: exp.Boolean) -> str:
372        if type(expression.parent) in BIT_TYPES or isinstance(
373            expression.find_ancestor(exp.Values, exp.Select), exp.Values
374        ):
375            return "1" if expression.this else "0"
376
377        return "(1 = 1)" if expression.this else "(1 = 0)"
def is_sql(self, expression: sqlglot.expressions.core.Is) -> str:
379    def is_sql(self, expression: exp.Is) -> str:
380        if isinstance(expression.expression, exp.Boolean):
381            return self.binary(expression, "=")
382        return self.binary(expression, "IS")
def createable_sql( self, expression: sqlglot.expressions.ddl.Create, locations: collections.defaultdict) -> str:
384    def createable_sql(self, expression: exp.Create, locations: defaultdict) -> str:
385        sql = self.sql(expression, "this")
386        properties = expression.args.get("properties")
387
388        if sql[:1] != "#" and any(
389            isinstance(prop, exp.TemporaryProperty)
390            for prop in (properties.expressions if properties else [])
391        ):
392            sql = f"[#{sql[1:]}" if sql.startswith("[") else f"#{sql}"
393
394        return sql
def create_sql(self, expression: sqlglot.expressions.ddl.Create) -> str:
396    def create_sql(self, expression: exp.Create) -> str:
397        kind = expression.kind
398        exists = expression.args.get("exists")
399        expression.set("exists", None)
400
401        like_property = expression.find(exp.LikeProperty)
402        if like_property:
403            ctas_expression = like_property.this
404        else:
405            ctas_expression = expression.expression
406
407        if kind == "VIEW":
408            expression.this.set("catalog", None)
409            with_ = expression.args.get("with_")
410            if ctas_expression and with_:
411                # We've already preprocessed the Create expression to bubble up any nested CTEs,
412                # but CREATE VIEW actually requires the WITH clause to come after it so we need
413                # to amend the AST by moving the CTEs to the CREATE VIEW statement's query.
414                ctas_expression.set("with_", with_.pop())
415
416        table = expression.find(exp.Table)
417
418        # Convert CTAS statement to SELECT .. INTO ..
419        if kind == "TABLE" and ctas_expression:
420            if isinstance(ctas_expression, exp.UNWRAPPED_QUERIES):
421                ctas_expression = ctas_expression.subquery()
422
423            properties = expression.args.get("properties") or exp.Properties()
424            is_temp = any(isinstance(p, exp.TemporaryProperty) for p in properties.expressions)
425
426            select_into = exp.select("*").from_(exp.alias_(ctas_expression, "temp", table=True))
427            select_into.set("into", exp.Into(this=table, temporary=is_temp))
428
429            if like_property:
430                select_into.limit(0, copy=False)
431
432            sql = self.sql(select_into)
433        else:
434            sql = super().create_sql(expression)
435
436        if exists:
437            identifier = self.sql(exp.Literal.string(exp.table_name(table) if table else ""))
438            sql_with_ctes = self.prepend_ctes(expression, sql)
439            sql_literal = self.sql(exp.Literal.string(sql_with_ctes))
440            if kind == "SCHEMA":
441                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = {identifier}) EXEC({sql_literal})"""
442            elif kind == "TABLE":
443                assert table
444                where = exp.and_(
445                    exp.column("TABLE_NAME").eq(table.name),
446                    exp.column("TABLE_SCHEMA").eq(table.db) if table.db else None,
447                    exp.column("TABLE_CATALOG").eq(table.catalog) if table.catalog else None,
448                )
449                return f"""IF NOT EXISTS (SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE {where}) EXEC({sql_literal})"""
450            elif kind == "INDEX":
451                index = self.sql(exp.Literal.string(expression.this.text("this")))
452                return f"""IF NOT EXISTS (SELECT * FROM sys.indexes WHERE object_id = object_id({identifier}) AND name = {index}) EXEC({sql_literal})"""
453        elif expression.args.get("replace"):
454            sql = sql.replace("CREATE OR REPLACE ", "CREATE OR ALTER ", 1)
455
456        return self.prepend_ctes(expression, sql)
@generator.unsupported_args('unlogged', 'expressions')
def into_sql(self, expression: sqlglot.expressions.query.Into) -> str:
458    @generator.unsupported_args("unlogged", "expressions")
459    def into_sql(self, expression: exp.Into) -> str:
460        if expression.args.get("temporary"):
461            # If the Into expression has a temporary property, push this down to the Identifier
462            table = expression.find(exp.Table)
463            if table and isinstance(table.this, exp.Identifier):
464                table.this.set("temporary", True)
465
466        return f"{self.seg('INTO')} {self.sql(expression, 'this')}"
def count_sql(self, expression: sqlglot.expressions.aggregate.Count) -> str:
468    def count_sql(self, expression: exp.Count) -> str:
469        func_name = "COUNT_BIG" if expression.args.get("big_int") else "COUNT"
470        return rename_func(func_name)(self, expression)
def datediff_sql(self, expression: sqlglot.expressions.temporal.DateDiff) -> str:
472    def datediff_sql(self, expression: exp.DateDiff) -> str:
473        func_name = "DATEDIFF_BIG" if expression.args.get("big_int") else "DATEDIFF"
474        return date_delta_sql(func_name)(self, expression)
def offset_sql(self, expression: sqlglot.expressions.query.Offset) -> str:
476    def offset_sql(self, expression: exp.Offset) -> str:
477        return f"{super().offset_sql(expression)} ROWS"
def version_sql(self, expression: sqlglot.expressions.query.Version) -> str:
479    def version_sql(self, expression: exp.Version) -> str:
480        name = "SYSTEM_TIME" if expression.name == "TIMESTAMP" else expression.name
481        this = f"FOR {name}"
482        expr = expression.expression
483        kind = expression.text("kind")
484        if kind in ("FROM", "BETWEEN"):
485            args = expr.expressions
486            sep = "TO" if kind == "FROM" else "AND"
487            expr_sql = f"{self.sql(seq_get(args, 0))} {sep} {self.sql(seq_get(args, 1))}"
488        else:
489            expr_sql = self.sql(expr)
490
491        expr_sql = f" {expr_sql}" if expr_sql else ""
492        return f"{this} {kind}{expr_sql}"
def returnsproperty_sql(self, expression: sqlglot.expressions.properties.ReturnsProperty) -> str:
494    def returnsproperty_sql(self, expression: exp.ReturnsProperty) -> str:
495        table = expression.args.get("table")
496        table = f"{table} " if table else ""
497        return f"RETURNS {table}{self.sql(expression, 'this')}"
def returning_sql(self, expression: sqlglot.expressions.dml.Returning) -> str:
499    def returning_sql(self, expression: exp.Returning) -> str:
500        into = self.sql(expression, "into")
501        into = self.seg(f"INTO {into}") if into else ""
502        return f"{self.seg('OUTPUT')} {self.expressions(expression, flat=True)}{into}"
def transaction_sql(self, expression: sqlglot.expressions.ddl.Transaction) -> str:
504    def transaction_sql(self, expression: exp.Transaction) -> str:
505        this = self.sql(expression, "this")
506        this = f" {this}" if this else ""
507        mark = self.sql(expression, "mark")
508        mark = f" WITH MARK {mark}" if mark else ""
509        return f"BEGIN TRANSACTION{this}{mark}"
def commit_sql(self, expression: sqlglot.expressions.ddl.Commit) -> str:
511    def commit_sql(self, expression: exp.Commit) -> str:
512        this = self.sql(expression, "this")
513        this = f" {this}" if this else ""
514        durability = expression.args.get("durability")
515        durability = (
516            f" WITH (DELAYED_DURABILITY = {'ON' if durability else 'OFF'})"
517            if durability is not None
518            else ""
519        )
520        return f"COMMIT TRANSACTION{this}{durability}"
def rollback_sql(self, expression: sqlglot.expressions.ddl.Rollback) -> str:
522    def rollback_sql(self, expression: exp.Rollback) -> str:
523        this = self.sql(expression, "this")
524        this = f" {this}" if this else ""
525        return f"ROLLBACK TRANSACTION{this}"
def identifier_sql(self, expression: sqlglot.expressions.core.Identifier) -> str:
527    def identifier_sql(self, expression: exp.Identifier) -> str:
528        identifier = super().identifier_sql(expression)
529
530        if expression.args.get("global_"):
531            identifier = f"##{identifier}"
532        elif expression.args.get("temporary"):
533            identifier = f"#{identifier}"
534
535        return identifier
def constraint_sql(self, expression: sqlglot.expressions.constraints.Constraint) -> str:
537    def constraint_sql(self, expression: exp.Constraint) -> str:
538        this = self.sql(expression, "this")
539        expressions = self.expressions(expression, flat=True, sep=" ")
540        return f"CONSTRAINT {this} {expressions}"
def length_sql(self, expression: sqlglot.expressions.string.Length) -> str:
542    def length_sql(self, expression: exp.Length) -> str:
543        return self._uncast_text(expression, "LEN")
def right_sql(self, expression: sqlglot.expressions.string.Right) -> str:
545    def right_sql(self, expression: exp.Right) -> str:
546        return self._uncast_text(expression, "RIGHT")
def left_sql(self, expression: sqlglot.expressions.string.Left) -> str:
548    def left_sql(self, expression: exp.Left) -> str:
549        return self._uncast_text(expression, "LEFT")
def partition_sql(self, expression: sqlglot.expressions.query.Partition) -> str:
560    def partition_sql(self, expression: exp.Partition) -> str:
561        return f"WITH (PARTITIONS({self.expressions(expression, flat=True)}))"
def alter_sql(self, expression: sqlglot.expressions.ddl.Alter) -> str:
563    def alter_sql(self, expression: exp.Alter) -> str:
564        action = seq_get(expression.args.get("actions") or [], 0)
565        if isinstance(action, exp.AlterRename):
566            return f"EXEC sp_rename '{self.sql(expression.this)}', '{action.this.name}'"
567        return super().alter_sql(expression)
def drop_sql(self, expression: sqlglot.expressions.ddl.Drop) -> str:
569    def drop_sql(self, expression: exp.Drop) -> str:
570        if expression.args["kind"] == "VIEW":
571            expression.this.set("catalog", None)
572        return super().drop_sql(expression)
def options_modifier(self, expression: sqlglot.expressions.core.Expr) -> str:
574    def options_modifier(self, expression: exp.Expr) -> str:
575        options = self.expressions(expression, key="options")
576        return f" OPTION{self.wrap(options)}" if options else ""
def dpipe_sql(self, expression: sqlglot.expressions.core.DPipe) -> str:
578    def dpipe_sql(self, expression: exp.DPipe) -> str:
579        return self.sql(reduce(lambda x, y: exp.Add(this=x, expression=y), expression.flatten()))
def isascii_sql(self, expression: sqlglot.expressions.string.IsAscii) -> str:
581    def isascii_sql(self, expression: exp.IsAscii) -> str:
582        return f"(PATINDEX(CONVERT(VARCHAR(MAX), 0x255b5e002d7f5d25) COLLATE Latin1_General_BIN, {self.sql(expression.this)}) = 0)"
def columndef_sql( self, expression: sqlglot.expressions.query.ColumnDef, sep: str = ' ') -> str:
584    def columndef_sql(self, expression: exp.ColumnDef, sep: str = " ") -> str:
585        this = super().columndef_sql(expression, sep)
586        default = self.sql(expression, "default")
587        default = f" = {default}" if default else ""
588        output = self.sql(expression, "output")
589        output = f" {output}" if output else ""
590        return f"{this}{default}{output}"
def coalesce_sql(self, expression: sqlglot.expressions.functions.Coalesce) -> str:
592    def coalesce_sql(self, expression: exp.Coalesce) -> str:
593        func_name = "ISNULL" if expression.args.get("is_null") else "COALESCE"
594        return rename_func(func_name)(self, expression)
def storedprocedure_sql(self, expression: sqlglot.expressions.query.StoredProcedure) -> str:
596    def storedprocedure_sql(self, expression: exp.StoredProcedure) -> str:
597        this = self.sql(expression, "this")
598        expressions = self.expressions(expression)
599        expressions = (
600            self.wrap(expressions) if expression.args.get("wrapped") else f" {expressions}"
601        )
602        return f"{this}{expressions}" if expressions.strip() != "" else this
def ifblock_sql(self, expression: sqlglot.expressions.query.IfBlock) -> str:
604    def ifblock_sql(self, expression: exp.IfBlock) -> str:
605        this = self.sql(expression, "this")
606        true = self.sql(expression, "true")
607        true = f" {true}" if true else " "
608        false = self.sql(expression, "false")
609        false = f"; ELSE BEGIN {false}" if false else ""
610        return f"IF {this} BEGIN{true}{false}"
def whileblock_sql(self, expression: sqlglot.expressions.query.WhileBlock) -> str:
612    def whileblock_sql(self, expression: exp.WhileBlock) -> str:
613        this = self.sql(expression, "this")
614        body = self.sql(expression, "body")
615        body = f" {body}" if body else " "
616        return f"WHILE {this} BEGIN{body}"
def execute_sql(self, expression: sqlglot.expressions.ddl.Execute) -> str:
618    def execute_sql(self, expression: exp.Execute) -> str:
619        this = self.sql(expression, "this")
620        expressions = self.expressions(expression)
621        expressions = f" {expressions}" if expressions else ""
622        return f"EXECUTE {this}{expressions}"
def executesql_sql(self, expression: sqlglot.expressions.ddl.ExecuteSql) -> str:
624    def executesql_sql(self, expression: exp.ExecuteSql) -> str:
625        return self.execute_sql(expression)
Inherited Members
sqlglot.generator.Generator
Generator
WINDOW_FUNCS_WITH_NULL_ORDERING
IGNORE_NULLS_IN_FUNC
IGNORE_NULLS_BEFORE_ORDER
LOCKING_READS_SUPPORTED
WRAP_DERIVED_VALUES
CREATE_FUNCTION_RETURN_AS
MATCHED_BY_SOURCE
SUPPORTS_MERGE_WHERE
SINGLE_STRING_INTERVAL
INTERVAL_ALLOWS_PLURAL_FORM
LIMIT_ONLY_LITERALS
RENAME_TABLE_WITH_DB
GROUPINGS_SEP
INDEX_ON
INOUT_SEPARATOR
JOIN_HINTS
DIRECTED_JOINS
TABLE_HINTS
QUERY_HINT_SEP
IS_BOOL_ALLOWED
DUPLICATE_KEY_UPDATE_WITH_SET
EXTRACT_ALLOWS_QUOTES
TZ_TO_WITH_TIME_ZONE
VALUES_AS_TABLE
UNNEST_WITH_ORDINALITY
AGGREGATE_FILTER_SUPPORTED
SEMI_ANTI_JOIN_WITH_SIDE
SUPPORTS_TABLE_COPY
TABLESAMPLE_REQUIRES_PARENS
TABLESAMPLE_SIZE_IS_ROWS
TABLESAMPLE_KEYWORDS
TABLESAMPLE_WITH_METHOD
COLLATE_IS_FUNC
DATA_TYPE_SPECIFIERS_ALLOWED
LAST_DAY_SUPPORTS_DATE_PART
SUPPORTS_TABLE_ALIAS_COLUMNS
UNPIVOT_ALIASES_ARE_IDENTIFIERS
JSON_KEY_VALUE_PAIR_SEP
INSERT_OVERWRITE
SUPPORTS_UNLOGGED_TABLES
SUPPORTS_CREATE_TABLE_LIKE
LIKE_PROPERTY_INSIDE_SCHEMA
MULTI_ARG_DISTINCT
JSON_TYPE_REQUIRED_FOR_EXTRACTION
JSON_PATH_SINGLE_QUOTE_ESCAPE
CAN_IMPLEMENT_ARRAY_ANY
SUPPORTS_WINDOW_EXCLUDE
COPY_PARAMS_ARE_WRAPPED
COPY_HAS_INTO_KEYWORD
UNICODE_SUBSTITUTE
STAR_EXCEPT
HEX_FUNC
WITH_PROPERTIES_PREFIX
QUOTE_JSON_PATH
PAD_FILL_PATTERN_IS_REQUIRED
SUPPORTS_EXPLODING_PROJECTIONS
ARRAY_CONCAT_IS_VAR_LEN
SUPPORTS_CONVERT_TIMEZONE
SUPPORTS_MEDIAN
SUPPORTS_UNIX_SECONDS
NORMALIZE_EXTRACT_DATE_PARTS
ARRAY_SIZE_NAME
ARRAY_SIZE_DIM_REQUIRED
SUPPORTS_BETWEEN_FLAGS
SUPPORTS_LIKE_QUANTIFIERS
MATCH_AGAINST_TABLE_PREFIX
SET_ASSIGNMENT_REQUIRES_VARIABLE_KEYWORD
DECLARE_DEFAULT_ASSIGNMENT
UPDATE_STATEMENT_SUPPORTS_FROM
STAR_EXCLUDE_REQUIRES_DERIVED_TABLE
SUPPORTS_DROP_ALTER_ICEBERG_PROPERTY
UNSUPPORTED_TYPES
TIME_PART_SINGULARS
TOKEN_MAPPING
STRUCT_DELIMITER
PARAMETER_TOKEN
NAMED_PLACEHOLDER_TOKEN
EXPRESSION_PRECEDES_PROPERTIES_CREATABLES
RESERVED_KEYWORDS
WITH_SEPARATED_COMMENTS
EXCLUDE_COMMENTS
UNWRAPPED_INTERVAL_VALUES
PARAMETERIZABLE_TEXT_TYPES
RESPECT_IGNORE_NULLS_UNSUPPORTED_EXPRESSIONS
SAFE_JSON_PATH_KEY_RE
SENTINEL_LINE_BREAK
pretty
identify
normalize
pad
unsupported_level
max_unsupported
leading_comma
max_text_width
comments
dialect
normalize_functions
unsupported_messages
generate
preprocess
unsupported
sep
seg
sanitize_comment
maybe_comment
wrap
no_identify
normalize_func
indent
sql
uncache_sql
cache_sql
characterset_sql
column_parts
column_sql
pseudocolumn_sql
columnposition_sql
columnconstraint_sql
computedcolumnconstraint_sql
autoincrementcolumnconstraint_sql
compresscolumnconstraint_sql
generatedasidentitycolumnconstraint_sql
generatedasrowcolumnconstraint_sql
periodforsystemtimeconstraint_sql
notnullcolumnconstraint_sql
primarykeycolumnconstraint_sql
uniquecolumnconstraint_sql
inoutcolumnconstraint_sql
sequenceproperties_sql
triggerproperties_sql
triggerreferencing_sql
triggerevent_sql
clone_sql
describe_sql
heredoc_sql
prepend_ctes
with_sql
cte_sql
tablealias_sql
bitstring_sql
hexstring_sql
bytestring_sql
unicodestring_sql
rawstring_sql
datatypeparam_sql
datatype_sql
directory_sql
delete_sql
set_operation
set_operations
fetch_sql
limitoptions_sql
filter_sql
hint_sql
indexparameters_sql
index_sql
hex_sql
lowerhex_sql
inputoutputformat_sql
national_sql
properties_sql
root_properties
properties
with_properties
locate_properties
property_name
property_sql
uuidproperty_sql
likeproperty_sql
fallbackproperty_sql
journalproperty_sql
freespaceproperty_sql
checksumproperty_sql
mergeblockratioproperty_sql
moduleproperty_sql
datablocksizeproperty_sql
blockcompressionproperty_sql
isolatedloadingproperty_sql
partitionboundspec_sql
partitionedofproperty_sql
lockingproperty_sql
withdataproperty_sql
withsystemversioningproperty_sql
insert_sql
introducer_sql
kill_sql
pseudotype_sql
objectidentifier_sql
onconflict_sql
rowformatdelimitedproperty_sql
withtablehint_sql
indextablehint_sql
historicaldata_sql
table_parts
table_sql
tablefromrows_sql
tablesample_sql
pivot_sql
tuple_sql
update_sql
values_sql
var_sql
from_sql
groupingsets_sql
rollup_sql
rollupindex_sql
rollupproperty_sql
cube_sql
group_sql
having_sql
connect_sql
prior_sql
join_sql
lambda_sql
lateral_sql
limit_sql
set_sql
queryband_sql
pragma_sql
lock_sql
literal_sql
escape_str
loaddata_sql
null_sql
booland_sql
boolor_sql
order_sql
withfill_sql
cluster_sql
distribute_sql
sort_sql
ordered_sql
matchrecognizemeasure_sql
matchrecognize_sql
query_modifiers
for_modifiers
offset_limit_modifiers
after_limit_modifiers
schema_sql
schema_columns_sql
star_sql
parameter_sql
sessionparameter_sql
placeholder_sql
subquery_sql
qualify_sql
unnest_sql
prewhere_sql
where_sql
window_sql
partition_by_sql
windowspec_sql
withingroup_sql
between_sql
bracket_offset_expressions
bracket_sql
all_sql
any_sql
exists_sql
case_sql
nextvaluefor_sql
trim_sql
convert_concat_args
concat_sql
concatws_sql
check_sql
foreignkey_sql
primarykey_sql
if_sql
matchagainst_sql
jsonkeyvalue_sql
jsonpath_sql
json_path_part
formatjson_sql
formatphrase_sql
jsonarray_sql
jsonarrayagg_sql
jsoncolumndef_sql
jsonschema_sql
jsontable_sql
openjsoncolumndef_sql
openjson_sql
in_sql
in_unnest_op
interval_sql
return_sql
reference_sql
anonymous_sql
paren_sql
neg_sql
not_sql
alias_sql
pivotalias_sql
aliases_sql
atindex_sql
attimezone_sql
fromtimezone_sql
add_sql
and_sql
or_sql
xor_sql
connector_sql
bitwiseand_sql
bitwiseleftshift_sql
bitwisenot_sql
bitwiseor_sql
bitwiserightshift_sql
bitwisexor_sql
cast_sql
strtotime_sql
currentdate_sql
collate_sql
command_sql
comment_sql
mergetreettlaction_sql
mergetreettl_sql
altercolumn_sql
alterindex_sql
alterdiststyle_sql
altersortkey_sql
alterrename_sql
renamecolumn_sql
alterset_sql
altersession_sql
add_column_sql
droppartition_sql
addconstraint_sql
addpartition_sql
distinct_sql
ignorenulls_sql
respectnulls_sql
havingmax_sql
intdiv_sql
div_sql
safedivide_sql
overlaps_sql
distance_sql
dot_sql
eq_sql
propertyeq_sql
escape_sql
glob_sql
gt_sql
gte_sql
like_sql
ilike_sql
match_sql
similarto_sql
lt_sql
lte_sql
mod_sql
mul_sql
neq_sql
nullsafeeq_sql
nullsafeneq_sql
sub_sql
trycast_sql
jsoncast_sql
try_sql
log_sql
use_sql
binary
ceil_floor
function_fallback_sql
func
format_args
too_wide
format_time
expressions
op_expressions
naked_property
tag_sql
token_sql
userdefinedfunction_sql
joinhint_sql
kwarg_sql
when_sql
whens_sql
merge_sql
tochar_sql
tonumber_sql
dictproperty_sql
dictrange_sql
dictsubproperty_sql
duplicatekeyproperty_sql
uniquekeyproperty_sql
distributedbyproperty_sql
oncluster_sql
clusteredbyproperty_sql
anyvalue_sql
querytransform_sql
indexconstraintoption_sql
checkcolumnconstraint_sql
indexcolumnconstraint_sql
nvl2_sql
comprehension_sql
columnprefix_sql
opclass_sql
predict_sql
generateembedding_sql
generatetext_sql
generatetable_sql
generatebool_sql
generateint_sql
generatedouble_sql
mltranslate_sql
mlforecast_sql
aiforecast_sql
featuresattime_sql
vectorsearch_sql
forin_sql
refresh_sql
toarray_sql
tsordstotime_sql
tsordstotimestamp_sql
tsordstodatetime_sql
tsordstodate_sql
unixdate_sql
lastday_sql
dateadd_sql
arrayany_sql
struct_sql
partitionrange_sql
truncatetable_sql
copyparameter_sql
credentials_sql
copy_sql
semicolon_sql
datadeletionproperty_sql
maskingpolicycolumnconstraint_sql
gapfill_sql
scoperesolution_sql
parsejson_sql
rand_sql
changes_sql
pad_sql
summarize_sql
explodinggenerateseries_sql
converttimezone_sql
json_sql
jsonvalue_sql
skipjsoncolumn_sql
conditionalinsert_sql
multitableinserts_sql
oncondition_sql
jsonextractquote_sql
jsonexists_sql
arrayagg_sql
slice_sql
apply_sql
grant_sql
revoke_sql
grantprivilege_sql
grantprincipal_sql
columns_sql
overlay_sql
todouble_sql
string_sql
median_sql
overflowtruncatebehavior_sql
unixseconds_sql
arraysize_sql
attach_sql
detach_sql
attachoption_sql
watermarkcolumnconstraint_sql
encodeproperty_sql
includeproperty_sql
xmlelement_sql
xmlkeyvalueoption_sql
partitionbyrangeproperty_sql
partitionbyrangepropertydynamic_sql
unpivotcolumns_sql
analyzesample_sql
analyzestatistics_sql
analyzehistogram_sql
analyzedelete_sql
analyzelistchainedrows_sql
analyzevalidate_sql
analyze_sql
xmltable_sql
xmlnamespace_sql
export_sql
declare_sql
declareitem_sql
recursivewithsearch_sql
parameterizedagg_sql
anonymousaggfunc_sql
combinedaggfunc_sql
combinedparameterizedagg_sql
show_sql
install_sql
get_put_sql
translatecharacters_sql
decodecase_sql
semanticview_sql
getextract_sql
datefromunixdate_sql
space_sql
buildproperty_sql
refreshtriggerproperty_sql
modelattribute_sql
directorystage_sql
uuid_sql
initcap_sql
localtime_sql
localtimestamp_sql
weekstart_sql
chr_sql
block_sql
altermodifysqlsecurity_sql
usingproperty_sql
renameindex_sql