Edit on GitHub

# sqlglot.dialects.clickhouse

View Source

      1from __future__ import annotations
      2
      3import typing as t
      4
      5from sqlglot import exp, generator, parser, tokens
      6from sqlglot.dialects.dialect import (
      7    Dialect,
      8    inline_array_sql,
      9    no_pivot_sql,
     10    rename_func,
     11    var_map_sql,
     12)
     13from sqlglot.errors import ParseError
     14from sqlglot.helper import seq_get
     15from sqlglot.parser import parse_var_map
     16from sqlglot.tokens import Token, TokenType
     17
     18
     19def _lower_func(sql: str) -> str:
     20    index = sql.index("(")
     21    return sql[:index].lower() + sql[index:]
     22
     23
     24class ClickHouse(Dialect):
     25    NORMALIZE_FUNCTIONS: bool | str = False
     26    NULL_ORDERING = "nulls_are_last"
     27    STRICT_STRING_CONCAT = True
     28    SUPPORTS_USER_DEFINED_TYPES = False
     29
     30    class Tokenizer(tokens.Tokenizer):
     31        COMMENTS = ["--", "#", "#!", ("/*", "*/")]
     32        IDENTIFIERS = ['"', "`"]
     33        STRING_ESCAPES = ["'", "\\"]
     34        BIT_STRINGS = [("0b", "")]
     35        HEX_STRINGS = [("0x", ""), ("0X", "")]
     36
     37        KEYWORDS = {
     38            **tokens.Tokenizer.KEYWORDS,
     39            "ATTACH": TokenType.COMMAND,
     40            "DATETIME64": TokenType.DATETIME64,
     41            "DICTIONARY": TokenType.DICTIONARY,
     42            "ENUM": TokenType.ENUM,
     43            "ENUM8": TokenType.ENUM8,
     44            "ENUM16": TokenType.ENUM16,
     45            "FINAL": TokenType.FINAL,
     46            "FIXEDSTRING": TokenType.FIXEDSTRING,
     47            "FLOAT32": TokenType.FLOAT,
     48            "FLOAT64": TokenType.DOUBLE,
     49            "GLOBAL": TokenType.GLOBAL,
     50            "INT16": TokenType.SMALLINT,
     51            "INT256": TokenType.INT256,
     52            "INT32": TokenType.INT,
     53            "INT64": TokenType.BIGINT,
     54            "INT8": TokenType.TINYINT,
     55            "LOWCARDINALITY": TokenType.LOWCARDINALITY,
     56            "MAP": TokenType.MAP,
     57            "NESTED": TokenType.NESTED,
     58            "TUPLE": TokenType.STRUCT,
     59            "UINT128": TokenType.UINT128,
     60            "UINT16": TokenType.USMALLINT,
     61            "UINT256": TokenType.UINT256,
     62            "UINT32": TokenType.UINT,
     63            "UINT64": TokenType.UBIGINT,
     64            "UINT8": TokenType.UTINYINT,
     65        }
     66
     67    class Parser(parser.Parser):
     68        FUNCTIONS = {
     69            **parser.Parser.FUNCTIONS,
     70            "ANY": exp.AnyValue.from_arg_list,
     71            "DATE_ADD": lambda args: exp.DateAdd(
     72                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     73            ),
     74            "DATEADD": lambda args: exp.DateAdd(
     75                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     76            ),
     77            "DATE_DIFF": lambda args: exp.DateDiff(
     78                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     79            ),
     80            "DATEDIFF": lambda args: exp.DateDiff(
     81                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     82            ),
     83            "MAP": parse_var_map,
     84            "MATCH": exp.RegexpLike.from_arg_list,
     85            "UNIQ": exp.ApproxDistinct.from_arg_list,
     86            "XOR": lambda args: exp.Xor(expressions=args),
     87        }
     88
     89        FUNCTIONS_WITH_ALIASED_ARGS = {*parser.Parser.FUNCTIONS_WITH_ALIASED_ARGS, "TUPLE"}
     90
     91        FUNCTION_PARSERS = {
     92            **parser.Parser.FUNCTION_PARSERS,
     93            "QUANTILE": lambda self: self._parse_quantile(),
     94        }
     95
     96        FUNCTION_PARSERS.pop("MATCH")
     97
     98        NO_PAREN_FUNCTION_PARSERS = parser.Parser.NO_PAREN_FUNCTION_PARSERS.copy()
     99        NO_PAREN_FUNCTION_PARSERS.pop("ANY")
    100
    101        RANGE_PARSERS = {
    102            **parser.Parser.RANGE_PARSERS,
    103            TokenType.GLOBAL: lambda self, this: self._match(TokenType.IN)
    104            and self._parse_in(this, is_global=True),
    105        }
    106
    107        # The PLACEHOLDER entry is popped because 1) it doesn't affect Clickhouse (it corresponds to
    108        # the postgres-specific JSONBContains parser) and 2) it makes parsing the ternary op simpler.
    109        COLUMN_OPERATORS = parser.Parser.COLUMN_OPERATORS.copy()
    110        COLUMN_OPERATORS.pop(TokenType.PLACEHOLDER)
    111
    112        JOIN_KINDS = {
    113            *parser.Parser.JOIN_KINDS,
    114            TokenType.ANY,
    115            TokenType.ASOF,
    116            TokenType.ANTI,
    117            TokenType.SEMI,
    118            TokenType.ARRAY,
    119        }
    120
    121        TABLE_ALIAS_TOKENS = {*parser.Parser.TABLE_ALIAS_TOKENS} - {
    122            TokenType.ANY,
    123            TokenType.SEMI,
    124            TokenType.ANTI,
    125            TokenType.SETTINGS,
    126            TokenType.FORMAT,
    127            TokenType.ARRAY,
    128        }
    129
    130        LOG_DEFAULTS_TO_LN = True
    131
    132        QUERY_MODIFIER_PARSERS = {
    133            **parser.Parser.QUERY_MODIFIER_PARSERS,
    134            TokenType.SETTINGS: lambda self: (
    135                "settings",
    136                self._advance() or self._parse_csv(self._parse_conjunction),
    137            ),
    138            TokenType.FORMAT: lambda self: ("format", self._advance() or self._parse_id_var()),
    139        }
    140
    141        def _parse_conjunction(self) -> t.Optional[exp.Expression]:
    142            this = super()._parse_conjunction()
    143
    144            if self._match(TokenType.PLACEHOLDER):
    145                return self.expression(
    146                    exp.If,
    147                    this=this,
    148                    true=self._parse_conjunction(),
    149                    false=self._match(TokenType.COLON) and self._parse_conjunction(),
    150                )
    151
    152            return this
    153
    154        def _parse_placeholder(self) -> t.Optional[exp.Expression]:
    155            """
    156            Parse a placeholder expression like SELECT {abc: UInt32} or FROM {table: Identifier}
    157            https://clickhouse.com/docs/en/sql-reference/syntax#defining-and-using-query-parameters
    158            """
    159            if not self._match(TokenType.L_BRACE):
    160                return None
    161
    162            this = self._parse_id_var()
    163            self._match(TokenType.COLON)
    164            kind = self._parse_types(check_func=False, allow_identifiers=False) or (
    165                self._match_text_seq("IDENTIFIER") and "Identifier"
    166            )
    167
    168            if not kind:
    169                self.raise_error("Expecting a placeholder type or 'Identifier' for tables")
    170            elif not self._match(TokenType.R_BRACE):
    171                self.raise_error("Expecting }")
    172
    173            return self.expression(exp.Placeholder, this=this, kind=kind)
    174
    175        def _parse_in(self, this: t.Optional[exp.Expression], is_global: bool = False) -> exp.In:
    176            this = super()._parse_in(this)
    177            this.set("is_global", is_global)
    178            return this
    179
    180        def _parse_table(
    181            self,
    182            schema: bool = False,
    183            joins: bool = False,
    184            alias_tokens: t.Optional[t.Collection[TokenType]] = None,
    185            parse_bracket: bool = False,
    186        ) -> t.Optional[exp.Expression]:
    187            this = super()._parse_table(
    188                schema=schema, joins=joins, alias_tokens=alias_tokens, parse_bracket=parse_bracket
    189            )
    190
    191            if self._match(TokenType.FINAL):
    192                this = self.expression(exp.Final, this=this)
    193
    194            return this
    195
    196        def _parse_position(self, haystack_first: bool = False) -> exp.StrPosition:
    197            return super()._parse_position(haystack_first=True)
    198
    199        # https://clickhouse.com/docs/en/sql-reference/statements/select/with/
    200        def _parse_cte(self) -> exp.CTE:
    201            index = self._index
    202            try:
    203                # WITH <identifier> AS <subquery expression>
    204                return super()._parse_cte()
    205            except ParseError:
    206                # WITH <expression> AS <identifier>
    207                self._retreat(index)
    208                statement = self._parse_statement()
    209
    210                if statement and isinstance(statement.this, exp.Alias):
    211                    self.raise_error("Expected CTE to have alias")
    212
    213                return self.expression(exp.CTE, this=statement, alias=statement and statement.this)
    214
    215        def _parse_join_parts(
    216            self,
    217        ) -> t.Tuple[t.Optional[Token], t.Optional[Token], t.Optional[Token]]:
    218            is_global = self._match(TokenType.GLOBAL) and self._prev
    219            kind_pre = self._match_set(self.JOIN_KINDS, advance=False) and self._prev
    220
    221            if kind_pre:
    222                kind = self._match_set(self.JOIN_KINDS) and self._prev
    223                side = self._match_set(self.JOIN_SIDES) and self._prev
    224                return is_global, side, kind
    225
    226            return (
    227                is_global,
    228                self._match_set(self.JOIN_SIDES) and self._prev,
    229                self._match_set(self.JOIN_KINDS) and self._prev,
    230            )
    231
    232        def _parse_join(
    233            self, skip_join_token: bool = False, parse_bracket: bool = False
    234        ) -> t.Optional[exp.Join]:
    235            join = super()._parse_join(skip_join_token=skip_join_token, parse_bracket=True)
    236
    237            if join:
    238                join.set("global", join.args.pop("method", None))
    239            return join
    240
    241        def _parse_function(
    242            self,
    243            functions: t.Optional[t.Dict[str, t.Callable]] = None,
    244            anonymous: bool = False,
    245            optional_parens: bool = True,
    246        ) -> t.Optional[exp.Expression]:
    247            func = super()._parse_function(
    248                functions=functions, anonymous=anonymous, optional_parens=optional_parens
    249            )
    250
    251            if isinstance(func, exp.Anonymous):
    252                params = self._parse_func_params(func)
    253
    254                if params:
    255                    return self.expression(
    256                        exp.ParameterizedAgg,
    257                        this=func.this,
    258                        expressions=func.expressions,
    259                        params=params,
    260                    )
    261
    262            return func
    263
    264        def _parse_func_params(
    265            self, this: t.Optional[exp.Func] = None
    266        ) -> t.Optional[t.List[exp.Expression]]:
    267            if self._match_pair(TokenType.R_PAREN, TokenType.L_PAREN):
    268                return self._parse_csv(self._parse_lambda)
    269
    270            if self._match(TokenType.L_PAREN):
    271                params = self._parse_csv(self._parse_lambda)
    272                self._match_r_paren(this)
    273                return params
    274
    275            return None
    276
    277        def _parse_quantile(self) -> exp.Quantile:
    278            this = self._parse_lambda()
    279            params = self._parse_func_params()
    280            if params:
    281                return self.expression(exp.Quantile, this=params[0], quantile=this)
    282            return self.expression(exp.Quantile, this=this, quantile=exp.Literal.number(0.5))
    283
    284        def _parse_wrapped_id_vars(self, optional: bool = False) -> t.List[exp.Expression]:
    285            return super()._parse_wrapped_id_vars(optional=True)
    286
    287        def _parse_primary_key(
    288            self, wrapped_optional: bool = False, in_props: bool = False
    289        ) -> exp.PrimaryKeyColumnConstraint | exp.PrimaryKey:
    290            return super()._parse_primary_key(
    291                wrapped_optional=wrapped_optional or in_props, in_props=in_props
    292            )
    293
    294        def _parse_on_property(self) -> t.Optional[exp.Expression]:
    295            index = self._index
    296            if self._match_text_seq("CLUSTER"):
    297                this = self._parse_id_var()
    298                if this:
    299                    return self.expression(exp.OnCluster, this=this)
    300                else:
    301                    self._retreat(index)
    302            return None
    303
    304    class Generator(generator.Generator):
    305        QUERY_HINTS = False
    306        STRUCT_DELIMITER = ("(", ")")
    307        NVL2_SUPPORTED = False
    308
    309        STRING_TYPE_MAPPING = {
    310            exp.DataType.Type.CHAR: "String",
    311            exp.DataType.Type.LONGBLOB: "String",
    312            exp.DataType.Type.LONGTEXT: "String",
    313            exp.DataType.Type.MEDIUMBLOB: "String",
    314            exp.DataType.Type.MEDIUMTEXT: "String",
    315            exp.DataType.Type.TINYBLOB: "String",
    316            exp.DataType.Type.TINYTEXT: "String",
    317            exp.DataType.Type.TEXT: "String",
    318            exp.DataType.Type.VARBINARY: "String",
    319            exp.DataType.Type.VARCHAR: "String",
    320        }
    321
    322        TYPE_MAPPING = {
    323            **generator.Generator.TYPE_MAPPING,
    324            **STRING_TYPE_MAPPING,
    325            exp.DataType.Type.ARRAY: "Array",
    326            exp.DataType.Type.BIGINT: "Int64",
    327            exp.DataType.Type.DATETIME64: "DateTime64",
    328            exp.DataType.Type.DOUBLE: "Float64",
    329            exp.DataType.Type.ENUM: "Enum",
    330            exp.DataType.Type.ENUM8: "Enum8",
    331            exp.DataType.Type.ENUM16: "Enum16",
    332            exp.DataType.Type.FIXEDSTRING: "FixedString",
    333            exp.DataType.Type.FLOAT: "Float32",
    334            exp.DataType.Type.INT: "Int32",
    335            exp.DataType.Type.MEDIUMINT: "Int32",
    336            exp.DataType.Type.INT128: "Int128",
    337            exp.DataType.Type.INT256: "Int256",
    338            exp.DataType.Type.LOWCARDINALITY: "LowCardinality",
    339            exp.DataType.Type.MAP: "Map",
    340            exp.DataType.Type.NESTED: "Nested",
    341            exp.DataType.Type.NULLABLE: "Nullable",
    342            exp.DataType.Type.SMALLINT: "Int16",
    343            exp.DataType.Type.STRUCT: "Tuple",
    344            exp.DataType.Type.TINYINT: "Int8",
    345            exp.DataType.Type.UBIGINT: "UInt64",
    346            exp.DataType.Type.UINT: "UInt32",
    347            exp.DataType.Type.UINT128: "UInt128",
    348            exp.DataType.Type.UINT256: "UInt256",
    349            exp.DataType.Type.USMALLINT: "UInt16",
    350            exp.DataType.Type.UTINYINT: "UInt8",
    351        }
    352
    353        TRANSFORMS = {
    354            **generator.Generator.TRANSFORMS,
    355            exp.AnyValue: rename_func("any"),
    356            exp.ApproxDistinct: rename_func("uniq"),
    357            exp.Array: inline_array_sql,
    358            exp.CastToStrType: rename_func("CAST"),
    359            exp.DateAdd: lambda self, e: self.func(
    360                "DATE_ADD", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    361            ),
    362            exp.DateDiff: lambda self, e: self.func(
    363                "DATE_DIFF", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    364            ),
    365            exp.Final: lambda self, e: f"{self.sql(e, 'this')} FINAL",
    366            exp.Map: lambda self, e: _lower_func(var_map_sql(self, e)),
    367            exp.PartitionedByProperty: lambda self, e: f"PARTITION BY {self.sql(e, 'this')}",
    368            exp.Pivot: no_pivot_sql,
    369            exp.Quantile: lambda self, e: self.func("quantile", e.args.get("quantile"))
    370            + f"({self.sql(e, 'this')})",
    371            exp.RegexpLike: lambda self, e: f"match({self.format_args(e.this, e.expression)})",
    372            exp.StrPosition: lambda self, e: f"position({self.format_args(e.this, e.args.get('substr'), e.args.get('position'))})",
    373            exp.VarMap: lambda self, e: _lower_func(var_map_sql(self, e)),
    374            exp.Xor: lambda self, e: self.func("xor", e.this, e.expression, *e.expressions),
    375        }
    376
    377        PROPERTIES_LOCATION = {
    378            **generator.Generator.PROPERTIES_LOCATION,
    379            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
    380            exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,
    381            exp.OnCluster: exp.Properties.Location.POST_NAME,
    382        }
    383
    384        JOIN_HINTS = False
    385        TABLE_HINTS = False
    386        EXPLICIT_UNION = True
    387        GROUPINGS_SEP = ""
    388
    389        # there's no list in docs, but it can be found in Clickhouse code
    390        # see `ClickHouse/src/Parsers/ParserCreate*.cpp`
    391        ON_CLUSTER_TARGETS = {
    392            "DATABASE",
    393            "TABLE",
    394            "VIEW",
    395            "DICTIONARY",
    396            "INDEX",
    397            "FUNCTION",
    398            "NAMED COLLECTION",
    399        }
    400
    401        def datatype_sql(self, expression: exp.DataType) -> str:
    402            # String is the standard ClickHouse type, every other variant is just an alias.
    403            # Additionally, any supplied length parameter will be ignored.
    404            #
    405            # https://clickhouse.com/docs/en/sql-reference/data-types/string
    406            if expression.this in self.STRING_TYPE_MAPPING:
    407                return "String"
    408
    409            return super().datatype_sql(expression)
    410
    411        def safeconcat_sql(self, expression: exp.SafeConcat) -> str:
    412            # Clickhouse errors out if we try to cast a NULL value to TEXT
    413            expression = expression.copy()
    414            return self.func(
    415                "CONCAT",
    416                *[
    417                    exp.func("if", e.is_(exp.null()), e, exp.cast(e, "text"))
    418                    for e in t.cast(t.List[exp.Condition], expression.expressions)
    419                ],
    420            )
    421
    422        def cte_sql(self, expression: exp.CTE) -> str:
    423            if isinstance(expression.this, exp.Alias):
    424                return self.sql(expression, "this")
    425
    426            return super().cte_sql(expression)
    427
    428        def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]:
    429            return super().after_limit_modifiers(expression) + [
    430                self.seg("SETTINGS ") + self.expressions(expression, key="settings", flat=True)
    431                if expression.args.get("settings")
    432                else "",
    433                self.seg("FORMAT ") + self.sql(expression, "format")
    434                if expression.args.get("format")
    435                else "",
    436            ]
    437
    438        def parameterizedagg_sql(self, expression: exp.Anonymous) -> str:
    439            params = self.expressions(expression, key="params", flat=True)
    440            return self.func(expression.name, *expression.expressions) + f"({params})"
    441
    442        def placeholder_sql(self, expression: exp.Placeholder) -> str:
    443            return f"{{{expression.name}: {self.sql(expression, 'kind')}}}"
    444
    445        def oncluster_sql(self, expression: exp.OnCluster) -> str:
    446            return f"ON CLUSTER {self.sql(expression, 'this')}"
    447
    448        def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str:
    449            kind = self.sql(expression, "kind").upper()
    450            if kind in self.ON_CLUSTER_TARGETS and locations.get(exp.Properties.Location.POST_NAME):
    451                this_name = self.sql(expression.this, "this")
    452                this_properties = " ".join(
    453                    [self.sql(prop) for prop in locations[exp.Properties.Location.POST_NAME]]
    454                )
    455                this_schema = self.schema_columns_sql(expression.this)
    456                return f"{this_name}{self.sep()}{this_properties}{self.sep()}{this_schema}"
    457
    458            return super().createable_sql(expression, locations)

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

     25class ClickHouse(Dialect):
     26    NORMALIZE_FUNCTIONS: bool | str = False
     27    NULL_ORDERING = "nulls_are_last"
     28    STRICT_STRING_CONCAT = True
     29    SUPPORTS_USER_DEFINED_TYPES = False
     30
     31    class Tokenizer(tokens.Tokenizer):
     32        COMMENTS = ["--", "#", "#!", ("/*", "*/")]
     33        IDENTIFIERS = ['"', "`"]
     34        STRING_ESCAPES = ["'", "\\"]
     35        BIT_STRINGS = [("0b", "")]
     36        HEX_STRINGS = [("0x", ""), ("0X", "")]
     37
     38        KEYWORDS = {
     39            **tokens.Tokenizer.KEYWORDS,
     40            "ATTACH": TokenType.COMMAND,
     41            "DATETIME64": TokenType.DATETIME64,
     42            "DICTIONARY": TokenType.DICTIONARY,
     43            "ENUM": TokenType.ENUM,
     44            "ENUM8": TokenType.ENUM8,
     45            "ENUM16": TokenType.ENUM16,
     46            "FINAL": TokenType.FINAL,
     47            "FIXEDSTRING": TokenType.FIXEDSTRING,
     48            "FLOAT32": TokenType.FLOAT,
     49            "FLOAT64": TokenType.DOUBLE,
     50            "GLOBAL": TokenType.GLOBAL,
     51            "INT16": TokenType.SMALLINT,
     52            "INT256": TokenType.INT256,
     53            "INT32": TokenType.INT,
     54            "INT64": TokenType.BIGINT,
     55            "INT8": TokenType.TINYINT,
     56            "LOWCARDINALITY": TokenType.LOWCARDINALITY,
     57            "MAP": TokenType.MAP,
     58            "NESTED": TokenType.NESTED,
     59            "TUPLE": TokenType.STRUCT,
     60            "UINT128": TokenType.UINT128,
     61            "UINT16": TokenType.USMALLINT,
     62            "UINT256": TokenType.UINT256,
     63            "UINT32": TokenType.UINT,
     64            "UINT64": TokenType.UBIGINT,
     65            "UINT8": TokenType.UTINYINT,
     66        }
     67
     68    class Parser(parser.Parser):
     69        FUNCTIONS = {
     70            **parser.Parser.FUNCTIONS,
     71            "ANY": exp.AnyValue.from_arg_list,
     72            "DATE_ADD": lambda args: exp.DateAdd(
     73                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     74            ),
     75            "DATEADD": lambda args: exp.DateAdd(
     76                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     77            ),
     78            "DATE_DIFF": lambda args: exp.DateDiff(
     79                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     80            ),
     81            "DATEDIFF": lambda args: exp.DateDiff(
     82                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     83            ),
     84            "MAP": parse_var_map,
     85            "MATCH": exp.RegexpLike.from_arg_list,
     86            "UNIQ": exp.ApproxDistinct.from_arg_list,
     87            "XOR": lambda args: exp.Xor(expressions=args),
     88        }
     89
     90        FUNCTIONS_WITH_ALIASED_ARGS = {*parser.Parser.FUNCTIONS_WITH_ALIASED_ARGS, "TUPLE"}
     91
     92        FUNCTION_PARSERS = {
     93            **parser.Parser.FUNCTION_PARSERS,
     94            "QUANTILE": lambda self: self._parse_quantile(),
     95        }
     96
     97        FUNCTION_PARSERS.pop("MATCH")
     98
     99        NO_PAREN_FUNCTION_PARSERS = parser.Parser.NO_PAREN_FUNCTION_PARSERS.copy()
    100        NO_PAREN_FUNCTION_PARSERS.pop("ANY")
    101
    102        RANGE_PARSERS = {
    103            **parser.Parser.RANGE_PARSERS,
    104            TokenType.GLOBAL: lambda self, this: self._match(TokenType.IN)
    105            and self._parse_in(this, is_global=True),
    106        }
    107
    108        # The PLACEHOLDER entry is popped because 1) it doesn't affect Clickhouse (it corresponds to
    109        # the postgres-specific JSONBContains parser) and 2) it makes parsing the ternary op simpler.
    110        COLUMN_OPERATORS = parser.Parser.COLUMN_OPERATORS.copy()
    111        COLUMN_OPERATORS.pop(TokenType.PLACEHOLDER)
    112
    113        JOIN_KINDS = {
    114            *parser.Parser.JOIN_KINDS,
    115            TokenType.ANY,
    116            TokenType.ASOF,
    117            TokenType.ANTI,
    118            TokenType.SEMI,
    119            TokenType.ARRAY,
    120        }
    121
    122        TABLE_ALIAS_TOKENS = {*parser.Parser.TABLE_ALIAS_TOKENS} - {
    123            TokenType.ANY,
    124            TokenType.SEMI,
    125            TokenType.ANTI,
    126            TokenType.SETTINGS,
    127            TokenType.FORMAT,
    128            TokenType.ARRAY,
    129        }
    130
    131        LOG_DEFAULTS_TO_LN = True
    132
    133        QUERY_MODIFIER_PARSERS = {
    134            **parser.Parser.QUERY_MODIFIER_PARSERS,
    135            TokenType.SETTINGS: lambda self: (
    136                "settings",
    137                self._advance() or self._parse_csv(self._parse_conjunction),
    138            ),
    139            TokenType.FORMAT: lambda self: ("format", self._advance() or self._parse_id_var()),
    140        }
    141
    142        def _parse_conjunction(self) -> t.Optional[exp.Expression]:
    143            this = super()._parse_conjunction()
    144
    145            if self._match(TokenType.PLACEHOLDER):
    146                return self.expression(
    147                    exp.If,
    148                    this=this,
    149                    true=self._parse_conjunction(),
    150                    false=self._match(TokenType.COLON) and self._parse_conjunction(),
    151                )
    152
    153            return this
    154
    155        def _parse_placeholder(self) -> t.Optional[exp.Expression]:
    156            """
    157            Parse a placeholder expression like SELECT {abc: UInt32} or FROM {table: Identifier}
    158            https://clickhouse.com/docs/en/sql-reference/syntax#defining-and-using-query-parameters
    159            """
    160            if not self._match(TokenType.L_BRACE):
    161                return None
    162
    163            this = self._parse_id_var()
    164            self._match(TokenType.COLON)
    165            kind = self._parse_types(check_func=False, allow_identifiers=False) or (
    166                self._match_text_seq("IDENTIFIER") and "Identifier"
    167            )
    168
    169            if not kind:
    170                self.raise_error("Expecting a placeholder type or 'Identifier' for tables")
    171            elif not self._match(TokenType.R_BRACE):
    172                self.raise_error("Expecting }")
    173
    174            return self.expression(exp.Placeholder, this=this, kind=kind)
    175
    176        def _parse_in(self, this: t.Optional[exp.Expression], is_global: bool = False) -> exp.In:
    177            this = super()._parse_in(this)
    178            this.set("is_global", is_global)
    179            return this
    180
    181        def _parse_table(
    182            self,
    183            schema: bool = False,
    184            joins: bool = False,
    185            alias_tokens: t.Optional[t.Collection[TokenType]] = None,
    186            parse_bracket: bool = False,
    187        ) -> t.Optional[exp.Expression]:
    188            this = super()._parse_table(
    189                schema=schema, joins=joins, alias_tokens=alias_tokens, parse_bracket=parse_bracket
    190            )
    191
    192            if self._match(TokenType.FINAL):
    193                this = self.expression(exp.Final, this=this)
    194
    195            return this
    196
    197        def _parse_position(self, haystack_first: bool = False) -> exp.StrPosition:
    198            return super()._parse_position(haystack_first=True)
    199
    200        # https://clickhouse.com/docs/en/sql-reference/statements/select/with/
    201        def _parse_cte(self) -> exp.CTE:
    202            index = self._index
    203            try:
    204                # WITH <identifier> AS <subquery expression>
    205                return super()._parse_cte()
    206            except ParseError:
    207                # WITH <expression> AS <identifier>
    208                self._retreat(index)
    209                statement = self._parse_statement()
    210
    211                if statement and isinstance(statement.this, exp.Alias):
    212                    self.raise_error("Expected CTE to have alias")
    213
    214                return self.expression(exp.CTE, this=statement, alias=statement and statement.this)
    215
    216        def _parse_join_parts(
    217            self,
    218        ) -> t.Tuple[t.Optional[Token], t.Optional[Token], t.Optional[Token]]:
    219            is_global = self._match(TokenType.GLOBAL) and self._prev
    220            kind_pre = self._match_set(self.JOIN_KINDS, advance=False) and self._prev
    221
    222            if kind_pre:
    223                kind = self._match_set(self.JOIN_KINDS) and self._prev
    224                side = self._match_set(self.JOIN_SIDES) and self._prev
    225                return is_global, side, kind
    226
    227            return (
    228                is_global,
    229                self._match_set(self.JOIN_SIDES) and self._prev,
    230                self._match_set(self.JOIN_KINDS) and self._prev,
    231            )
    232
    233        def _parse_join(
    234            self, skip_join_token: bool = False, parse_bracket: bool = False
    235        ) -> t.Optional[exp.Join]:
    236            join = super()._parse_join(skip_join_token=skip_join_token, parse_bracket=True)
    237
    238            if join:
    239                join.set("global", join.args.pop("method", None))
    240            return join
    241
    242        def _parse_function(
    243            self,
    244            functions: t.Optional[t.Dict[str, t.Callable]] = None,
    245            anonymous: bool = False,
    246            optional_parens: bool = True,
    247        ) -> t.Optional[exp.Expression]:
    248            func = super()._parse_function(
    249                functions=functions, anonymous=anonymous, optional_parens=optional_parens
    250            )
    251
    252            if isinstance(func, exp.Anonymous):
    253                params = self._parse_func_params(func)
    254
    255                if params:
    256                    return self.expression(
    257                        exp.ParameterizedAgg,
    258                        this=func.this,
    259                        expressions=func.expressions,
    260                        params=params,
    261                    )
    262
    263            return func
    264
    265        def _parse_func_params(
    266            self, this: t.Optional[exp.Func] = None
    267        ) -> t.Optional[t.List[exp.Expression]]:
    268            if self._match_pair(TokenType.R_PAREN, TokenType.L_PAREN):
    269                return self._parse_csv(self._parse_lambda)
    270
    271            if self._match(TokenType.L_PAREN):
    272                params = self._parse_csv(self._parse_lambda)
    273                self._match_r_paren(this)
    274                return params
    275
    276            return None
    277
    278        def _parse_quantile(self) -> exp.Quantile:
    279            this = self._parse_lambda()
    280            params = self._parse_func_params()
    281            if params:
    282                return self.expression(exp.Quantile, this=params[0], quantile=this)
    283            return self.expression(exp.Quantile, this=this, quantile=exp.Literal.number(0.5))
    284
    285        def _parse_wrapped_id_vars(self, optional: bool = False) -> t.List[exp.Expression]:
    286            return super()._parse_wrapped_id_vars(optional=True)
    287
    288        def _parse_primary_key(
    289            self, wrapped_optional: bool = False, in_props: bool = False
    290        ) -> exp.PrimaryKeyColumnConstraint | exp.PrimaryKey:
    291            return super()._parse_primary_key(
    292                wrapped_optional=wrapped_optional or in_props, in_props=in_props
    293            )
    294
    295        def _parse_on_property(self) -> t.Optional[exp.Expression]:
    296            index = self._index
    297            if self._match_text_seq("CLUSTER"):
    298                this = self._parse_id_var()
    299                if this:
    300                    return self.expression(exp.OnCluster, this=this)
    301                else:
    302                    self._retreat(index)
    303            return None
    304
    305    class Generator(generator.Generator):
    306        QUERY_HINTS = False
    307        STRUCT_DELIMITER = ("(", ")")
    308        NVL2_SUPPORTED = False
    309
    310        STRING_TYPE_MAPPING = {
    311            exp.DataType.Type.CHAR: "String",
    312            exp.DataType.Type.LONGBLOB: "String",
    313            exp.DataType.Type.LONGTEXT: "String",
    314            exp.DataType.Type.MEDIUMBLOB: "String",
    315            exp.DataType.Type.MEDIUMTEXT: "String",
    316            exp.DataType.Type.TINYBLOB: "String",
    317            exp.DataType.Type.TINYTEXT: "String",
    318            exp.DataType.Type.TEXT: "String",
    319            exp.DataType.Type.VARBINARY: "String",
    320            exp.DataType.Type.VARCHAR: "String",
    321        }
    322
    323        TYPE_MAPPING = {
    324            **generator.Generator.TYPE_MAPPING,
    325            **STRING_TYPE_MAPPING,
    326            exp.DataType.Type.ARRAY: "Array",
    327            exp.DataType.Type.BIGINT: "Int64",
    328            exp.DataType.Type.DATETIME64: "DateTime64",
    329            exp.DataType.Type.DOUBLE: "Float64",
    330            exp.DataType.Type.ENUM: "Enum",
    331            exp.DataType.Type.ENUM8: "Enum8",
    332            exp.DataType.Type.ENUM16: "Enum16",
    333            exp.DataType.Type.FIXEDSTRING: "FixedString",
    334            exp.DataType.Type.FLOAT: "Float32",
    335            exp.DataType.Type.INT: "Int32",
    336            exp.DataType.Type.MEDIUMINT: "Int32",
    337            exp.DataType.Type.INT128: "Int128",
    338            exp.DataType.Type.INT256: "Int256",
    339            exp.DataType.Type.LOWCARDINALITY: "LowCardinality",
    340            exp.DataType.Type.MAP: "Map",
    341            exp.DataType.Type.NESTED: "Nested",
    342            exp.DataType.Type.NULLABLE: "Nullable",
    343            exp.DataType.Type.SMALLINT: "Int16",
    344            exp.DataType.Type.STRUCT: "Tuple",
    345            exp.DataType.Type.TINYINT: "Int8",
    346            exp.DataType.Type.UBIGINT: "UInt64",
    347            exp.DataType.Type.UINT: "UInt32",
    348            exp.DataType.Type.UINT128: "UInt128",
    349            exp.DataType.Type.UINT256: "UInt256",
    350            exp.DataType.Type.USMALLINT: "UInt16",
    351            exp.DataType.Type.UTINYINT: "UInt8",
    352        }
    353
    354        TRANSFORMS = {
    355            **generator.Generator.TRANSFORMS,
    356            exp.AnyValue: rename_func("any"),
    357            exp.ApproxDistinct: rename_func("uniq"),
    358            exp.Array: inline_array_sql,
    359            exp.CastToStrType: rename_func("CAST"),
    360            exp.DateAdd: lambda self, e: self.func(
    361                "DATE_ADD", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    362            ),
    363            exp.DateDiff: lambda self, e: self.func(
    364                "DATE_DIFF", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    365            ),
    366            exp.Final: lambda self, e: f"{self.sql(e, 'this')} FINAL",
    367            exp.Map: lambda self, e: _lower_func(var_map_sql(self, e)),
    368            exp.PartitionedByProperty: lambda self, e: f"PARTITION BY {self.sql(e, 'this')}",
    369            exp.Pivot: no_pivot_sql,
    370            exp.Quantile: lambda self, e: self.func("quantile", e.args.get("quantile"))
    371            + f"({self.sql(e, 'this')})",
    372            exp.RegexpLike: lambda self, e: f"match({self.format_args(e.this, e.expression)})",
    373            exp.StrPosition: lambda self, e: f"position({self.format_args(e.this, e.args.get('substr'), e.args.get('position'))})",
    374            exp.VarMap: lambda self, e: _lower_func(var_map_sql(self, e)),
    375            exp.Xor: lambda self, e: self.func("xor", e.this, e.expression, *e.expressions),
    376        }
    377
    378        PROPERTIES_LOCATION = {
    379            **generator.Generator.PROPERTIES_LOCATION,
    380            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
    381            exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,
    382            exp.OnCluster: exp.Properties.Location.POST_NAME,
    383        }
    384
    385        JOIN_HINTS = False
    386        TABLE_HINTS = False
    387        EXPLICIT_UNION = True
    388        GROUPINGS_SEP = ""
    389
    390        # there's no list in docs, but it can be found in Clickhouse code
    391        # see `ClickHouse/src/Parsers/ParserCreate*.cpp`
    392        ON_CLUSTER_TARGETS = {
    393            "DATABASE",
    394            "TABLE",
    395            "VIEW",
    396            "DICTIONARY",
    397            "INDEX",
    398            "FUNCTION",
    399            "NAMED COLLECTION",
    400        }
    401
    402        def datatype_sql(self, expression: exp.DataType) -> str:
    403            # String is the standard ClickHouse type, every other variant is just an alias.
    404            # Additionally, any supplied length parameter will be ignored.
    405            #
    406            # https://clickhouse.com/docs/en/sql-reference/data-types/string
    407            if expression.this in self.STRING_TYPE_MAPPING:
    408                return "String"
    409
    410            return super().datatype_sql(expression)
    411
    412        def safeconcat_sql(self, expression: exp.SafeConcat) -> str:
    413            # Clickhouse errors out if we try to cast a NULL value to TEXT
    414            expression = expression.copy()
    415            return self.func(
    416                "CONCAT",
    417                *[
    418                    exp.func("if", e.is_(exp.null()), e, exp.cast(e, "text"))
    419                    for e in t.cast(t.List[exp.Condition], expression.expressions)
    420                ],
    421            )
    422
    423        def cte_sql(self, expression: exp.CTE) -> str:
    424            if isinstance(expression.this, exp.Alias):
    425                return self.sql(expression, "this")
    426
    427            return super().cte_sql(expression)
    428
    429        def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]:
    430            return super().after_limit_modifiers(expression) + [
    431                self.seg("SETTINGS ") + self.expressions(expression, key="settings", flat=True)
    432                if expression.args.get("settings")
    433                else "",
    434                self.seg("FORMAT ") + self.sql(expression, "format")
    435                if expression.args.get("format")
    436                else "",
    437            ]
    438
    439        def parameterizedagg_sql(self, expression: exp.Anonymous) -> str:
    440            params = self.expressions(expression, key="params", flat=True)
    441            return self.func(expression.name, *expression.expressions) + f"({params})"
    442
    443        def placeholder_sql(self, expression: exp.Placeholder) -> str:
    444            return f"{{{expression.name}: {self.sql(expression, 'kind')}}}"
    445
    446        def oncluster_sql(self, expression: exp.OnCluster) -> str:
    447            return f"ON CLUSTER {self.sql(expression, 'this')}"
    448
    449        def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str:
    450            kind = self.sql(expression, "kind").upper()
    451            if kind in self.ON_CLUSTER_TARGETS and locations.get(exp.Properties.Location.POST_NAME):
    452                this_name = self.sql(expression.this, "this")
    453                this_properties = " ".join(
    454                    [self.sql(prop) for prop in locations[exp.Properties.Location.POST_NAME]]
    455                )
    456                this_schema = self.schema_columns_sql(expression.this)
    457                return f"{this_name}{self.sep()}{this_properties}{self.sep()}{this_schema}"
    458
    459            return super().createable_sql(expression, locations)

NORMALIZE_FUNCTIONS: bool | str = False
NULL_ORDERING = 'nulls_are_last'
STRICT_STRING_CONCAT = True
SUPPORTS_USER_DEFINED_TYPES = False
tokenizer_class = <class 'ClickHouse.Tokenizer'>
parser_class = <class 'ClickHouse.Parser'>
generator_class = <class 'ClickHouse.Generator'>
TIME_TRIE: Dict = {}
FORMAT_TRIE: Dict = {}
INVERSE_TIME_MAPPING: Dict[str, str] = {}
INVERSE_TIME_TRIE: Dict = {}
QUOTE_START = "'"
QUOTE_END = "'"
IDENTIFIER_START = '"'
IDENTIFIER_END = '"'
BIT_START = '0b'
BIT_END = ''
HEX_START = '0x'
HEX_END = ''
BYTE_START = None
BYTE_END = None

##### Inherited Members

sqlglot.dialects.dialect.Dialect
  INDEX_OFFSET
  UNNEST_COLUMN_ONLY
  ALIAS_POST_TABLESAMPLE
  RESOLVES_IDENTIFIERS_AS_UPPERCASE
  IDENTIFIERS_CAN_START_WITH_DIGIT
  DPIPE_IS_STRING_CONCAT
  DATE_FORMAT
  DATEINT_FORMAT
  TIME_FORMAT
  TIME_MAPPING
  FORMAT_MAPPING
  PSEUDOCOLUMNS
  get_or_raise
  format_time
  normalize_identifier
  case_sensitive
  can_identify
  quote_identifier
  parse
  parse_into
  generate
  transpile
  tokenize
  tokenizer
  parser
  generator

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

    31    class Tokenizer(tokens.Tokenizer):
    32        COMMENTS = ["--", "#", "#!", ("/*", "*/")]
    33        IDENTIFIERS = ['"', "`"]
    34        STRING_ESCAPES = ["'", "\\"]
    35        BIT_STRINGS = [("0b", "")]
    36        HEX_STRINGS = [("0x", ""), ("0X", "")]
    37
    38        KEYWORDS = {
    39            **tokens.Tokenizer.KEYWORDS,
    40            "ATTACH": TokenType.COMMAND,
    41            "DATETIME64": TokenType.DATETIME64,
    42            "DICTIONARY": TokenType.DICTIONARY,
    43            "ENUM": TokenType.ENUM,
    44            "ENUM8": TokenType.ENUM8,
    45            "ENUM16": TokenType.ENUM16,
    46            "FINAL": TokenType.FINAL,
    47            "FIXEDSTRING": TokenType.FIXEDSTRING,
    48            "FLOAT32": TokenType.FLOAT,
    49            "FLOAT64": TokenType.DOUBLE,
    50            "GLOBAL": TokenType.GLOBAL,
    51            "INT16": TokenType.SMALLINT,
    52            "INT256": TokenType.INT256,
    53            "INT32": TokenType.INT,
    54            "INT64": TokenType.BIGINT,
    55            "INT8": TokenType.TINYINT,
    56            "LOWCARDINALITY": TokenType.LOWCARDINALITY,
    57            "MAP": TokenType.MAP,
    58            "NESTED": TokenType.NESTED,
    59            "TUPLE": TokenType.STRUCT,
    60            "UINT128": TokenType.UINT128,
    61            "UINT16": TokenType.USMALLINT,
    62            "UINT256": TokenType.UINT256,
    63            "UINT32": TokenType.UINT,
    64            "UINT64": TokenType.UBIGINT,
    65            "UINT8": TokenType.UTINYINT,
    66        }

COMMENTS = ['--', '#', '#!', ('/*', '*/')]
IDENTIFIERS = ['"', '`']
STRING_ESCAPES = ["'", '\\']
BIT_STRINGS = [('0b', '')]
HEX_STRINGS = [('0x', ''), ('0X', '')]
KEYWORDS = {'{%': <TokenType.BLOCK_START: 'BLOCK_START'>, '{%+': <TokenType.BLOCK_START: 'BLOCK_START'>, '{%-': <TokenType.BLOCK_START: 'BLOCK_START'>, '%}': <TokenType.BLOCK_END: 'BLOCK_END'>, '+%}': <TokenType.BLOCK_END: 'BLOCK_END'>, '-%}': <TokenType.BLOCK_END: 'BLOCK_END'>, '{{+': <TokenType.BLOCK_START: 'BLOCK_START'>, '{{-': <TokenType.BLOCK_START: 'BLOCK_START'>, '+}}': <TokenType.BLOCK_END: 'BLOCK_END'>, '-}}': <TokenType.BLOCK_END: 'BLOCK_END'>, '/*+': <TokenType.HINT: 'HINT'>, '==': <TokenType.EQ: 'EQ'>, '::': <TokenType.DCOLON: 'DCOLON'>, '||': <TokenType.DPIPE: 'DPIPE'>, '>=': <TokenType.GTE: 'GTE'>, '<=': <TokenType.LTE: 'LTE'>, '<>': <TokenType.NEQ: 'NEQ'>, '!=': <TokenType.NEQ: 'NEQ'>, '<=>': <TokenType.NULLSAFE_EQ: 'NULLSAFE_EQ'>, '->': <TokenType.ARROW: 'ARROW'>, '->>': <TokenType.DARROW: 'DARROW'>, '=>': <TokenType.FARROW: 'FARROW'>, '#>': <TokenType.HASH_ARROW: 'HASH_ARROW'>, '#>>': <TokenType.DHASH_ARROW: 'DHASH_ARROW'>, '<->': <TokenType.LR_ARROW: 'LR_ARROW'>, '&&': <TokenType.DAMP: 'DAMP'>, '??': <TokenType.DQMARK: 'DQMARK'>, 'ALL': <TokenType.ALL: 'ALL'>, 'ALWAYS': <TokenType.ALWAYS: 'ALWAYS'>, 'AND': <TokenType.AND: 'AND'>, 'ANTI': <TokenType.ANTI: 'ANTI'>, 'ANY': <TokenType.ANY: 'ANY'>, 'ASC': <TokenType.ASC: 'ASC'>, 'AS': <TokenType.ALIAS: 'ALIAS'>, 'ASOF': <TokenType.ASOF: 'ASOF'>, 'AUTOINCREMENT': <TokenType.AUTO_INCREMENT: 'AUTO_INCREMENT'>, 'AUTO_INCREMENT': <TokenType.AUTO_INCREMENT: 'AUTO_INCREMENT'>, 'BEGIN': <TokenType.BEGIN: 'BEGIN'>, 'BETWEEN': <TokenType.BETWEEN: 'BETWEEN'>, 'CACHE': <TokenType.CACHE: 'CACHE'>, 'UNCACHE': <TokenType.UNCACHE: 'UNCACHE'>, 'CASE': <TokenType.CASE: 'CASE'>, 'CHARACTER SET': <TokenType.CHARACTER_SET: 'CHARACTER_SET'>, 'CLUSTER BY': <TokenType.CLUSTER_BY: 'CLUSTER_BY'>, 'COLLATE': <TokenType.COLLATE: 'COLLATE'>, 'COLUMN': <TokenType.COLUMN: 'COLUMN'>, 'COMMIT': <TokenType.COMMIT: 'COMMIT'>, 'CONNECT BY': <TokenType.CONNECT_BY: 'CONNECT_BY'>, 'CONSTRAINT': <TokenType.CONSTRAINT: 'CONSTRAINT'>, 'CREATE': <TokenType.CREATE: 'CREATE'>, 'CROSS': <TokenType.CROSS: 'CROSS'>, 'CUBE': <TokenType.CUBE: 'CUBE'>, 'CURRENT_DATE': <TokenType.CURRENT_DATE: 'CURRENT_DATE'>, 'CURRENT_TIME': <TokenType.CURRENT_TIME: 'CURRENT_TIME'>, 'CURRENT_TIMESTAMP': <TokenType.CURRENT_TIMESTAMP: 'CURRENT_TIMESTAMP'>, 'CURRENT_USER': <TokenType.CURRENT_USER: 'CURRENT_USER'>, 'DATABASE': <TokenType.DATABASE: 'DATABASE'>, 'DEFAULT': <TokenType.DEFAULT: 'DEFAULT'>, 'DELETE': <TokenType.DELETE: 'DELETE'>, 'DESC': <TokenType.DESC: 'DESC'>, 'DESCRIBE': <TokenType.DESCRIBE: 'DESCRIBE'>, 'DISTINCT': <TokenType.DISTINCT: 'DISTINCT'>, 'DISTRIBUTE BY': <TokenType.DISTRIBUTE_BY: 'DISTRIBUTE_BY'>, 'DIV': <TokenType.DIV: 'DIV'>, 'DROP': <TokenType.DROP: 'DROP'>, 'ELSE': <TokenType.ELSE: 'ELSE'>, 'END': <TokenType.END: 'END'>, 'ESCAPE': <TokenType.ESCAPE: 'ESCAPE'>, 'EXCEPT': <TokenType.EXCEPT: 'EXCEPT'>, 'EXECUTE': <TokenType.EXECUTE: 'EXECUTE'>, 'EXISTS': <TokenType.EXISTS: 'EXISTS'>, 'FALSE': <TokenType.FALSE: 'FALSE'>, 'FETCH': <TokenType.FETCH: 'FETCH'>, 'FILTER': <TokenType.FILTER: 'FILTER'>, 'FIRST': <TokenType.FIRST: 'FIRST'>, 'FULL': <TokenType.FULL: 'FULL'>, 'FUNCTION': <TokenType.FUNCTION: 'FUNCTION'>, 'FOR': <TokenType.FOR: 'FOR'>, 'FOREIGN KEY': <TokenType.FOREIGN_KEY: 'FOREIGN_KEY'>, 'FORMAT': <TokenType.FORMAT: 'FORMAT'>, 'FROM': <TokenType.FROM: 'FROM'>, 'GEOGRAPHY': <TokenType.GEOGRAPHY: 'GEOGRAPHY'>, 'GEOMETRY': <TokenType.GEOMETRY: 'GEOMETRY'>, 'GLOB': <TokenType.GLOB: 'GLOB'>, 'GROUP BY': <TokenType.GROUP_BY: 'GROUP_BY'>, 'GROUPING SETS': <TokenType.GROUPING_SETS: 'GROUPING_SETS'>, 'HAVING': <TokenType.HAVING: 'HAVING'>, 'ILIKE': <TokenType.ILIKE: 'ILIKE'>, 'IN': <TokenType.IN: 'IN'>, 'INDEX': <TokenType.INDEX: 'INDEX'>, 'INET': <TokenType.INET: 'INET'>, 'INNER': <TokenType.INNER: 'INNER'>, 'INSERT': <TokenType.INSERT: 'INSERT'>, 'INTERVAL': <TokenType.INTERVAL: 'INTERVAL'>, 'INTERSECT': <TokenType.INTERSECT: 'INTERSECT'>, 'INTO': <TokenType.INTO: 'INTO'>, 'IS': <TokenType.IS: 'IS'>, 'ISNULL': <TokenType.ISNULL: 'ISNULL'>, 'JOIN': <TokenType.JOIN: 'JOIN'>, 'KEEP': <TokenType.KEEP: 'KEEP'>, 'LATERAL': <TokenType.LATERAL: 'LATERAL'>, 'LEFT': <TokenType.LEFT: 'LEFT'>, 'LIKE': <TokenType.LIKE: 'LIKE'>, 'LIMIT': <TokenType.LIMIT: 'LIMIT'>, 'LOAD': <TokenType.LOAD: 'LOAD'>, 'LOCK': <TokenType.LOCK: 'LOCK'>, 'MERGE': <TokenType.MERGE: 'MERGE'>, 'NATURAL': <TokenType.NATURAL: 'NATURAL'>, 'NEXT': <TokenType.NEXT: 'NEXT'>, 'NOT': <TokenType.NOT: 'NOT'>, 'NOTNULL': <TokenType.NOTNULL: 'NOTNULL'>, 'NULL': <TokenType.NULL: 'NULL'>, 'OBJECT': <TokenType.OBJECT: 'OBJECT'>, 'OFFSET': <TokenType.OFFSET: 'OFFSET'>, 'ON': <TokenType.ON: 'ON'>, 'OR': <TokenType.OR: 'OR'>, 'XOR': <TokenType.XOR: 'XOR'>, 'ORDER BY': <TokenType.ORDER_BY: 'ORDER_BY'>, 'ORDINALITY': <TokenType.ORDINALITY: 'ORDINALITY'>, 'OUTER': <TokenType.OUTER: 'OUTER'>, 'OVER': <TokenType.OVER: 'OVER'>, 'OVERLAPS': <TokenType.OVERLAPS: 'OVERLAPS'>, 'OVERWRITE': <TokenType.OVERWRITE: 'OVERWRITE'>, 'PARTITION': <TokenType.PARTITION: 'PARTITION'>, 'PARTITION BY': <TokenType.PARTITION_BY: 'PARTITION_BY'>, 'PARTITIONED BY': <TokenType.PARTITION_BY: 'PARTITION_BY'>, 'PARTITIONED_BY': <TokenType.PARTITION_BY: 'PARTITION_BY'>, 'PERCENT': <TokenType.PERCENT: 'PERCENT'>, 'PIVOT': <TokenType.PIVOT: 'PIVOT'>, 'PRAGMA': <TokenType.PRAGMA: 'PRAGMA'>, 'PRIMARY KEY': <TokenType.PRIMARY_KEY: 'PRIMARY_KEY'>, 'PROCEDURE': <TokenType.PROCEDURE: 'PROCEDURE'>, 'QUALIFY': <TokenType.QUALIFY: 'QUALIFY'>, 'RANGE': <TokenType.RANGE: 'RANGE'>, 'RECURSIVE': <TokenType.RECURSIVE: 'RECURSIVE'>, 'REGEXP': <TokenType.RLIKE: 'RLIKE'>, 'REPLACE': <TokenType.REPLACE: 'REPLACE'>, 'RETURNING': <TokenType.RETURNING: 'RETURNING'>, 'REFERENCES': <TokenType.REFERENCES: 'REFERENCES'>, 'RIGHT': <TokenType.RIGHT: 'RIGHT'>, 'RLIKE': <TokenType.RLIKE: 'RLIKE'>, 'ROLLBACK': <TokenType.ROLLBACK: 'ROLLBACK'>, 'ROLLUP': <TokenType.ROLLUP: 'ROLLUP'>, 'ROW': <TokenType.ROW: 'ROW'>, 'ROWS': <TokenType.ROWS: 'ROWS'>, 'SCHEMA': <TokenType.SCHEMA: 'SCHEMA'>, 'SELECT': <TokenType.SELECT: 'SELECT'>, 'SEMI': <TokenType.SEMI: 'SEMI'>, 'SET': <TokenType.SET: 'SET'>, 'SETTINGS': <TokenType.SETTINGS: 'SETTINGS'>, 'SHOW': <TokenType.SHOW: 'SHOW'>, 'SIMILAR TO': <TokenType.SIMILAR_TO: 'SIMILAR_TO'>, 'SOME': <TokenType.SOME: 'SOME'>, 'SORT BY': <TokenType.SORT_BY: 'SORT_BY'>, 'START WITH': <TokenType.START_WITH: 'START_WITH'>, 'TABLE': <TokenType.TABLE: 'TABLE'>, 'TABLESAMPLE': <TokenType.TABLE_SAMPLE: 'TABLE_SAMPLE'>, 'TEMP': <TokenType.TEMPORARY: 'TEMPORARY'>, 'TEMPORARY': <TokenType.TEMPORARY: 'TEMPORARY'>, 'THEN': <TokenType.THEN: 'THEN'>, 'TRUE': <TokenType.TRUE: 'TRUE'>, 'UNION': <TokenType.UNION: 'UNION'>, 'UNKNOWN': <TokenType.UNKNOWN: 'UNKNOWN'>, 'UNNEST': <TokenType.UNNEST: 'UNNEST'>, 'UNPIVOT': <TokenType.UNPIVOT: 'UNPIVOT'>, 'UPDATE': <TokenType.UPDATE: 'UPDATE'>, 'USE': <TokenType.USE: 'USE'>, 'USING': <TokenType.USING: 'USING'>, 'UUID': <TokenType.UUID: 'UUID'>, 'VALUES': <TokenType.VALUES: 'VALUES'>, 'VIEW': <TokenType.VIEW: 'VIEW'>, 'VOLATILE': <TokenType.VOLATILE: 'VOLATILE'>, 'WHEN': <TokenType.WHEN: 'WHEN'>, 'WHERE': <TokenType.WHERE: 'WHERE'>, 'WINDOW': <TokenType.WINDOW: 'WINDOW'>, 'WITH': <TokenType.WITH: 'WITH'>, 'APPLY': <TokenType.APPLY: 'APPLY'>, 'ARRAY': <TokenType.ARRAY: 'ARRAY'>, 'BIT': <TokenType.BIT: 'BIT'>, 'BOOL': <TokenType.BOOLEAN: 'BOOLEAN'>, 'BOOLEAN': <TokenType.BOOLEAN: 'BOOLEAN'>, 'BYTE': <TokenType.TINYINT: 'TINYINT'>, 'MEDIUMINT': <TokenType.MEDIUMINT: 'MEDIUMINT'>, 'TINYINT': <TokenType.TINYINT: 'TINYINT'>, 'SHORT': <TokenType.SMALLINT: 'SMALLINT'>, 'SMALLINT': <TokenType.SMALLINT: 'SMALLINT'>, 'INT128': <TokenType.INT128: 'INT128'>, 'INT2': <TokenType.SMALLINT: 'SMALLINT'>, 'INTEGER': <TokenType.INT: 'INT'>, 'INT': <TokenType.INT: 'INT'>, 'INT4': <TokenType.INT: 'INT'>, 'LONG': <TokenType.BIGINT: 'BIGINT'>, 'BIGINT': <TokenType.BIGINT: 'BIGINT'>, 'INT8': <TokenType.TINYINT: 'TINYINT'>, 'DEC': <TokenType.DECIMAL: 'DECIMAL'>, 'DECIMAL': <TokenType.DECIMAL: 'DECIMAL'>, 'BIGDECIMAL': <TokenType.BIGDECIMAL: 'BIGDECIMAL'>, 'BIGNUMERIC': <TokenType.BIGDECIMAL: 'BIGDECIMAL'>, 'MAP': <TokenType.MAP: 'MAP'>, 'NULLABLE': <TokenType.NULLABLE: 'NULLABLE'>, 'NUMBER': <TokenType.DECIMAL: 'DECIMAL'>, 'NUMERIC': <TokenType.DECIMAL: 'DECIMAL'>, 'FIXED': <TokenType.DECIMAL: 'DECIMAL'>, 'REAL': <TokenType.FLOAT: 'FLOAT'>, 'FLOAT': <TokenType.FLOAT: 'FLOAT'>, 'FLOAT4': <TokenType.FLOAT: 'FLOAT'>, 'FLOAT8': <TokenType.DOUBLE: 'DOUBLE'>, 'DOUBLE': <TokenType.DOUBLE: 'DOUBLE'>, 'DOUBLE PRECISION': <TokenType.DOUBLE: 'DOUBLE'>, 'JSON': <TokenType.JSON: 'JSON'>, 'CHAR': <TokenType.CHAR: 'CHAR'>, 'CHARACTER': <TokenType.CHAR: 'CHAR'>, 'NCHAR': <TokenType.NCHAR: 'NCHAR'>, 'VARCHAR': <TokenType.VARCHAR: 'VARCHAR'>, 'VARCHAR2': <TokenType.VARCHAR: 'VARCHAR'>, 'NVARCHAR': <TokenType.NVARCHAR: 'NVARCHAR'>, 'NVARCHAR2': <TokenType.NVARCHAR: 'NVARCHAR'>, 'STR': <TokenType.TEXT: 'TEXT'>, 'STRING': <TokenType.TEXT: 'TEXT'>, 'TEXT': <TokenType.TEXT: 'TEXT'>, 'LONGTEXT': <TokenType.LONGTEXT: 'LONGTEXT'>, 'MEDIUMTEXT': <TokenType.MEDIUMTEXT: 'MEDIUMTEXT'>, 'TINYTEXT': <TokenType.TINYTEXT: 'TINYTEXT'>, 'CLOB': <TokenType.TEXT: 'TEXT'>, 'LONGVARCHAR': <TokenType.TEXT: 'TEXT'>, 'BINARY': <TokenType.BINARY: 'BINARY'>, 'BLOB': <TokenType.VARBINARY: 'VARBINARY'>, 'LONGBLOB': <TokenType.LONGBLOB: 'LONGBLOB'>, 'MEDIUMBLOB': <TokenType.MEDIUMBLOB: 'MEDIUMBLOB'>, 'TINYBLOB': <TokenType.TINYBLOB: 'TINYBLOB'>, 'BYTEA': <TokenType.VARBINARY: 'VARBINARY'>, 'VARBINARY': <TokenType.VARBINARY: 'VARBINARY'>, 'TIME': <TokenType.TIME: 'TIME'>, 'TIMETZ': <TokenType.TIMETZ: 'TIMETZ'>, 'TIMESTAMP': <TokenType.TIMESTAMP: 'TIMESTAMP'>, 'TIMESTAMPTZ': <TokenType.TIMESTAMPTZ: 'TIMESTAMPTZ'>, 'TIMESTAMPLTZ': <TokenType.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>, 'DATE': <TokenType.DATE: 'DATE'>, 'DATETIME': <TokenType.DATETIME: 'DATETIME'>, 'INT4RANGE': <TokenType.INT4RANGE: 'INT4RANGE'>, 'INT4MULTIRANGE': <TokenType.INT4MULTIRANGE: 'INT4MULTIRANGE'>, 'INT8RANGE': <TokenType.INT8RANGE: 'INT8RANGE'>, 'INT8MULTIRANGE': <TokenType.INT8MULTIRANGE: 'INT8MULTIRANGE'>, 'NUMRANGE': <TokenType.NUMRANGE: 'NUMRANGE'>, 'NUMMULTIRANGE': <TokenType.NUMMULTIRANGE: 'NUMMULTIRANGE'>, 'TSRANGE': <TokenType.TSRANGE: 'TSRANGE'>, 'TSMULTIRANGE': <TokenType.TSMULTIRANGE: 'TSMULTIRANGE'>, 'TSTZRANGE': <TokenType.TSTZRANGE: 'TSTZRANGE'>, 'TSTZMULTIRANGE': <TokenType.TSTZMULTIRANGE: 'TSTZMULTIRANGE'>, 'DATERANGE': <TokenType.DATERANGE: 'DATERANGE'>, 'DATEMULTIRANGE': <TokenType.DATEMULTIRANGE: 'DATEMULTIRANGE'>, 'UNIQUE': <TokenType.UNIQUE: 'UNIQUE'>, 'STRUCT': <TokenType.STRUCT: 'STRUCT'>, 'VARIANT': <TokenType.VARIANT: 'VARIANT'>, 'ALTER': <TokenType.ALTER: 'ALTER'>, 'ANALYZE': <TokenType.COMMAND: 'COMMAND'>, 'CALL': <TokenType.COMMAND: 'COMMAND'>, 'COMMENT': <TokenType.COMMENT: 'COMMENT'>, 'COPY': <TokenType.COMMAND: 'COMMAND'>, 'EXPLAIN': <TokenType.COMMAND: 'COMMAND'>, 'GRANT': <TokenType.COMMAND: 'COMMAND'>, 'OPTIMIZE': <TokenType.COMMAND: 'COMMAND'>, 'PREPARE': <TokenType.COMMAND: 'COMMAND'>, 'TRUNCATE': <TokenType.COMMAND: 'COMMAND'>, 'VACUUM': <TokenType.COMMAND: 'COMMAND'>, 'USER-DEFINED': <TokenType.USERDEFINED: 'USERDEFINED'>, 'FOR VERSION': <TokenType.VERSION_SNAPSHOT: 'VERSION_SNAPSHOT'>, 'FOR TIMESTAMP': <TokenType.TIMESTAMP_SNAPSHOT: 'TIMESTAMP_SNAPSHOT'>, 'ATTACH': <TokenType.COMMAND: 'COMMAND'>, 'DATETIME64': <TokenType.DATETIME64: 'DATETIME64'>, 'DICTIONARY': <TokenType.DICTIONARY: 'DICTIONARY'>, 'ENUM': <TokenType.ENUM: 'ENUM'>, 'ENUM8': <TokenType.ENUM8: 'ENUM8'>, 'ENUM16': <TokenType.ENUM16: 'ENUM16'>, 'FINAL': <TokenType.FINAL: 'FINAL'>, 'FIXEDSTRING': <TokenType.FIXEDSTRING: 'FIXEDSTRING'>, 'FLOAT32': <TokenType.FLOAT: 'FLOAT'>, 'FLOAT64': <TokenType.DOUBLE: 'DOUBLE'>, 'GLOBAL': <TokenType.GLOBAL: 'GLOBAL'>, 'INT16': <TokenType.SMALLINT: 'SMALLINT'>, 'INT256': <TokenType.INT256: 'INT256'>, 'INT32': <TokenType.INT: 'INT'>, 'INT64': <TokenType.BIGINT: 'BIGINT'>, 'LOWCARDINALITY': <TokenType.LOWCARDINALITY: 'LOWCARDINALITY'>, 'NESTED': <TokenType.NESTED: 'NESTED'>, 'TUPLE': <TokenType.STRUCT: 'STRUCT'>, 'UINT128': <TokenType.UINT128: 'UINT128'>, 'UINT16': <TokenType.USMALLINT: 'USMALLINT'>, 'UINT256': <TokenType.UINT256: 'UINT256'>, 'UINT32': <TokenType.UINT: 'UINT'>, 'UINT64': <TokenType.UBIGINT: 'UBIGINT'>, 'UINT8': <TokenType.UTINYINT: 'UTINYINT'>}

##### Inherited Members

sqlglot.tokens.Tokenizer
  SINGLE_TOKENS
  BYTE_STRINGS
  RAW_STRINGS
  IDENTIFIER_ESCAPES
  QUOTES
  VAR_SINGLE_TOKENS
  IDENTIFIERS_CAN_START_WITH_DIGIT
  WHITE_SPACE
  COMMANDS
  COMMAND_PREFIX_TOKENS
  NUMERIC_LITERALS
  ENCODE
  reset
  tokenize
  peek
  size
  sql
  tokens

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

     68    class Parser(parser.Parser):
     69        FUNCTIONS = {
     70            **parser.Parser.FUNCTIONS,
     71            "ANY": exp.AnyValue.from_arg_list,
     72            "DATE_ADD": lambda args: exp.DateAdd(
     73                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     74            ),
     75            "DATEADD": lambda args: exp.DateAdd(
     76                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     77            ),
     78            "DATE_DIFF": lambda args: exp.DateDiff(
     79                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     80            ),
     81            "DATEDIFF": lambda args: exp.DateDiff(
     82                this=seq_get(args, 2), expression=seq_get(args, 1), unit=seq_get(args, 0)
     83            ),
     84            "MAP": parse_var_map,
     85            "MATCH": exp.RegexpLike.from_arg_list,
     86            "UNIQ": exp.ApproxDistinct.from_arg_list,
     87            "XOR": lambda args: exp.Xor(expressions=args),
     88        }
     89
     90        FUNCTIONS_WITH_ALIASED_ARGS = {*parser.Parser.FUNCTIONS_WITH_ALIASED_ARGS, "TUPLE"}
     91
     92        FUNCTION_PARSERS = {
     93            **parser.Parser.FUNCTION_PARSERS,
     94            "QUANTILE": lambda self: self._parse_quantile(),
     95        }
     96
     97        FUNCTION_PARSERS.pop("MATCH")
     98
     99        NO_PAREN_FUNCTION_PARSERS = parser.Parser.NO_PAREN_FUNCTION_PARSERS.copy()
    100        NO_PAREN_FUNCTION_PARSERS.pop("ANY")
    101
    102        RANGE_PARSERS = {
    103            **parser.Parser.RANGE_PARSERS,
    104            TokenType.GLOBAL: lambda self, this: self._match(TokenType.IN)
    105            and self._parse_in(this, is_global=True),
    106        }
    107
    108        # The PLACEHOLDER entry is popped because 1) it doesn't affect Clickhouse (it corresponds to
    109        # the postgres-specific JSONBContains parser) and 2) it makes parsing the ternary op simpler.
    110        COLUMN_OPERATORS = parser.Parser.COLUMN_OPERATORS.copy()
    111        COLUMN_OPERATORS.pop(TokenType.PLACEHOLDER)
    112
    113        JOIN_KINDS = {
    114            *parser.Parser.JOIN_KINDS,
    115            TokenType.ANY,
    116            TokenType.ASOF,
    117            TokenType.ANTI,
    118            TokenType.SEMI,
    119            TokenType.ARRAY,
    120        }
    121
    122        TABLE_ALIAS_TOKENS = {*parser.Parser.TABLE_ALIAS_TOKENS} - {
    123            TokenType.ANY,
    124            TokenType.SEMI,
    125            TokenType.ANTI,
    126            TokenType.SETTINGS,
    127            TokenType.FORMAT,
    128            TokenType.ARRAY,
    129        }
    130
    131        LOG_DEFAULTS_TO_LN = True
    132
    133        QUERY_MODIFIER_PARSERS = {
    134            **parser.Parser.QUERY_MODIFIER_PARSERS,
    135            TokenType.SETTINGS: lambda self: (
    136                "settings",
    137                self._advance() or self._parse_csv(self._parse_conjunction),
    138            ),
    139            TokenType.FORMAT: lambda self: ("format", self._advance() or self._parse_id_var()),
    140        }
    141
    142        def _parse_conjunction(self) -> t.Optional[exp.Expression]:
    143            this = super()._parse_conjunction()
    144
    145            if self._match(TokenType.PLACEHOLDER):
    146                return self.expression(
    147                    exp.If,
    148                    this=this,
    149                    true=self._parse_conjunction(),
    150                    false=self._match(TokenType.COLON) and self._parse_conjunction(),
    151                )
    152
    153            return this
    154
    155        def _parse_placeholder(self) -> t.Optional[exp.Expression]:
    156            """
    157            Parse a placeholder expression like SELECT {abc: UInt32} or FROM {table: Identifier}
    158            https://clickhouse.com/docs/en/sql-reference/syntax#defining-and-using-query-parameters
    159            """
    160            if not self._match(TokenType.L_BRACE):
    161                return None
    162
    163            this = self._parse_id_var()
    164            self._match(TokenType.COLON)
    165            kind = self._parse_types(check_func=False, allow_identifiers=False) or (
    166                self._match_text_seq("IDENTIFIER") and "Identifier"
    167            )
    168
    169            if not kind:
    170                self.raise_error("Expecting a placeholder type or 'Identifier' for tables")
    171            elif not self._match(TokenType.R_BRACE):
    172                self.raise_error("Expecting }")
    173
    174            return self.expression(exp.Placeholder, this=this, kind=kind)
    175
    176        def _parse_in(self, this: t.Optional[exp.Expression], is_global: bool = False) -> exp.In:
    177            this = super()._parse_in(this)
    178            this.set("is_global", is_global)
    179            return this
    180
    181        def _parse_table(
    182            self,
    183            schema: bool = False,
    184            joins: bool = False,
    185            alias_tokens: t.Optional[t.Collection[TokenType]] = None,
    186            parse_bracket: bool = False,
    187        ) -> t.Optional[exp.Expression]:
    188            this = super()._parse_table(
    189                schema=schema, joins=joins, alias_tokens=alias_tokens, parse_bracket=parse_bracket
    190            )
    191
    192            if self._match(TokenType.FINAL):
    193                this = self.expression(exp.Final, this=this)
    194
    195            return this
    196
    197        def _parse_position(self, haystack_first: bool = False) -> exp.StrPosition:
    198            return super()._parse_position(haystack_first=True)
    199
    200        # https://clickhouse.com/docs/en/sql-reference/statements/select/with/
    201        def _parse_cte(self) -> exp.CTE:
    202            index = self._index
    203            try:
    204                # WITH <identifier> AS <subquery expression>
    205                return super()._parse_cte()
    206            except ParseError:
    207                # WITH <expression> AS <identifier>
    208                self._retreat(index)
    209                statement = self._parse_statement()
    210
    211                if statement and isinstance(statement.this, exp.Alias):
    212                    self.raise_error("Expected CTE to have alias")
    213
    214                return self.expression(exp.CTE, this=statement, alias=statement and statement.this)
    215
    216        def _parse_join_parts(
    217            self,
    218        ) -> t.Tuple[t.Optional[Token], t.Optional[Token], t.Optional[Token]]:
    219            is_global = self._match(TokenType.GLOBAL) and self._prev
    220            kind_pre = self._match_set(self.JOIN_KINDS, advance=False) and self._prev
    221
    222            if kind_pre:
    223                kind = self._match_set(self.JOIN_KINDS) and self._prev
    224                side = self._match_set(self.JOIN_SIDES) and self._prev
    225                return is_global, side, kind
    226
    227            return (
    228                is_global,
    229                self._match_set(self.JOIN_SIDES) and self._prev,
    230                self._match_set(self.JOIN_KINDS) and self._prev,
    231            )
    232
    233        def _parse_join(
    234            self, skip_join_token: bool = False, parse_bracket: bool = False
    235        ) -> t.Optional[exp.Join]:
    236            join = super()._parse_join(skip_join_token=skip_join_token, parse_bracket=True)
    237
    238            if join:
    239                join.set("global", join.args.pop("method", None))
    240            return join
    241
    242        def _parse_function(
    243            self,
    244            functions: t.Optional[t.Dict[str, t.Callable]] = None,
    245            anonymous: bool = False,
    246            optional_parens: bool = True,
    247        ) -> t.Optional[exp.Expression]:
    248            func = super()._parse_function(
    249                functions=functions, anonymous=anonymous, optional_parens=optional_parens
    250            )
    251
    252            if isinstance(func, exp.Anonymous):
    253                params = self._parse_func_params(func)
    254
    255                if params:
    256                    return self.expression(
    257                        exp.ParameterizedAgg,
    258                        this=func.this,
    259                        expressions=func.expressions,
    260                        params=params,
    261                    )
    262
    263            return func
    264
    265        def _parse_func_params(
    266            self, this: t.Optional[exp.Func] = None
    267        ) -> t.Optional[t.List[exp.Expression]]:
    268            if self._match_pair(TokenType.R_PAREN, TokenType.L_PAREN):
    269                return self._parse_csv(self._parse_lambda)
    270
    271            if self._match(TokenType.L_PAREN):
    272                params = self._parse_csv(self._parse_lambda)
    273                self._match_r_paren(this)
    274                return params
    275
    276            return None
    277
    278        def _parse_quantile(self) -> exp.Quantile:
    279            this = self._parse_lambda()
    280            params = self._parse_func_params()
    281            if params:
    282                return self.expression(exp.Quantile, this=params[0], quantile=this)
    283            return self.expression(exp.Quantile, this=this, quantile=exp.Literal.number(0.5))
    284
    285        def _parse_wrapped_id_vars(self, optional: bool = False) -> t.List[exp.Expression]:
    286            return super()._parse_wrapped_id_vars(optional=True)
    287
    288        def _parse_primary_key(
    289            self, wrapped_optional: bool = False, in_props: bool = False
    290        ) -> exp.PrimaryKeyColumnConstraint | exp.PrimaryKey:
    291            return super()._parse_primary_key(
    292                wrapped_optional=wrapped_optional or in_props, in_props=in_props
    293            )
    294
    295        def _parse_on_property(self) -> t.Optional[exp.Expression]:
    296            index = self._index
    297            if self._match_text_seq("CLUSTER"):
    298                this = self._parse_id_var()
    299                if this:
    300                    return self.expression(exp.OnCluster, this=this)
    301                else:
    302                    self._retreat(index)
    303            return None

Parser consumes a list of tokens produced by the 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: 100
- 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

FUNCTIONS = {'ABS': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Abs'>>, 'ANY_VALUE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.AnyValue'>>, 'APPROX_DISTINCT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ApproxDistinct'>>, 'APPROX_COUNT_DISTINCT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ApproxDistinct'>>, 'APPROX_QUANTILE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ApproxQuantile'>>, 'ARRAY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Array'>>, 'ARRAY_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayAgg'>>, 'ARRAY_ALL': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayAll'>>, 'ARRAY_ANY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayAny'>>, 'ARRAY_CONCAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayConcat'>>, 'ARRAY_CAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayConcat'>>, 'ARRAY_CONTAINS': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayContains'>>, 'FILTER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayFilter'>>, 'ARRAY_FILTER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayFilter'>>, 'ARRAY_JOIN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayJoin'>>, 'ARRAY_SIZE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArraySize'>>, 'ARRAY_SORT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArraySort'>>, 'ARRAY_SUM': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArraySum'>>, 'ARRAY_UNION_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ArrayUnionAgg'>>, 'AVG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Avg'>>, 'CASE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Case'>>, 'CAST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Cast'>>, 'CAST_TO_STR_TYPE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CastToStrType'>>, 'CEIL': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Ceil'>>, 'CEILING': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Ceil'>>, 'COALESCE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Coalesce'>>, 'IFNULL': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Coalesce'>>, 'NVL': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Coalesce'>>, 'CONCAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Concat'>>, 'CONCAT_WS': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ConcatWs'>>, 'COUNT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Count'>>, 'COUNT_IF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CountIf'>>, 'CURRENT_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CurrentDate'>>, 'CURRENT_DATETIME': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CurrentDatetime'>>, 'CURRENT_TIME': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CurrentTime'>>, 'CURRENT_TIMESTAMP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CurrentTimestamp'>>, 'CURRENT_USER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.CurrentUser'>>, 'DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Date'>>, 'DATE_ADD': <function ClickHouse.Parser.<lambda>>, 'DATEDIFF': <function ClickHouse.Parser.<lambda>>, 'DATE_DIFF': <function ClickHouse.Parser.<lambda>>, 'DATEFROMPARTS': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DateFromParts'>>, 'DATE_STR_TO_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DateStrToDate'>>, 'DATE_SUB': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DateSub'>>, 'DATE_TO_DATE_STR': <function Parser.<lambda>>, 'DATE_TO_DI': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DateToDi'>>, 'DATE_TRUNC': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DateTrunc'>>, 'DATETIME_ADD': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DatetimeAdd'>>, 'DATETIME_DIFF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DatetimeDiff'>>, 'DATETIME_SUB': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DatetimeSub'>>, 'DATETIME_TRUNC': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DatetimeTrunc'>>, 'DAY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Day'>>, 'DAY_OF_MONTH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfMonth'>>, 'DAYOFMONTH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfMonth'>>, 'DAY_OF_WEEK': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfWeek'>>, 'DAYOFWEEK': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfWeek'>>, 'DAY_OF_YEAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfYear'>>, 'DAYOFYEAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DayOfYear'>>, 'DECODE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Decode'>>, 'DI_TO_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.DiToDate'>>, 'ENCODE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Encode'>>, 'EXP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Exp'>>, 'EXPLODE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Explode'>>, 'EXTRACT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Extract'>>, 'FIRST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.First'>>, 'FLOOR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Floor'>>, 'FROM_BASE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.FromBase'>>, 'FROM_BASE64': <bound method Func.from_arg_list of <class 'sqlglot.expressions.FromBase64'>>, 'GENERATE_SERIES': <bound method Func.from_arg_list of <class 'sqlglot.expressions.GenerateSeries'>>, 'GREATEST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Greatest'>>, 'GROUP_CONCAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.GroupConcat'>>, 'HEX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Hex'>>, 'HLL': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Hll'>>, 'IF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.If'>>, 'INITCAP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Initcap'>>, 'IS_NAN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.IsNan'>>, 'ISNAN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.IsNan'>>, 'J_S_O_N_ARRAY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONArray'>>, 'J_S_O_N_ARRAY_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONArrayAgg'>>, 'JSON_ARRAY_CONTAINS': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONArrayContains'>>, 'JSONB_EXTRACT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONBExtract'>>, 'JSONB_EXTRACT_SCALAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONBExtractScalar'>>, 'JSON_EXTRACT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONExtract'>>, 'JSON_EXTRACT_SCALAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONExtractScalar'>>, 'JSON_FORMAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONFormat'>>, 'J_S_O_N_OBJECT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONObject'>>, 'J_S_O_N_TABLE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.JSONTable'>>, 'LAST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Last'>>, 'LAST_DATE_OF_MONTH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LastDateOfMonth'>>, 'LEAST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Least'>>, 'LEFT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Left'>>, 'LENGTH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Length'>>, 'LEN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Length'>>, 'LEVENSHTEIN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Levenshtein'>>, 'LN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Ln'>>, 'LOG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Log'>>, 'LOG10': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Log10'>>, 'LOG2': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Log2'>>, 'LOGICAL_AND': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalAnd'>>, 'BOOL_AND': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalAnd'>>, 'BOOLAND_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalAnd'>>, 'LOGICAL_OR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalOr'>>, 'BOOL_OR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalOr'>>, 'BOOLOR_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.LogicalOr'>>, 'LOWER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Lower'>>, 'LCASE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Lower'>>, 'MD5': <bound method Func.from_arg_list of <class 'sqlglot.expressions.MD5'>>, 'MD5_DIGEST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.MD5Digest'>>, 'MAP': <function parse_var_map>, 'MAP_FROM_ENTRIES': <bound method Func.from_arg_list of <class 'sqlglot.expressions.MapFromEntries'>>, 'MATCH_AGAINST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.MatchAgainst'>>, 'MAX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Max'>>, 'MIN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Min'>>, 'MONTH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Month'>>, 'MONTHS_BETWEEN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.MonthsBetween'>>, 'NEXT_VALUE_FOR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.NextValueFor'>>, 'NUMBER_TO_STR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.NumberToStr'>>, 'NVL2': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Nvl2'>>, 'OPEN_J_S_O_N': <bound method Func.from_arg_list of <class 'sqlglot.expressions.OpenJSON'>>, 'PARAMETERIZED_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ParameterizedAgg'>>, 'PERCENTILE_CONT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.PercentileCont'>>, 'PERCENTILE_DISC': <bound method Func.from_arg_list of <class 'sqlglot.expressions.PercentileDisc'>>, 'POSEXPLODE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Posexplode'>>, 'POWER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Pow'>>, 'POW': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Pow'>>, 'QUANTILE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Quantile'>>, 'RANGE_N': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RangeN'>>, 'READ_CSV': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ReadCSV'>>, 'REDUCE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Reduce'>>, 'REGEXP_EXTRACT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpExtract'>>, 'REGEXP_I_LIKE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpILike'>>, 'REGEXP_LIKE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpLike'>>, 'REGEXP_REPLACE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpReplace'>>, 'REGEXP_SPLIT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpSplit'>>, 'REPEAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Repeat'>>, 'RIGHT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Right'>>, 'ROUND': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Round'>>, 'ROW_NUMBER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RowNumber'>>, 'SHA': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SHA'>>, 'SHA1': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SHA'>>, 'SHA2': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SHA2'>>, 'SAFE_CONCAT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SafeConcat'>>, 'SAFE_DIVIDE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SafeDivide'>>, 'SET_AGG': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SetAgg'>>, 'SORT_ARRAY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.SortArray'>>, 'SPLIT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Split'>>, 'SQRT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Sqrt'>>, 'STANDARD_HASH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StandardHash'>>, 'STAR_MAP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StarMap'>>, 'STARTS_WITH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StartsWith'>>, 'STARTSWITH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StartsWith'>>, 'STDDEV': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Stddev'>>, 'STDDEV_POP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StddevPop'>>, 'STDDEV_SAMP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StddevSamp'>>, 'STR_POSITION': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StrPosition'>>, 'STR_TO_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StrToDate'>>, 'STR_TO_MAP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StrToMap'>>, 'STR_TO_TIME': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StrToTime'>>, 'STR_TO_UNIX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StrToUnix'>>, 'STRUCT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Struct'>>, 'STRUCT_EXTRACT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.StructExtract'>>, 'STUFF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Stuff'>>, 'INSERT': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Stuff'>>, 'SUBSTRING': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Substring'>>, 'SUM': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Sum'>>, 'TIME_ADD': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeAdd'>>, 'TIME_DIFF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeDiff'>>, 'TIME_STR_TO_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeStrToDate'>>, 'TIME_STR_TO_TIME': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeStrToTime'>>, 'TIME_STR_TO_UNIX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeStrToUnix'>>, 'TIME_SUB': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeSub'>>, 'TIME_TO_STR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeToStr'>>, 'TIME_TO_TIME_STR': <function Parser.<lambda>>, 'TIME_TO_UNIX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeToUnix'>>, 'TIME_TRUNC': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimeTrunc'>>, 'TIMESTAMP_ADD': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimestampAdd'>>, 'TIMESTAMP_DIFF': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimestampDiff'>>, 'TIMESTAMP_SUB': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimestampSub'>>, 'TIMESTAMP_TRUNC': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TimestampTrunc'>>, 'TO_BASE64': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ToBase64'>>, 'TO_CHAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ToChar'>>, 'TRANSFORM': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Transform'>>, 'TRIM': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Trim'>>, 'TRY_CAST': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TryCast'>>, 'TS_OR_DI_TO_DI': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TsOrDiToDi'>>, 'TS_OR_DS_ADD': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TsOrDsAdd'>>, 'TS_OR_DS_TO_DATE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.TsOrDsToDate'>>, 'TS_OR_DS_TO_DATE_STR': <function Parser.<lambda>>, 'UNHEX': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Unhex'>>, 'UNIX_TO_STR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.UnixToStr'>>, 'UNIX_TO_TIME': <bound method Func.from_arg_list of <class 'sqlglot.expressions.UnixToTime'>>, 'UNIX_TO_TIME_STR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.UnixToTimeStr'>>, 'UPPER': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Upper'>>, 'UCASE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Upper'>>, 'VAR_MAP': <function parse_var_map>, 'VARIANCE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Variance'>>, 'VARIANCE_SAMP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Variance'>>, 'VAR_SAMP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Variance'>>, 'VARIANCE_POP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.VariancePop'>>, 'VAR_POP': <bound method Func.from_arg_list of <class 'sqlglot.expressions.VariancePop'>>, 'WEEK': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Week'>>, 'WEEK_OF_YEAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.WeekOfYear'>>, 'WEEKOFYEAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.WeekOfYear'>>, 'WHEN': <bound method Func.from_arg_list of <class 'sqlglot.expressions.When'>>, 'X_M_L_TABLE': <bound method Func.from_arg_list of <class 'sqlglot.expressions.XMLTable'>>, 'XOR': <function ClickHouse.Parser.<lambda>>, 'YEAR': <bound method Func.from_arg_list of <class 'sqlglot.expressions.Year'>>, 'GLOB': <function Parser.<lambda>>, 'LIKE': <function parse_like>, 'ANY': <bound method Func.from_arg_list of <class 'sqlglot.expressions.AnyValue'>>, 'DATEADD': <function ClickHouse.Parser.<lambda>>, 'MATCH': <bound method Func.from_arg_list of <class 'sqlglot.expressions.RegexpLike'>>, 'UNIQ': <bound method Func.from_arg_list of <class 'sqlglot.expressions.ApproxDistinct'>>}
FUNCTIONS_WITH_ALIASED_ARGS = {'STRUCT', 'TUPLE'}
FUNCTION_PARSERS = {'ANY_VALUE': <function Parser.<lambda>>, 'CAST': <function Parser.<lambda>>, 'CONCAT': <function Parser.<lambda>>, 'CONCAT_WS': <function Parser.<lambda>>, 'CONVERT': <function Parser.<lambda>>, 'DECODE': <function Parser.<lambda>>, 'EXTRACT': <function Parser.<lambda>>, 'JSON_OBJECT': <function Parser.<lambda>>, 'LOG': <function Parser.<lambda>>, 'OPENJSON': <function Parser.<lambda>>, 'POSITION': <function Parser.<lambda>>, 'SAFE_CAST': <function Parser.<lambda>>, 'STRING_AGG': <function Parser.<lambda>>, 'SUBSTRING': <function Parser.<lambda>>, 'TRIM': <function Parser.<lambda>>, 'TRY_CAST': <function Parser.<lambda>>, 'TRY_CONVERT': <function Parser.<lambda>>, 'QUANTILE': <function ClickHouse.Parser.<lambda>>}
NO_PAREN_FUNCTION_PARSERS = {'CASE': <function Parser.<lambda>>, 'IF': <function Parser.<lambda>>, 'NEXT': <function Parser.<lambda>>}
RANGE_PARSERS = {<TokenType.BETWEEN: 'BETWEEN'>: <function Parser.<lambda>>, <TokenType.GLOB: 'GLOB'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.ILIKE: 'ILIKE'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.IN: 'IN'>: <function Parser.<lambda>>, <TokenType.IRLIKE: 'IRLIKE'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.IS: 'IS'>: <function Parser.<lambda>>, <TokenType.LIKE: 'LIKE'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.OVERLAPS: 'OVERLAPS'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.RLIKE: 'RLIKE'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.SIMILAR_TO: 'SIMILAR_TO'>: <function binary_range_parser.<locals>.<lambda>>, <TokenType.FOR: 'FOR'>: <function Parser.<lambda>>, <TokenType.GLOBAL: 'GLOBAL'>: <function ClickHouse.Parser.<lambda>>}
COLUMN_OPERATORS = {<TokenType.DOT: 'DOT'>: None, <TokenType.DCOLON: 'DCOLON'>: <function Parser.<lambda>>, <TokenType.ARROW: 'ARROW'>: <function Parser.<lambda>>, <TokenType.DARROW: 'DARROW'>: <function Parser.<lambda>>, <TokenType.HASH_ARROW: 'HASH_ARROW'>: <function Parser.<lambda>>, <TokenType.DHASH_ARROW: 'DHASH_ARROW'>: <function Parser.<lambda>>}
JOIN_KINDS = {<TokenType.CROSS: 'CROSS'>, <TokenType.ASOF: 'ASOF'>, <TokenType.ANTI: 'ANTI'>, <TokenType.OUTER: 'OUTER'>, <TokenType.SEMI: 'SEMI'>, <TokenType.ARRAY: 'ARRAY'>, <TokenType.ANY: 'ANY'>, <TokenType.INNER: 'INNER'>}
TABLE_ALIAS_TOKENS = {<TokenType.TEXT: 'TEXT'>, <TokenType.TINYTEXT: 'TINYTEXT'>, <TokenType.TSTZMULTIRANGE: 'TSTZMULTIRANGE'>, <TokenType.SMALLINT: 'SMALLINT'>, <TokenType.DEFAULT: 'DEFAULT'>, <TokenType.PROCEDURE: 'PROCEDURE'>, <TokenType.ROWS: 'ROWS'>, <TokenType.UUID: 'UUID'>, <TokenType.ALL: 'ALL'>, <TokenType.INT4RANGE: 'INT4RANGE'>, <TokenType.FIRST: 'FIRST'>, <TokenType.TIMESTAMPTZ: 'TIMESTAMPTZ'>, <TokenType.BEGIN: 'BEGIN'>, <TokenType.DESC: 'DESC'>, <TokenType.INT4MULTIRANGE: 'INT4MULTIRANGE'>, <TokenType.CURRENT_DATE: 'CURRENT_DATE'>, <TokenType.INT8RANGE: 'INT8RANGE'>, <TokenType.COLLATE: 'COLLATE'>, <TokenType.VAR: 'VAR'>, <TokenType.VIEW: 'VIEW'>, <TokenType.FALSE: 'FALSE'>, <TokenType.ENUM: 'ENUM'>, <TokenType.PRAGMA: 'PRAGMA'>, <TokenType.KEEP: 'KEEP'>, <TokenType.UINT256: 'UINT256'>, <TokenType.AUTO_INCREMENT: 'AUTO_INCREMENT'>, <TokenType.TSMULTIRANGE: 'TSMULTIRANGE'>, <TokenType.IS: 'IS'>, <TokenType.OBJECT: 'OBJECT'>, <TokenType.ASC: 'ASC'>, <TokenType.INTERVAL: 'INTERVAL'>, <TokenType.DELETE: 'DELETE'>, <TokenType.VARBINARY: 'VARBINARY'>, <TokenType.NEXT: 'NEXT'>, <TokenType.IPPREFIX: 'IPPREFIX'>, <TokenType.FUNCTION: 'FUNCTION'>, <TokenType.DATERANGE: 'DATERANGE'>, <TokenType.LONGTEXT: 'LONGTEXT'>, <TokenType.JSON: 'JSON'>, <TokenType.COLUMN: 'COLUMN'>, <TokenType.INT: 'INT'>, <TokenType.CURRENT_TIME: 'CURRENT_TIME'>, <TokenType.BIGINT: 'BIGINT'>, <TokenType.SCHEMA: 'SCHEMA'>, <TokenType.PSEUDO_TYPE: 'PSEUDO_TYPE'>, <TokenType.NULL: 'NULL'>, <TokenType.DATETIME64: 'DATETIME64'>, <TokenType.ISNULL: 'ISNULL'>, <TokenType.NUMMULTIRANGE: 'NUMMULTIRANGE'>, <TokenType.CURRENT_TIMESTAMP: 'CURRENT_TIMESTAMP'>, <TokenType.BIGDECIMAL: 'BIGDECIMAL'>, <TokenType.COMMENT: 'COMMENT'>, <TokenType.UNKNOWN: 'UNKNOWN'>, <TokenType.UMEDIUMINT: 'UMEDIUMINT'>, <TokenType.SET: 'SET'>, <TokenType.GEOMETRY: 'GEOMETRY'>, <TokenType.CURRENT_USER: 'CURRENT_USER'>, <TokenType.TINYINT: 'TINYINT'>, <TokenType.CHAR: 'CHAR'>, <TokenType.LOWCARDINALITY: 'LOWCARDINALITY'>, <TokenType.DATETIME: 'DATETIME'>, <TokenType.EXECUTE: 'EXECUTE'>, <TokenType.UNIQUE: 'UNIQUE'>, <TokenType.ESCAPE: 'ESCAPE'>, <TokenType.MEDIUMINT: 'MEDIUMINT'>, <TokenType.TEMPORARY: 'TEMPORARY'>, <TokenType.INT8MULTIRANGE: 'INT8MULTIRANGE'>, <TokenType.PIVOT: 'PIVOT'>, <TokenType.MAP: 'MAP'>, <TokenType.MEDIUMBLOB: 'MEDIUMBLOB'>, <TokenType.UPDATE: 'UPDATE'>, <TokenType.VARCHAR: 'VARCHAR'>, <TokenType.IMAGE: 'IMAGE'>, <TokenType.TIMESTAMP: 'TIMESTAMP'>, <TokenType.COMMIT: 'COMMIT'>, <TokenType.YEAR: 'YEAR'>, <TokenType.RANGE: 'RANGE'>, <TokenType.DOUBLE: 'DOUBLE'>, <TokenType.VARIANT: 'VARIANT'>, <TokenType.DICTIONARY: 'DICTIONARY'>, <TokenType.STRUCT: 'STRUCT'>, <TokenType.SUPER: 'SUPER'>, <TokenType.INT256: 'INT256'>, <TokenType.JSONB: 'JSONB'>, <TokenType.ENUM8: 'ENUM8'>, <TokenType.FIXEDSTRING: 'FIXEDSTRING'>, <TokenType.XML: 'XML'>, <TokenType.MONEY: 'MONEY'>, <TokenType.REFERENCES: 'REFERENCES'>, <TokenType.PERCENT: 'PERCENT'>, <TokenType.USMALLINT: 'USMALLINT'>, <TokenType.CACHE: 'CACHE'>, <TokenType.FILTER: 'FILTER'>, <TokenType.MERGE: 'MERGE'>, <TokenType.VOLATILE: 'VOLATILE'>, <TokenType.TOP: 'TOP'>, <TokenType.OBJECT_IDENTIFIER: 'OBJECT_IDENTIFIER'>, <TokenType.DATABASE: 'DATABASE'>, <TokenType.DATEMULTIRANGE: 'DATEMULTIRANGE'>, <TokenType.FLOAT: 'FLOAT'>, <TokenType.OVERWRITE: 'OVERWRITE'>, <TokenType.NVARCHAR: 'NVARCHAR'>, <TokenType.MEDIUMTEXT: 'MEDIUMTEXT'>, <TokenType.ROW: 'ROW'>, <TokenType.PARTITION: 'PARTITION'>, <TokenType.COMMAND: 'COMMAND'>, <TokenType.LOAD: 'LOAD'>, <TokenType.INET: 'INET'>, <TokenType.NUMRANGE: 'NUMRANGE'>, <TokenType.UINT128: 'UINT128'>, <TokenType.TRUE: 'TRUE'>, <TokenType.UNIQUEIDENTIFIER: 'UNIQUEIDENTIFIER'>, <TokenType.TIMETZ: 'TIMETZ'>, <TokenType.DESCRIBE: 'DESCRIBE'>, <TokenType.SMALLSERIAL: 'SMALLSERIAL'>, <TokenType.NULLABLE: 'NULLABLE'>, <TokenType.INT128: 'INT128'>, <TokenType.BIT: 'BIT'>, <TokenType.UTINYINT: 'UTINYINT'>, <TokenType.HSTORE: 'HSTORE'>, <TokenType.TABLE: 'TABLE'>, <TokenType.SMALLMONEY: 'SMALLMONEY'>, <TokenType.TSRANGE: 'TSRANGE'>, <TokenType.NCHAR: 'NCHAR'>, <TokenType.UNPIVOT: 'UNPIVOT'>, <TokenType.TIME: 'TIME'>, <TokenType.DIV: 'DIV'>, <TokenType.CURRENT_DATETIME: 'CURRENT_DATETIME'>, <TokenType.ROWVERSION: 'ROWVERSION'>, <TokenType.TINYBLOB: 'TINYBLOB'>, <TokenType.ENUM16: 'ENUM16'>, <TokenType.ORDINALITY: 'ORDINALITY'>, <TokenType.SHOW: 'SHOW'>, <TokenType.END: 'END'>, <TokenType.SOME: 'SOME'>, <TokenType.EXISTS: 'EXISTS'>, <TokenType.BOOLEAN: 'BOOLEAN'>, <TokenType.BINARY: 'BINARY'>, <TokenType.HLLSKETCH: 'HLLSKETCH'>, <TokenType.UINT: 'UINT'>, <TokenType.DECIMAL: 'DECIMAL'>, <TokenType.GEOGRAPHY: 'GEOGRAPHY'>, <TokenType.SERIAL: 'SERIAL'>, <TokenType.DATE: 'DATE'>, <TokenType.INDEX: 'INDEX'>, <TokenType.USERDEFINED: 'USERDEFINED'>, <TokenType.UBIGINT: 'UBIGINT'>, <TokenType.TSTZRANGE: 'TSTZRANGE'>, <TokenType.NESTED: 'NESTED'>, <TokenType.CASE: 'CASE'>, <TokenType.LONGBLOB: 'LONGBLOB'>, <TokenType.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>, <TokenType.IPADDRESS: 'IPADDRESS'>, <TokenType.CONSTRAINT: 'CONSTRAINT'>, <TokenType.BIGSERIAL: 'BIGSERIAL'>}
LOG_DEFAULTS_TO_LN = True
QUERY_MODIFIER_PARSERS = {<TokenType.MATCH_RECOGNIZE: 'MATCH_RECOGNIZE'>: <function Parser.<lambda>>, <TokenType.WHERE: 'WHERE'>: <function Parser.<lambda>>, <TokenType.GROUP_BY: 'GROUP_BY'>: <function Parser.<lambda>>, <TokenType.HAVING: 'HAVING'>: <function Parser.<lambda>>, <TokenType.QUALIFY: 'QUALIFY'>: <function Parser.<lambda>>, <TokenType.WINDOW: 'WINDOW'>: <function Parser.<lambda>>, <TokenType.ORDER_BY: 'ORDER_BY'>: <function Parser.<lambda>>, <TokenType.LIMIT: 'LIMIT'>: <function Parser.<lambda>>, <TokenType.FETCH: 'FETCH'>: <function Parser.<lambda>>, <TokenType.OFFSET: 'OFFSET'>: <function Parser.<lambda>>, <TokenType.FOR: 'FOR'>: <function Parser.<lambda>>, <TokenType.LOCK: 'LOCK'>: <function Parser.<lambda>>, <TokenType.TABLE_SAMPLE: 'TABLE_SAMPLE'>: <function Parser.<lambda>>, <TokenType.USING: 'USING'>: <function Parser.<lambda>>, <TokenType.CLUSTER_BY: 'CLUSTER_BY'>: <function Parser.<lambda>>, <TokenType.DISTRIBUTE_BY: 'DISTRIBUTE_BY'>: <function Parser.<lambda>>, <TokenType.SORT_BY: 'SORT_BY'>: <function Parser.<lambda>>, <TokenType.CONNECT_BY: 'CONNECT_BY'>: <function Parser.<lambda>>, <TokenType.START_WITH: 'START_WITH'>: <function Parser.<lambda>>, <TokenType.SETTINGS: 'SETTINGS'>: <function ClickHouse.Parser.<lambda>>, <TokenType.FORMAT: 'FORMAT'>: <function ClickHouse.Parser.<lambda>>}
TOKENIZER_CLASS: Type[sqlglot.tokens.Tokenizer] = <class 'ClickHouse.Tokenizer'>
STRICT_STRING_CONCAT = True
SUPPORTS_USER_DEFINED_TYPES = False
NORMALIZE_FUNCTIONS = False
NULL_ORDERING: str = 'nulls_are_last'
SHOW_TRIE: Dict = {}
SET_TRIE: Dict = {'GLOBAL': {0: True}, 'LOCAL': {0: True}, 'SESSION': {0: True}, 'TRANSACTION': {0: True}}
FORMAT_TRIE: Dict = {}
TIME_TRIE: Dict = {}

##### Inherited Members

sqlglot.parser.Parser
  Parser
  NO_PAREN_FUNCTIONS
  STRUCT_TYPE_TOKENS
  NESTED_TYPE_TOKENS
  ENUM_TYPE_TOKENS
  TYPE_TOKENS
  SIGNED_TO_UNSIGNED_TYPE_TOKEN
  SUBQUERY_PREDICATES
  RESERVED_KEYWORDS
  DB_CREATABLES
  CREATABLES
  ID_VAR_TOKENS
  INTERVAL_VARS
  COMMENT_TABLE_ALIAS_TOKENS
  UPDATE_ALIAS_TOKENS
  TRIM_TYPES
  FUNC_TOKENS
  CONJUNCTION
  EQUALITY
  COMPARISON
  BITWISE
  TERM
  FACTOR
  TIMES
  TIMESTAMPS
  SET_OPERATIONS
  JOIN_METHODS
  JOIN_SIDES
  JOIN_HINTS
  LAMBDAS
  EXPRESSION_PARSERS
  STATEMENT_PARSERS
  UNARY_PARSERS
  PRIMARY_PARSERS
  PLACEHOLDER_PARSERS
  PROPERTY_PARSERS
  CONSTRAINT_PARSERS
  ALTER_PARSERS
  SCHEMA_UNNAMED_CONSTRAINTS
  INVALID_FUNC_NAME_TOKENS
  SET_PARSERS
  SHOW_PARSERS
  TYPE_LITERAL_PARSERS
  MODIFIABLES
  DDL_SELECT_TOKENS
  PRE_VOLATILE_TOKENS
  TRANSACTION_KIND
  TRANSACTION_CHARACTERISTICS
  INSERT_ALTERNATIVES
  CLONE_KINDS
  TABLE_INDEX_HINT_TOKENS
  WINDOW_ALIAS_TOKENS
  WINDOW_BEFORE_PAREN_TOKENS
  WINDOW_SIDES
  FETCH_TOKENS
  ADD_CONSTRAINT_TOKENS
  DISTINCT_TOKENS
  STRICT_CAST
  CONCAT_NULL_OUTPUTS_STRING
  PREFIXED_PIVOT_COLUMNS
  IDENTIFY_PIVOT_STRINGS
  LOG_BASE_FIRST
  ALTER_TABLE_ADD_COLUMN_KEYWORD
  TABLESAMPLE_CSV
  INDEX_OFFSET
  UNNEST_COLUMN_ONLY
  ALIAS_POST_TABLESAMPLE
  FORMAT_MAPPING
  TIME_MAPPING
  error_level
  error_message_context
  max_errors
  reset
  parse
  parse_into
  check_errors
  raise_error
  expression
  validate_expression
  errors
  sql

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

    305    class Generator(generator.Generator):
    306        QUERY_HINTS = False
    307        STRUCT_DELIMITER = ("(", ")")
    308        NVL2_SUPPORTED = False
    309
    310        STRING_TYPE_MAPPING = {
    311            exp.DataType.Type.CHAR: "String",
    312            exp.DataType.Type.LONGBLOB: "String",
    313            exp.DataType.Type.LONGTEXT: "String",
    314            exp.DataType.Type.MEDIUMBLOB: "String",
    315            exp.DataType.Type.MEDIUMTEXT: "String",
    316            exp.DataType.Type.TINYBLOB: "String",
    317            exp.DataType.Type.TINYTEXT: "String",
    318            exp.DataType.Type.TEXT: "String",
    319            exp.DataType.Type.VARBINARY: "String",
    320            exp.DataType.Type.VARCHAR: "String",
    321        }
    322
    323        TYPE_MAPPING = {
    324            **generator.Generator.TYPE_MAPPING,
    325            **STRING_TYPE_MAPPING,
    326            exp.DataType.Type.ARRAY: "Array",
    327            exp.DataType.Type.BIGINT: "Int64",
    328            exp.DataType.Type.DATETIME64: "DateTime64",
    329            exp.DataType.Type.DOUBLE: "Float64",
    330            exp.DataType.Type.ENUM: "Enum",
    331            exp.DataType.Type.ENUM8: "Enum8",
    332            exp.DataType.Type.ENUM16: "Enum16",
    333            exp.DataType.Type.FIXEDSTRING: "FixedString",
    334            exp.DataType.Type.FLOAT: "Float32",
    335            exp.DataType.Type.INT: "Int32",
    336            exp.DataType.Type.MEDIUMINT: "Int32",
    337            exp.DataType.Type.INT128: "Int128",
    338            exp.DataType.Type.INT256: "Int256",
    339            exp.DataType.Type.LOWCARDINALITY: "LowCardinality",
    340            exp.DataType.Type.MAP: "Map",
    341            exp.DataType.Type.NESTED: "Nested",
    342            exp.DataType.Type.NULLABLE: "Nullable",
    343            exp.DataType.Type.SMALLINT: "Int16",
    344            exp.DataType.Type.STRUCT: "Tuple",
    345            exp.DataType.Type.TINYINT: "Int8",
    346            exp.DataType.Type.UBIGINT: "UInt64",
    347            exp.DataType.Type.UINT: "UInt32",
    348            exp.DataType.Type.UINT128: "UInt128",
    349            exp.DataType.Type.UINT256: "UInt256",
    350            exp.DataType.Type.USMALLINT: "UInt16",
    351            exp.DataType.Type.UTINYINT: "UInt8",
    352        }
    353
    354        TRANSFORMS = {
    355            **generator.Generator.TRANSFORMS,
    356            exp.AnyValue: rename_func("any"),
    357            exp.ApproxDistinct: rename_func("uniq"),
    358            exp.Array: inline_array_sql,
    359            exp.CastToStrType: rename_func("CAST"),
    360            exp.DateAdd: lambda self, e: self.func(
    361                "DATE_ADD", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    362            ),
    363            exp.DateDiff: lambda self, e: self.func(
    364                "DATE_DIFF", exp.Literal.string(e.text("unit") or "day"), e.expression, e.this
    365            ),
    366            exp.Final: lambda self, e: f"{self.sql(e, 'this')} FINAL",
    367            exp.Map: lambda self, e: _lower_func(var_map_sql(self, e)),
    368            exp.PartitionedByProperty: lambda self, e: f"PARTITION BY {self.sql(e, 'this')}",
    369            exp.Pivot: no_pivot_sql,
    370            exp.Quantile: lambda self, e: self.func("quantile", e.args.get("quantile"))
    371            + f"({self.sql(e, 'this')})",
    372            exp.RegexpLike: lambda self, e: f"match({self.format_args(e.this, e.expression)})",
    373            exp.StrPosition: lambda self, e: f"position({self.format_args(e.this, e.args.get('substr'), e.args.get('position'))})",
    374            exp.VarMap: lambda self, e: _lower_func(var_map_sql(self, e)),
    375            exp.Xor: lambda self, e: self.func("xor", e.this, e.expression, *e.expressions),
    376        }
    377
    378        PROPERTIES_LOCATION = {
    379            **generator.Generator.PROPERTIES_LOCATION,
    380            exp.VolatileProperty: exp.Properties.Location.UNSUPPORTED,
    381            exp.PartitionedByProperty: exp.Properties.Location.POST_SCHEMA,
    382            exp.OnCluster: exp.Properties.Location.POST_NAME,
    383        }
    384
    385        JOIN_HINTS = False
    386        TABLE_HINTS = False
    387        EXPLICIT_UNION = True
    388        GROUPINGS_SEP = ""
    389
    390        # there's no list in docs, but it can be found in Clickhouse code
    391        # see `ClickHouse/src/Parsers/ParserCreate*.cpp`
    392        ON_CLUSTER_TARGETS = {
    393            "DATABASE",
    394            "TABLE",
    395            "VIEW",
    396            "DICTIONARY",
    397            "INDEX",
    398            "FUNCTION",
    399            "NAMED COLLECTION",
    400        }
    401
    402        def datatype_sql(self, expression: exp.DataType) -> str:
    403            # String is the standard ClickHouse type, every other variant is just an alias.
    404            # Additionally, any supplied length parameter will be ignored.
    405            #
    406            # https://clickhouse.com/docs/en/sql-reference/data-types/string
    407            if expression.this in self.STRING_TYPE_MAPPING:
    408                return "String"
    409
    410            return super().datatype_sql(expression)
    411
    412        def safeconcat_sql(self, expression: exp.SafeConcat) -> str:
    413            # Clickhouse errors out if we try to cast a NULL value to TEXT
    414            expression = expression.copy()
    415            return self.func(
    416                "CONCAT",
    417                *[
    418                    exp.func("if", e.is_(exp.null()), e, exp.cast(e, "text"))
    419                    for e in t.cast(t.List[exp.Condition], expression.expressions)
    420                ],
    421            )
    422
    423        def cte_sql(self, expression: exp.CTE) -> str:
    424            if isinstance(expression.this, exp.Alias):
    425                return self.sql(expression, "this")
    426
    427            return super().cte_sql(expression)
    428
    429        def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]:
    430            return super().after_limit_modifiers(expression) + [
    431                self.seg("SETTINGS ") + self.expressions(expression, key="settings", flat=True)
    432                if expression.args.get("settings")
    433                else "",
    434                self.seg("FORMAT ") + self.sql(expression, "format")
    435                if expression.args.get("format")
    436                else "",
    437            ]
    438
    439        def parameterizedagg_sql(self, expression: exp.Anonymous) -> str:
    440            params = self.expressions(expression, key="params", flat=True)
    441            return self.func(expression.name, *expression.expressions) + f"({params})"
    442
    443        def placeholder_sql(self, expression: exp.Placeholder) -> str:
    444            return f"{{{expression.name}: {self.sql(expression, 'kind')}}}"
    445
    446        def oncluster_sql(self, expression: exp.OnCluster) -> str:
    447            return f"ON CLUSTER {self.sql(expression, 'this')}"
    448
    449        def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str:
    450            kind = self.sql(expression, "kind").upper()
    451            if kind in self.ON_CLUSTER_TARGETS and locations.get(exp.Properties.Location.POST_NAME):
    452                this_name = self.sql(expression.this, "this")
    453                this_properties = " ".join(
    454                    [self.sql(prop) for prop in locations[exp.Properties.Location.POST_NAME]]
    455                )
    456                this_schema = self.schema_columns_sql(expression.this)
    457                return f"{this_name}{self.sep()}{this_properties}{self.sep()}{this_schema}"
    458
    459            return super().createable_sql(expression, locations)

Generator converts a given syntax tree to the corresponding SQL string.

###### Arguments:

- pretty: Whether or not to format the produced SQL string. Default: False.
- identify: Determines when an identifier should be quoted. Possible values are: False (default): Never quote, except in cases where it's mandatory by the dialect. True or 'always': Always quote. 'safe': Only quote identifiers that are case insensitive.
- normalize: Whether or not to normalize identifiers to lowercase. Default: False.
- pad: Determines the pad size in a formatted string. Default: 2.
- indent: Determines the indentation size in a formatted string. Default: 2.
- normalize_functions: Whether or not to normalize all 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: Determines whether or not 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 or not to preserve comments in the output SQL code. Default: True

QUERY_HINTS = False
STRUCT_DELIMITER = ('(', ')')
NVL2_SUPPORTED = False
STRING_TYPE_MAPPING = {<Type.CHAR: 'CHAR'>: 'String', <Type.LONGBLOB: 'LONGBLOB'>: 'String', <Type.LONGTEXT: 'LONGTEXT'>: 'String', <Type.MEDIUMBLOB: 'MEDIUMBLOB'>: 'String', <Type.MEDIUMTEXT: 'MEDIUMTEXT'>: 'String', <Type.TINYBLOB: 'TINYBLOB'>: 'String', <Type.TINYTEXT: 'TINYTEXT'>: 'String', <Type.TEXT: 'TEXT'>: 'String', <Type.VARBINARY: 'VARBINARY'>: 'String', <Type.VARCHAR: 'VARCHAR'>: 'String'}
TYPE_MAPPING = {<Type.NCHAR: 'NCHAR'>: 'CHAR', <Type.NVARCHAR: 'NVARCHAR'>: 'VARCHAR', <Type.MEDIUMTEXT: 'MEDIUMTEXT'>: 'String', <Type.LONGTEXT: 'LONGTEXT'>: 'String', <Type.TINYTEXT: 'TINYTEXT'>: 'String', <Type.MEDIUMBLOB: 'MEDIUMBLOB'>: 'String', <Type.LONGBLOB: 'LONGBLOB'>: 'String', <Type.TINYBLOB: 'TINYBLOB'>: 'String', <Type.INET: 'INET'>: 'INET', <Type.CHAR: 'CHAR'>: 'String', <Type.TEXT: 'TEXT'>: 'String', <Type.VARBINARY: 'VARBINARY'>: 'String', <Type.VARCHAR: 'VARCHAR'>: 'String', <Type.ARRAY: 'ARRAY'>: 'Array', <Type.BIGINT: 'BIGINT'>: 'Int64', <Type.DATETIME64: 'DATETIME64'>: 'DateTime64', <Type.DOUBLE: 'DOUBLE'>: 'Float64', <Type.ENUM: 'ENUM'>: 'Enum', <Type.ENUM8: 'ENUM8'>: 'Enum8', <Type.ENUM16: 'ENUM16'>: 'Enum16', <Type.FIXEDSTRING: 'FIXEDSTRING'>: 'FixedString', <Type.FLOAT: 'FLOAT'>: 'Float32', <Type.INT: 'INT'>: 'Int32', <Type.MEDIUMINT: 'MEDIUMINT'>: 'Int32', <Type.INT128: 'INT128'>: 'Int128', <Type.INT256: 'INT256'>: 'Int256', <Type.LOWCARDINALITY: 'LOWCARDINALITY'>: 'LowCardinality', <Type.MAP: 'MAP'>: 'Map', <Type.NESTED: 'NESTED'>: 'Nested', <Type.NULLABLE: 'NULLABLE'>: 'Nullable', <Type.SMALLINT: 'SMALLINT'>: 'Int16', <Type.STRUCT: 'STRUCT'>: 'Tuple', <Type.TINYINT: 'TINYINT'>: 'Int8', <Type.UBIGINT: 'UBIGINT'>: 'UInt64', <Type.UINT: 'UINT'>: 'UInt32', <Type.UINT128: 'UINT128'>: 'UInt128', <Type.UINT256: 'UINT256'>: 'UInt256', <Type.USMALLINT: 'USMALLINT'>: 'UInt16', <Type.UTINYINT: 'UTINYINT'>: 'UInt8'}
TRANSFORMS = {<class 'sqlglot.expressions.DateAdd'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.TsOrDsAdd'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CaseSpecificColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CharacterSetColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CharacterSetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CheckColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CollateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CopyGrantsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.CommentColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DateFormatColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.DefaultColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.EncodeColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExecuteAsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ExternalProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.HeapProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.InlineLengthColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.IntervalSpan'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LanguageProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LocationProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.LogProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.MaterializedProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NoPrimaryIndexProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NonClusteredColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.NotForReplicationColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnCommitProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.OnUpdateColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.PathColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ReturnsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SetProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SettingsProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.SqlSecurityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.StabilityProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TemporaryProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.ToTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TransientProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.TitleColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.UppercaseColumnConstraint'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.VarMap'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.VolatileProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.WithJournalTableProperty'>: <function Generator.<lambda>>, <class 'sqlglot.expressions.AnyValue'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.ApproxDistinct'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.Array'>: <function inline_array_sql>, <class 'sqlglot.expressions.CastToStrType'>: <function rename_func.<locals>.<lambda>>, <class 'sqlglot.expressions.DateDiff'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.Final'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.Map'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.PartitionedByProperty'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.Pivot'>: <function no_pivot_sql>, <class 'sqlglot.expressions.Quantile'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.RegexpLike'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.StrPosition'>: <function ClickHouse.Generator.<lambda>>, <class 'sqlglot.expressions.Xor'>: <function ClickHouse.Generator.<lambda>>}
PROPERTIES_LOCATION = {<class 'sqlglot.expressions.AlgorithmProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.AutoIncrementProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.BlockCompressionProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.CharacterSetProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ChecksumProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.CollateProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.CopyGrantsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Cluster'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ClusteredByProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DataBlocksizeProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.DefinerProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.DictRange'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DictProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DistKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.DistStyleProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.EngineProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ExecuteAsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.ExternalProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.FallbackProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.FileFormatProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.FreespaceProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.HeapProperty'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.IsolatedLoadingProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.JournalProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.LanguageProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LikeProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LocationProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.LockingProperty'>: <Location.POST_ALIAS: 'POST_ALIAS'>, <class 'sqlglot.expressions.LogProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.MaterializedProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.MergeBlockRatioProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.NoPrimaryIndexProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.OnProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.OnCommitProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.Order'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.PartitionedByProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.PrimaryKey'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Property'>: <Location.POST_WITH: 'POST_WITH'>, <class 'sqlglot.expressions.ReturnsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatDelimitedProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.RowFormatSerdeProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SchemaCommentProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SerdeProperties'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.Set'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SettingsProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SetProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.SortKeyProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.SqlSecurityProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.StabilityProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.TemporaryProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.ToTableProperty'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.TransientProperty'>: <Location.POST_CREATE: 'POST_CREATE'>, <class 'sqlglot.expressions.MergeTreeTTL'>: <Location.POST_SCHEMA: 'POST_SCHEMA'>, <class 'sqlglot.expressions.VolatileProperty'>: <Location.UNSUPPORTED: 'UNSUPPORTED'>, <class 'sqlglot.expressions.WithDataProperty'>: <Location.POST_EXPRESSION: 'POST_EXPRESSION'>, <class 'sqlglot.expressions.WithJournalTableProperty'>: <Location.POST_NAME: 'POST_NAME'>, <class 'sqlglot.expressions.OnCluster'>: <Location.POST_NAME: 'POST_NAME'>}
JOIN_HINTS = False
TABLE_HINTS = False
EXPLICIT_UNION = True
GROUPINGS_SEP = ''
ON_CLUSTER_TARGETS = {'INDEX', 'FUNCTION', 'TABLE', 'DATABASE', 'VIEW', 'DICTIONARY', 'NAMED COLLECTION'}
def datatype_sql(self, expression: sqlglot.expressions.DataType) -> str: View Source

    402        def datatype_sql(self, expression: exp.DataType) -> str:
    403            # String is the standard ClickHouse type, every other variant is just an alias.
    404            # Additionally, any supplied length parameter will be ignored.
    405            #
    406            # https://clickhouse.com/docs/en/sql-reference/data-types/string
    407            if expression.this in self.STRING_TYPE_MAPPING:
    408                return "String"
    409
    410            return super().datatype_sql(expression)

def safeconcat_sql(self, expression: sqlglot.expressions.SafeConcat) -> str: View Source

    412        def safeconcat_sql(self, expression: exp.SafeConcat) -> str:
    413            # Clickhouse errors out if we try to cast a NULL value to TEXT
    414            expression = expression.copy()
    415            return self.func(
    416                "CONCAT",
    417                *[
    418                    exp.func("if", e.is_(exp.null()), e, exp.cast(e, "text"))
    419                    for e in t.cast(t.List[exp.Condition], expression.expressions)
    420                ],
    421            )

def cte_sql(self, expression: sqlglot.expressions.CTE) -> str: View Source

    423        def cte_sql(self, expression: exp.CTE) -> str:
    424            if isinstance(expression.this, exp.Alias):
    425                return self.sql(expression, "this")
    426
    427            return super().cte_sql(expression)

def after_limit_modifiers(self, expression: sqlglot.expressions.Expression) -> List[str]: View Source

    429        def after_limit_modifiers(self, expression: exp.Expression) -> t.List[str]:
    430            return super().after_limit_modifiers(expression) + [
    431                self.seg("SETTINGS ") + self.expressions(expression, key="settings", flat=True)
    432                if expression.args.get("settings")
    433                else "",
    434                self.seg("FORMAT ") + self.sql(expression, "format")
    435                if expression.args.get("format")
    436                else "",
    437            ]

def parameterizedagg_sql(self, expression: sqlglot.expressions.Anonymous) -> str: View Source

    439        def parameterizedagg_sql(self, expression: exp.Anonymous) -> str:
    440            params = self.expressions(expression, key="params", flat=True)
    441            return self.func(expression.name, *expression.expressions) + f"({params})"

def placeholder_sql(self, expression: sqlglot.expressions.Placeholder) -> str: View Source

    443        def placeholder_sql(self, expression: exp.Placeholder) -> str:
    444            return f"{{{expression.name}: {self.sql(expression, 'kind')}}}"

def oncluster_sql(self, expression: sqlglot.expressions.OnCluster) -> str: View Source

    446        def oncluster_sql(self, expression: exp.OnCluster) -> str:
    447            return f"ON CLUSTER {self.sql(expression, 'this')}"

def createable_sql( self, expression: sqlglot.expressions.Create, locations: DefaultDict) -> str: View Source

    449        def createable_sql(self, expression: exp.Create, locations: t.DefaultDict) -> str:
    450            kind = self.sql(expression, "kind").upper()
    451            if kind in self.ON_CLUSTER_TARGETS and locations.get(exp.Properties.Location.POST_NAME):
    452                this_name = self.sql(expression.this, "this")
    453                this_properties = " ".join(
    454                    [self.sql(prop) for prop in locations[exp.Properties.Location.POST_NAME]]
    455                )
    456                this_schema = self.schema_columns_sql(expression.this)
    457                return f"{this_name}{self.sep()}{this_properties}{self.sep()}{this_schema}"
    458
    459            return super().createable_sql(expression, locations)

SELECT_KINDS: Tuple[str, ...] = ()
INVERSE_TIME_MAPPING: Dict[str, str] = {}
INVERSE_TIME_TRIE: Dict = {}
STRICT_STRING_CONCAT = True
NORMALIZE_FUNCTIONS: bool | str = False
NULL_ORDERING = 'nulls_are_last'
@classmethod
def can_identify(text: str, identify: str | bool = 'safe') -> bool: View Source

    260    @classmethod
    261    def can_identify(cls, text: str, identify: str | bool = "safe") -> bool:
    262        """Checks if text can be identified given an identify option.
    263
    264        Args:
    265            text: The text to check.
    266            identify:
    267                "always" or `True`: Always returns true.
    268                "safe": True if the identifier is case-insensitive.
    269
    270        Returns:
    271            Whether or not the given text can be identified.
    272        """
    273        if identify is True or identify == "always":
    274            return True
    275
    276        if identify == "safe":
    277            return not cls.case_sensitive(text)
    278
    279        return False

Checks if text can be identified given an identify option.

###### Arguments:

- text: The text to check.
- identify: "always" or `True`: Always returns true. "safe": True if the identifier is case-insensitive.

###### Returns:

> Whether or not the given text can be identified.

QUOTE_START = "'"
QUOTE_END = "'"
IDENTIFIER_START = '"'
IDENTIFIER_END = '"'
TOKENIZER_CLASS = <class 'ClickHouse.Tokenizer'>
BIT_START: Optional[str] = '0b'
BIT_END: Optional[str] = ''
HEX_START: Optional[str] = '0x'
HEX_END: Optional[str] = ''
BYTE_START: Optional[str] = None
BYTE_END: Optional[str] = None

##### Inherited Members

sqlglot.generator.Generator
  Generator
  NULL_ORDERING_SUPPORTED
  LOCKING_READS_SUPPORTED
  WRAP_DERIVED_VALUES
  CREATE_FUNCTION_RETURN_AS
  MATCHED_BY_SOURCE
  SINGLE_STRING_INTERVAL
  INTERVAL_ALLOWS_PLURAL_FORM
  TABLESAMPLE_WITH_METHOD
  TABLESAMPLE_SIZE_IS_PERCENT
  LIMIT_FETCH
  RENAME_TABLE_WITH_DB
  INDEX_ON
  QUERY_HINT_SEP
  IS_BOOL_ALLOWED
  DUPLICATE_KEY_UPDATE_WITH_SET
  LIMIT_IS_TOP
  RETURNING_END
  COLUMN_JOIN_MARKS_SUPPORTED
  EXTRACT_ALLOWS_QUOTES
  TZ_TO_WITH_TIME_ZONE
  VALUES_AS_TABLE
  ALTER_TABLE_ADD_COLUMN_KEYWORD
  STAR_MAPPING
  TIME_PART_SINGULARS
  TOKEN_MAPPING
  PARAMETER_TOKEN
  RESERVED_KEYWORDS
  WITH_SEPARATED_COMMENTS
  UNWRAPPED_INTERVAL_VALUES
  SENTINEL_LINE_BREAK
  INDEX_OFFSET
  UNNEST_COLUMN_ONLY
  ALIAS_POST_TABLESAMPLE
  IDENTIFIERS_CAN_START_WITH_DIGIT
  ESCAPE_LINE_BREAK
  pretty
  identify
  normalize
  pad
  unsupported_level
  max_unsupported
  leading_comma
  max_text_width
  comments
  normalize_functions
  unsupported_messages
  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
  computedcolumnconstraint_sql
  autoincrementcolumnconstraint_sql
  compresscolumnconstraint_sql
  generatedasidentitycolumnconstraint_sql
  notnullcolumnconstraint_sql
  primarykeycolumnconstraint_sql
  uniquecolumnconstraint_sql
  create_sql
  clone_sql
  describe_sql
  prepend_ctes
  with_sql
  tablealias_sql
  bitstring_sql
  hexstring_sql
  bytestring_sql
  rawstring_sql
  datatypeparam_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
  objectidentifier_sql
  onconflict_sql
  returning_sql
  rowformatdelimitedproperty_sql
  withtablehint_sql
  indextablehint_sql
  table_sql
  tablesample_sql
  pivot_sql
  version_sql
  tuple_sql
  update_sql
  values_sql
  var_sql
  into_sql
  from_sql
  group_sql
  having_sql
  connect_sql
  prior_sql
  join_sql
  lambda_sql
  lateral_sql
  limit_sql
  offset_sql
  setitem_sql
  set_sql
  pragma_sql
  lock_sql
  literal_sql
  escape_str
  loaddata_sql
  null_sql
  boolean_sql
  order_sql
  cluster_sql
  distribute_sql
  sort_sql
  ordered_sql
  matchrecognize_sql
  query_modifiers
  offset_limit_modifiers
  after_having_modifiers
  select_sql
  schema_sql
  schema_columns_sql
  star_sql
  parameter_sql
  sessionparameter_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
  safebracket_sql
  all_sql
  any_sql
  exists_sql
  case_sql
  constraint_sql
  nextvaluefor_sql
  extract_sql
  trim_sql
  check_sql
  foreignkey_sql
  primarykey_sql
  if_sql
  matchagainst_sql
  jsonkeyvalue_sql
  formatjson_sql
  jsonobject_sql
  jsonarray_sql
  jsonarrayagg_sql
  jsoncolumndef_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
  aliases_sql
  attimezone_sql
  add_sql
  and_sql
  xor_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
  mergetreettlaction_sql
  mergetreettl_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
  safedpipe_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
  clusteredbyproperty_sql
  anyvalue_sql
  querytransform_sql
  indexconstraintoption_sql
  indexcolumnconstraint_sql
  nvl2_sql
  comprehension_sql
  columnprefix_sql