Edit on GitHub

sqlglot.dialects.duckdb

  1from __future__ import annotations
  2
  3from sqlglot import exp, generator, parser, tokens
  4from sqlglot.dialects.dialect import (
  5    Dialect,
  6    approx_count_distinct_sql,
  7    arrow_json_extract_scalar_sql,
  8    arrow_json_extract_sql,
  9    datestrtodate_sql,
 10    format_time_lambda,
 11    no_pivot_sql,
 12    no_properties_sql,
 13    no_safe_divide_sql,
 14    no_tablesample_sql,
 15    rename_func,
 16    str_position_sql,
 17    str_to_time_sql,
 18    timestrtotime_sql,
 19    ts_or_ds_to_date_sql,
 20)
 21from sqlglot.helper import seq_get
 22from sqlglot.tokens import TokenType
 23
 24
 25def _ts_or_ds_add(self, expression):
 26    this = expression.args.get("this")
 27    unit = self.sql(expression, "unit").strip("'") or "DAY"
 28    return f"CAST({this} AS DATE) + {self.sql(exp.Interval(this=expression.expression, unit=unit))}"
 29
 30
 31def _date_add(self, expression):
 32    this = self.sql(expression, "this")
 33    unit = self.sql(expression, "unit").strip("'") or "DAY"
 34    return f"{this} + {self.sql(exp.Interval(this=expression.expression, unit=unit))}"
 35
 36
 37def _array_sort_sql(self, expression):
 38    if expression.expression:
 39        self.unsupported("DUCKDB ARRAY_SORT does not support a comparator")
 40    return f"ARRAY_SORT({self.sql(expression, 'this')})"
 41
 42
 43def _sort_array_sql(self, expression):
 44    this = self.sql(expression, "this")
 45    if expression.args.get("asc") == exp.false():
 46        return f"ARRAY_REVERSE_SORT({this})"
 47    return f"ARRAY_SORT({this})"
 48
 49
 50def _sort_array_reverse(args):
 51    return exp.SortArray(this=seq_get(args, 0), asc=exp.false())
 52
 53
 54def _struct_sql(self, expression):
 55    args = [
 56        f"'{e.name or e.this.name}': {self.sql(e, 'expression')}" for e in expression.expressions
 57    ]
 58    return f"{{{', '.join(args)}}}"
 59
 60
 61def _datatype_sql(self, expression):
 62    if expression.this == exp.DataType.Type.ARRAY:
 63        return f"{self.expressions(expression, flat=True)}[]"
 64    return self.datatype_sql(expression)
 65
 66
 67def _regexp_extract_sql(self, expression):
 68    bad_args = list(filter(expression.args.get, ("position", "occurrence")))
 69    if bad_args:
 70        self.unsupported(f"REGEXP_EXTRACT does not support arg(s) {bad_args}")
 71    return self.func(
 72        "REGEXP_EXTRACT",
 73        expression.args.get("this"),
 74        expression.args.get("expression"),
 75        expression.args.get("group"),
 76    )
 77
 78
 79class DuckDB(Dialect):
 80    class Tokenizer(tokens.Tokenizer):
 81        KEYWORDS = {
 82            **tokens.Tokenizer.KEYWORDS,
 83            ":=": TokenType.EQ,
 84            "ATTACH": TokenType.COMMAND,
 85            "CHARACTER VARYING": TokenType.VARCHAR,
 86            "EXCLUDE": TokenType.EXCEPT,
 87        }
 88
 89    class Parser(parser.Parser):
 90        FUNCTIONS = {
 91            **parser.Parser.FUNCTIONS,  # type: ignore
 92            "APPROX_COUNT_DISTINCT": exp.ApproxDistinct.from_arg_list,
 93            "ARRAY_LENGTH": exp.ArraySize.from_arg_list,
 94            "ARRAY_SORT": exp.SortArray.from_arg_list,
 95            "ARRAY_REVERSE_SORT": _sort_array_reverse,
 96            "EPOCH": exp.TimeToUnix.from_arg_list,
 97            "EPOCH_MS": lambda args: exp.UnixToTime(
 98                this=exp.Div(
 99                    this=seq_get(args, 0),
100                    expression=exp.Literal.number(1000),
101                )
102            ),
103            "LIST_SORT": exp.SortArray.from_arg_list,
104            "LIST_REVERSE_SORT": _sort_array_reverse,
105            "LIST_VALUE": exp.Array.from_arg_list,
106            "REGEXP_MATCHES": exp.RegexpLike.from_arg_list,
107            "STRFTIME": format_time_lambda(exp.TimeToStr, "duckdb"),
108            "STRPTIME": format_time_lambda(exp.StrToTime, "duckdb"),
109            "STR_SPLIT": exp.Split.from_arg_list,
110            "STRING_SPLIT": exp.Split.from_arg_list,
111            "STRING_TO_ARRAY": exp.Split.from_arg_list,
112            "STR_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
113            "STRING_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
114            "STRUCT_PACK": exp.Struct.from_arg_list,
115            "TO_TIMESTAMP": exp.UnixToTime.from_arg_list,
116            "UNNEST": exp.Explode.from_arg_list,
117        }
118
119    class Generator(generator.Generator):
120        STRUCT_DELIMITER = ("(", ")")
121
122        TRANSFORMS = {
123            **generator.Generator.TRANSFORMS,  # type: ignore
124            exp.ApproxDistinct: approx_count_distinct_sql,
125            exp.Array: lambda self, e: self.func("ARRAY", e.expressions[0])
126            if isinstance(seq_get(e.expressions, 0), exp.Select)
127            else rename_func("LIST_VALUE")(self, e),
128            exp.ArraySize: rename_func("ARRAY_LENGTH"),
129            exp.ArraySort: _array_sort_sql,
130            exp.ArraySum: rename_func("LIST_SUM"),
131            exp.DataType: _datatype_sql,
132            exp.DateAdd: _date_add,
133            exp.DateDiff: lambda self, e: self.func(
134                "DATE_DIFF", e.args.get("unit") or exp.Literal.string("day"), e.expression, e.this
135            ),
136            exp.DateStrToDate: datestrtodate_sql,
137            exp.DateToDi: lambda self, e: f"CAST(STRFTIME({self.sql(e, 'this')}, {DuckDB.dateint_format}) AS INT)",
138            exp.DiToDate: lambda self, e: f"CAST(STRPTIME(CAST({self.sql(e, 'this')} AS TEXT), {DuckDB.dateint_format}) AS DATE)",
139            exp.Explode: rename_func("UNNEST"),
140            exp.JSONExtract: arrow_json_extract_sql,
141            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
142            exp.JSONBExtract: arrow_json_extract_sql,
143            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
144            exp.LogicalOr: rename_func("BOOL_OR"),
145            exp.Pivot: no_pivot_sql,
146            exp.Properties: no_properties_sql,
147            exp.RegexpExtract: _regexp_extract_sql,
148            exp.RegexpLike: rename_func("REGEXP_MATCHES"),
149            exp.RegexpSplit: rename_func("STR_SPLIT_REGEX"),
150            exp.SafeDivide: no_safe_divide_sql,
151            exp.Split: rename_func("STR_SPLIT"),
152            exp.SortArray: _sort_array_sql,
153            exp.StrPosition: str_position_sql,
154            exp.StrToDate: lambda self, e: f"CAST({str_to_time_sql(self, e)} AS DATE)",
155            exp.StrToTime: str_to_time_sql,
156            exp.StrToUnix: lambda self, e: f"EPOCH(STRPTIME({self.sql(e, 'this')}, {self.format_time(e)}))",
157            exp.Struct: _struct_sql,
158            exp.TableSample: no_tablesample_sql,
159            exp.TimeStrToDate: lambda self, e: f"CAST({self.sql(e, 'this')} AS DATE)",
160            exp.TimeStrToTime: timestrtotime_sql,
161            exp.TimeStrToUnix: lambda self, e: f"EPOCH(CAST({self.sql(e, 'this')} AS TIMESTAMP))",
162            exp.TimeToStr: lambda self, e: f"STRFTIME({self.sql(e, 'this')}, {self.format_time(e)})",
163            exp.TimeToUnix: rename_func("EPOCH"),
164            exp.TsOrDiToDi: lambda self, e: f"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS TEXT), '-', ''), 1, 8) AS INT)",
165            exp.TsOrDsAdd: _ts_or_ds_add,
166            exp.TsOrDsToDate: ts_or_ds_to_date_sql("duckdb"),
167            exp.UnixToStr: lambda self, e: f"STRFTIME(TO_TIMESTAMP({self.sql(e, 'this')}), {self.format_time(e)})",
168            exp.UnixToTime: rename_func("TO_TIMESTAMP"),
169            exp.UnixToTimeStr: lambda self, e: f"CAST(TO_TIMESTAMP({self.sql(e, 'this')}) AS TEXT)",
170        }
171
172        TYPE_MAPPING = {
173            **generator.Generator.TYPE_MAPPING,  # type: ignore
174            exp.DataType.Type.VARCHAR: "TEXT",
175            exp.DataType.Type.NVARCHAR: "TEXT",
176        }
177
178        STAR_MAPPING = {
179            **generator.Generator.STAR_MAPPING,
180            "except": "EXCLUDE",
181        }
class DuckDB(sqlglot.dialects.dialect.Dialect):
 80class DuckDB(Dialect):
 81    class Tokenizer(tokens.Tokenizer):
 82        KEYWORDS = {
 83            **tokens.Tokenizer.KEYWORDS,
 84            ":=": TokenType.EQ,
 85            "ATTACH": TokenType.COMMAND,
 86            "CHARACTER VARYING": TokenType.VARCHAR,
 87            "EXCLUDE": TokenType.EXCEPT,
 88        }
 89
 90    class Parser(parser.Parser):
 91        FUNCTIONS = {
 92            **parser.Parser.FUNCTIONS,  # type: ignore
 93            "APPROX_COUNT_DISTINCT": exp.ApproxDistinct.from_arg_list,
 94            "ARRAY_LENGTH": exp.ArraySize.from_arg_list,
 95            "ARRAY_SORT": exp.SortArray.from_arg_list,
 96            "ARRAY_REVERSE_SORT": _sort_array_reverse,
 97            "EPOCH": exp.TimeToUnix.from_arg_list,
 98            "EPOCH_MS": lambda args: exp.UnixToTime(
 99                this=exp.Div(
100                    this=seq_get(args, 0),
101                    expression=exp.Literal.number(1000),
102                )
103            ),
104            "LIST_SORT": exp.SortArray.from_arg_list,
105            "LIST_REVERSE_SORT": _sort_array_reverse,
106            "LIST_VALUE": exp.Array.from_arg_list,
107            "REGEXP_MATCHES": exp.RegexpLike.from_arg_list,
108            "STRFTIME": format_time_lambda(exp.TimeToStr, "duckdb"),
109            "STRPTIME": format_time_lambda(exp.StrToTime, "duckdb"),
110            "STR_SPLIT": exp.Split.from_arg_list,
111            "STRING_SPLIT": exp.Split.from_arg_list,
112            "STRING_TO_ARRAY": exp.Split.from_arg_list,
113            "STR_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
114            "STRING_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
115            "STRUCT_PACK": exp.Struct.from_arg_list,
116            "TO_TIMESTAMP": exp.UnixToTime.from_arg_list,
117            "UNNEST": exp.Explode.from_arg_list,
118        }
119
120    class Generator(generator.Generator):
121        STRUCT_DELIMITER = ("(", ")")
122
123        TRANSFORMS = {
124            **generator.Generator.TRANSFORMS,  # type: ignore
125            exp.ApproxDistinct: approx_count_distinct_sql,
126            exp.Array: lambda self, e: self.func("ARRAY", e.expressions[0])
127            if isinstance(seq_get(e.expressions, 0), exp.Select)
128            else rename_func("LIST_VALUE")(self, e),
129            exp.ArraySize: rename_func("ARRAY_LENGTH"),
130            exp.ArraySort: _array_sort_sql,
131            exp.ArraySum: rename_func("LIST_SUM"),
132            exp.DataType: _datatype_sql,
133            exp.DateAdd: _date_add,
134            exp.DateDiff: lambda self, e: self.func(
135                "DATE_DIFF", e.args.get("unit") or exp.Literal.string("day"), e.expression, e.this
136            ),
137            exp.DateStrToDate: datestrtodate_sql,
138            exp.DateToDi: lambda self, e: f"CAST(STRFTIME({self.sql(e, 'this')}, {DuckDB.dateint_format}) AS INT)",
139            exp.DiToDate: lambda self, e: f"CAST(STRPTIME(CAST({self.sql(e, 'this')} AS TEXT), {DuckDB.dateint_format}) AS DATE)",
140            exp.Explode: rename_func("UNNEST"),
141            exp.JSONExtract: arrow_json_extract_sql,
142            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
143            exp.JSONBExtract: arrow_json_extract_sql,
144            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
145            exp.LogicalOr: rename_func("BOOL_OR"),
146            exp.Pivot: no_pivot_sql,
147            exp.Properties: no_properties_sql,
148            exp.RegexpExtract: _regexp_extract_sql,
149            exp.RegexpLike: rename_func("REGEXP_MATCHES"),
150            exp.RegexpSplit: rename_func("STR_SPLIT_REGEX"),
151            exp.SafeDivide: no_safe_divide_sql,
152            exp.Split: rename_func("STR_SPLIT"),
153            exp.SortArray: _sort_array_sql,
154            exp.StrPosition: str_position_sql,
155            exp.StrToDate: lambda self, e: f"CAST({str_to_time_sql(self, e)} AS DATE)",
156            exp.StrToTime: str_to_time_sql,
157            exp.StrToUnix: lambda self, e: f"EPOCH(STRPTIME({self.sql(e, 'this')}, {self.format_time(e)}))",
158            exp.Struct: _struct_sql,
159            exp.TableSample: no_tablesample_sql,
160            exp.TimeStrToDate: lambda self, e: f"CAST({self.sql(e, 'this')} AS DATE)",
161            exp.TimeStrToTime: timestrtotime_sql,
162            exp.TimeStrToUnix: lambda self, e: f"EPOCH(CAST({self.sql(e, 'this')} AS TIMESTAMP))",
163            exp.TimeToStr: lambda self, e: f"STRFTIME({self.sql(e, 'this')}, {self.format_time(e)})",
164            exp.TimeToUnix: rename_func("EPOCH"),
165            exp.TsOrDiToDi: lambda self, e: f"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS TEXT), '-', ''), 1, 8) AS INT)",
166            exp.TsOrDsAdd: _ts_or_ds_add,
167            exp.TsOrDsToDate: ts_or_ds_to_date_sql("duckdb"),
168            exp.UnixToStr: lambda self, e: f"STRFTIME(TO_TIMESTAMP({self.sql(e, 'this')}), {self.format_time(e)})",
169            exp.UnixToTime: rename_func("TO_TIMESTAMP"),
170            exp.UnixToTimeStr: lambda self, e: f"CAST(TO_TIMESTAMP({self.sql(e, 'this')}) AS TEXT)",
171        }
172
173        TYPE_MAPPING = {
174            **generator.Generator.TYPE_MAPPING,  # type: ignore
175            exp.DataType.Type.VARCHAR: "TEXT",
176            exp.DataType.Type.NVARCHAR: "TEXT",
177        }
178
179        STAR_MAPPING = {
180            **generator.Generator.STAR_MAPPING,
181            "except": "EXCLUDE",
182        }
class DuckDB.Tokenizer(sqlglot.tokens.Tokenizer):
81    class Tokenizer(tokens.Tokenizer):
82        KEYWORDS = {
83            **tokens.Tokenizer.KEYWORDS,
84            ":=": TokenType.EQ,
85            "ATTACH": TokenType.COMMAND,
86            "CHARACTER VARYING": TokenType.VARCHAR,
87            "EXCLUDE": TokenType.EXCEPT,
88        }
class DuckDB.Parser(sqlglot.parser.Parser):
 90    class Parser(parser.Parser):
 91        FUNCTIONS = {
 92            **parser.Parser.FUNCTIONS,  # type: ignore
 93            "APPROX_COUNT_DISTINCT": exp.ApproxDistinct.from_arg_list,
 94            "ARRAY_LENGTH": exp.ArraySize.from_arg_list,
 95            "ARRAY_SORT": exp.SortArray.from_arg_list,
 96            "ARRAY_REVERSE_SORT": _sort_array_reverse,
 97            "EPOCH": exp.TimeToUnix.from_arg_list,
 98            "EPOCH_MS": lambda args: exp.UnixToTime(
 99                this=exp.Div(
100                    this=seq_get(args, 0),
101                    expression=exp.Literal.number(1000),
102                )
103            ),
104            "LIST_SORT": exp.SortArray.from_arg_list,
105            "LIST_REVERSE_SORT": _sort_array_reverse,
106            "LIST_VALUE": exp.Array.from_arg_list,
107            "REGEXP_MATCHES": exp.RegexpLike.from_arg_list,
108            "STRFTIME": format_time_lambda(exp.TimeToStr, "duckdb"),
109            "STRPTIME": format_time_lambda(exp.StrToTime, "duckdb"),
110            "STR_SPLIT": exp.Split.from_arg_list,
111            "STRING_SPLIT": exp.Split.from_arg_list,
112            "STRING_TO_ARRAY": exp.Split.from_arg_list,
113            "STR_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
114            "STRING_SPLIT_REGEX": exp.RegexpSplit.from_arg_list,
115            "STRUCT_PACK": exp.Struct.from_arg_list,
116            "TO_TIMESTAMP": exp.UnixToTime.from_arg_list,
117            "UNNEST": exp.Explode.from_arg_list,
118        }

Parser consumes a list of tokens produced by the sqlglot.tokens.Tokenizer and produces a parsed syntax tree.

Arguments:
  • error_level: the desired error level. Default: ErrorLevel.RAISE
  • error_message_context: determines the amount of context to capture from a query string when displaying the error message (in number of characters). Default: 50.
  • index_offset: Index offset for arrays eg ARRAY[0] vs ARRAY[1] as the head of a list. Default: 0
  • alias_post_tablesample: If the table alias comes after tablesample. Default: False
  • max_errors: Maximum number of error messages to include in a raised ParseError. This is only relevant if error_level is ErrorLevel.RAISE. Default: 3
  • null_ordering: Indicates the default null ordering method to use if not explicitly set. Options are "nulls_are_small", "nulls_are_large", "nulls_are_last". Default: "nulls_are_small"
class DuckDB.Generator(sqlglot.generator.Generator):
120    class Generator(generator.Generator):
121        STRUCT_DELIMITER = ("(", ")")
122
123        TRANSFORMS = {
124            **generator.Generator.TRANSFORMS,  # type: ignore
125            exp.ApproxDistinct: approx_count_distinct_sql,
126            exp.Array: lambda self, e: self.func("ARRAY", e.expressions[0])
127            if isinstance(seq_get(e.expressions, 0), exp.Select)
128            else rename_func("LIST_VALUE")(self, e),
129            exp.ArraySize: rename_func("ARRAY_LENGTH"),
130            exp.ArraySort: _array_sort_sql,
131            exp.ArraySum: rename_func("LIST_SUM"),
132            exp.DataType: _datatype_sql,
133            exp.DateAdd: _date_add,
134            exp.DateDiff: lambda self, e: self.func(
135                "DATE_DIFF", e.args.get("unit") or exp.Literal.string("day"), e.expression, e.this
136            ),
137            exp.DateStrToDate: datestrtodate_sql,
138            exp.DateToDi: lambda self, e: f"CAST(STRFTIME({self.sql(e, 'this')}, {DuckDB.dateint_format}) AS INT)",
139            exp.DiToDate: lambda self, e: f"CAST(STRPTIME(CAST({self.sql(e, 'this')} AS TEXT), {DuckDB.dateint_format}) AS DATE)",
140            exp.Explode: rename_func("UNNEST"),
141            exp.JSONExtract: arrow_json_extract_sql,
142            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
143            exp.JSONBExtract: arrow_json_extract_sql,
144            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
145            exp.LogicalOr: rename_func("BOOL_OR"),
146            exp.Pivot: no_pivot_sql,
147            exp.Properties: no_properties_sql,
148            exp.RegexpExtract: _regexp_extract_sql,
149            exp.RegexpLike: rename_func("REGEXP_MATCHES"),
150            exp.RegexpSplit: rename_func("STR_SPLIT_REGEX"),
151            exp.SafeDivide: no_safe_divide_sql,
152            exp.Split: rename_func("STR_SPLIT"),
153            exp.SortArray: _sort_array_sql,
154            exp.StrPosition: str_position_sql,
155            exp.StrToDate: lambda self, e: f"CAST({str_to_time_sql(self, e)} AS DATE)",
156            exp.StrToTime: str_to_time_sql,
157            exp.StrToUnix: lambda self, e: f"EPOCH(STRPTIME({self.sql(e, 'this')}, {self.format_time(e)}))",
158            exp.Struct: _struct_sql,
159            exp.TableSample: no_tablesample_sql,
160            exp.TimeStrToDate: lambda self, e: f"CAST({self.sql(e, 'this')} AS DATE)",
161            exp.TimeStrToTime: timestrtotime_sql,
162            exp.TimeStrToUnix: lambda self, e: f"EPOCH(CAST({self.sql(e, 'this')} AS TIMESTAMP))",
163            exp.TimeToStr: lambda self, e: f"STRFTIME({self.sql(e, 'this')}, {self.format_time(e)})",
164            exp.TimeToUnix: rename_func("EPOCH"),
165            exp.TsOrDiToDi: lambda self, e: f"CAST(SUBSTR(REPLACE(CAST({self.sql(e, 'this')} AS TEXT), '-', ''), 1, 8) AS INT)",
166            exp.TsOrDsAdd: _ts_or_ds_add,
167            exp.TsOrDsToDate: ts_or_ds_to_date_sql("duckdb"),
168            exp.UnixToStr: lambda self, e: f"STRFTIME(TO_TIMESTAMP({self.sql(e, 'this')}), {self.format_time(e)})",
169            exp.UnixToTime: rename_func("TO_TIMESTAMP"),
170            exp.UnixToTimeStr: lambda self, e: f"CAST(TO_TIMESTAMP({self.sql(e, 'this')}) AS TEXT)",
171        }
172
173        TYPE_MAPPING = {
174            **generator.Generator.TYPE_MAPPING,  # type: ignore
175            exp.DataType.Type.VARCHAR: "TEXT",
176            exp.DataType.Type.NVARCHAR: "TEXT",
177        }
178
179        STAR_MAPPING = {
180            **generator.Generator.STAR_MAPPING,
181            "except": "EXCLUDE",
182        }

Generator interprets the given syntax tree and produces a SQL string as an output.

Arguments:
  • time_mapping (dict): the dictionary of custom time mappings in which the key represents a python time format and the output the target time format
  • time_trie (trie): a trie of the time_mapping keys
  • pretty (bool): if set to True the returned string will be formatted. Default: False.
  • quote_start (str): specifies which starting character to use to delimit quotes. Default: '.
  • quote_end (str): specifies which ending character to use to delimit quotes. Default: '.
  • identifier_start (str): specifies which starting character to use to delimit identifiers. Default: ".
  • identifier_end (str): specifies which ending character to use to delimit identifiers. Default: ".
  • identify (bool): if set to True all identifiers will be delimited by the corresponding character.
  • normalize (bool): if set to True all identifiers will lower cased
  • string_escape (str): specifies a string escape character. Default: '.
  • identifier_escape (str): specifies an identifier escape character. Default: ".
  • pad (int): determines padding in a formatted string. Default: 2.
  • indent (int): determines the size of indentation in a formatted string. Default: 4.
  • unnest_column_only (bool): if true unnest table aliases are considered only as column aliases
  • normalize_functions (str): normalize function names, "upper", "lower", or None Default: "upper"
  • alias_post_tablesample (bool): if the table alias comes after tablesample Default: False
  • unsupported_level (ErrorLevel): determines the generator's behavior when it encounters unsupported expressions. Default ErrorLevel.WARN.
  • null_ordering (str): Indicates the default null ordering method to use if not explicitly set. Options are "nulls_are_small", "nulls_are_large", "nulls_are_last". Default: "nulls_are_small"
  • max_unsupported (int): 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 (bool): if the the comma is leading or trailing in select statements Default: False
  • max_text_width: The max number of characters in a segment before creating new lines in pretty mode. The default is on the smaller end because the length only represents a segment and not the true line length. Default: 80
  • comments: Whether or not to preserve comments in the output SQL code. Default: True
Inherited Members
sqlglot.generator.Generator
Generator
generate
unsupported
sep
seg
pad_comment
maybe_comment
wrap
no_identify
normalize_func
indent
sql
uncache_sql
cache_sql
characterset_sql
column_sql
columndef_sql
columnconstraint_sql
autoincrementcolumnconstraint_sql
compresscolumnconstraint_sql
generatedasidentitycolumnconstraint_sql
notnullcolumnconstraint_sql
primarykeycolumnconstraint_sql
uniquecolumnconstraint_sql
create_sql
describe_sql
prepend_ctes
with_sql
cte_sql
tablealias_sql
bitstring_sql
hexstring_sql
datatype_sql
directory_sql
delete_sql
drop_sql
except_sql
except_op
fetch_sql
filter_sql
hint_sql
index_sql
identifier_sql
national_sql
partition_sql
properties_sql
root_properties
properties
with_properties
locate_properties
property_sql
likeproperty_sql
fallbackproperty_sql
journalproperty_sql
freespaceproperty_sql
afterjournalproperty_sql
checksumproperty_sql
mergeblockratioproperty_sql
datablocksizeproperty_sql
blockcompressionproperty_sql
isolatedloadingproperty_sql
lockingproperty_sql
withdataproperty_sql
insert_sql
intersect_sql
intersect_op
introducer_sql
pseudotype_sql
rowformatdelimitedproperty_sql
table_sql
tablesample_sql
pivot_sql
tuple_sql
update_sql
values_sql
var_sql
into_sql
from_sql
group_sql
having_sql
join_sql
lambda_sql
lateral_sql
limit_sql
offset_sql
lock_sql
literal_sql
loaddata_sql
null_sql
boolean_sql
order_sql
cluster_sql
distribute_sql
sort_sql
ordered_sql
matchrecognize_sql
query_modifiers
select_sql
schema_sql
star_sql
structkwarg_sql
parameter_sql
sessionparameter_sql
placeholder_sql
subquery_sql
qualify_sql
union_sql
union_op
unnest_sql
where_sql
window_sql
partition_by_sql
window_spec_sql
withingroup_sql
between_sql
bracket_sql
all_sql
any_sql
exists_sql
case_sql
constraint_sql
extract_sql
trim_sql
concat_sql
check_sql
foreignkey_sql
primarykey_sql
unique_sql
if_sql
in_sql
in_unnest_op
interval_sql
return_sql
reference_sql
anonymous_sql
paren_sql
neg_sql
not_sql
alias_sql
aliases_sql
attimezone_sql
add_sql
and_sql
connector_sql
bitwiseand_sql
bitwiseleftshift_sql
bitwisenot_sql
bitwiseor_sql
bitwiserightshift_sql
bitwisexor_sql
cast_sql
currentdate_sql
collate_sql
command_sql
comment_sql
transaction_sql
commit_sql
rollback_sql
altercolumn_sql
renametable_sql
altertable_sql
droppartition_sql
addconstraint_sql
distinct_sql
ignorenulls_sql
respectnulls_sql
intdiv_sql
dpipe_sql
div_sql
overlaps_sql
distance_sql
dot_sql
eq_sql
escape_sql
glob_sql
gt_sql
gte_sql
ilike_sql
is_sql
like_sql
similarto_sql
lt_sql
lte_sql
mod_sql
mul_sql
neq_sql
nullsafeeq_sql
nullsafeneq_sql
or_sql
slice_sql
sub_sql
trycast_sql
use_sql
binary
function_fallback_sql
func
format_args
text_width
format_time
expressions
op_expressions
naked_property
set_operation
tag_sql
token_sql
userdefinedfunction_sql
joinhint_sql
kwarg_sql
when_sql
merge_sql