sqlglot.dialects.sqlite API documentation

Edit on GitHub

# sqlglot.dialects.sqlite

View Source

      1from __future__ import annotations
      2
      3from sqlglot import exp, generator, parser, tokens, transforms
      4from sqlglot.dialects.dialect import (
      5    Dialect,
      6    arrow_json_extract_scalar_sql,
      7    arrow_json_extract_sql,
      8    count_if_to_sum,
      9    no_ilike_sql,
     10    no_pivot_sql,
     11    no_tablesample_sql,
     12    no_trycast_sql,
     13    rename_func,
     14)
     15from sqlglot.tokens import TokenType
     16
     17
     18def _date_add_sql(self: generator.Generator, expression: exp.DateAdd) -> str:
     19    modifier = expression.expression
     20    modifier = modifier.name if modifier.is_string else self.sql(modifier)
     21    unit = expression.args.get("unit")
     22    modifier = f"'{modifier} {unit.name}'" if unit else f"'{modifier}'"
     23    return self.func("DATE", expression.this, modifier)
     24
     25
     26def _transform_create(expression: exp.Expression) -> exp.Expression:
     27    """Move primary key to a column and enforce auto_increment on primary keys."""
     28    schema = expression.this
     29
     30    if isinstance(expression, exp.Create) and isinstance(schema, exp.Schema):
     31        defs = {}
     32        primary_key = None
     33
     34        for e in schema.expressions:
     35            if isinstance(e, exp.ColumnDef):
     36                defs[e.name] = e
     37            elif isinstance(e, exp.PrimaryKey):
     38                primary_key = e
     39
     40        if primary_key and len(primary_key.expressions) == 1:
     41            column = defs[primary_key.expressions[0].name]
     42            column.append(
     43                "constraints", exp.ColumnConstraint(kind=exp.PrimaryKeyColumnConstraint())
     44            )
     45            schema.expressions.remove(primary_key)
     46        else:
     47            for column in defs.values():
     48                auto_increment = None
     49                for constraint in column.constraints.copy():
     50                    if isinstance(constraint.kind, exp.PrimaryKeyColumnConstraint):
     51                        break
     52                    if isinstance(constraint.kind, exp.AutoIncrementColumnConstraint):
     53                        auto_increment = constraint
     54                if auto_increment:
     55                    column.constraints.remove(auto_increment)
     56
     57    return expression
     58
     59
     60class SQLite(Dialect):
     61    class Tokenizer(tokens.Tokenizer):
     62        IDENTIFIERS = ['"', ("[", "]"), "`"]
     63        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", ""), ("0X", "")]
     64
     65        KEYWORDS = {
     66            **tokens.Tokenizer.KEYWORDS,
     67        }
     68
     69    class Parser(parser.Parser):
     70        FUNCTIONS = {
     71            **parser.Parser.FUNCTIONS,
     72            "EDITDIST3": exp.Levenshtein.from_arg_list,
     73        }
     74
     75    class Generator(generator.Generator):
     76        JOIN_HINTS = False
     77        TABLE_HINTS = False
     78
     79        TYPE_MAPPING = {
     80            **generator.Generator.TYPE_MAPPING,
     81            exp.DataType.Type.BOOLEAN: "INTEGER",
     82            exp.DataType.Type.TINYINT: "INTEGER",
     83            exp.DataType.Type.SMALLINT: "INTEGER",
     84            exp.DataType.Type.INT: "INTEGER",
     85            exp.DataType.Type.BIGINT: "INTEGER",
     86            exp.DataType.Type.FLOAT: "REAL",
     87            exp.DataType.Type.DOUBLE: "REAL",
     88            exp.DataType.Type.DECIMAL: "REAL",
     89            exp.DataType.Type.CHAR: "TEXT",
     90            exp.DataType.Type.NCHAR: "TEXT",
     91            exp.DataType.Type.VARCHAR: "TEXT",
     92            exp.DataType.Type.NVARCHAR: "TEXT",
     93            exp.DataType.Type.BINARY: "BLOB",
     94            exp.DataType.Type.VARBINARY: "BLOB",
     95        }
     96
     97        TOKEN_MAPPING = {
     98            TokenType.AUTO_INCREMENT: "AUTOINCREMENT",
     99        }
    100
    101        TRANSFORMS = {
    102            **generator.Generator.TRANSFORMS,
    103            exp.CountIf: count_if_to_sum,
    104            exp.Create: transforms.preprocess([_transform_create]),
    105            exp.CurrentDate: lambda *_: "CURRENT_DATE",
    106            exp.CurrentTime: lambda *_: "CURRENT_TIME",
    107            exp.CurrentTimestamp: lambda *_: "CURRENT_TIMESTAMP",
    108            exp.DateAdd: _date_add_sql,
    109            exp.DateStrToDate: lambda self, e: self.sql(e, "this"),
    110            exp.ILike: no_ilike_sql,
    111            exp.JSONExtract: arrow_json_extract_sql,
    112            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
    113            exp.JSONBExtract: arrow_json_extract_sql,
    114            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
    115            exp.Levenshtein: rename_func("EDITDIST3"),
    116            exp.LogicalOr: rename_func("MAX"),
    117            exp.LogicalAnd: rename_func("MIN"),
    118            exp.Pivot: no_pivot_sql,
    119            exp.Select: transforms.preprocess(
    120                [transforms.eliminate_distinct_on, transforms.eliminate_qualify]
    121            ),
    122            exp.TableSample: no_tablesample_sql,
    123            exp.TimeStrToTime: lambda self, e: self.sql(e, "this"),
    124            exp.TryCast: no_trycast_sql,
    125        }
    126
    127        PROPERTIES_LOCATION = {
    128            k: exp.Properties.Location.UNSUPPORTED
    129            for k, v in generator.Generator.PROPERTIES_LOCATION.items()
    130        }
    131
    132        LIMIT_FETCH = "LIMIT"
    133
    134        def cast_sql(self, expression: exp.Cast) -> str:
    135            if expression.is_type("date"):
    136                return self.func("DATE", expression.this)
    137
    138            return super().cast_sql(expression)
    139
    140        def datediff_sql(self, expression: exp.DateDiff) -> str:
    141            unit = expression.args.get("unit")
    142            unit = unit.name.upper() if unit else "DAY"
    143
    144            sql = f"(JULIANDAY({self.sql(expression, 'this')}) - JULIANDAY({self.sql(expression, 'expression')}))"
    145
    146            if unit == "MONTH":
    147                sql = f"{sql} / 30.0"
    148            elif unit == "YEAR":
    149                sql = f"{sql} / 365.0"
    150            elif unit == "HOUR":
    151                sql = f"{sql} * 24.0"
    152            elif unit == "MINUTE":
    153                sql = f"{sql} * 1440.0"
    154            elif unit == "SECOND":
    155                sql = f"{sql} * 86400.0"
    156            elif unit == "MILLISECOND":
    157                sql = f"{sql} * 86400000.0"
    158            elif unit == "MICROSECOND":
    159                sql = f"{sql} * 86400000000.0"
    160            elif unit == "NANOSECOND":
    161                sql = f"{sql} * 8640000000000.0"
    162            else:
    163                self.unsupported("DATEDIFF unsupported for '{unit}'.")
    164
    165            return f"CAST({sql} AS INTEGER)"
    166
    167        # https://www.sqlite.org/lang_aggfunc.html#group_concat
    168        def groupconcat_sql(self, expression: exp.GroupConcat) -> str:
    169            this = expression.this
    170            distinct = expression.find(exp.Distinct)
    171
    172            if distinct:
    173                this = distinct.expressions[0]
    174                distinct_sql = "DISTINCT "
    175            else:
    176                distinct_sql = ""
    177
    178            if isinstance(expression.this, exp.Order):
    179                self.unsupported("SQLite GROUP_CONCAT doesn't support ORDER BY.")
    180                if expression.this.this and not distinct:
    181                    this = expression.this.this
    182
    183            separator = expression.args.get("separator")
    184            return f"GROUP_CONCAT({distinct_sql}{self.format_args(this, separator)})"
    185
    186        def least_sql(self, expression: exp.Least) -> str:
    187            if len(expression.expressions) > 1:
    188                return rename_func("MIN")(self, expression)
    189
    190            return self.expressions(expression)
    191
    192        def transaction_sql(self, expression: exp.Transaction) -> str:
    193            this = expression.this
    194            this = f" {this}" if this else ""
    195            return f"BEGIN{this} TRANSACTION"

class SQLite(sqlglot.dialects.dialect.Dialect): View Source

     61class SQLite(Dialect):
     62    class Tokenizer(tokens.Tokenizer):
     63        IDENTIFIERS = ['"', ("[", "]"), "`"]
     64        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", ""), ("0X", "")]
     65
     66        KEYWORDS = {
     67            **tokens.Tokenizer.KEYWORDS,
     68        }
     69
     70    class Parser(parser.Parser):
     71        FUNCTIONS = {
     72            **parser.Parser.FUNCTIONS,
     73            "EDITDIST3": exp.Levenshtein.from_arg_list,
     74        }
     75
     76    class Generator(generator.Generator):
     77        JOIN_HINTS = False
     78        TABLE_HINTS = False
     79
     80        TYPE_MAPPING = {
     81            **generator.Generator.TYPE_MAPPING,
     82            exp.DataType.Type.BOOLEAN: "INTEGER",
     83            exp.DataType.Type.TINYINT: "INTEGER",
     84            exp.DataType.Type.SMALLINT: "INTEGER",
     85            exp.DataType.Type.INT: "INTEGER",
     86            exp.DataType.Type.BIGINT: "INTEGER",
     87            exp.DataType.Type.FLOAT: "REAL",
     88            exp.DataType.Type.DOUBLE: "REAL",
     89            exp.DataType.Type.DECIMAL: "REAL",
     90            exp.DataType.Type.CHAR: "TEXT",
     91            exp.DataType.Type.NCHAR: "TEXT",
     92            exp.DataType.Type.VARCHAR: "TEXT",
     93            exp.DataType.Type.NVARCHAR: "TEXT",
     94            exp.DataType.Type.BINARY: "BLOB",
     95            exp.DataType.Type.VARBINARY: "BLOB",
     96        }
     97
     98        TOKEN_MAPPING = {
     99            TokenType.AUTO_INCREMENT: "AUTOINCREMENT",
    100        }
    101
    102        TRANSFORMS = {
    103            **generator.Generator.TRANSFORMS,
    104            exp.CountIf: count_if_to_sum,
    105            exp.Create: transforms.preprocess([_transform_create]),
    106            exp.CurrentDate: lambda *_: "CURRENT_DATE",
    107            exp.CurrentTime: lambda *_: "CURRENT_TIME",
    108            exp.CurrentTimestamp: lambda *_: "CURRENT_TIMESTAMP",
    109            exp.DateAdd: _date_add_sql,
    110            exp.DateStrToDate: lambda self, e: self.sql(e, "this"),
    111            exp.ILike: no_ilike_sql,
    112            exp.JSONExtract: arrow_json_extract_sql,
    113            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
    114            exp.JSONBExtract: arrow_json_extract_sql,
    115            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
    116            exp.Levenshtein: rename_func("EDITDIST3"),
    117            exp.LogicalOr: rename_func("MAX"),
    118            exp.LogicalAnd: rename_func("MIN"),
    119            exp.Pivot: no_pivot_sql,
    120            exp.Select: transforms.preprocess(
    121                [transforms.eliminate_distinct_on, transforms.eliminate_qualify]
    122            ),
    123            exp.TableSample: no_tablesample_sql,
    124            exp.TimeStrToTime: lambda self, e: self.sql(e, "this"),
    125            exp.TryCast: no_trycast_sql,
    126        }
    127
    128        PROPERTIES_LOCATION = {
    129            k: exp.Properties.Location.UNSUPPORTED
    130            for k, v in generator.Generator.PROPERTIES_LOCATION.items()
    131        }
    132
    133        LIMIT_FETCH = "LIMIT"
    134
    135        def cast_sql(self, expression: exp.Cast) -> str:
    136            if expression.is_type("date"):
    137                return self.func("DATE", expression.this)
    138
    139            return super().cast_sql(expression)
    140
    141        def datediff_sql(self, expression: exp.DateDiff) -> str:
    142            unit = expression.args.get("unit")
    143            unit = unit.name.upper() if unit else "DAY"
    144
    145            sql = f"(JULIANDAY({self.sql(expression, 'this')}) - JULIANDAY({self.sql(expression, 'expression')}))"
    146
    147            if unit == "MONTH":
    148                sql = f"{sql} / 30.0"
    149            elif unit == "YEAR":
    150                sql = f"{sql} / 365.0"
    151            elif unit == "HOUR":
    152                sql = f"{sql} * 24.0"
    153            elif unit == "MINUTE":
    154                sql = f"{sql} * 1440.0"
    155            elif unit == "SECOND":
    156                sql = f"{sql} * 86400.0"
    157            elif unit == "MILLISECOND":
    158                sql = f"{sql} * 86400000.0"
    159            elif unit == "MICROSECOND":
    160                sql = f"{sql} * 86400000000.0"
    161            elif unit == "NANOSECOND":
    162                sql = f"{sql} * 8640000000000.0"
    163            else:
    164                self.unsupported("DATEDIFF unsupported for '{unit}'.")
    165
    166            return f"CAST({sql} AS INTEGER)"
    167
    168        # https://www.sqlite.org/lang_aggfunc.html#group_concat
    169        def groupconcat_sql(self, expression: exp.GroupConcat) -> str:
    170            this = expression.this
    171            distinct = expression.find(exp.Distinct)
    172
    173            if distinct:
    174                this = distinct.expressions[0]
    175                distinct_sql = "DISTINCT "
    176            else:
    177                distinct_sql = ""
    178
    179            if isinstance(expression.this, exp.Order):
    180                self.unsupported("SQLite GROUP_CONCAT doesn't support ORDER BY.")
    181                if expression.this.this and not distinct:
    182                    this = expression.this.this
    183
    184            separator = expression.args.get("separator")
    185            return f"GROUP_CONCAT({distinct_sql}{self.format_args(this, separator)})"
    186
    187        def least_sql(self, expression: exp.Least) -> str:
    188            if len(expression.expressions) > 1:
    189                return rename_func("MIN")(self, expression)
    190
    191            return self.expressions(expression)
    192
    193        def transaction_sql(self, expression: exp.Transaction) -> str:
    194            this = expression.this
    195            this = f" {this}" if this else ""
    196            return f"BEGIN{this} TRANSACTION"

##### Inherited Members

sqlglot.dialects.dialect.Dialect
  get_or_raise
  format_time
  parse
  parse_into
  generate
  transpile
  tokenize
  parser
  generator

class SQLite.Tokenizer(sqlglot.tokens.Tokenizer): View Source

    62    class Tokenizer(tokens.Tokenizer):
    63        IDENTIFIERS = ['"', ("[", "]"), "`"]
    64        HEX_STRINGS = [("x'", "'"), ("X'", "'"), ("0x", ""), ("0X", "")]
    65
    66        KEYWORDS = {
    67            **tokens.Tokenizer.KEYWORDS,
    68        }

##### Inherited Members

sqlglot.tokens.Tokenizer
  reset
  tokenize

class SQLite.Parser(sqlglot.parser.Parser): View Source

    70    class Parser(parser.Parser):
    71        FUNCTIONS = {
    72            **parser.Parser.FUNCTIONS,
    73            "EDITDIST3": exp.Levenshtein.from_arg_list,
    74        }

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.IMMEDIATE
- 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"

##### Inherited Members

sqlglot.parser.Parser
  Parser
  reset
  parse
  parse_into
  check_errors
  raise_error
  expression
  validate_expression

class SQLite.Generator(sqlglot.generator.Generator): View Source

     76    class Generator(generator.Generator):
     77        JOIN_HINTS = False
     78        TABLE_HINTS = False
     79
     80        TYPE_MAPPING = {
     81            **generator.Generator.TYPE_MAPPING,
     82            exp.DataType.Type.BOOLEAN: "INTEGER",
     83            exp.DataType.Type.TINYINT: "INTEGER",
     84            exp.DataType.Type.SMALLINT: "INTEGER",
     85            exp.DataType.Type.INT: "INTEGER",
     86            exp.DataType.Type.BIGINT: "INTEGER",
     87            exp.DataType.Type.FLOAT: "REAL",
     88            exp.DataType.Type.DOUBLE: "REAL",
     89            exp.DataType.Type.DECIMAL: "REAL",
     90            exp.DataType.Type.CHAR: "TEXT",
     91            exp.DataType.Type.NCHAR: "TEXT",
     92            exp.DataType.Type.VARCHAR: "TEXT",
     93            exp.DataType.Type.NVARCHAR: "TEXT",
     94            exp.DataType.Type.BINARY: "BLOB",
     95            exp.DataType.Type.VARBINARY: "BLOB",
     96        }
     97
     98        TOKEN_MAPPING = {
     99            TokenType.AUTO_INCREMENT: "AUTOINCREMENT",
    100        }
    101
    102        TRANSFORMS = {
    103            **generator.Generator.TRANSFORMS,
    104            exp.CountIf: count_if_to_sum,
    105            exp.Create: transforms.preprocess([_transform_create]),
    106            exp.CurrentDate: lambda *_: "CURRENT_DATE",
    107            exp.CurrentTime: lambda *_: "CURRENT_TIME",
    108            exp.CurrentTimestamp: lambda *_: "CURRENT_TIMESTAMP",
    109            exp.DateAdd: _date_add_sql,
    110            exp.DateStrToDate: lambda self, e: self.sql(e, "this"),
    111            exp.ILike: no_ilike_sql,
    112            exp.JSONExtract: arrow_json_extract_sql,
    113            exp.JSONExtractScalar: arrow_json_extract_scalar_sql,
    114            exp.JSONBExtract: arrow_json_extract_sql,
    115            exp.JSONBExtractScalar: arrow_json_extract_scalar_sql,
    116            exp.Levenshtein: rename_func("EDITDIST3"),
    117            exp.LogicalOr: rename_func("MAX"),
    118            exp.LogicalAnd: rename_func("MIN"),
    119            exp.Pivot: no_pivot_sql,
    120            exp.Select: transforms.preprocess(
    121                [transforms.eliminate_distinct_on, transforms.eliminate_qualify]
    122            ),
    123            exp.TableSample: no_tablesample_sql,
    124            exp.TimeStrToTime: lambda self, e: self.sql(e, "this"),
    125            exp.TryCast: no_trycast_sql,
    126        }
    127
    128        PROPERTIES_LOCATION = {
    129            k: exp.Properties.Location.UNSUPPORTED
    130            for k, v in generator.Generator.PROPERTIES_LOCATION.items()
    131        }
    132
    133        LIMIT_FETCH = "LIMIT"
    134
    135        def cast_sql(self, expression: exp.Cast) -> str:
    136            if expression.is_type("date"):
    137                return self.func("DATE", expression.this)
    138
    139            return super().cast_sql(expression)
    140
    141        def datediff_sql(self, expression: exp.DateDiff) -> str:
    142            unit = expression.args.get("unit")
    143            unit = unit.name.upper() if unit else "DAY"
    144
    145            sql = f"(JULIANDAY({self.sql(expression, 'this')}) - JULIANDAY({self.sql(expression, 'expression')}))"
    146
    147            if unit == "MONTH":
    148                sql = f"{sql} / 30.0"
    149            elif unit == "YEAR":
    150                sql = f"{sql} / 365.0"
    151            elif unit == "HOUR":
    152                sql = f"{sql} * 24.0"
    153            elif unit == "MINUTE":
    154                sql = f"{sql} * 1440.0"
    155            elif unit == "SECOND":
    156                sql = f"{sql} * 86400.0"
    157            elif unit == "MILLISECOND":
    158                sql = f"{sql} * 86400000.0"
    159            elif unit == "MICROSECOND":
    160                sql = f"{sql} * 86400000000.0"
    161            elif unit == "NANOSECOND":
    162                sql = f"{sql} * 8640000000000.0"
    163            else:
    164                self.unsupported("DATEDIFF unsupported for '{unit}'.")
    165
    166            return f"CAST({sql} AS INTEGER)"
    167
    168        # https://www.sqlite.org/lang_aggfunc.html#group_concat
    169        def groupconcat_sql(self, expression: exp.GroupConcat) -> str:
    170            this = expression.this
    171            distinct = expression.find(exp.Distinct)
    172
    173            if distinct:
    174                this = distinct.expressions[0]
    175                distinct_sql = "DISTINCT "
    176            else:
    177                distinct_sql = ""
    178
    179            if isinstance(expression.this, exp.Order):
    180                self.unsupported("SQLite GROUP_CONCAT doesn't support ORDER BY.")
    181                if expression.this.this and not distinct:
    182                    this = expression.this.this
    183
    184            separator = expression.args.get("separator")
    185            return f"GROUP_CONCAT({distinct_sql}{self.format_args(this, separator)})"
    186
    187        def least_sql(self, expression: exp.Least) -> str:
    188            if len(expression.expressions) > 1:
    189                return rename_func("MIN")(self, expression)
    190
    191            return self.expressions(expression)
    192
    193        def transaction_sql(self, expression: exp.Transaction) -> str:
    194            this = expression.this
    195            this = f" {this}" if this else ""
    196            return f"BEGIN{this} TRANSACTION"

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: ".
- bit_start (str): specifies which starting character to use to delimit bit literals. Default: None.
- bit_end (str): specifies which ending character to use to delimit bit literals. Default: None.
- hex_start (str): specifies which starting character to use to delimit hex literals. Default: None.
- hex_end (str): specifies which ending character to use to delimit hex literals. Default: None.
- byte_start (str): specifies which starting character to use to delimit byte literals. Default: None.
- byte_end (str): specifies which ending character to use to delimit byte literals. Default: None.
- raw_start (str): specifies which starting character to use to delimit raw literals. Default: None.
- raw_end (str): specifies which ending character to use to delimit raw literals. Default: None.
- identify (bool | str): 'always': always quote, 'safe': quote identifiers if they don't contain an upcase, True defaults to always.
- 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
- identifiers_can_start_with_digit (bool): if an unquoted identifier can start with digit 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

def cast_sql(self, expression: sqlglot.expressions.Cast) -> str: View Source

    135        def cast_sql(self, expression: exp.Cast) -> str:
    136            if expression.is_type("date"):
    137                return self.func("DATE", expression.this)
    138
    139            return super().cast_sql(expression)

def datediff_sql(self, expression: sqlglot.expressions.DateDiff) -> str: View Source

    141        def datediff_sql(self, expression: exp.DateDiff) -> str:
    142            unit = expression.args.get("unit")
    143            unit = unit.name.upper() if unit else "DAY"
    144
    145            sql = f"(JULIANDAY({self.sql(expression, 'this')}) - JULIANDAY({self.sql(expression, 'expression')}))"
    146
    147            if unit == "MONTH":
    148                sql = f"{sql} / 30.0"
    149            elif unit == "YEAR":
    150                sql = f"{sql} / 365.0"
    151            elif unit == "HOUR":
    152                sql = f"{sql} * 24.0"
    153            elif unit == "MINUTE":
    154                sql = f"{sql} * 1440.0"
    155            elif unit == "SECOND":
    156                sql = f"{sql} * 86400.0"
    157            elif unit == "MILLISECOND":
    158                sql = f"{sql} * 86400000.0"
    159            elif unit == "MICROSECOND":
    160                sql = f"{sql} * 86400000000.0"
    161            elif unit == "NANOSECOND":
    162                sql = f"{sql} * 8640000000000.0"
    163            else:
    164                self.unsupported("DATEDIFF unsupported for '{unit}'.")
    165
    166            return f"CAST({sql} AS INTEGER)"

def groupconcat_sql(self, expression: sqlglot.expressions.GroupConcat) -> str: View Source

    169        def groupconcat_sql(self, expression: exp.GroupConcat) -> str:
    170            this = expression.this
    171            distinct = expression.find(exp.Distinct)
    172
    173            if distinct:
    174                this = distinct.expressions[0]
    175                distinct_sql = "DISTINCT "
    176            else:
    177                distinct_sql = ""
    178
    179            if isinstance(expression.this, exp.Order):
    180                self.unsupported("SQLite GROUP_CONCAT doesn't support ORDER BY.")
    181                if expression.this.this and not distinct:
    182                    this = expression.this.this
    183
    184            separator = expression.args.get("separator")
    185            return f"GROUP_CONCAT({distinct_sql}{self.format_args(this, separator)})"

def least_sql(self, expression: sqlglot.expressions.Least) -> str: View Source

    187        def least_sql(self, expression: exp.Least) -> str:
    188            if len(expression.expressions) > 1:
    189                return rename_func("MIN")(self, expression)
    190
    191            return self.expressions(expression)

def transaction_sql(self, expression: sqlglot.expressions.Transaction) -> str: View Source

    193        def transaction_sql(self, expression: exp.Transaction) -> str:
    194            this = expression.this
    195            this = f" {this}" if this else ""
    196            return f"BEGIN{this} TRANSACTION"

##### 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
  columnposition_sql
  columndef_sql
  columnconstraint_sql
  autoincrementcolumnconstraint_sql
  compresscolumnconstraint_sql
  generatedasidentitycolumnconstraint_sql
  notnullcolumnconstraint_sql
  primarykeycolumnconstraint_sql
  uniquecolumnconstraint_sql
  create_sql
  clone_sql
  describe_sql
  prepend_ctes
  with_sql
  cte_sql
  tablealias_sql
  bitstring_sql
  hexstring_sql
  bytestring_sql
  rawstring_sql
  datatypesize_sql
  datatype_sql
  directory_sql
  delete_sql
  drop_sql
  except_sql
  except_op
  fetch_sql
  filter_sql
  hint_sql
  index_sql
  identifier_sql
  inputoutputformat_sql
  national_sql
  partition_sql
  properties_sql
  root_properties
  properties
  with_properties
  locate_properties
  property_sql
  likeproperty_sql
  fallbackproperty_sql
  journalproperty_sql
  freespaceproperty_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
  onconflict_sql
  returning_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
  setitem_sql
  set_sql
  pragma_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
  after_having_modifiers
  after_limit_modifiers
  select_sql
  schema_sql
  star_sql
  parameter_sql
  sessionparameter_sql
  placeholder_sql
  subquery_sql
  qualify_sql
  union_sql
  union_op
  unnest_sql
  where_sql
  window_sql
  partition_by_sql
  windowspec_sql
  withingroup_sql
  between_sql
  bracket_sql
  all_sql
  any_sql
  exists_sql
  case_sql
  constraint_sql
  nextvaluefor_sql
  extract_sql
  trim_sql
  concat_sql
  check_sql
  foreignkey_sql
  primarykey_sql
  if_sql
  matchagainst_sql
  jsonkeyvalue_sql
  jsonobject_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
  aliases_sql
  attimezone_sql
  add_sql
  and_sql
  connector_sql
  bitwiseand_sql
  bitwiseleftshift_sql
  bitwisenot_sql
  bitwiseor_sql
  bitwiserightshift_sql
  bitwisexor_sql
  currentdate_sql
  collate_sql
  command_sql
  comment_sql
  mergetreettlaction_sql
  mergetreettl_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
  ilikeany_sql
  is_sql
  like_sql
  likeany_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
  tochar_sql
  dictproperty_sql
  dictrange_sql
  dictsubproperty_sql