Edit on GitHub

sqlglot.tokens

   1from __future__ import annotations
   2
   3import os
   4import typing as t
   5from enum import auto
   6
   7from sqlglot.errors import SqlglotError, TokenError
   8from sqlglot.helper import AutoName
   9from sqlglot.trie import TrieResult, in_trie, new_trie
  10
  11if t.TYPE_CHECKING:
  12    from sqlglot.dialects.dialect import DialectType
  13
  14
  15try:
  16    from sqlglotrs import (  # type: ignore
  17        Tokenizer as RsTokenizer,
  18        TokenizerDialectSettings as RsTokenizerDialectSettings,
  19        TokenizerSettings as RsTokenizerSettings,
  20        TokenTypeSettings as RsTokenTypeSettings,
  21    )
  22
  23    USE_RS_TOKENIZER = os.environ.get("SQLGLOTRS_TOKENIZER", "1") == "1"
  24except ImportError:
  25    USE_RS_TOKENIZER = False
  26
  27
  28class TokenType(AutoName):
  29    L_PAREN = auto()
  30    R_PAREN = auto()
  31    L_BRACKET = auto()
  32    R_BRACKET = auto()
  33    L_BRACE = auto()
  34    R_BRACE = auto()
  35    COMMA = auto()
  36    DOT = auto()
  37    DASH = auto()
  38    PLUS = auto()
  39    COLON = auto()
  40    DOTCOLON = auto()
  41    DCOLON = auto()
  42    DQMARK = auto()
  43    SEMICOLON = auto()
  44    STAR = auto()
  45    BACKSLASH = auto()
  46    SLASH = auto()
  47    LT = auto()
  48    LTE = auto()
  49    GT = auto()
  50    GTE = auto()
  51    NOT = auto()
  52    EQ = auto()
  53    NEQ = auto()
  54    NULLSAFE_EQ = auto()
  55    COLON_EQ = auto()
  56    AND = auto()
  57    OR = auto()
  58    AMP = auto()
  59    DPIPE = auto()
  60    PIPE_GT = auto()
  61    PIPE = auto()
  62    PIPE_SLASH = auto()
  63    DPIPE_SLASH = auto()
  64    CARET = auto()
  65    CARET_AT = auto()
  66    TILDA = auto()
  67    ARROW = auto()
  68    DARROW = auto()
  69    FARROW = auto()
  70    HASH = auto()
  71    HASH_ARROW = auto()
  72    DHASH_ARROW = auto()
  73    LR_ARROW = auto()
  74    DAT = auto()
  75    LT_AT = auto()
  76    AT_GT = auto()
  77    DOLLAR = auto()
  78    PARAMETER = auto()
  79    SESSION_PARAMETER = auto()
  80    DAMP = auto()
  81    XOR = auto()
  82    DSTAR = auto()
  83
  84    URI_START = auto()
  85
  86    BLOCK_START = auto()
  87    BLOCK_END = auto()
  88
  89    SPACE = auto()
  90    BREAK = auto()
  91
  92    STRING = auto()
  93    NUMBER = auto()
  94    IDENTIFIER = auto()
  95    DATABASE = auto()
  96    COLUMN = auto()
  97    COLUMN_DEF = auto()
  98    SCHEMA = auto()
  99    TABLE = auto()
 100    WAREHOUSE = auto()
 101    STAGE = auto()
 102    STREAMLIT = auto()
 103    VAR = auto()
 104    BIT_STRING = auto()
 105    HEX_STRING = auto()
 106    BYTE_STRING = auto()
 107    NATIONAL_STRING = auto()
 108    RAW_STRING = auto()
 109    HEREDOC_STRING = auto()
 110    UNICODE_STRING = auto()
 111
 112    # types
 113    BIT = auto()
 114    BOOLEAN = auto()
 115    TINYINT = auto()
 116    UTINYINT = auto()
 117    SMALLINT = auto()
 118    USMALLINT = auto()
 119    MEDIUMINT = auto()
 120    UMEDIUMINT = auto()
 121    INT = auto()
 122    UINT = auto()
 123    BIGINT = auto()
 124    UBIGINT = auto()
 125    INT128 = auto()
 126    UINT128 = auto()
 127    INT256 = auto()
 128    UINT256 = auto()
 129    FLOAT = auto()
 130    DOUBLE = auto()
 131    UDOUBLE = auto()
 132    DECIMAL = auto()
 133    DECIMAL32 = auto()
 134    DECIMAL64 = auto()
 135    DECIMAL128 = auto()
 136    DECIMAL256 = auto()
 137    UDECIMAL = auto()
 138    BIGDECIMAL = auto()
 139    CHAR = auto()
 140    NCHAR = auto()
 141    VARCHAR = auto()
 142    NVARCHAR = auto()
 143    BPCHAR = auto()
 144    TEXT = auto()
 145    MEDIUMTEXT = auto()
 146    LONGTEXT = auto()
 147    BLOB = auto()
 148    MEDIUMBLOB = auto()
 149    LONGBLOB = auto()
 150    TINYBLOB = auto()
 151    TINYTEXT = auto()
 152    NAME = auto()
 153    BINARY = auto()
 154    VARBINARY = auto()
 155    JSON = auto()
 156    JSONB = auto()
 157    TIME = auto()
 158    TIMETZ = auto()
 159    TIMESTAMP = auto()
 160    TIMESTAMPTZ = auto()
 161    TIMESTAMPLTZ = auto()
 162    TIMESTAMPNTZ = auto()
 163    TIMESTAMP_S = auto()
 164    TIMESTAMP_MS = auto()
 165    TIMESTAMP_NS = auto()
 166    DATETIME = auto()
 167    DATETIME2 = auto()
 168    DATETIME64 = auto()
 169    SMALLDATETIME = auto()
 170    DATE = auto()
 171    DATE32 = auto()
 172    INT4RANGE = auto()
 173    INT4MULTIRANGE = auto()
 174    INT8RANGE = auto()
 175    INT8MULTIRANGE = auto()
 176    NUMRANGE = auto()
 177    NUMMULTIRANGE = auto()
 178    TSRANGE = auto()
 179    TSMULTIRANGE = auto()
 180    TSTZRANGE = auto()
 181    TSTZMULTIRANGE = auto()
 182    DATERANGE = auto()
 183    DATEMULTIRANGE = auto()
 184    UUID = auto()
 185    GEOGRAPHY = auto()
 186    NULLABLE = auto()
 187    GEOMETRY = auto()
 188    POINT = auto()
 189    RING = auto()
 190    LINESTRING = auto()
 191    MULTILINESTRING = auto()
 192    POLYGON = auto()
 193    MULTIPOLYGON = auto()
 194    HLLSKETCH = auto()
 195    HSTORE = auto()
 196    SUPER = auto()
 197    SERIAL = auto()
 198    SMALLSERIAL = auto()
 199    BIGSERIAL = auto()
 200    XML = auto()
 201    YEAR = auto()
 202    USERDEFINED = auto()
 203    MONEY = auto()
 204    SMALLMONEY = auto()
 205    ROWVERSION = auto()
 206    IMAGE = auto()
 207    VARIANT = auto()
 208    OBJECT = auto()
 209    INET = auto()
 210    IPADDRESS = auto()
 211    IPPREFIX = auto()
 212    IPV4 = auto()
 213    IPV6 = auto()
 214    ENUM = auto()
 215    ENUM8 = auto()
 216    ENUM16 = auto()
 217    FIXEDSTRING = auto()
 218    LOWCARDINALITY = auto()
 219    NESTED = auto()
 220    AGGREGATEFUNCTION = auto()
 221    SIMPLEAGGREGATEFUNCTION = auto()
 222    TDIGEST = auto()
 223    UNKNOWN = auto()
 224    VECTOR = auto()
 225    DYNAMIC = auto()
 226    VOID = auto()
 227
 228    # keywords
 229    ALIAS = auto()
 230    ALTER = auto()
 231    ALWAYS = auto()
 232    ALL = auto()
 233    ANTI = auto()
 234    ANY = auto()
 235    APPLY = auto()
 236    ARRAY = auto()
 237    ASC = auto()
 238    ASOF = auto()
 239    ATTACH = auto()
 240    AUTO_INCREMENT = auto()
 241    BEGIN = auto()
 242    BETWEEN = auto()
 243    BULK_COLLECT_INTO = auto()
 244    CACHE = auto()
 245    CASE = auto()
 246    CHARACTER_SET = auto()
 247    CLUSTER_BY = auto()
 248    COLLATE = auto()
 249    COMMAND = auto()
 250    COMMENT = auto()
 251    COMMIT = auto()
 252    CONNECT_BY = auto()
 253    CONSTRAINT = auto()
 254    COPY = auto()
 255    CREATE = auto()
 256    CROSS = auto()
 257    CUBE = auto()
 258    CURRENT_DATE = auto()
 259    CURRENT_DATETIME = auto()
 260    CURRENT_SCHEMA = auto()
 261    CURRENT_TIME = auto()
 262    CURRENT_TIMESTAMP = auto()
 263    CURRENT_USER = auto()
 264    DECLARE = auto()
 265    DEFAULT = auto()
 266    DELETE = auto()
 267    DESC = auto()
 268    DESCRIBE = auto()
 269    DETACH = auto()
 270    DICTIONARY = auto()
 271    DISTINCT = auto()
 272    DISTRIBUTE_BY = auto()
 273    DIV = auto()
 274    DROP = auto()
 275    ELSE = auto()
 276    END = auto()
 277    ESCAPE = auto()
 278    EXCEPT = auto()
 279    EXECUTE = auto()
 280    EXISTS = auto()
 281    FALSE = auto()
 282    FETCH = auto()
 283    FILE_FORMAT = auto()
 284    FILTER = auto()
 285    FINAL = auto()
 286    FIRST = auto()
 287    FOR = auto()
 288    FORCE = auto()
 289    FOREIGN_KEY = auto()
 290    FORMAT = auto()
 291    FROM = auto()
 292    FULL = auto()
 293    FUNCTION = auto()
 294    GET = auto()
 295    GLOB = auto()
 296    GLOBAL = auto()
 297    GRANT = auto()
 298    GROUP_BY = auto()
 299    GROUPING_SETS = auto()
 300    HAVING = auto()
 301    HINT = auto()
 302    IGNORE = auto()
 303    ILIKE = auto()
 304    ILIKE_ANY = auto()
 305    IN = auto()
 306    INDEX = auto()
 307    INNER = auto()
 308    INSERT = auto()
 309    INTERSECT = auto()
 310    INTERVAL = auto()
 311    INTO = auto()
 312    INTRODUCER = auto()
 313    IRLIKE = auto()
 314    IS = auto()
 315    ISNULL = auto()
 316    JOIN = auto()
 317    JOIN_MARKER = auto()
 318    KEEP = auto()
 319    KEY = auto()
 320    KILL = auto()
 321    LANGUAGE = auto()
 322    LATERAL = auto()
 323    LEFT = auto()
 324    LIKE = auto()
 325    LIKE_ANY = auto()
 326    LIMIT = auto()
 327    LIST = auto()
 328    LOAD = auto()
 329    LOCK = auto()
 330    MAP = auto()
 331    MATCH_CONDITION = auto()
 332    MATCH_RECOGNIZE = auto()
 333    MEMBER_OF = auto()
 334    MERGE = auto()
 335    MOD = auto()
 336    MODEL = auto()
 337    NATURAL = auto()
 338    NEXT = auto()
 339    NOTHING = auto()
 340    NOTNULL = auto()
 341    NULL = auto()
 342    OBJECT_IDENTIFIER = auto()
 343    OFFSET = auto()
 344    ON = auto()
 345    ONLY = auto()
 346    OPERATOR = auto()
 347    ORDER_BY = auto()
 348    ORDER_SIBLINGS_BY = auto()
 349    ORDERED = auto()
 350    ORDINALITY = auto()
 351    OUTER = auto()
 352    OVER = auto()
 353    OVERLAPS = auto()
 354    OVERWRITE = auto()
 355    PARTITION = auto()
 356    PARTITION_BY = auto()
 357    PERCENT = auto()
 358    PIVOT = auto()
 359    PLACEHOLDER = auto()
 360    POSITIONAL = auto()
 361    PRAGMA = auto()
 362    PREWHERE = auto()
 363    PRIMARY_KEY = auto()
 364    PROCEDURE = auto()
 365    PROPERTIES = auto()
 366    PSEUDO_TYPE = auto()
 367    PUT = auto()
 368    QUALIFY = auto()
 369    QUOTE = auto()
 370    RANGE = auto()
 371    RECURSIVE = auto()
 372    REFRESH = auto()
 373    RENAME = auto()
 374    REPLACE = auto()
 375    RETURNING = auto()
 376    REFERENCES = auto()
 377    RIGHT = auto()
 378    RLIKE = auto()
 379    ROLLBACK = auto()
 380    ROLLUP = auto()
 381    ROW = auto()
 382    ROWS = auto()
 383    SELECT = auto()
 384    SEMI = auto()
 385    SEPARATOR = auto()
 386    SEQUENCE = auto()
 387    SERDE_PROPERTIES = auto()
 388    SET = auto()
 389    SETTINGS = auto()
 390    SHOW = auto()
 391    SIMILAR_TO = auto()
 392    SOME = auto()
 393    SORT_BY = auto()
 394    START_WITH = auto()
 395    STORAGE_INTEGRATION = auto()
 396    STRAIGHT_JOIN = auto()
 397    STRUCT = auto()
 398    SUMMARIZE = auto()
 399    TABLE_SAMPLE = auto()
 400    TAG = auto()
 401    TEMPORARY = auto()
 402    TOP = auto()
 403    THEN = auto()
 404    TRUE = auto()
 405    TRUNCATE = auto()
 406    UNCACHE = auto()
 407    UNION = auto()
 408    UNNEST = auto()
 409    UNPIVOT = auto()
 410    UPDATE = auto()
 411    USE = auto()
 412    USING = auto()
 413    VALUES = auto()
 414    VIEW = auto()
 415    SEMANTIC_VIEW = auto()
 416    VOLATILE = auto()
 417    WHEN = auto()
 418    WHERE = auto()
 419    WINDOW = auto()
 420    WITH = auto()
 421    UNIQUE = auto()
 422    VERSION_SNAPSHOT = auto()
 423    TIMESTAMP_SNAPSHOT = auto()
 424    OPTION = auto()
 425    SINK = auto()
 426    SOURCE = auto()
 427    ANALYZE = auto()
 428    NAMESPACE = auto()
 429    EXPORT = auto()
 430
 431    # sentinel
 432    HIVE_TOKEN_STREAM = auto()
 433
 434
 435_ALL_TOKEN_TYPES = list(TokenType)
 436_TOKEN_TYPE_TO_INDEX = {token_type: i for i, token_type in enumerate(_ALL_TOKEN_TYPES)}
 437
 438
 439class Token:
 440    __slots__ = ("token_type", "text", "line", "col", "start", "end", "comments")
 441
 442    @classmethod
 443    def number(cls, number: int) -> Token:
 444        """Returns a NUMBER token with `number` as its text."""
 445        return cls(TokenType.NUMBER, str(number))
 446
 447    @classmethod
 448    def string(cls, string: str) -> Token:
 449        """Returns a STRING token with `string` as its text."""
 450        return cls(TokenType.STRING, string)
 451
 452    @classmethod
 453    def identifier(cls, identifier: str) -> Token:
 454        """Returns an IDENTIFIER token with `identifier` as its text."""
 455        return cls(TokenType.IDENTIFIER, identifier)
 456
 457    @classmethod
 458    def var(cls, var: str) -> Token:
 459        """Returns an VAR token with `var` as its text."""
 460        return cls(TokenType.VAR, var)
 461
 462    def __init__(
 463        self,
 464        token_type: TokenType,
 465        text: str,
 466        line: int = 1,
 467        col: int = 1,
 468        start: int = 0,
 469        end: int = 0,
 470        comments: t.Optional[t.List[str]] = None,
 471    ) -> None:
 472        """Token initializer.
 473
 474        Args:
 475            token_type: The TokenType Enum.
 476            text: The text of the token.
 477            line: The line that the token ends on.
 478            col: The column that the token ends on.
 479            start: The start index of the token.
 480            end: The ending index of the token.
 481            comments: The comments to attach to the token.
 482        """
 483        self.token_type = token_type
 484        self.text = text
 485        self.line = line
 486        self.col = col
 487        self.start = start
 488        self.end = end
 489        self.comments = [] if comments is None else comments
 490
 491    def __repr__(self) -> str:
 492        attributes = ", ".join(f"{k}: {getattr(self, k)}" for k in self.__slots__)
 493        return f"<Token {attributes}>"
 494
 495
 496class _Tokenizer(type):
 497    def __new__(cls, clsname, bases, attrs):
 498        klass = super().__new__(cls, clsname, bases, attrs)
 499
 500        def _convert_quotes(arr: t.List[str | t.Tuple[str, str]]) -> t.Dict[str, str]:
 501            return dict(
 502                (item, item) if isinstance(item, str) else (item[0], item[1]) for item in arr
 503            )
 504
 505        def _quotes_to_format(
 506            token_type: TokenType, arr: t.List[str | t.Tuple[str, str]]
 507        ) -> t.Dict[str, t.Tuple[str, TokenType]]:
 508            return {k: (v, token_type) for k, v in _convert_quotes(arr).items()}
 509
 510        klass._QUOTES = _convert_quotes(klass.QUOTES)
 511        klass._IDENTIFIERS = _convert_quotes(klass.IDENTIFIERS)
 512
 513        klass._FORMAT_STRINGS = {
 514            **{
 515                p + s: (e, TokenType.NATIONAL_STRING)
 516                for s, e in klass._QUOTES.items()
 517                for p in ("n", "N")
 518            },
 519            **_quotes_to_format(TokenType.BIT_STRING, klass.BIT_STRINGS),
 520            **_quotes_to_format(TokenType.BYTE_STRING, klass.BYTE_STRINGS),
 521            **_quotes_to_format(TokenType.HEX_STRING, klass.HEX_STRINGS),
 522            **_quotes_to_format(TokenType.RAW_STRING, klass.RAW_STRINGS),
 523            **_quotes_to_format(TokenType.HEREDOC_STRING, klass.HEREDOC_STRINGS),
 524            **_quotes_to_format(TokenType.UNICODE_STRING, klass.UNICODE_STRINGS),
 525        }
 526
 527        klass._STRING_ESCAPES = set(klass.STRING_ESCAPES)
 528        klass._IDENTIFIER_ESCAPES = set(klass.IDENTIFIER_ESCAPES)
 529        klass._COMMENTS = {
 530            **dict(
 531                (comment, None) if isinstance(comment, str) else (comment[0], comment[1])
 532                for comment in klass.COMMENTS
 533            ),
 534            "{#": "#}",  # Ensure Jinja comments are tokenized correctly in all dialects
 535        }
 536        if klass.HINT_START in klass.KEYWORDS:
 537            klass._COMMENTS[klass.HINT_START] = "*/"
 538
 539        klass._KEYWORD_TRIE = new_trie(
 540            key.upper()
 541            for key in (
 542                *klass.KEYWORDS,
 543                *klass._COMMENTS,
 544                *klass._QUOTES,
 545                *klass._FORMAT_STRINGS,
 546            )
 547            if " " in key or any(single in key for single in klass.SINGLE_TOKENS)
 548        )
 549
 550        if USE_RS_TOKENIZER:
 551            settings = RsTokenizerSettings(
 552                white_space={k: _TOKEN_TYPE_TO_INDEX[v] for k, v in klass.WHITE_SPACE.items()},
 553                single_tokens={k: _TOKEN_TYPE_TO_INDEX[v] for k, v in klass.SINGLE_TOKENS.items()},
 554                keywords={k: _TOKEN_TYPE_TO_INDEX[v] for k, v in klass.KEYWORDS.items()},
 555                numeric_literals=klass.NUMERIC_LITERALS,
 556                identifiers=klass._IDENTIFIERS,
 557                identifier_escapes=klass._IDENTIFIER_ESCAPES,
 558                string_escapes=klass._STRING_ESCAPES,
 559                quotes=klass._QUOTES,
 560                format_strings={
 561                    k: (v1, _TOKEN_TYPE_TO_INDEX[v2])
 562                    for k, (v1, v2) in klass._FORMAT_STRINGS.items()
 563                },
 564                has_bit_strings=bool(klass.BIT_STRINGS),
 565                has_hex_strings=bool(klass.HEX_STRINGS),
 566                comments=klass._COMMENTS,
 567                var_single_tokens=klass.VAR_SINGLE_TOKENS,
 568                commands={_TOKEN_TYPE_TO_INDEX[v] for v in klass.COMMANDS},
 569                command_prefix_tokens={
 570                    _TOKEN_TYPE_TO_INDEX[v] for v in klass.COMMAND_PREFIX_TOKENS
 571                },
 572                heredoc_tag_is_identifier=klass.HEREDOC_TAG_IS_IDENTIFIER,
 573                string_escapes_allowed_in_raw_strings=klass.STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS,
 574                nested_comments=klass.NESTED_COMMENTS,
 575                hint_start=klass.HINT_START,
 576                tokens_preceding_hint={
 577                    _TOKEN_TYPE_TO_INDEX[v] for v in klass.TOKENS_PRECEDING_HINT
 578                },
 579            )
 580            token_types = RsTokenTypeSettings(
 581                bit_string=_TOKEN_TYPE_TO_INDEX[TokenType.BIT_STRING],
 582                break_=_TOKEN_TYPE_TO_INDEX[TokenType.BREAK],
 583                dcolon=_TOKEN_TYPE_TO_INDEX[TokenType.DCOLON],
 584                heredoc_string=_TOKEN_TYPE_TO_INDEX[TokenType.HEREDOC_STRING],
 585                raw_string=_TOKEN_TYPE_TO_INDEX[TokenType.RAW_STRING],
 586                hex_string=_TOKEN_TYPE_TO_INDEX[TokenType.HEX_STRING],
 587                identifier=_TOKEN_TYPE_TO_INDEX[TokenType.IDENTIFIER],
 588                number=_TOKEN_TYPE_TO_INDEX[TokenType.NUMBER],
 589                parameter=_TOKEN_TYPE_TO_INDEX[TokenType.PARAMETER],
 590                semicolon=_TOKEN_TYPE_TO_INDEX[TokenType.SEMICOLON],
 591                string=_TOKEN_TYPE_TO_INDEX[TokenType.STRING],
 592                var=_TOKEN_TYPE_TO_INDEX[TokenType.VAR],
 593                heredoc_string_alternative=_TOKEN_TYPE_TO_INDEX[klass.HEREDOC_STRING_ALTERNATIVE],
 594                hint=_TOKEN_TYPE_TO_INDEX[TokenType.HINT],
 595            )
 596            klass._RS_TOKENIZER = RsTokenizer(settings, token_types)
 597        else:
 598            klass._RS_TOKENIZER = None
 599
 600        return klass
 601
 602
 603class Tokenizer(metaclass=_Tokenizer):
 604    SINGLE_TOKENS = {
 605        "(": TokenType.L_PAREN,
 606        ")": TokenType.R_PAREN,
 607        "[": TokenType.L_BRACKET,
 608        "]": TokenType.R_BRACKET,
 609        "{": TokenType.L_BRACE,
 610        "}": TokenType.R_BRACE,
 611        "&": TokenType.AMP,
 612        "^": TokenType.CARET,
 613        ":": TokenType.COLON,
 614        ",": TokenType.COMMA,
 615        ".": TokenType.DOT,
 616        "-": TokenType.DASH,
 617        "=": TokenType.EQ,
 618        ">": TokenType.GT,
 619        "<": TokenType.LT,
 620        "%": TokenType.MOD,
 621        "!": TokenType.NOT,
 622        "|": TokenType.PIPE,
 623        "+": TokenType.PLUS,
 624        ";": TokenType.SEMICOLON,
 625        "/": TokenType.SLASH,
 626        "\\": TokenType.BACKSLASH,
 627        "*": TokenType.STAR,
 628        "~": TokenType.TILDA,
 629        "?": TokenType.PLACEHOLDER,
 630        "@": TokenType.PARAMETER,
 631        "#": TokenType.HASH,
 632        # Used for breaking a var like x'y' but nothing else the token type doesn't matter
 633        "'": TokenType.UNKNOWN,
 634        "`": TokenType.UNKNOWN,
 635        '"': TokenType.UNKNOWN,
 636    }
 637
 638    BIT_STRINGS: t.List[str | t.Tuple[str, str]] = []
 639    BYTE_STRINGS: t.List[str | t.Tuple[str, str]] = []
 640    HEX_STRINGS: t.List[str | t.Tuple[str, str]] = []
 641    RAW_STRINGS: t.List[str | t.Tuple[str, str]] = []
 642    HEREDOC_STRINGS: t.List[str | t.Tuple[str, str]] = []
 643    UNICODE_STRINGS: t.List[str | t.Tuple[str, str]] = []
 644    IDENTIFIERS: t.List[str | t.Tuple[str, str]] = ['"']
 645    QUOTES: t.List[t.Tuple[str, str] | str] = ["'"]
 646    STRING_ESCAPES = ["'"]
 647    VAR_SINGLE_TOKENS: t.Set[str] = set()
 648
 649    # The strings in this list can always be used as escapes, regardless of the surrounding
 650    # identifier delimiters. By default, the closing delimiter is assumed to also act as an
 651    # identifier escape, e.g. if we use double-quotes, then they also act as escapes: "x"""
 652    IDENTIFIER_ESCAPES: t.List[str] = []
 653
 654    # Whether the heredoc tags follow the same lexical rules as unquoted identifiers
 655    HEREDOC_TAG_IS_IDENTIFIER = False
 656
 657    # Token that we'll generate as a fallback if the heredoc prefix doesn't correspond to a heredoc
 658    HEREDOC_STRING_ALTERNATIVE = TokenType.VAR
 659
 660    # Whether string escape characters function as such when placed within raw strings
 661    STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS = True
 662
 663    NESTED_COMMENTS = True
 664
 665    HINT_START = "/*+"
 666
 667    TOKENS_PRECEDING_HINT = {TokenType.SELECT, TokenType.INSERT, TokenType.UPDATE, TokenType.DELETE}
 668
 669    # Autofilled
 670    _COMMENTS: t.Dict[str, str] = {}
 671    _FORMAT_STRINGS: t.Dict[str, t.Tuple[str, TokenType]] = {}
 672    _IDENTIFIERS: t.Dict[str, str] = {}
 673    _IDENTIFIER_ESCAPES: t.Set[str] = set()
 674    _QUOTES: t.Dict[str, str] = {}
 675    _STRING_ESCAPES: t.Set[str] = set()
 676    _KEYWORD_TRIE: t.Dict = {}
 677    _RS_TOKENIZER: t.Optional[t.Any] = None
 678
 679    KEYWORDS: t.Dict[str, TokenType] = {
 680        **{f"{{%{postfix}": TokenType.BLOCK_START for postfix in ("", "+", "-")},
 681        **{f"{prefix}%}}": TokenType.BLOCK_END for prefix in ("", "+", "-")},
 682        **{f"{{{{{postfix}": TokenType.BLOCK_START for postfix in ("+", "-")},
 683        **{f"{prefix}}}}}": TokenType.BLOCK_END for prefix in ("+", "-")},
 684        HINT_START: TokenType.HINT,
 685        "==": TokenType.EQ,
 686        "::": TokenType.DCOLON,
 687        "||": TokenType.DPIPE,
 688        "|>": TokenType.PIPE_GT,
 689        ">=": TokenType.GTE,
 690        "<=": TokenType.LTE,
 691        "<>": TokenType.NEQ,
 692        "!=": TokenType.NEQ,
 693        ":=": TokenType.COLON_EQ,
 694        "<=>": TokenType.NULLSAFE_EQ,
 695        "->": TokenType.ARROW,
 696        "->>": TokenType.DARROW,
 697        "=>": TokenType.FARROW,
 698        "#>": TokenType.HASH_ARROW,
 699        "#>>": TokenType.DHASH_ARROW,
 700        "<->": TokenType.LR_ARROW,
 701        "&&": TokenType.DAMP,
 702        "??": TokenType.DQMARK,
 703        "~~~": TokenType.GLOB,
 704        "~~": TokenType.LIKE,
 705        "~~*": TokenType.ILIKE,
 706        "~*": TokenType.IRLIKE,
 707        "ALL": TokenType.ALL,
 708        "ALWAYS": TokenType.ALWAYS,
 709        "AND": TokenType.AND,
 710        "ANTI": TokenType.ANTI,
 711        "ANY": TokenType.ANY,
 712        "ASC": TokenType.ASC,
 713        "AS": TokenType.ALIAS,
 714        "ASOF": TokenType.ASOF,
 715        "AUTOINCREMENT": TokenType.AUTO_INCREMENT,
 716        "AUTO_INCREMENT": TokenType.AUTO_INCREMENT,
 717        "BEGIN": TokenType.BEGIN,
 718        "BETWEEN": TokenType.BETWEEN,
 719        "CACHE": TokenType.CACHE,
 720        "UNCACHE": TokenType.UNCACHE,
 721        "CASE": TokenType.CASE,
 722        "CHARACTER SET": TokenType.CHARACTER_SET,
 723        "CLUSTER BY": TokenType.CLUSTER_BY,
 724        "COLLATE": TokenType.COLLATE,
 725        "COLUMN": TokenType.COLUMN,
 726        "COMMIT": TokenType.COMMIT,
 727        "CONNECT BY": TokenType.CONNECT_BY,
 728        "CONSTRAINT": TokenType.CONSTRAINT,
 729        "COPY": TokenType.COPY,
 730        "CREATE": TokenType.CREATE,
 731        "CROSS": TokenType.CROSS,
 732        "CUBE": TokenType.CUBE,
 733        "CURRENT_DATE": TokenType.CURRENT_DATE,
 734        "CURRENT_SCHEMA": TokenType.CURRENT_SCHEMA,
 735        "CURRENT_TIME": TokenType.CURRENT_TIME,
 736        "CURRENT_TIMESTAMP": TokenType.CURRENT_TIMESTAMP,
 737        "CURRENT_USER": TokenType.CURRENT_USER,
 738        "DATABASE": TokenType.DATABASE,
 739        "DEFAULT": TokenType.DEFAULT,
 740        "DELETE": TokenType.DELETE,
 741        "DESC": TokenType.DESC,
 742        "DESCRIBE": TokenType.DESCRIBE,
 743        "DISTINCT": TokenType.DISTINCT,
 744        "DISTRIBUTE BY": TokenType.DISTRIBUTE_BY,
 745        "DIV": TokenType.DIV,
 746        "DROP": TokenType.DROP,
 747        "ELSE": TokenType.ELSE,
 748        "END": TokenType.END,
 749        "ENUM": TokenType.ENUM,
 750        "ESCAPE": TokenType.ESCAPE,
 751        "EXCEPT": TokenType.EXCEPT,
 752        "EXECUTE": TokenType.EXECUTE,
 753        "EXISTS": TokenType.EXISTS,
 754        "FALSE": TokenType.FALSE,
 755        "FETCH": TokenType.FETCH,
 756        "FILTER": TokenType.FILTER,
 757        "FIRST": TokenType.FIRST,
 758        "FULL": TokenType.FULL,
 759        "FUNCTION": TokenType.FUNCTION,
 760        "FOR": TokenType.FOR,
 761        "FOREIGN KEY": TokenType.FOREIGN_KEY,
 762        "FORMAT": TokenType.FORMAT,
 763        "FROM": TokenType.FROM,
 764        "GEOGRAPHY": TokenType.GEOGRAPHY,
 765        "GEOMETRY": TokenType.GEOMETRY,
 766        "GLOB": TokenType.GLOB,
 767        "GROUP BY": TokenType.GROUP_BY,
 768        "GROUPING SETS": TokenType.GROUPING_SETS,
 769        "HAVING": TokenType.HAVING,
 770        "ILIKE": TokenType.ILIKE,
 771        "IN": TokenType.IN,
 772        "INDEX": TokenType.INDEX,
 773        "INET": TokenType.INET,
 774        "INNER": TokenType.INNER,
 775        "INSERT": TokenType.INSERT,
 776        "INTERVAL": TokenType.INTERVAL,
 777        "INTERSECT": TokenType.INTERSECT,
 778        "INTO": TokenType.INTO,
 779        "IS": TokenType.IS,
 780        "ISNULL": TokenType.ISNULL,
 781        "JOIN": TokenType.JOIN,
 782        "KEEP": TokenType.KEEP,
 783        "KILL": TokenType.KILL,
 784        "LATERAL": TokenType.LATERAL,
 785        "LEFT": TokenType.LEFT,
 786        "LIKE": TokenType.LIKE,
 787        "LIMIT": TokenType.LIMIT,
 788        "LOAD": TokenType.LOAD,
 789        "LOCK": TokenType.LOCK,
 790        "MERGE": TokenType.MERGE,
 791        "NAMESPACE": TokenType.NAMESPACE,
 792        "NATURAL": TokenType.NATURAL,
 793        "NEXT": TokenType.NEXT,
 794        "NOT": TokenType.NOT,
 795        "NOTNULL": TokenType.NOTNULL,
 796        "NULL": TokenType.NULL,
 797        "OBJECT": TokenType.OBJECT,
 798        "OFFSET": TokenType.OFFSET,
 799        "ON": TokenType.ON,
 800        "OR": TokenType.OR,
 801        "XOR": TokenType.XOR,
 802        "ORDER BY": TokenType.ORDER_BY,
 803        "ORDINALITY": TokenType.ORDINALITY,
 804        "OUTER": TokenType.OUTER,
 805        "OVER": TokenType.OVER,
 806        "OVERLAPS": TokenType.OVERLAPS,
 807        "OVERWRITE": TokenType.OVERWRITE,
 808        "PARTITION": TokenType.PARTITION,
 809        "PARTITION BY": TokenType.PARTITION_BY,
 810        "PARTITIONED BY": TokenType.PARTITION_BY,
 811        "PARTITIONED_BY": TokenType.PARTITION_BY,
 812        "PERCENT": TokenType.PERCENT,
 813        "PIVOT": TokenType.PIVOT,
 814        "PRAGMA": TokenType.PRAGMA,
 815        "PRIMARY KEY": TokenType.PRIMARY_KEY,
 816        "PROCEDURE": TokenType.PROCEDURE,
 817        "QUALIFY": TokenType.QUALIFY,
 818        "RANGE": TokenType.RANGE,
 819        "RECURSIVE": TokenType.RECURSIVE,
 820        "REGEXP": TokenType.RLIKE,
 821        "RENAME": TokenType.RENAME,
 822        "REPLACE": TokenType.REPLACE,
 823        "RETURNING": TokenType.RETURNING,
 824        "REFERENCES": TokenType.REFERENCES,
 825        "RIGHT": TokenType.RIGHT,
 826        "RLIKE": TokenType.RLIKE,
 827        "ROLLBACK": TokenType.ROLLBACK,
 828        "ROLLUP": TokenType.ROLLUP,
 829        "ROW": TokenType.ROW,
 830        "ROWS": TokenType.ROWS,
 831        "SCHEMA": TokenType.SCHEMA,
 832        "SELECT": TokenType.SELECT,
 833        "SEMI": TokenType.SEMI,
 834        "SET": TokenType.SET,
 835        "SETTINGS": TokenType.SETTINGS,
 836        "SHOW": TokenType.SHOW,
 837        "SIMILAR TO": TokenType.SIMILAR_TO,
 838        "SOME": TokenType.SOME,
 839        "SORT BY": TokenType.SORT_BY,
 840        "START WITH": TokenType.START_WITH,
 841        "STRAIGHT_JOIN": TokenType.STRAIGHT_JOIN,
 842        "TABLE": TokenType.TABLE,
 843        "TABLESAMPLE": TokenType.TABLE_SAMPLE,
 844        "TEMP": TokenType.TEMPORARY,
 845        "TEMPORARY": TokenType.TEMPORARY,
 846        "THEN": TokenType.THEN,
 847        "TRUE": TokenType.TRUE,
 848        "TRUNCATE": TokenType.TRUNCATE,
 849        "UNION": TokenType.UNION,
 850        "UNKNOWN": TokenType.UNKNOWN,
 851        "UNNEST": TokenType.UNNEST,
 852        "UNPIVOT": TokenType.UNPIVOT,
 853        "UPDATE": TokenType.UPDATE,
 854        "USE": TokenType.USE,
 855        "USING": TokenType.USING,
 856        "UUID": TokenType.UUID,
 857        "VALUES": TokenType.VALUES,
 858        "VIEW": TokenType.VIEW,
 859        "VOLATILE": TokenType.VOLATILE,
 860        "WHEN": TokenType.WHEN,
 861        "WHERE": TokenType.WHERE,
 862        "WINDOW": TokenType.WINDOW,
 863        "WITH": TokenType.WITH,
 864        "APPLY": TokenType.APPLY,
 865        "ARRAY": TokenType.ARRAY,
 866        "BIT": TokenType.BIT,
 867        "BOOL": TokenType.BOOLEAN,
 868        "BOOLEAN": TokenType.BOOLEAN,
 869        "BYTE": TokenType.TINYINT,
 870        "MEDIUMINT": TokenType.MEDIUMINT,
 871        "INT1": TokenType.TINYINT,
 872        "TINYINT": TokenType.TINYINT,
 873        "INT16": TokenType.SMALLINT,
 874        "SHORT": TokenType.SMALLINT,
 875        "SMALLINT": TokenType.SMALLINT,
 876        "HUGEINT": TokenType.INT128,
 877        "UHUGEINT": TokenType.UINT128,
 878        "INT2": TokenType.SMALLINT,
 879        "INTEGER": TokenType.INT,
 880        "INT": TokenType.INT,
 881        "INT4": TokenType.INT,
 882        "INT32": TokenType.INT,
 883        "INT64": TokenType.BIGINT,
 884        "INT128": TokenType.INT128,
 885        "INT256": TokenType.INT256,
 886        "LONG": TokenType.BIGINT,
 887        "BIGINT": TokenType.BIGINT,
 888        "INT8": TokenType.TINYINT,
 889        "UINT": TokenType.UINT,
 890        "UINT128": TokenType.UINT128,
 891        "UINT256": TokenType.UINT256,
 892        "DEC": TokenType.DECIMAL,
 893        "DECIMAL": TokenType.DECIMAL,
 894        "DECIMAL32": TokenType.DECIMAL32,
 895        "DECIMAL64": TokenType.DECIMAL64,
 896        "DECIMAL128": TokenType.DECIMAL128,
 897        "DECIMAL256": TokenType.DECIMAL256,
 898        "BIGDECIMAL": TokenType.BIGDECIMAL,
 899        "BIGNUMERIC": TokenType.BIGDECIMAL,
 900        "LIST": TokenType.LIST,
 901        "MAP": TokenType.MAP,
 902        "NULLABLE": TokenType.NULLABLE,
 903        "NUMBER": TokenType.DECIMAL,
 904        "NUMERIC": TokenType.DECIMAL,
 905        "FIXED": TokenType.DECIMAL,
 906        "REAL": TokenType.FLOAT,
 907        "FLOAT": TokenType.FLOAT,
 908        "FLOAT4": TokenType.FLOAT,
 909        "FLOAT8": TokenType.DOUBLE,
 910        "DOUBLE": TokenType.DOUBLE,
 911        "DOUBLE PRECISION": TokenType.DOUBLE,
 912        "JSON": TokenType.JSON,
 913        "JSONB": TokenType.JSONB,
 914        "CHAR": TokenType.CHAR,
 915        "CHARACTER": TokenType.CHAR,
 916        "CHAR VARYING": TokenType.VARCHAR,
 917        "CHARACTER VARYING": TokenType.VARCHAR,
 918        "NCHAR": TokenType.NCHAR,
 919        "VARCHAR": TokenType.VARCHAR,
 920        "VARCHAR2": TokenType.VARCHAR,
 921        "NVARCHAR": TokenType.NVARCHAR,
 922        "NVARCHAR2": TokenType.NVARCHAR,
 923        "BPCHAR": TokenType.BPCHAR,
 924        "STR": TokenType.TEXT,
 925        "STRING": TokenType.TEXT,
 926        "TEXT": TokenType.TEXT,
 927        "LONGTEXT": TokenType.LONGTEXT,
 928        "MEDIUMTEXT": TokenType.MEDIUMTEXT,
 929        "TINYTEXT": TokenType.TINYTEXT,
 930        "CLOB": TokenType.TEXT,
 931        "LONGVARCHAR": TokenType.TEXT,
 932        "BINARY": TokenType.BINARY,
 933        "BLOB": TokenType.VARBINARY,
 934        "LONGBLOB": TokenType.LONGBLOB,
 935        "MEDIUMBLOB": TokenType.MEDIUMBLOB,
 936        "TINYBLOB": TokenType.TINYBLOB,
 937        "BYTEA": TokenType.VARBINARY,
 938        "VARBINARY": TokenType.VARBINARY,
 939        "TIME": TokenType.TIME,
 940        "TIMETZ": TokenType.TIMETZ,
 941        "TIMESTAMP": TokenType.TIMESTAMP,
 942        "TIMESTAMPTZ": TokenType.TIMESTAMPTZ,
 943        "TIMESTAMPLTZ": TokenType.TIMESTAMPLTZ,
 944        "TIMESTAMP_LTZ": TokenType.TIMESTAMPLTZ,
 945        "TIMESTAMPNTZ": TokenType.TIMESTAMPNTZ,
 946        "TIMESTAMP_NTZ": TokenType.TIMESTAMPNTZ,
 947        "DATE": TokenType.DATE,
 948        "DATETIME": TokenType.DATETIME,
 949        "INT4RANGE": TokenType.INT4RANGE,
 950        "INT4MULTIRANGE": TokenType.INT4MULTIRANGE,
 951        "INT8RANGE": TokenType.INT8RANGE,
 952        "INT8MULTIRANGE": TokenType.INT8MULTIRANGE,
 953        "NUMRANGE": TokenType.NUMRANGE,
 954        "NUMMULTIRANGE": TokenType.NUMMULTIRANGE,
 955        "TSRANGE": TokenType.TSRANGE,
 956        "TSMULTIRANGE": TokenType.TSMULTIRANGE,
 957        "TSTZRANGE": TokenType.TSTZRANGE,
 958        "TSTZMULTIRANGE": TokenType.TSTZMULTIRANGE,
 959        "DATERANGE": TokenType.DATERANGE,
 960        "DATEMULTIRANGE": TokenType.DATEMULTIRANGE,
 961        "UNIQUE": TokenType.UNIQUE,
 962        "VECTOR": TokenType.VECTOR,
 963        "STRUCT": TokenType.STRUCT,
 964        "SEQUENCE": TokenType.SEQUENCE,
 965        "VARIANT": TokenType.VARIANT,
 966        "ALTER": TokenType.ALTER,
 967        "ANALYZE": TokenType.ANALYZE,
 968        "CALL": TokenType.COMMAND,
 969        "COMMENT": TokenType.COMMENT,
 970        "EXPLAIN": TokenType.COMMAND,
 971        "GRANT": TokenType.GRANT,
 972        "OPTIMIZE": TokenType.COMMAND,
 973        "PREPARE": TokenType.COMMAND,
 974        "VACUUM": TokenType.COMMAND,
 975        "USER-DEFINED": TokenType.USERDEFINED,
 976        "FOR VERSION": TokenType.VERSION_SNAPSHOT,
 977        "FOR TIMESTAMP": TokenType.TIMESTAMP_SNAPSHOT,
 978    }
 979
 980    WHITE_SPACE: t.Dict[t.Optional[str], TokenType] = {
 981        " ": TokenType.SPACE,
 982        "\t": TokenType.SPACE,
 983        "\n": TokenType.BREAK,
 984        "\r": TokenType.BREAK,
 985    }
 986
 987    COMMANDS = {
 988        TokenType.COMMAND,
 989        TokenType.EXECUTE,
 990        TokenType.FETCH,
 991        TokenType.SHOW,
 992        TokenType.RENAME,
 993    }
 994
 995    COMMAND_PREFIX_TOKENS = {TokenType.SEMICOLON, TokenType.BEGIN}
 996
 997    # Handle numeric literals like in hive (3L = BIGINT)
 998    NUMERIC_LITERALS: t.Dict[str, str] = {}
 999
1000    COMMENTS = ["--", ("/*", "*/")]
1001
1002    __slots__ = (
1003        "sql",
1004        "size",
1005        "tokens",
1006        "dialect",
1007        "use_rs_tokenizer",
1008        "_start",
1009        "_current",
1010        "_line",
1011        "_col",
1012        "_comments",
1013        "_char",
1014        "_end",
1015        "_peek",
1016        "_prev_token_line",
1017        "_rs_dialect_settings",
1018    )
1019
1020    def __init__(
1021        self,
1022        dialect: DialectType = None,
1023        use_rs_tokenizer: t.Optional[bool] = None,
1024        **opts: t.Any,
1025    ) -> None:
1026        from sqlglot.dialects import Dialect
1027
1028        self.dialect = Dialect.get_or_raise(dialect)
1029
1030        # initialize `use_rs_tokenizer`, and allow it to be overwritten per Tokenizer instance
1031        self.use_rs_tokenizer = (
1032            use_rs_tokenizer if use_rs_tokenizer is not None else USE_RS_TOKENIZER
1033        )
1034
1035        if self.use_rs_tokenizer:
1036            self._rs_dialect_settings = RsTokenizerDialectSettings(
1037                unescaped_sequences=self.dialect.UNESCAPED_SEQUENCES,
1038                identifiers_can_start_with_digit=self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT,
1039                numbers_can_be_underscore_separated=self.dialect.NUMBERS_CAN_BE_UNDERSCORE_SEPARATED,
1040            )
1041
1042        self.reset()
1043
1044    def reset(self) -> None:
1045        self.sql = ""
1046        self.size = 0
1047        self.tokens: t.List[Token] = []
1048        self._start = 0
1049        self._current = 0
1050        self._line = 1
1051        self._col = 0
1052        self._comments: t.List[str] = []
1053
1054        self._char = ""
1055        self._end = False
1056        self._peek = ""
1057        self._prev_token_line = -1
1058
1059    def tokenize(self, sql: str) -> t.List[Token]:
1060        """Returns a list of tokens corresponding to the SQL string `sql`."""
1061        if self.use_rs_tokenizer:
1062            return self.tokenize_rs(sql)
1063
1064        self.reset()
1065        self.sql = sql
1066        self.size = len(sql)
1067
1068        try:
1069            self._scan()
1070        except Exception as e:
1071            start = max(self._current - 50, 0)
1072            end = min(self._current + 50, self.size - 1)
1073            context = self.sql[start:end]
1074            raise TokenError(f"Error tokenizing '{context}'") from e
1075
1076        return self.tokens
1077
1078    def _scan(self, until: t.Optional[t.Callable] = None) -> None:
1079        while self.size and not self._end:
1080            current = self._current
1081
1082            # Skip spaces here rather than iteratively calling advance() for performance reasons
1083            while current < self.size:
1084                char = self.sql[current]
1085
1086                if char.isspace() and (char == " " or char == "\t"):
1087                    current += 1
1088                else:
1089                    break
1090
1091            offset = current - self._current if current > self._current else 1
1092
1093            self._start = current
1094            self._advance(offset)
1095
1096            if not self._char.isspace():
1097                if self._char.isdigit():
1098                    self._scan_number()
1099                elif self._char in self._IDENTIFIERS:
1100                    self._scan_identifier(self._IDENTIFIERS[self._char])
1101                else:
1102                    self._scan_keywords()
1103
1104            if until and until():
1105                break
1106
1107        if self.tokens and self._comments:
1108            self.tokens[-1].comments.extend(self._comments)
1109
1110    def _chars(self, size: int) -> str:
1111        if size == 1:
1112            return self._char
1113
1114        start = self._current - 1
1115        end = start + size
1116
1117        return self.sql[start:end] if end <= self.size else ""
1118
1119    def _advance(self, i: int = 1, alnum: bool = False) -> None:
1120        if self.WHITE_SPACE.get(self._char) is TokenType.BREAK:
1121            # Ensures we don't count an extra line if we get a \r\n line break sequence
1122            if not (self._char == "\r" and self._peek == "\n"):
1123                self._col = i
1124                self._line += 1
1125        else:
1126            self._col += i
1127
1128        self._current += i
1129        self._end = self._current >= self.size
1130        self._char = self.sql[self._current - 1]
1131        self._peek = "" if self._end else self.sql[self._current]
1132
1133        if alnum and self._char.isalnum():
1134            # Here we use local variables instead of attributes for better performance
1135            _col = self._col
1136            _current = self._current
1137            _end = self._end
1138            _peek = self._peek
1139
1140            while _peek.isalnum():
1141                _col += 1
1142                _current += 1
1143                _end = _current >= self.size
1144                _peek = "" if _end else self.sql[_current]
1145
1146            self._col = _col
1147            self._current = _current
1148            self._end = _end
1149            self._peek = _peek
1150            self._char = self.sql[_current - 1]
1151
1152    @property
1153    def _text(self) -> str:
1154        return self.sql[self._start : self._current]
1155
1156    def _add(self, token_type: TokenType, text: t.Optional[str] = None) -> None:
1157        self._prev_token_line = self._line
1158
1159        if self._comments and token_type == TokenType.SEMICOLON and self.tokens:
1160            self.tokens[-1].comments.extend(self._comments)
1161            self._comments = []
1162
1163        self.tokens.append(
1164            Token(
1165                token_type,
1166                text=self._text if text is None else text,
1167                line=self._line,
1168                col=self._col,
1169                start=self._start,
1170                end=self._current - 1,
1171                comments=self._comments,
1172            )
1173        )
1174        self._comments = []
1175
1176        # If we have either a semicolon or a begin token before the command's token, we'll parse
1177        # whatever follows the command's token as a string
1178        if (
1179            token_type in self.COMMANDS
1180            and self._peek != ";"
1181            and (len(self.tokens) == 1 or self.tokens[-2].token_type in self.COMMAND_PREFIX_TOKENS)
1182        ):
1183            start = self._current
1184            tokens = len(self.tokens)
1185            self._scan(lambda: self._peek == ";")
1186            self.tokens = self.tokens[:tokens]
1187            text = self.sql[start : self._current].strip()
1188            if text:
1189                self._add(TokenType.STRING, text)
1190
1191    def _scan_keywords(self) -> None:
1192        size = 0
1193        word = None
1194        chars = self._text
1195        char = chars
1196        prev_space = False
1197        skip = False
1198        trie = self._KEYWORD_TRIE
1199        single_token = char in self.SINGLE_TOKENS
1200
1201        while chars:
1202            if skip:
1203                result = TrieResult.PREFIX
1204            else:
1205                result, trie = in_trie(trie, char.upper())
1206
1207            if result == TrieResult.FAILED:
1208                break
1209            if result == TrieResult.EXISTS:
1210                word = chars
1211
1212            end = self._current + size
1213            size += 1
1214
1215            if end < self.size:
1216                char = self.sql[end]
1217                single_token = single_token or char in self.SINGLE_TOKENS
1218                is_space = char.isspace()
1219
1220                if not is_space or not prev_space:
1221                    if is_space:
1222                        char = " "
1223                    chars += char
1224                    prev_space = is_space
1225                    skip = False
1226                else:
1227                    skip = True
1228            else:
1229                char = ""
1230                break
1231
1232        if word:
1233            if self._scan_string(word):
1234                return
1235            if self._scan_comment(word):
1236                return
1237            if prev_space or single_token or not char:
1238                self._advance(size - 1)
1239                word = word.upper()
1240                self._add(self.KEYWORDS[word], text=word)
1241                return
1242
1243        if self._char in self.SINGLE_TOKENS:
1244            self._add(self.SINGLE_TOKENS[self._char], text=self._char)
1245            return
1246
1247        self._scan_var()
1248
1249    def _scan_comment(self, comment_start: str) -> bool:
1250        if comment_start not in self._COMMENTS:
1251            return False
1252
1253        comment_start_line = self._line
1254        comment_start_size = len(comment_start)
1255        comment_end = self._COMMENTS[comment_start]
1256
1257        if comment_end:
1258            # Skip the comment's start delimiter
1259            self._advance(comment_start_size)
1260
1261            comment_count = 1
1262            comment_end_size = len(comment_end)
1263
1264            while not self._end:
1265                if self._chars(comment_end_size) == comment_end:
1266                    comment_count -= 1
1267                    if not comment_count:
1268                        break
1269
1270                self._advance(alnum=True)
1271
1272                # Nested comments are allowed by some dialects, e.g. databricks, duckdb, postgres
1273                if (
1274                    self.NESTED_COMMENTS
1275                    and not self._end
1276                    and self._chars(comment_end_size) == comment_start
1277                ):
1278                    self._advance(comment_start_size)
1279                    comment_count += 1
1280
1281            self._comments.append(self._text[comment_start_size : -comment_end_size + 1])
1282            self._advance(comment_end_size - 1)
1283        else:
1284            while not self._end and self.WHITE_SPACE.get(self._peek) is not TokenType.BREAK:
1285                self._advance(alnum=True)
1286            self._comments.append(self._text[comment_start_size:])
1287
1288        if (
1289            comment_start == self.HINT_START
1290            and self.tokens
1291            and self.tokens[-1].token_type in self.TOKENS_PRECEDING_HINT
1292        ):
1293            self._add(TokenType.HINT)
1294
1295        # Leading comment is attached to the succeeding token, whilst trailing comment to the preceding.
1296        # Multiple consecutive comments are preserved by appending them to the current comments list.
1297        if comment_start_line == self._prev_token_line:
1298            self.tokens[-1].comments.extend(self._comments)
1299            self._comments = []
1300            self._prev_token_line = self._line
1301
1302        return True
1303
1304    def _scan_number(self) -> None:
1305        if self._char == "0":
1306            peek = self._peek.upper()
1307            if peek == "B":
1308                return self._scan_bits() if self.BIT_STRINGS else self._add(TokenType.NUMBER)
1309            elif peek == "X":
1310                return self._scan_hex() if self.HEX_STRINGS else self._add(TokenType.NUMBER)
1311
1312        decimal = False
1313        scientific = 0
1314
1315        while True:
1316            if self._peek.isdigit():
1317                self._advance()
1318            elif self._peek == "." and not decimal:
1319                if self.tokens and self.tokens[-1].token_type == TokenType.PARAMETER:
1320                    return self._add(TokenType.NUMBER)
1321                decimal = True
1322                self._advance()
1323            elif self._peek in ("-", "+") and scientific == 1:
1324                scientific += 1
1325                self._advance()
1326            elif self._peek.upper() == "E" and not scientific:
1327                scientific += 1
1328                self._advance()
1329            elif self._peek.isidentifier():
1330                number_text = self._text
1331                literal = ""
1332
1333                while self._peek.strip() and self._peek not in self.SINGLE_TOKENS:
1334                    literal += self._peek
1335                    self._advance()
1336
1337                token_type = self.KEYWORDS.get(self.NUMERIC_LITERALS.get(literal.upper(), ""))
1338
1339                if token_type:
1340                    self._add(TokenType.NUMBER, number_text)
1341                    self._add(TokenType.DCOLON, "::")
1342                    return self._add(token_type, literal)
1343                else:
1344                    replaced = literal.replace("_", "")
1345                    if self.dialect.NUMBERS_CAN_BE_UNDERSCORE_SEPARATED and replaced.isdigit():
1346                        return self._add(TokenType.NUMBER, number_text + replaced)
1347                    if self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT:
1348                        return self._add(TokenType.VAR)
1349
1350                self._advance(-len(literal))
1351                return self._add(TokenType.NUMBER, number_text)
1352            else:
1353                return self._add(TokenType.NUMBER)
1354
1355    def _scan_bits(self) -> None:
1356        self._advance()
1357        value = self._extract_value()
1358        try:
1359            # If `value` can't be converted to a binary, fallback to tokenizing it as an identifier
1360            int(value, 2)
1361            self._add(TokenType.BIT_STRING, value[2:])  # Drop the 0b
1362        except ValueError:
1363            self._add(TokenType.IDENTIFIER)
1364
1365    def _scan_hex(self) -> None:
1366        self._advance()
1367        value = self._extract_value()
1368        try:
1369            # If `value` can't be converted to a hex, fallback to tokenizing it as an identifier
1370            int(value, 16)
1371            self._add(TokenType.HEX_STRING, value[2:])  # Drop the 0x
1372        except ValueError:
1373            self._add(TokenType.IDENTIFIER)
1374
1375    def _extract_value(self) -> str:
1376        while True:
1377            char = self._peek.strip()
1378            if char and char not in self.SINGLE_TOKENS:
1379                self._advance(alnum=True)
1380            else:
1381                break
1382
1383        return self._text
1384
1385    def _scan_string(self, start: str) -> bool:
1386        base = None
1387        token_type = TokenType.STRING
1388
1389        if start in self._QUOTES:
1390            end = self._QUOTES[start]
1391        elif start in self._FORMAT_STRINGS:
1392            end, token_type = self._FORMAT_STRINGS[start]
1393
1394            if token_type == TokenType.HEX_STRING:
1395                base = 16
1396            elif token_type == TokenType.BIT_STRING:
1397                base = 2
1398            elif token_type == TokenType.HEREDOC_STRING:
1399                self._advance()
1400
1401                if self._char == end:
1402                    tag = ""
1403                else:
1404                    tag = self._extract_string(
1405                        end,
1406                        raw_string=True,
1407                        raise_unmatched=not self.HEREDOC_TAG_IS_IDENTIFIER,
1408                    )
1409
1410                if tag and self.HEREDOC_TAG_IS_IDENTIFIER and (self._end or not tag.isidentifier()):
1411                    if not self._end:
1412                        self._advance(-1)
1413
1414                    self._advance(-len(tag))
1415                    self._add(self.HEREDOC_STRING_ALTERNATIVE)
1416                    return True
1417
1418                end = f"{start}{tag}{end}"
1419        else:
1420            return False
1421
1422        self._advance(len(start))
1423        text = self._extract_string(end, raw_string=token_type == TokenType.RAW_STRING)
1424
1425        if base:
1426            try:
1427                int(text, base)
1428            except Exception:
1429                raise TokenError(
1430                    f"Numeric string contains invalid characters from {self._line}:{self._start}"
1431                )
1432
1433        self._add(token_type, text)
1434        return True
1435
1436    def _scan_identifier(self, identifier_end: str) -> None:
1437        self._advance()
1438        text = self._extract_string(
1439            identifier_end, escapes=self._IDENTIFIER_ESCAPES | {identifier_end}
1440        )
1441        self._add(TokenType.IDENTIFIER, text)
1442
1443    def _scan_var(self) -> None:
1444        while True:
1445            char = self._peek.strip()
1446            if char and (char in self.VAR_SINGLE_TOKENS or char not in self.SINGLE_TOKENS):
1447                self._advance(alnum=True)
1448            else:
1449                break
1450
1451        self._add(
1452            TokenType.VAR
1453            if self.tokens and self.tokens[-1].token_type == TokenType.PARAMETER
1454            else self.KEYWORDS.get(self._text.upper(), TokenType.VAR)
1455        )
1456
1457    def _extract_string(
1458        self,
1459        delimiter: str,
1460        escapes: t.Optional[t.Set[str]] = None,
1461        raw_string: bool = False,
1462        raise_unmatched: bool = True,
1463    ) -> str:
1464        text = ""
1465        delim_size = len(delimiter)
1466        escapes = self._STRING_ESCAPES if escapes is None else escapes
1467
1468        while True:
1469            if (
1470                not raw_string
1471                and self.dialect.UNESCAPED_SEQUENCES
1472                and self._peek
1473                and self._char in self.STRING_ESCAPES
1474            ):
1475                unescaped_sequence = self.dialect.UNESCAPED_SEQUENCES.get(self._char + self._peek)
1476                if unescaped_sequence:
1477                    self._advance(2)
1478                    text += unescaped_sequence
1479                    continue
1480            if (
1481                (self.STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS or not raw_string)
1482                and self._char in escapes
1483                and (self._peek == delimiter or self._peek in escapes)
1484                and (self._char not in self._QUOTES or self._char == self._peek)
1485            ):
1486                if self._peek == delimiter:
1487                    text += self._peek
1488                else:
1489                    text += self._char + self._peek
1490
1491                if self._current + 1 < self.size:
1492                    self._advance(2)
1493                else:
1494                    raise TokenError(f"Missing {delimiter} from {self._line}:{self._current}")
1495            else:
1496                if self._chars(delim_size) == delimiter:
1497                    if delim_size > 1:
1498                        self._advance(delim_size - 1)
1499                    break
1500
1501                if self._end:
1502                    if not raise_unmatched:
1503                        return text + self._char
1504
1505                    raise TokenError(f"Missing {delimiter} from {self._line}:{self._start}")
1506
1507                current = self._current - 1
1508                self._advance(alnum=True)
1509                text += self.sql[current : self._current - 1]
1510
1511        return text
1512
1513    def tokenize_rs(self, sql: str) -> t.List[Token]:
1514        if not self._RS_TOKENIZER:
1515            raise SqlglotError("Rust tokenizer is not available")
1516
1517        tokens, error_msg = self._RS_TOKENIZER.tokenize(sql, self._rs_dialect_settings)
1518        for token in tokens:
1519            token.token_type = _ALL_TOKEN_TYPES[token.token_type_index]
1520
1521        # Setting this here so partial token lists can be inspected even if there is a failure
1522        self.tokens = tokens
1523
1524        if error_msg is not None:
1525            raise TokenError(error_msg)
1526
1527        return tokens
class TokenType(sqlglot.helper.AutoName):
 29class TokenType(AutoName):
 30    L_PAREN = auto()
 31    R_PAREN = auto()
 32    L_BRACKET = auto()
 33    R_BRACKET = auto()
 34    L_BRACE = auto()
 35    R_BRACE = auto()
 36    COMMA = auto()
 37    DOT = auto()
 38    DASH = auto()
 39    PLUS = auto()
 40    COLON = auto()
 41    DOTCOLON = auto()
 42    DCOLON = auto()
 43    DQMARK = auto()
 44    SEMICOLON = auto()
 45    STAR = auto()
 46    BACKSLASH = auto()
 47    SLASH = auto()
 48    LT = auto()
 49    LTE = auto()
 50    GT = auto()
 51    GTE = auto()
 52    NOT = auto()
 53    EQ = auto()
 54    NEQ = auto()
 55    NULLSAFE_EQ = auto()
 56    COLON_EQ = auto()
 57    AND = auto()
 58    OR = auto()
 59    AMP = auto()
 60    DPIPE = auto()
 61    PIPE_GT = auto()
 62    PIPE = auto()
 63    PIPE_SLASH = auto()
 64    DPIPE_SLASH = auto()
 65    CARET = auto()
 66    CARET_AT = auto()
 67    TILDA = auto()
 68    ARROW = auto()
 69    DARROW = auto()
 70    FARROW = auto()
 71    HASH = auto()
 72    HASH_ARROW = auto()
 73    DHASH_ARROW = auto()
 74    LR_ARROW = auto()
 75    DAT = auto()
 76    LT_AT = auto()
 77    AT_GT = auto()
 78    DOLLAR = auto()
 79    PARAMETER = auto()
 80    SESSION_PARAMETER = auto()
 81    DAMP = auto()
 82    XOR = auto()
 83    DSTAR = auto()
 84
 85    URI_START = auto()
 86
 87    BLOCK_START = auto()
 88    BLOCK_END = auto()
 89
 90    SPACE = auto()
 91    BREAK = auto()
 92
 93    STRING = auto()
 94    NUMBER = auto()
 95    IDENTIFIER = auto()
 96    DATABASE = auto()
 97    COLUMN = auto()
 98    COLUMN_DEF = auto()
 99    SCHEMA = auto()
100    TABLE = auto()
101    WAREHOUSE = auto()
102    STAGE = auto()
103    STREAMLIT = auto()
104    VAR = auto()
105    BIT_STRING = auto()
106    HEX_STRING = auto()
107    BYTE_STRING = auto()
108    NATIONAL_STRING = auto()
109    RAW_STRING = auto()
110    HEREDOC_STRING = auto()
111    UNICODE_STRING = auto()
112
113    # types
114    BIT = auto()
115    BOOLEAN = auto()
116    TINYINT = auto()
117    UTINYINT = auto()
118    SMALLINT = auto()
119    USMALLINT = auto()
120    MEDIUMINT = auto()
121    UMEDIUMINT = auto()
122    INT = auto()
123    UINT = auto()
124    BIGINT = auto()
125    UBIGINT = auto()
126    INT128 = auto()
127    UINT128 = auto()
128    INT256 = auto()
129    UINT256 = auto()
130    FLOAT = auto()
131    DOUBLE = auto()
132    UDOUBLE = auto()
133    DECIMAL = auto()
134    DECIMAL32 = auto()
135    DECIMAL64 = auto()
136    DECIMAL128 = auto()
137    DECIMAL256 = auto()
138    UDECIMAL = auto()
139    BIGDECIMAL = auto()
140    CHAR = auto()
141    NCHAR = auto()
142    VARCHAR = auto()
143    NVARCHAR = auto()
144    BPCHAR = auto()
145    TEXT = auto()
146    MEDIUMTEXT = auto()
147    LONGTEXT = auto()
148    BLOB = auto()
149    MEDIUMBLOB = auto()
150    LONGBLOB = auto()
151    TINYBLOB = auto()
152    TINYTEXT = auto()
153    NAME = auto()
154    BINARY = auto()
155    VARBINARY = auto()
156    JSON = auto()
157    JSONB = auto()
158    TIME = auto()
159    TIMETZ = auto()
160    TIMESTAMP = auto()
161    TIMESTAMPTZ = auto()
162    TIMESTAMPLTZ = auto()
163    TIMESTAMPNTZ = auto()
164    TIMESTAMP_S = auto()
165    TIMESTAMP_MS = auto()
166    TIMESTAMP_NS = auto()
167    DATETIME = auto()
168    DATETIME2 = auto()
169    DATETIME64 = auto()
170    SMALLDATETIME = auto()
171    DATE = auto()
172    DATE32 = auto()
173    INT4RANGE = auto()
174    INT4MULTIRANGE = auto()
175    INT8RANGE = auto()
176    INT8MULTIRANGE = auto()
177    NUMRANGE = auto()
178    NUMMULTIRANGE = auto()
179    TSRANGE = auto()
180    TSMULTIRANGE = auto()
181    TSTZRANGE = auto()
182    TSTZMULTIRANGE = auto()
183    DATERANGE = auto()
184    DATEMULTIRANGE = auto()
185    UUID = auto()
186    GEOGRAPHY = auto()
187    NULLABLE = auto()
188    GEOMETRY = auto()
189    POINT = auto()
190    RING = auto()
191    LINESTRING = auto()
192    MULTILINESTRING = auto()
193    POLYGON = auto()
194    MULTIPOLYGON = auto()
195    HLLSKETCH = auto()
196    HSTORE = auto()
197    SUPER = auto()
198    SERIAL = auto()
199    SMALLSERIAL = auto()
200    BIGSERIAL = auto()
201    XML = auto()
202    YEAR = auto()
203    USERDEFINED = auto()
204    MONEY = auto()
205    SMALLMONEY = auto()
206    ROWVERSION = auto()
207    IMAGE = auto()
208    VARIANT = auto()
209    OBJECT = auto()
210    INET = auto()
211    IPADDRESS = auto()
212    IPPREFIX = auto()
213    IPV4 = auto()
214    IPV6 = auto()
215    ENUM = auto()
216    ENUM8 = auto()
217    ENUM16 = auto()
218    FIXEDSTRING = auto()
219    LOWCARDINALITY = auto()
220    NESTED = auto()
221    AGGREGATEFUNCTION = auto()
222    SIMPLEAGGREGATEFUNCTION = auto()
223    TDIGEST = auto()
224    UNKNOWN = auto()
225    VECTOR = auto()
226    DYNAMIC = auto()
227    VOID = auto()
228
229    # keywords
230    ALIAS = auto()
231    ALTER = auto()
232    ALWAYS = auto()
233    ALL = auto()
234    ANTI = auto()
235    ANY = auto()
236    APPLY = auto()
237    ARRAY = auto()
238    ASC = auto()
239    ASOF = auto()
240    ATTACH = auto()
241    AUTO_INCREMENT = auto()
242    BEGIN = auto()
243    BETWEEN = auto()
244    BULK_COLLECT_INTO = auto()
245    CACHE = auto()
246    CASE = auto()
247    CHARACTER_SET = auto()
248    CLUSTER_BY = auto()
249    COLLATE = auto()
250    COMMAND = auto()
251    COMMENT = auto()
252    COMMIT = auto()
253    CONNECT_BY = auto()
254    CONSTRAINT = auto()
255    COPY = auto()
256    CREATE = auto()
257    CROSS = auto()
258    CUBE = auto()
259    CURRENT_DATE = auto()
260    CURRENT_DATETIME = auto()
261    CURRENT_SCHEMA = auto()
262    CURRENT_TIME = auto()
263    CURRENT_TIMESTAMP = auto()
264    CURRENT_USER = auto()
265    DECLARE = auto()
266    DEFAULT = auto()
267    DELETE = auto()
268    DESC = auto()
269    DESCRIBE = auto()
270    DETACH = auto()
271    DICTIONARY = auto()
272    DISTINCT = auto()
273    DISTRIBUTE_BY = auto()
274    DIV = auto()
275    DROP = auto()
276    ELSE = auto()
277    END = auto()
278    ESCAPE = auto()
279    EXCEPT = auto()
280    EXECUTE = auto()
281    EXISTS = auto()
282    FALSE = auto()
283    FETCH = auto()
284    FILE_FORMAT = auto()
285    FILTER = auto()
286    FINAL = auto()
287    FIRST = auto()
288    FOR = auto()
289    FORCE = auto()
290    FOREIGN_KEY = auto()
291    FORMAT = auto()
292    FROM = auto()
293    FULL = auto()
294    FUNCTION = auto()
295    GET = auto()
296    GLOB = auto()
297    GLOBAL = auto()
298    GRANT = auto()
299    GROUP_BY = auto()
300    GROUPING_SETS = auto()
301    HAVING = auto()
302    HINT = auto()
303    IGNORE = auto()
304    ILIKE = auto()
305    ILIKE_ANY = auto()
306    IN = auto()
307    INDEX = auto()
308    INNER = auto()
309    INSERT = auto()
310    INTERSECT = auto()
311    INTERVAL = auto()
312    INTO = auto()
313    INTRODUCER = auto()
314    IRLIKE = auto()
315    IS = auto()
316    ISNULL = auto()
317    JOIN = auto()
318    JOIN_MARKER = auto()
319    KEEP = auto()
320    KEY = auto()
321    KILL = auto()
322    LANGUAGE = auto()
323    LATERAL = auto()
324    LEFT = auto()
325    LIKE = auto()
326    LIKE_ANY = auto()
327    LIMIT = auto()
328    LIST = auto()
329    LOAD = auto()
330    LOCK = auto()
331    MAP = auto()
332    MATCH_CONDITION = auto()
333    MATCH_RECOGNIZE = auto()
334    MEMBER_OF = auto()
335    MERGE = auto()
336    MOD = auto()
337    MODEL = auto()
338    NATURAL = auto()
339    NEXT = auto()
340    NOTHING = auto()
341    NOTNULL = auto()
342    NULL = auto()
343    OBJECT_IDENTIFIER = auto()
344    OFFSET = auto()
345    ON = auto()
346    ONLY = auto()
347    OPERATOR = auto()
348    ORDER_BY = auto()
349    ORDER_SIBLINGS_BY = auto()
350    ORDERED = auto()
351    ORDINALITY = auto()
352    OUTER = auto()
353    OVER = auto()
354    OVERLAPS = auto()
355    OVERWRITE = auto()
356    PARTITION = auto()
357    PARTITION_BY = auto()
358    PERCENT = auto()
359    PIVOT = auto()
360    PLACEHOLDER = auto()
361    POSITIONAL = auto()
362    PRAGMA = auto()
363    PREWHERE = auto()
364    PRIMARY_KEY = auto()
365    PROCEDURE = auto()
366    PROPERTIES = auto()
367    PSEUDO_TYPE = auto()
368    PUT = auto()
369    QUALIFY = auto()
370    QUOTE = auto()
371    RANGE = auto()
372    RECURSIVE = auto()
373    REFRESH = auto()
374    RENAME = auto()
375    REPLACE = auto()
376    RETURNING = auto()
377    REFERENCES = auto()
378    RIGHT = auto()
379    RLIKE = auto()
380    ROLLBACK = auto()
381    ROLLUP = auto()
382    ROW = auto()
383    ROWS = auto()
384    SELECT = auto()
385    SEMI = auto()
386    SEPARATOR = auto()
387    SEQUENCE = auto()
388    SERDE_PROPERTIES = auto()
389    SET = auto()
390    SETTINGS = auto()
391    SHOW = auto()
392    SIMILAR_TO = auto()
393    SOME = auto()
394    SORT_BY = auto()
395    START_WITH = auto()
396    STORAGE_INTEGRATION = auto()
397    STRAIGHT_JOIN = auto()
398    STRUCT = auto()
399    SUMMARIZE = auto()
400    TABLE_SAMPLE = auto()
401    TAG = auto()
402    TEMPORARY = auto()
403    TOP = auto()
404    THEN = auto()
405    TRUE = auto()
406    TRUNCATE = auto()
407    UNCACHE = auto()
408    UNION = auto()
409    UNNEST = auto()
410    UNPIVOT = auto()
411    UPDATE = auto()
412    USE = auto()
413    USING = auto()
414    VALUES = auto()
415    VIEW = auto()
416    SEMANTIC_VIEW = auto()
417    VOLATILE = auto()
418    WHEN = auto()
419    WHERE = auto()
420    WINDOW = auto()
421    WITH = auto()
422    UNIQUE = auto()
423    VERSION_SNAPSHOT = auto()
424    TIMESTAMP_SNAPSHOT = auto()
425    OPTION = auto()
426    SINK = auto()
427    SOURCE = auto()
428    ANALYZE = auto()
429    NAMESPACE = auto()
430    EXPORT = auto()
431
432    # sentinel
433    HIVE_TOKEN_STREAM = auto()

An enumeration.

L_PAREN = <TokenType.L_PAREN: 'L_PAREN'>
R_PAREN = <TokenType.R_PAREN: 'R_PAREN'>
L_BRACKET = <TokenType.L_BRACKET: 'L_BRACKET'>
R_BRACKET = <TokenType.R_BRACKET: 'R_BRACKET'>
L_BRACE = <TokenType.L_BRACE: 'L_BRACE'>
R_BRACE = <TokenType.R_BRACE: 'R_BRACE'>
COMMA = <TokenType.COMMA: 'COMMA'>
DOT = <TokenType.DOT: 'DOT'>
DASH = <TokenType.DASH: 'DASH'>
PLUS = <TokenType.PLUS: 'PLUS'>
COLON = <TokenType.COLON: 'COLON'>
DOTCOLON = <TokenType.DOTCOLON: 'DOTCOLON'>
DCOLON = <TokenType.DCOLON: 'DCOLON'>
DQMARK = <TokenType.DQMARK: 'DQMARK'>
SEMICOLON = <TokenType.SEMICOLON: 'SEMICOLON'>
STAR = <TokenType.STAR: 'STAR'>
BACKSLASH = <TokenType.BACKSLASH: 'BACKSLASH'>
SLASH = <TokenType.SLASH: 'SLASH'>
LT = <TokenType.LT: 'LT'>
LTE = <TokenType.LTE: 'LTE'>
GT = <TokenType.GT: 'GT'>
GTE = <TokenType.GTE: 'GTE'>
NOT = <TokenType.NOT: 'NOT'>
EQ = <TokenType.EQ: 'EQ'>
NEQ = <TokenType.NEQ: 'NEQ'>
NULLSAFE_EQ = <TokenType.NULLSAFE_EQ: 'NULLSAFE_EQ'>
COLON_EQ = <TokenType.COLON_EQ: 'COLON_EQ'>
AND = <TokenType.AND: 'AND'>
OR = <TokenType.OR: 'OR'>
AMP = <TokenType.AMP: 'AMP'>
DPIPE = <TokenType.DPIPE: 'DPIPE'>
PIPE_GT = <TokenType.PIPE_GT: 'PIPE_GT'>
PIPE = <TokenType.PIPE: 'PIPE'>
PIPE_SLASH = <TokenType.PIPE_SLASH: 'PIPE_SLASH'>
DPIPE_SLASH = <TokenType.DPIPE_SLASH: 'DPIPE_SLASH'>
CARET = <TokenType.CARET: 'CARET'>
CARET_AT = <TokenType.CARET_AT: 'CARET_AT'>
TILDA = <TokenType.TILDA: 'TILDA'>
ARROW = <TokenType.ARROW: 'ARROW'>
DARROW = <TokenType.DARROW: 'DARROW'>
FARROW = <TokenType.FARROW: 'FARROW'>
HASH = <TokenType.HASH: 'HASH'>
HASH_ARROW = <TokenType.HASH_ARROW: 'HASH_ARROW'>
DHASH_ARROW = <TokenType.DHASH_ARROW: 'DHASH_ARROW'>
LR_ARROW = <TokenType.LR_ARROW: 'LR_ARROW'>
DAT = <TokenType.DAT: 'DAT'>
LT_AT = <TokenType.LT_AT: 'LT_AT'>
AT_GT = <TokenType.AT_GT: 'AT_GT'>
DOLLAR = <TokenType.DOLLAR: 'DOLLAR'>
PARAMETER = <TokenType.PARAMETER: 'PARAMETER'>
SESSION_PARAMETER = <TokenType.SESSION_PARAMETER: 'SESSION_PARAMETER'>
DAMP = <TokenType.DAMP: 'DAMP'>
XOR = <TokenType.XOR: 'XOR'>
DSTAR = <TokenType.DSTAR: 'DSTAR'>
URI_START = <TokenType.URI_START: 'URI_START'>
BLOCK_START = <TokenType.BLOCK_START: 'BLOCK_START'>
BLOCK_END = <TokenType.BLOCK_END: 'BLOCK_END'>
SPACE = <TokenType.SPACE: 'SPACE'>
BREAK = <TokenType.BREAK: 'BREAK'>
STRING = <TokenType.STRING: 'STRING'>
NUMBER = <TokenType.NUMBER: 'NUMBER'>
IDENTIFIER = <TokenType.IDENTIFIER: 'IDENTIFIER'>
DATABASE = <TokenType.DATABASE: 'DATABASE'>
COLUMN = <TokenType.COLUMN: 'COLUMN'>
COLUMN_DEF = <TokenType.COLUMN_DEF: 'COLUMN_DEF'>
SCHEMA = <TokenType.SCHEMA: 'SCHEMA'>
TABLE = <TokenType.TABLE: 'TABLE'>
WAREHOUSE = <TokenType.WAREHOUSE: 'WAREHOUSE'>
STAGE = <TokenType.STAGE: 'STAGE'>
STREAMLIT = <TokenType.STREAMLIT: 'STREAMLIT'>
VAR = <TokenType.VAR: 'VAR'>
BIT_STRING = <TokenType.BIT_STRING: 'BIT_STRING'>
HEX_STRING = <TokenType.HEX_STRING: 'HEX_STRING'>
BYTE_STRING = <TokenType.BYTE_STRING: 'BYTE_STRING'>
NATIONAL_STRING = <TokenType.NATIONAL_STRING: 'NATIONAL_STRING'>
RAW_STRING = <TokenType.RAW_STRING: 'RAW_STRING'>
HEREDOC_STRING = <TokenType.HEREDOC_STRING: 'HEREDOC_STRING'>
UNICODE_STRING = <TokenType.UNICODE_STRING: 'UNICODE_STRING'>
BIT = <TokenType.BIT: 'BIT'>
BOOLEAN = <TokenType.BOOLEAN: 'BOOLEAN'>
TINYINT = <TokenType.TINYINT: 'TINYINT'>
UTINYINT = <TokenType.UTINYINT: 'UTINYINT'>
SMALLINT = <TokenType.SMALLINT: 'SMALLINT'>
USMALLINT = <TokenType.USMALLINT: 'USMALLINT'>
MEDIUMINT = <TokenType.MEDIUMINT: 'MEDIUMINT'>
UMEDIUMINT = <TokenType.UMEDIUMINT: 'UMEDIUMINT'>
INT = <TokenType.INT: 'INT'>
UINT = <TokenType.UINT: 'UINT'>
BIGINT = <TokenType.BIGINT: 'BIGINT'>
UBIGINT = <TokenType.UBIGINT: 'UBIGINT'>
INT128 = <TokenType.INT128: 'INT128'>
UINT128 = <TokenType.UINT128: 'UINT128'>
INT256 = <TokenType.INT256: 'INT256'>
UINT256 = <TokenType.UINT256: 'UINT256'>
FLOAT = <TokenType.FLOAT: 'FLOAT'>
DOUBLE = <TokenType.DOUBLE: 'DOUBLE'>
UDOUBLE = <TokenType.UDOUBLE: 'UDOUBLE'>
DECIMAL = <TokenType.DECIMAL: 'DECIMAL'>
DECIMAL32 = <TokenType.DECIMAL32: 'DECIMAL32'>
DECIMAL64 = <TokenType.DECIMAL64: 'DECIMAL64'>
DECIMAL128 = <TokenType.DECIMAL128: 'DECIMAL128'>
DECIMAL256 = <TokenType.DECIMAL256: 'DECIMAL256'>
UDECIMAL = <TokenType.UDECIMAL: 'UDECIMAL'>
BIGDECIMAL = <TokenType.BIGDECIMAL: 'BIGDECIMAL'>
CHAR = <TokenType.CHAR: 'CHAR'>
NCHAR = <TokenType.NCHAR: 'NCHAR'>
VARCHAR = <TokenType.VARCHAR: 'VARCHAR'>
NVARCHAR = <TokenType.NVARCHAR: 'NVARCHAR'>
BPCHAR = <TokenType.BPCHAR: 'BPCHAR'>
TEXT = <TokenType.TEXT: 'TEXT'>
MEDIUMTEXT = <TokenType.MEDIUMTEXT: 'MEDIUMTEXT'>
LONGTEXT = <TokenType.LONGTEXT: 'LONGTEXT'>
BLOB = <TokenType.BLOB: 'BLOB'>
MEDIUMBLOB = <TokenType.MEDIUMBLOB: 'MEDIUMBLOB'>
LONGBLOB = <TokenType.LONGBLOB: 'LONGBLOB'>
TINYBLOB = <TokenType.TINYBLOB: 'TINYBLOB'>
TINYTEXT = <TokenType.TINYTEXT: 'TINYTEXT'>
NAME = <TokenType.NAME: 'NAME'>
BINARY = <TokenType.BINARY: 'BINARY'>
VARBINARY = <TokenType.VARBINARY: 'VARBINARY'>
JSON = <TokenType.JSON: 'JSON'>
JSONB = <TokenType.JSONB: 'JSONB'>
TIME = <TokenType.TIME: 'TIME'>
TIMETZ = <TokenType.TIMETZ: 'TIMETZ'>
TIMESTAMP = <TokenType.TIMESTAMP: 'TIMESTAMP'>
TIMESTAMPTZ = <TokenType.TIMESTAMPTZ: 'TIMESTAMPTZ'>
TIMESTAMPLTZ = <TokenType.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>
TIMESTAMPNTZ = <TokenType.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>
TIMESTAMP_S = <TokenType.TIMESTAMP_S: 'TIMESTAMP_S'>
TIMESTAMP_MS = <TokenType.TIMESTAMP_MS: 'TIMESTAMP_MS'>
TIMESTAMP_NS = <TokenType.TIMESTAMP_NS: 'TIMESTAMP_NS'>
DATETIME = <TokenType.DATETIME: 'DATETIME'>
DATETIME2 = <TokenType.DATETIME2: 'DATETIME2'>
DATETIME64 = <TokenType.DATETIME64: 'DATETIME64'>
SMALLDATETIME = <TokenType.SMALLDATETIME: 'SMALLDATETIME'>
DATE = <TokenType.DATE: 'DATE'>
DATE32 = <TokenType.DATE32: 'DATE32'>
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'>
UUID = <TokenType.UUID: 'UUID'>
GEOGRAPHY = <TokenType.GEOGRAPHY: 'GEOGRAPHY'>
NULLABLE = <TokenType.NULLABLE: 'NULLABLE'>
GEOMETRY = <TokenType.GEOMETRY: 'GEOMETRY'>
POINT = <TokenType.POINT: 'POINT'>
RING = <TokenType.RING: 'RING'>
LINESTRING = <TokenType.LINESTRING: 'LINESTRING'>
MULTILINESTRING = <TokenType.MULTILINESTRING: 'MULTILINESTRING'>
POLYGON = <TokenType.POLYGON: 'POLYGON'>
MULTIPOLYGON = <TokenType.MULTIPOLYGON: 'MULTIPOLYGON'>
HLLSKETCH = <TokenType.HLLSKETCH: 'HLLSKETCH'>
HSTORE = <TokenType.HSTORE: 'HSTORE'>
SUPER = <TokenType.SUPER: 'SUPER'>
SERIAL = <TokenType.SERIAL: 'SERIAL'>
SMALLSERIAL = <TokenType.SMALLSERIAL: 'SMALLSERIAL'>
BIGSERIAL = <TokenType.BIGSERIAL: 'BIGSERIAL'>
XML = <TokenType.XML: 'XML'>
YEAR = <TokenType.YEAR: 'YEAR'>
USERDEFINED = <TokenType.USERDEFINED: 'USERDEFINED'>
MONEY = <TokenType.MONEY: 'MONEY'>
SMALLMONEY = <TokenType.SMALLMONEY: 'SMALLMONEY'>
ROWVERSION = <TokenType.ROWVERSION: 'ROWVERSION'>
IMAGE = <TokenType.IMAGE: 'IMAGE'>
VARIANT = <TokenType.VARIANT: 'VARIANT'>
OBJECT = <TokenType.OBJECT: 'OBJECT'>
INET = <TokenType.INET: 'INET'>
IPADDRESS = <TokenType.IPADDRESS: 'IPADDRESS'>
IPPREFIX = <TokenType.IPPREFIX: 'IPPREFIX'>
IPV4 = <TokenType.IPV4: 'IPV4'>
IPV6 = <TokenType.IPV6: 'IPV6'>
ENUM = <TokenType.ENUM: 'ENUM'>
ENUM8 = <TokenType.ENUM8: 'ENUM8'>
ENUM16 = <TokenType.ENUM16: 'ENUM16'>
FIXEDSTRING = <TokenType.FIXEDSTRING: 'FIXEDSTRING'>
LOWCARDINALITY = <TokenType.LOWCARDINALITY: 'LOWCARDINALITY'>
NESTED = <TokenType.NESTED: 'NESTED'>
AGGREGATEFUNCTION = <TokenType.AGGREGATEFUNCTION: 'AGGREGATEFUNCTION'>
SIMPLEAGGREGATEFUNCTION = <TokenType.SIMPLEAGGREGATEFUNCTION: 'SIMPLEAGGREGATEFUNCTION'>
TDIGEST = <TokenType.TDIGEST: 'TDIGEST'>
UNKNOWN = <TokenType.UNKNOWN: 'UNKNOWN'>
VECTOR = <TokenType.VECTOR: 'VECTOR'>
DYNAMIC = <TokenType.DYNAMIC: 'DYNAMIC'>
VOID = <TokenType.VOID: 'VOID'>
ALIAS = <TokenType.ALIAS: 'ALIAS'>
ALTER = <TokenType.ALTER: 'ALTER'>
ALWAYS = <TokenType.ALWAYS: 'ALWAYS'>
ALL = <TokenType.ALL: 'ALL'>
ANTI = <TokenType.ANTI: 'ANTI'>
ANY = <TokenType.ANY: 'ANY'>
APPLY = <TokenType.APPLY: 'APPLY'>
ARRAY = <TokenType.ARRAY: 'ARRAY'>
ASC = <TokenType.ASC: 'ASC'>
ASOF = <TokenType.ASOF: 'ASOF'>
ATTACH = <TokenType.ATTACH: 'ATTACH'>
AUTO_INCREMENT = <TokenType.AUTO_INCREMENT: 'AUTO_INCREMENT'>
BEGIN = <TokenType.BEGIN: 'BEGIN'>
BETWEEN = <TokenType.BETWEEN: 'BETWEEN'>
BULK_COLLECT_INTO = <TokenType.BULK_COLLECT_INTO: 'BULK_COLLECT_INTO'>
CACHE = <TokenType.CACHE: 'CACHE'>
CASE = <TokenType.CASE: 'CASE'>
CHARACTER_SET = <TokenType.CHARACTER_SET: 'CHARACTER_SET'>
CLUSTER_BY = <TokenType.CLUSTER_BY: 'CLUSTER_BY'>
COLLATE = <TokenType.COLLATE: 'COLLATE'>
COMMAND = <TokenType.COMMAND: 'COMMAND'>
COMMENT = <TokenType.COMMENT: 'COMMENT'>
COMMIT = <TokenType.COMMIT: 'COMMIT'>
CONNECT_BY = <TokenType.CONNECT_BY: 'CONNECT_BY'>
CONSTRAINT = <TokenType.CONSTRAINT: 'CONSTRAINT'>
COPY = <TokenType.COPY: 'COPY'>
CREATE = <TokenType.CREATE: 'CREATE'>
CROSS = <TokenType.CROSS: 'CROSS'>
CUBE = <TokenType.CUBE: 'CUBE'>
CURRENT_DATE = <TokenType.CURRENT_DATE: 'CURRENT_DATE'>
CURRENT_DATETIME = <TokenType.CURRENT_DATETIME: 'CURRENT_DATETIME'>
CURRENT_SCHEMA = <TokenType.CURRENT_SCHEMA: 'CURRENT_SCHEMA'>
CURRENT_TIME = <TokenType.CURRENT_TIME: 'CURRENT_TIME'>
CURRENT_TIMESTAMP = <TokenType.CURRENT_TIMESTAMP: 'CURRENT_TIMESTAMP'>
CURRENT_USER = <TokenType.CURRENT_USER: 'CURRENT_USER'>
DECLARE = <TokenType.DECLARE: 'DECLARE'>
DEFAULT = <TokenType.DEFAULT: 'DEFAULT'>
DELETE = <TokenType.DELETE: 'DELETE'>
DESC = <TokenType.DESC: 'DESC'>
DESCRIBE = <TokenType.DESCRIBE: 'DESCRIBE'>
DETACH = <TokenType.DETACH: 'DETACH'>
DICTIONARY = <TokenType.DICTIONARY: 'DICTIONARY'>
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'>
FILE_FORMAT = <TokenType.FILE_FORMAT: 'FILE_FORMAT'>
FILTER = <TokenType.FILTER: 'FILTER'>
FINAL = <TokenType.FINAL: 'FINAL'>
FIRST = <TokenType.FIRST: 'FIRST'>
FOR = <TokenType.FOR: 'FOR'>
FORCE = <TokenType.FORCE: 'FORCE'>
FOREIGN_KEY = <TokenType.FOREIGN_KEY: 'FOREIGN_KEY'>
FORMAT = <TokenType.FORMAT: 'FORMAT'>
FROM = <TokenType.FROM: 'FROM'>
FULL = <TokenType.FULL: 'FULL'>
FUNCTION = <TokenType.FUNCTION: 'FUNCTION'>
GET = <TokenType.GET: 'GET'>
GLOB = <TokenType.GLOB: 'GLOB'>
GLOBAL = <TokenType.GLOBAL: 'GLOBAL'>
GRANT = <TokenType.GRANT: 'GRANT'>
GROUP_BY = <TokenType.GROUP_BY: 'GROUP_BY'>
GROUPING_SETS = <TokenType.GROUPING_SETS: 'GROUPING_SETS'>
HAVING = <TokenType.HAVING: 'HAVING'>
HINT = <TokenType.HINT: 'HINT'>
IGNORE = <TokenType.IGNORE: 'IGNORE'>
ILIKE = <TokenType.ILIKE: 'ILIKE'>
ILIKE_ANY = <TokenType.ILIKE_ANY: 'ILIKE_ANY'>
IN = <TokenType.IN: 'IN'>
INDEX = <TokenType.INDEX: 'INDEX'>
INNER = <TokenType.INNER: 'INNER'>
INSERT = <TokenType.INSERT: 'INSERT'>
INTERSECT = <TokenType.INTERSECT: 'INTERSECT'>
INTERVAL = <TokenType.INTERVAL: 'INTERVAL'>
INTO = <TokenType.INTO: 'INTO'>
INTRODUCER = <TokenType.INTRODUCER: 'INTRODUCER'>
IRLIKE = <TokenType.IRLIKE: 'IRLIKE'>
IS = <TokenType.IS: 'IS'>
ISNULL = <TokenType.ISNULL: 'ISNULL'>
JOIN = <TokenType.JOIN: 'JOIN'>
JOIN_MARKER = <TokenType.JOIN_MARKER: 'JOIN_MARKER'>
KEEP = <TokenType.KEEP: 'KEEP'>
KEY = <TokenType.KEY: 'KEY'>
KILL = <TokenType.KILL: 'KILL'>
LANGUAGE = <TokenType.LANGUAGE: 'LANGUAGE'>
LATERAL = <TokenType.LATERAL: 'LATERAL'>
LEFT = <TokenType.LEFT: 'LEFT'>
LIKE = <TokenType.LIKE: 'LIKE'>
LIKE_ANY = <TokenType.LIKE_ANY: 'LIKE_ANY'>
LIMIT = <TokenType.LIMIT: 'LIMIT'>
LIST = <TokenType.LIST: 'LIST'>
LOAD = <TokenType.LOAD: 'LOAD'>
LOCK = <TokenType.LOCK: 'LOCK'>
MAP = <TokenType.MAP: 'MAP'>
MATCH_CONDITION = <TokenType.MATCH_CONDITION: 'MATCH_CONDITION'>
MATCH_RECOGNIZE = <TokenType.MATCH_RECOGNIZE: 'MATCH_RECOGNIZE'>
MEMBER_OF = <TokenType.MEMBER_OF: 'MEMBER_OF'>
MERGE = <TokenType.MERGE: 'MERGE'>
MOD = <TokenType.MOD: 'MOD'>
MODEL = <TokenType.MODEL: 'MODEL'>
NATURAL = <TokenType.NATURAL: 'NATURAL'>
NEXT = <TokenType.NEXT: 'NEXT'>
NOTHING = <TokenType.NOTHING: 'NOTHING'>
NOTNULL = <TokenType.NOTNULL: 'NOTNULL'>
NULL = <TokenType.NULL: 'NULL'>
OBJECT_IDENTIFIER = <TokenType.OBJECT_IDENTIFIER: 'OBJECT_IDENTIFIER'>
OFFSET = <TokenType.OFFSET: 'OFFSET'>
ON = <TokenType.ON: 'ON'>
ONLY = <TokenType.ONLY: 'ONLY'>
OPERATOR = <TokenType.OPERATOR: 'OPERATOR'>
ORDER_BY = <TokenType.ORDER_BY: 'ORDER_BY'>
ORDER_SIBLINGS_BY = <TokenType.ORDER_SIBLINGS_BY: 'ORDER_SIBLINGS_BY'>
ORDERED = <TokenType.ORDERED: 'ORDERED'>
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'>
PERCENT = <TokenType.PERCENT: 'PERCENT'>
PIVOT = <TokenType.PIVOT: 'PIVOT'>
PLACEHOLDER = <TokenType.PLACEHOLDER: 'PLACEHOLDER'>
POSITIONAL = <TokenType.POSITIONAL: 'POSITIONAL'>
PRAGMA = <TokenType.PRAGMA: 'PRAGMA'>
PREWHERE = <TokenType.PREWHERE: 'PREWHERE'>
PRIMARY_KEY = <TokenType.PRIMARY_KEY: 'PRIMARY_KEY'>
PROCEDURE = <TokenType.PROCEDURE: 'PROCEDURE'>
PROPERTIES = <TokenType.PROPERTIES: 'PROPERTIES'>
PSEUDO_TYPE = <TokenType.PSEUDO_TYPE: 'PSEUDO_TYPE'>
PUT = <TokenType.PUT: 'PUT'>
QUALIFY = <TokenType.QUALIFY: 'QUALIFY'>
QUOTE = <TokenType.QUOTE: 'QUOTE'>
RANGE = <TokenType.RANGE: 'RANGE'>
RECURSIVE = <TokenType.RECURSIVE: 'RECURSIVE'>
REFRESH = <TokenType.REFRESH: 'REFRESH'>
RENAME = <TokenType.RENAME: 'RENAME'>
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'>
SELECT = <TokenType.SELECT: 'SELECT'>
SEMI = <TokenType.SEMI: 'SEMI'>
SEPARATOR = <TokenType.SEPARATOR: 'SEPARATOR'>
SEQUENCE = <TokenType.SEQUENCE: 'SEQUENCE'>
SERDE_PROPERTIES = <TokenType.SERDE_PROPERTIES: 'SERDE_PROPERTIES'>
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'>
STORAGE_INTEGRATION = <TokenType.STORAGE_INTEGRATION: 'STORAGE_INTEGRATION'>
STRAIGHT_JOIN = <TokenType.STRAIGHT_JOIN: 'STRAIGHT_JOIN'>
STRUCT = <TokenType.STRUCT: 'STRUCT'>
SUMMARIZE = <TokenType.SUMMARIZE: 'SUMMARIZE'>
TABLE_SAMPLE = <TokenType.TABLE_SAMPLE: 'TABLE_SAMPLE'>
TAG = <TokenType.TAG: 'TAG'>
TEMPORARY = <TokenType.TEMPORARY: 'TEMPORARY'>
TOP = <TokenType.TOP: 'TOP'>
THEN = <TokenType.THEN: 'THEN'>
TRUE = <TokenType.TRUE: 'TRUE'>
TRUNCATE = <TokenType.TRUNCATE: 'TRUNCATE'>
UNCACHE = <TokenType.UNCACHE: 'UNCACHE'>
UNION = <TokenType.UNION: 'UNION'>
UNNEST = <TokenType.UNNEST: 'UNNEST'>
UNPIVOT = <TokenType.UNPIVOT: 'UNPIVOT'>
UPDATE = <TokenType.UPDATE: 'UPDATE'>
USE = <TokenType.USE: 'USE'>
USING = <TokenType.USING: 'USING'>
VALUES = <TokenType.VALUES: 'VALUES'>
VIEW = <TokenType.VIEW: 'VIEW'>
SEMANTIC_VIEW = <TokenType.SEMANTIC_VIEW: 'SEMANTIC_VIEW'>
VOLATILE = <TokenType.VOLATILE: 'VOLATILE'>
WHEN = <TokenType.WHEN: 'WHEN'>
WHERE = <TokenType.WHERE: 'WHERE'>
WINDOW = <TokenType.WINDOW: 'WINDOW'>
WITH = <TokenType.WITH: 'WITH'>
UNIQUE = <TokenType.UNIQUE: 'UNIQUE'>
VERSION_SNAPSHOT = <TokenType.VERSION_SNAPSHOT: 'VERSION_SNAPSHOT'>
TIMESTAMP_SNAPSHOT = <TokenType.TIMESTAMP_SNAPSHOT: 'TIMESTAMP_SNAPSHOT'>
OPTION = <TokenType.OPTION: 'OPTION'>
SINK = <TokenType.SINK: 'SINK'>
SOURCE = <TokenType.SOURCE: 'SOURCE'>
ANALYZE = <TokenType.ANALYZE: 'ANALYZE'>
NAMESPACE = <TokenType.NAMESPACE: 'NAMESPACE'>
EXPORT = <TokenType.EXPORT: 'EXPORT'>
HIVE_TOKEN_STREAM = <TokenType.HIVE_TOKEN_STREAM: 'HIVE_TOKEN_STREAM'>
class Token:
440class Token:
441    __slots__ = ("token_type", "text", "line", "col", "start", "end", "comments")
442
443    @classmethod
444    def number(cls, number: int) -> Token:
445        """Returns a NUMBER token with `number` as its text."""
446        return cls(TokenType.NUMBER, str(number))
447
448    @classmethod
449    def string(cls, string: str) -> Token:
450        """Returns a STRING token with `string` as its text."""
451        return cls(TokenType.STRING, string)
452
453    @classmethod
454    def identifier(cls, identifier: str) -> Token:
455        """Returns an IDENTIFIER token with `identifier` as its text."""
456        return cls(TokenType.IDENTIFIER, identifier)
457
458    @classmethod
459    def var(cls, var: str) -> Token:
460        """Returns an VAR token with `var` as its text."""
461        return cls(TokenType.VAR, var)
462
463    def __init__(
464        self,
465        token_type: TokenType,
466        text: str,
467        line: int = 1,
468        col: int = 1,
469        start: int = 0,
470        end: int = 0,
471        comments: t.Optional[t.List[str]] = None,
472    ) -> None:
473        """Token initializer.
474
475        Args:
476            token_type: The TokenType Enum.
477            text: The text of the token.
478            line: The line that the token ends on.
479            col: The column that the token ends on.
480            start: The start index of the token.
481            end: The ending index of the token.
482            comments: The comments to attach to the token.
483        """
484        self.token_type = token_type
485        self.text = text
486        self.line = line
487        self.col = col
488        self.start = start
489        self.end = end
490        self.comments = [] if comments is None else comments
491
492    def __repr__(self) -> str:
493        attributes = ", ".join(f"{k}: {getattr(self, k)}" for k in self.__slots__)
494        return f"<Token {attributes}>"
Token( token_type: TokenType, text: str, line: int = 1, col: int = 1, start: int = 0, end: int = 0, comments: Optional[List[str]] = None)
463    def __init__(
464        self,
465        token_type: TokenType,
466        text: str,
467        line: int = 1,
468        col: int = 1,
469        start: int = 0,
470        end: int = 0,
471        comments: t.Optional[t.List[str]] = None,
472    ) -> None:
473        """Token initializer.
474
475        Args:
476            token_type: The TokenType Enum.
477            text: The text of the token.
478            line: The line that the token ends on.
479            col: The column that the token ends on.
480            start: The start index of the token.
481            end: The ending index of the token.
482            comments: The comments to attach to the token.
483        """
484        self.token_type = token_type
485        self.text = text
486        self.line = line
487        self.col = col
488        self.start = start
489        self.end = end
490        self.comments = [] if comments is None else comments

Token initializer.

Arguments:
  • token_type: The TokenType Enum.
  • text: The text of the token.
  • line: The line that the token ends on.
  • col: The column that the token ends on.
  • start: The start index of the token.
  • end: The ending index of the token.
  • comments: The comments to attach to the token.
@classmethod
def number(cls, number: int) -> Token:
443    @classmethod
444    def number(cls, number: int) -> Token:
445        """Returns a NUMBER token with `number` as its text."""
446        return cls(TokenType.NUMBER, str(number))

Returns a NUMBER token with number as its text.

@classmethod
def string(cls, string: str) -> Token:
448    @classmethod
449    def string(cls, string: str) -> Token:
450        """Returns a STRING token with `string` as its text."""
451        return cls(TokenType.STRING, string)

Returns a STRING token with string as its text.

@classmethod
def identifier(cls, identifier: str) -> Token:
453    @classmethod
454    def identifier(cls, identifier: str) -> Token:
455        """Returns an IDENTIFIER token with `identifier` as its text."""
456        return cls(TokenType.IDENTIFIER, identifier)

Returns an IDENTIFIER token with identifier as its text.

@classmethod
def var(cls, var: str) -> Token:
458    @classmethod
459    def var(cls, var: str) -> Token:
460        """Returns an VAR token with `var` as its text."""
461        return cls(TokenType.VAR, var)

Returns an VAR token with var as its text.

token_type
text
line
col
start
end
comments
class Tokenizer:
 604class Tokenizer(metaclass=_Tokenizer):
 605    SINGLE_TOKENS = {
 606        "(": TokenType.L_PAREN,
 607        ")": TokenType.R_PAREN,
 608        "[": TokenType.L_BRACKET,
 609        "]": TokenType.R_BRACKET,
 610        "{": TokenType.L_BRACE,
 611        "}": TokenType.R_BRACE,
 612        "&": TokenType.AMP,
 613        "^": TokenType.CARET,
 614        ":": TokenType.COLON,
 615        ",": TokenType.COMMA,
 616        ".": TokenType.DOT,
 617        "-": TokenType.DASH,
 618        "=": TokenType.EQ,
 619        ">": TokenType.GT,
 620        "<": TokenType.LT,
 621        "%": TokenType.MOD,
 622        "!": TokenType.NOT,
 623        "|": TokenType.PIPE,
 624        "+": TokenType.PLUS,
 625        ";": TokenType.SEMICOLON,
 626        "/": TokenType.SLASH,
 627        "\\": TokenType.BACKSLASH,
 628        "*": TokenType.STAR,
 629        "~": TokenType.TILDA,
 630        "?": TokenType.PLACEHOLDER,
 631        "@": TokenType.PARAMETER,
 632        "#": TokenType.HASH,
 633        # Used for breaking a var like x'y' but nothing else the token type doesn't matter
 634        "'": TokenType.UNKNOWN,
 635        "`": TokenType.UNKNOWN,
 636        '"': TokenType.UNKNOWN,
 637    }
 638
 639    BIT_STRINGS: t.List[str | t.Tuple[str, str]] = []
 640    BYTE_STRINGS: t.List[str | t.Tuple[str, str]] = []
 641    HEX_STRINGS: t.List[str | t.Tuple[str, str]] = []
 642    RAW_STRINGS: t.List[str | t.Tuple[str, str]] = []
 643    HEREDOC_STRINGS: t.List[str | t.Tuple[str, str]] = []
 644    UNICODE_STRINGS: t.List[str | t.Tuple[str, str]] = []
 645    IDENTIFIERS: t.List[str | t.Tuple[str, str]] = ['"']
 646    QUOTES: t.List[t.Tuple[str, str] | str] = ["'"]
 647    STRING_ESCAPES = ["'"]
 648    VAR_SINGLE_TOKENS: t.Set[str] = set()
 649
 650    # The strings in this list can always be used as escapes, regardless of the surrounding
 651    # identifier delimiters. By default, the closing delimiter is assumed to also act as an
 652    # identifier escape, e.g. if we use double-quotes, then they also act as escapes: "x"""
 653    IDENTIFIER_ESCAPES: t.List[str] = []
 654
 655    # Whether the heredoc tags follow the same lexical rules as unquoted identifiers
 656    HEREDOC_TAG_IS_IDENTIFIER = False
 657
 658    # Token that we'll generate as a fallback if the heredoc prefix doesn't correspond to a heredoc
 659    HEREDOC_STRING_ALTERNATIVE = TokenType.VAR
 660
 661    # Whether string escape characters function as such when placed within raw strings
 662    STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS = True
 663
 664    NESTED_COMMENTS = True
 665
 666    HINT_START = "/*+"
 667
 668    TOKENS_PRECEDING_HINT = {TokenType.SELECT, TokenType.INSERT, TokenType.UPDATE, TokenType.DELETE}
 669
 670    # Autofilled
 671    _COMMENTS: t.Dict[str, str] = {}
 672    _FORMAT_STRINGS: t.Dict[str, t.Tuple[str, TokenType]] = {}
 673    _IDENTIFIERS: t.Dict[str, str] = {}
 674    _IDENTIFIER_ESCAPES: t.Set[str] = set()
 675    _QUOTES: t.Dict[str, str] = {}
 676    _STRING_ESCAPES: t.Set[str] = set()
 677    _KEYWORD_TRIE: t.Dict = {}
 678    _RS_TOKENIZER: t.Optional[t.Any] = None
 679
 680    KEYWORDS: t.Dict[str, TokenType] = {
 681        **{f"{{%{postfix}": TokenType.BLOCK_START for postfix in ("", "+", "-")},
 682        **{f"{prefix}%}}": TokenType.BLOCK_END for prefix in ("", "+", "-")},
 683        **{f"{{{{{postfix}": TokenType.BLOCK_START for postfix in ("+", "-")},
 684        **{f"{prefix}}}}}": TokenType.BLOCK_END for prefix in ("+", "-")},
 685        HINT_START: TokenType.HINT,
 686        "==": TokenType.EQ,
 687        "::": TokenType.DCOLON,
 688        "||": TokenType.DPIPE,
 689        "|>": TokenType.PIPE_GT,
 690        ">=": TokenType.GTE,
 691        "<=": TokenType.LTE,
 692        "<>": TokenType.NEQ,
 693        "!=": TokenType.NEQ,
 694        ":=": TokenType.COLON_EQ,
 695        "<=>": TokenType.NULLSAFE_EQ,
 696        "->": TokenType.ARROW,
 697        "->>": TokenType.DARROW,
 698        "=>": TokenType.FARROW,
 699        "#>": TokenType.HASH_ARROW,
 700        "#>>": TokenType.DHASH_ARROW,
 701        "<->": TokenType.LR_ARROW,
 702        "&&": TokenType.DAMP,
 703        "??": TokenType.DQMARK,
 704        "~~~": TokenType.GLOB,
 705        "~~": TokenType.LIKE,
 706        "~~*": TokenType.ILIKE,
 707        "~*": TokenType.IRLIKE,
 708        "ALL": TokenType.ALL,
 709        "ALWAYS": TokenType.ALWAYS,
 710        "AND": TokenType.AND,
 711        "ANTI": TokenType.ANTI,
 712        "ANY": TokenType.ANY,
 713        "ASC": TokenType.ASC,
 714        "AS": TokenType.ALIAS,
 715        "ASOF": TokenType.ASOF,
 716        "AUTOINCREMENT": TokenType.AUTO_INCREMENT,
 717        "AUTO_INCREMENT": TokenType.AUTO_INCREMENT,
 718        "BEGIN": TokenType.BEGIN,
 719        "BETWEEN": TokenType.BETWEEN,
 720        "CACHE": TokenType.CACHE,
 721        "UNCACHE": TokenType.UNCACHE,
 722        "CASE": TokenType.CASE,
 723        "CHARACTER SET": TokenType.CHARACTER_SET,
 724        "CLUSTER BY": TokenType.CLUSTER_BY,
 725        "COLLATE": TokenType.COLLATE,
 726        "COLUMN": TokenType.COLUMN,
 727        "COMMIT": TokenType.COMMIT,
 728        "CONNECT BY": TokenType.CONNECT_BY,
 729        "CONSTRAINT": TokenType.CONSTRAINT,
 730        "COPY": TokenType.COPY,
 731        "CREATE": TokenType.CREATE,
 732        "CROSS": TokenType.CROSS,
 733        "CUBE": TokenType.CUBE,
 734        "CURRENT_DATE": TokenType.CURRENT_DATE,
 735        "CURRENT_SCHEMA": TokenType.CURRENT_SCHEMA,
 736        "CURRENT_TIME": TokenType.CURRENT_TIME,
 737        "CURRENT_TIMESTAMP": TokenType.CURRENT_TIMESTAMP,
 738        "CURRENT_USER": TokenType.CURRENT_USER,
 739        "DATABASE": TokenType.DATABASE,
 740        "DEFAULT": TokenType.DEFAULT,
 741        "DELETE": TokenType.DELETE,
 742        "DESC": TokenType.DESC,
 743        "DESCRIBE": TokenType.DESCRIBE,
 744        "DISTINCT": TokenType.DISTINCT,
 745        "DISTRIBUTE BY": TokenType.DISTRIBUTE_BY,
 746        "DIV": TokenType.DIV,
 747        "DROP": TokenType.DROP,
 748        "ELSE": TokenType.ELSE,
 749        "END": TokenType.END,
 750        "ENUM": TokenType.ENUM,
 751        "ESCAPE": TokenType.ESCAPE,
 752        "EXCEPT": TokenType.EXCEPT,
 753        "EXECUTE": TokenType.EXECUTE,
 754        "EXISTS": TokenType.EXISTS,
 755        "FALSE": TokenType.FALSE,
 756        "FETCH": TokenType.FETCH,
 757        "FILTER": TokenType.FILTER,
 758        "FIRST": TokenType.FIRST,
 759        "FULL": TokenType.FULL,
 760        "FUNCTION": TokenType.FUNCTION,
 761        "FOR": TokenType.FOR,
 762        "FOREIGN KEY": TokenType.FOREIGN_KEY,
 763        "FORMAT": TokenType.FORMAT,
 764        "FROM": TokenType.FROM,
 765        "GEOGRAPHY": TokenType.GEOGRAPHY,
 766        "GEOMETRY": TokenType.GEOMETRY,
 767        "GLOB": TokenType.GLOB,
 768        "GROUP BY": TokenType.GROUP_BY,
 769        "GROUPING SETS": TokenType.GROUPING_SETS,
 770        "HAVING": TokenType.HAVING,
 771        "ILIKE": TokenType.ILIKE,
 772        "IN": TokenType.IN,
 773        "INDEX": TokenType.INDEX,
 774        "INET": TokenType.INET,
 775        "INNER": TokenType.INNER,
 776        "INSERT": TokenType.INSERT,
 777        "INTERVAL": TokenType.INTERVAL,
 778        "INTERSECT": TokenType.INTERSECT,
 779        "INTO": TokenType.INTO,
 780        "IS": TokenType.IS,
 781        "ISNULL": TokenType.ISNULL,
 782        "JOIN": TokenType.JOIN,
 783        "KEEP": TokenType.KEEP,
 784        "KILL": TokenType.KILL,
 785        "LATERAL": TokenType.LATERAL,
 786        "LEFT": TokenType.LEFT,
 787        "LIKE": TokenType.LIKE,
 788        "LIMIT": TokenType.LIMIT,
 789        "LOAD": TokenType.LOAD,
 790        "LOCK": TokenType.LOCK,
 791        "MERGE": TokenType.MERGE,
 792        "NAMESPACE": TokenType.NAMESPACE,
 793        "NATURAL": TokenType.NATURAL,
 794        "NEXT": TokenType.NEXT,
 795        "NOT": TokenType.NOT,
 796        "NOTNULL": TokenType.NOTNULL,
 797        "NULL": TokenType.NULL,
 798        "OBJECT": TokenType.OBJECT,
 799        "OFFSET": TokenType.OFFSET,
 800        "ON": TokenType.ON,
 801        "OR": TokenType.OR,
 802        "XOR": TokenType.XOR,
 803        "ORDER BY": TokenType.ORDER_BY,
 804        "ORDINALITY": TokenType.ORDINALITY,
 805        "OUTER": TokenType.OUTER,
 806        "OVER": TokenType.OVER,
 807        "OVERLAPS": TokenType.OVERLAPS,
 808        "OVERWRITE": TokenType.OVERWRITE,
 809        "PARTITION": TokenType.PARTITION,
 810        "PARTITION BY": TokenType.PARTITION_BY,
 811        "PARTITIONED BY": TokenType.PARTITION_BY,
 812        "PARTITIONED_BY": TokenType.PARTITION_BY,
 813        "PERCENT": TokenType.PERCENT,
 814        "PIVOT": TokenType.PIVOT,
 815        "PRAGMA": TokenType.PRAGMA,
 816        "PRIMARY KEY": TokenType.PRIMARY_KEY,
 817        "PROCEDURE": TokenType.PROCEDURE,
 818        "QUALIFY": TokenType.QUALIFY,
 819        "RANGE": TokenType.RANGE,
 820        "RECURSIVE": TokenType.RECURSIVE,
 821        "REGEXP": TokenType.RLIKE,
 822        "RENAME": TokenType.RENAME,
 823        "REPLACE": TokenType.REPLACE,
 824        "RETURNING": TokenType.RETURNING,
 825        "REFERENCES": TokenType.REFERENCES,
 826        "RIGHT": TokenType.RIGHT,
 827        "RLIKE": TokenType.RLIKE,
 828        "ROLLBACK": TokenType.ROLLBACK,
 829        "ROLLUP": TokenType.ROLLUP,
 830        "ROW": TokenType.ROW,
 831        "ROWS": TokenType.ROWS,
 832        "SCHEMA": TokenType.SCHEMA,
 833        "SELECT": TokenType.SELECT,
 834        "SEMI": TokenType.SEMI,
 835        "SET": TokenType.SET,
 836        "SETTINGS": TokenType.SETTINGS,
 837        "SHOW": TokenType.SHOW,
 838        "SIMILAR TO": TokenType.SIMILAR_TO,
 839        "SOME": TokenType.SOME,
 840        "SORT BY": TokenType.SORT_BY,
 841        "START WITH": TokenType.START_WITH,
 842        "STRAIGHT_JOIN": TokenType.STRAIGHT_JOIN,
 843        "TABLE": TokenType.TABLE,
 844        "TABLESAMPLE": TokenType.TABLE_SAMPLE,
 845        "TEMP": TokenType.TEMPORARY,
 846        "TEMPORARY": TokenType.TEMPORARY,
 847        "THEN": TokenType.THEN,
 848        "TRUE": TokenType.TRUE,
 849        "TRUNCATE": TokenType.TRUNCATE,
 850        "UNION": TokenType.UNION,
 851        "UNKNOWN": TokenType.UNKNOWN,
 852        "UNNEST": TokenType.UNNEST,
 853        "UNPIVOT": TokenType.UNPIVOT,
 854        "UPDATE": TokenType.UPDATE,
 855        "USE": TokenType.USE,
 856        "USING": TokenType.USING,
 857        "UUID": TokenType.UUID,
 858        "VALUES": TokenType.VALUES,
 859        "VIEW": TokenType.VIEW,
 860        "VOLATILE": TokenType.VOLATILE,
 861        "WHEN": TokenType.WHEN,
 862        "WHERE": TokenType.WHERE,
 863        "WINDOW": TokenType.WINDOW,
 864        "WITH": TokenType.WITH,
 865        "APPLY": TokenType.APPLY,
 866        "ARRAY": TokenType.ARRAY,
 867        "BIT": TokenType.BIT,
 868        "BOOL": TokenType.BOOLEAN,
 869        "BOOLEAN": TokenType.BOOLEAN,
 870        "BYTE": TokenType.TINYINT,
 871        "MEDIUMINT": TokenType.MEDIUMINT,
 872        "INT1": TokenType.TINYINT,
 873        "TINYINT": TokenType.TINYINT,
 874        "INT16": TokenType.SMALLINT,
 875        "SHORT": TokenType.SMALLINT,
 876        "SMALLINT": TokenType.SMALLINT,
 877        "HUGEINT": TokenType.INT128,
 878        "UHUGEINT": TokenType.UINT128,
 879        "INT2": TokenType.SMALLINT,
 880        "INTEGER": TokenType.INT,
 881        "INT": TokenType.INT,
 882        "INT4": TokenType.INT,
 883        "INT32": TokenType.INT,
 884        "INT64": TokenType.BIGINT,
 885        "INT128": TokenType.INT128,
 886        "INT256": TokenType.INT256,
 887        "LONG": TokenType.BIGINT,
 888        "BIGINT": TokenType.BIGINT,
 889        "INT8": TokenType.TINYINT,
 890        "UINT": TokenType.UINT,
 891        "UINT128": TokenType.UINT128,
 892        "UINT256": TokenType.UINT256,
 893        "DEC": TokenType.DECIMAL,
 894        "DECIMAL": TokenType.DECIMAL,
 895        "DECIMAL32": TokenType.DECIMAL32,
 896        "DECIMAL64": TokenType.DECIMAL64,
 897        "DECIMAL128": TokenType.DECIMAL128,
 898        "DECIMAL256": TokenType.DECIMAL256,
 899        "BIGDECIMAL": TokenType.BIGDECIMAL,
 900        "BIGNUMERIC": TokenType.BIGDECIMAL,
 901        "LIST": TokenType.LIST,
 902        "MAP": TokenType.MAP,
 903        "NULLABLE": TokenType.NULLABLE,
 904        "NUMBER": TokenType.DECIMAL,
 905        "NUMERIC": TokenType.DECIMAL,
 906        "FIXED": TokenType.DECIMAL,
 907        "REAL": TokenType.FLOAT,
 908        "FLOAT": TokenType.FLOAT,
 909        "FLOAT4": TokenType.FLOAT,
 910        "FLOAT8": TokenType.DOUBLE,
 911        "DOUBLE": TokenType.DOUBLE,
 912        "DOUBLE PRECISION": TokenType.DOUBLE,
 913        "JSON": TokenType.JSON,
 914        "JSONB": TokenType.JSONB,
 915        "CHAR": TokenType.CHAR,
 916        "CHARACTER": TokenType.CHAR,
 917        "CHAR VARYING": TokenType.VARCHAR,
 918        "CHARACTER VARYING": TokenType.VARCHAR,
 919        "NCHAR": TokenType.NCHAR,
 920        "VARCHAR": TokenType.VARCHAR,
 921        "VARCHAR2": TokenType.VARCHAR,
 922        "NVARCHAR": TokenType.NVARCHAR,
 923        "NVARCHAR2": TokenType.NVARCHAR,
 924        "BPCHAR": TokenType.BPCHAR,
 925        "STR": TokenType.TEXT,
 926        "STRING": TokenType.TEXT,
 927        "TEXT": TokenType.TEXT,
 928        "LONGTEXT": TokenType.LONGTEXT,
 929        "MEDIUMTEXT": TokenType.MEDIUMTEXT,
 930        "TINYTEXT": TokenType.TINYTEXT,
 931        "CLOB": TokenType.TEXT,
 932        "LONGVARCHAR": TokenType.TEXT,
 933        "BINARY": TokenType.BINARY,
 934        "BLOB": TokenType.VARBINARY,
 935        "LONGBLOB": TokenType.LONGBLOB,
 936        "MEDIUMBLOB": TokenType.MEDIUMBLOB,
 937        "TINYBLOB": TokenType.TINYBLOB,
 938        "BYTEA": TokenType.VARBINARY,
 939        "VARBINARY": TokenType.VARBINARY,
 940        "TIME": TokenType.TIME,
 941        "TIMETZ": TokenType.TIMETZ,
 942        "TIMESTAMP": TokenType.TIMESTAMP,
 943        "TIMESTAMPTZ": TokenType.TIMESTAMPTZ,
 944        "TIMESTAMPLTZ": TokenType.TIMESTAMPLTZ,
 945        "TIMESTAMP_LTZ": TokenType.TIMESTAMPLTZ,
 946        "TIMESTAMPNTZ": TokenType.TIMESTAMPNTZ,
 947        "TIMESTAMP_NTZ": TokenType.TIMESTAMPNTZ,
 948        "DATE": TokenType.DATE,
 949        "DATETIME": TokenType.DATETIME,
 950        "INT4RANGE": TokenType.INT4RANGE,
 951        "INT4MULTIRANGE": TokenType.INT4MULTIRANGE,
 952        "INT8RANGE": TokenType.INT8RANGE,
 953        "INT8MULTIRANGE": TokenType.INT8MULTIRANGE,
 954        "NUMRANGE": TokenType.NUMRANGE,
 955        "NUMMULTIRANGE": TokenType.NUMMULTIRANGE,
 956        "TSRANGE": TokenType.TSRANGE,
 957        "TSMULTIRANGE": TokenType.TSMULTIRANGE,
 958        "TSTZRANGE": TokenType.TSTZRANGE,
 959        "TSTZMULTIRANGE": TokenType.TSTZMULTIRANGE,
 960        "DATERANGE": TokenType.DATERANGE,
 961        "DATEMULTIRANGE": TokenType.DATEMULTIRANGE,
 962        "UNIQUE": TokenType.UNIQUE,
 963        "VECTOR": TokenType.VECTOR,
 964        "STRUCT": TokenType.STRUCT,
 965        "SEQUENCE": TokenType.SEQUENCE,
 966        "VARIANT": TokenType.VARIANT,
 967        "ALTER": TokenType.ALTER,
 968        "ANALYZE": TokenType.ANALYZE,
 969        "CALL": TokenType.COMMAND,
 970        "COMMENT": TokenType.COMMENT,
 971        "EXPLAIN": TokenType.COMMAND,
 972        "GRANT": TokenType.GRANT,
 973        "OPTIMIZE": TokenType.COMMAND,
 974        "PREPARE": TokenType.COMMAND,
 975        "VACUUM": TokenType.COMMAND,
 976        "USER-DEFINED": TokenType.USERDEFINED,
 977        "FOR VERSION": TokenType.VERSION_SNAPSHOT,
 978        "FOR TIMESTAMP": TokenType.TIMESTAMP_SNAPSHOT,
 979    }
 980
 981    WHITE_SPACE: t.Dict[t.Optional[str], TokenType] = {
 982        " ": TokenType.SPACE,
 983        "\t": TokenType.SPACE,
 984        "\n": TokenType.BREAK,
 985        "\r": TokenType.BREAK,
 986    }
 987
 988    COMMANDS = {
 989        TokenType.COMMAND,
 990        TokenType.EXECUTE,
 991        TokenType.FETCH,
 992        TokenType.SHOW,
 993        TokenType.RENAME,
 994    }
 995
 996    COMMAND_PREFIX_TOKENS = {TokenType.SEMICOLON, TokenType.BEGIN}
 997
 998    # Handle numeric literals like in hive (3L = BIGINT)
 999    NUMERIC_LITERALS: t.Dict[str, str] = {}
1000
1001    COMMENTS = ["--", ("/*", "*/")]
1002
1003    __slots__ = (
1004        "sql",
1005        "size",
1006        "tokens",
1007        "dialect",
1008        "use_rs_tokenizer",
1009        "_start",
1010        "_current",
1011        "_line",
1012        "_col",
1013        "_comments",
1014        "_char",
1015        "_end",
1016        "_peek",
1017        "_prev_token_line",
1018        "_rs_dialect_settings",
1019    )
1020
1021    def __init__(
1022        self,
1023        dialect: DialectType = None,
1024        use_rs_tokenizer: t.Optional[bool] = None,
1025        **opts: t.Any,
1026    ) -> None:
1027        from sqlglot.dialects import Dialect
1028
1029        self.dialect = Dialect.get_or_raise(dialect)
1030
1031        # initialize `use_rs_tokenizer`, and allow it to be overwritten per Tokenizer instance
1032        self.use_rs_tokenizer = (
1033            use_rs_tokenizer if use_rs_tokenizer is not None else USE_RS_TOKENIZER
1034        )
1035
1036        if self.use_rs_tokenizer:
1037            self._rs_dialect_settings = RsTokenizerDialectSettings(
1038                unescaped_sequences=self.dialect.UNESCAPED_SEQUENCES,
1039                identifiers_can_start_with_digit=self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT,
1040                numbers_can_be_underscore_separated=self.dialect.NUMBERS_CAN_BE_UNDERSCORE_SEPARATED,
1041            )
1042
1043        self.reset()
1044
1045    def reset(self) -> None:
1046        self.sql = ""
1047        self.size = 0
1048        self.tokens: t.List[Token] = []
1049        self._start = 0
1050        self._current = 0
1051        self._line = 1
1052        self._col = 0
1053        self._comments: t.List[str] = []
1054
1055        self._char = ""
1056        self._end = False
1057        self._peek = ""
1058        self._prev_token_line = -1
1059
1060    def tokenize(self, sql: str) -> t.List[Token]:
1061        """Returns a list of tokens corresponding to the SQL string `sql`."""
1062        if self.use_rs_tokenizer:
1063            return self.tokenize_rs(sql)
1064
1065        self.reset()
1066        self.sql = sql
1067        self.size = len(sql)
1068
1069        try:
1070            self._scan()
1071        except Exception as e:
1072            start = max(self._current - 50, 0)
1073            end = min(self._current + 50, self.size - 1)
1074            context = self.sql[start:end]
1075            raise TokenError(f"Error tokenizing '{context}'") from e
1076
1077        return self.tokens
1078
1079    def _scan(self, until: t.Optional[t.Callable] = None) -> None:
1080        while self.size and not self._end:
1081            current = self._current
1082
1083            # Skip spaces here rather than iteratively calling advance() for performance reasons
1084            while current < self.size:
1085                char = self.sql[current]
1086
1087                if char.isspace() and (char == " " or char == "\t"):
1088                    current += 1
1089                else:
1090                    break
1091
1092            offset = current - self._current if current > self._current else 1
1093
1094            self._start = current
1095            self._advance(offset)
1096
1097            if not self._char.isspace():
1098                if self._char.isdigit():
1099                    self._scan_number()
1100                elif self._char in self._IDENTIFIERS:
1101                    self._scan_identifier(self._IDENTIFIERS[self._char])
1102                else:
1103                    self._scan_keywords()
1104
1105            if until and until():
1106                break
1107
1108        if self.tokens and self._comments:
1109            self.tokens[-1].comments.extend(self._comments)
1110
1111    def _chars(self, size: int) -> str:
1112        if size == 1:
1113            return self._char
1114
1115        start = self._current - 1
1116        end = start + size
1117
1118        return self.sql[start:end] if end <= self.size else ""
1119
1120    def _advance(self, i: int = 1, alnum: bool = False) -> None:
1121        if self.WHITE_SPACE.get(self._char) is TokenType.BREAK:
1122            # Ensures we don't count an extra line if we get a \r\n line break sequence
1123            if not (self._char == "\r" and self._peek == "\n"):
1124                self._col = i
1125                self._line += 1
1126        else:
1127            self._col += i
1128
1129        self._current += i
1130        self._end = self._current >= self.size
1131        self._char = self.sql[self._current - 1]
1132        self._peek = "" if self._end else self.sql[self._current]
1133
1134        if alnum and self._char.isalnum():
1135            # Here we use local variables instead of attributes for better performance
1136            _col = self._col
1137            _current = self._current
1138            _end = self._end
1139            _peek = self._peek
1140
1141            while _peek.isalnum():
1142                _col += 1
1143                _current += 1
1144                _end = _current >= self.size
1145                _peek = "" if _end else self.sql[_current]
1146
1147            self._col = _col
1148            self._current = _current
1149            self._end = _end
1150            self._peek = _peek
1151            self._char = self.sql[_current - 1]
1152
1153    @property
1154    def _text(self) -> str:
1155        return self.sql[self._start : self._current]
1156
1157    def _add(self, token_type: TokenType, text: t.Optional[str] = None) -> None:
1158        self._prev_token_line = self._line
1159
1160        if self._comments and token_type == TokenType.SEMICOLON and self.tokens:
1161            self.tokens[-1].comments.extend(self._comments)
1162            self._comments = []
1163
1164        self.tokens.append(
1165            Token(
1166                token_type,
1167                text=self._text if text is None else text,
1168                line=self._line,
1169                col=self._col,
1170                start=self._start,
1171                end=self._current - 1,
1172                comments=self._comments,
1173            )
1174        )
1175        self._comments = []
1176
1177        # If we have either a semicolon or a begin token before the command's token, we'll parse
1178        # whatever follows the command's token as a string
1179        if (
1180            token_type in self.COMMANDS
1181            and self._peek != ";"
1182            and (len(self.tokens) == 1 or self.tokens[-2].token_type in self.COMMAND_PREFIX_TOKENS)
1183        ):
1184            start = self._current
1185            tokens = len(self.tokens)
1186            self._scan(lambda: self._peek == ";")
1187            self.tokens = self.tokens[:tokens]
1188            text = self.sql[start : self._current].strip()
1189            if text:
1190                self._add(TokenType.STRING, text)
1191
1192    def _scan_keywords(self) -> None:
1193        size = 0
1194        word = None
1195        chars = self._text
1196        char = chars
1197        prev_space = False
1198        skip = False
1199        trie = self._KEYWORD_TRIE
1200        single_token = char in self.SINGLE_TOKENS
1201
1202        while chars:
1203            if skip:
1204                result = TrieResult.PREFIX
1205            else:
1206                result, trie = in_trie(trie, char.upper())
1207
1208            if result == TrieResult.FAILED:
1209                break
1210            if result == TrieResult.EXISTS:
1211                word = chars
1212
1213            end = self._current + size
1214            size += 1
1215
1216            if end < self.size:
1217                char = self.sql[end]
1218                single_token = single_token or char in self.SINGLE_TOKENS
1219                is_space = char.isspace()
1220
1221                if not is_space or not prev_space:
1222                    if is_space:
1223                        char = " "
1224                    chars += char
1225                    prev_space = is_space
1226                    skip = False
1227                else:
1228                    skip = True
1229            else:
1230                char = ""
1231                break
1232
1233        if word:
1234            if self._scan_string(word):
1235                return
1236            if self._scan_comment(word):
1237                return
1238            if prev_space or single_token or not char:
1239                self._advance(size - 1)
1240                word = word.upper()
1241                self._add(self.KEYWORDS[word], text=word)
1242                return
1243
1244        if self._char in self.SINGLE_TOKENS:
1245            self._add(self.SINGLE_TOKENS[self._char], text=self._char)
1246            return
1247
1248        self._scan_var()
1249
1250    def _scan_comment(self, comment_start: str) -> bool:
1251        if comment_start not in self._COMMENTS:
1252            return False
1253
1254        comment_start_line = self._line
1255        comment_start_size = len(comment_start)
1256        comment_end = self._COMMENTS[comment_start]
1257
1258        if comment_end:
1259            # Skip the comment's start delimiter
1260            self._advance(comment_start_size)
1261
1262            comment_count = 1
1263            comment_end_size = len(comment_end)
1264
1265            while not self._end:
1266                if self._chars(comment_end_size) == comment_end:
1267                    comment_count -= 1
1268                    if not comment_count:
1269                        break
1270
1271                self._advance(alnum=True)
1272
1273                # Nested comments are allowed by some dialects, e.g. databricks, duckdb, postgres
1274                if (
1275                    self.NESTED_COMMENTS
1276                    and not self._end
1277                    and self._chars(comment_end_size) == comment_start
1278                ):
1279                    self._advance(comment_start_size)
1280                    comment_count += 1
1281
1282            self._comments.append(self._text[comment_start_size : -comment_end_size + 1])
1283            self._advance(comment_end_size - 1)
1284        else:
1285            while not self._end and self.WHITE_SPACE.get(self._peek) is not TokenType.BREAK:
1286                self._advance(alnum=True)
1287            self._comments.append(self._text[comment_start_size:])
1288
1289        if (
1290            comment_start == self.HINT_START
1291            and self.tokens
1292            and self.tokens[-1].token_type in self.TOKENS_PRECEDING_HINT
1293        ):
1294            self._add(TokenType.HINT)
1295
1296        # Leading comment is attached to the succeeding token, whilst trailing comment to the preceding.
1297        # Multiple consecutive comments are preserved by appending them to the current comments list.
1298        if comment_start_line == self._prev_token_line:
1299            self.tokens[-1].comments.extend(self._comments)
1300            self._comments = []
1301            self._prev_token_line = self._line
1302
1303        return True
1304
1305    def _scan_number(self) -> None:
1306        if self._char == "0":
1307            peek = self._peek.upper()
1308            if peek == "B":
1309                return self._scan_bits() if self.BIT_STRINGS else self._add(TokenType.NUMBER)
1310            elif peek == "X":
1311                return self._scan_hex() if self.HEX_STRINGS else self._add(TokenType.NUMBER)
1312
1313        decimal = False
1314        scientific = 0
1315
1316        while True:
1317            if self._peek.isdigit():
1318                self._advance()
1319            elif self._peek == "." and not decimal:
1320                if self.tokens and self.tokens[-1].token_type == TokenType.PARAMETER:
1321                    return self._add(TokenType.NUMBER)
1322                decimal = True
1323                self._advance()
1324            elif self._peek in ("-", "+") and scientific == 1:
1325                scientific += 1
1326                self._advance()
1327            elif self._peek.upper() == "E" and not scientific:
1328                scientific += 1
1329                self._advance()
1330            elif self._peek.isidentifier():
1331                number_text = self._text
1332                literal = ""
1333
1334                while self._peek.strip() and self._peek not in self.SINGLE_TOKENS:
1335                    literal += self._peek
1336                    self._advance()
1337
1338                token_type = self.KEYWORDS.get(self.NUMERIC_LITERALS.get(literal.upper(), ""))
1339
1340                if token_type:
1341                    self._add(TokenType.NUMBER, number_text)
1342                    self._add(TokenType.DCOLON, "::")
1343                    return self._add(token_type, literal)
1344                else:
1345                    replaced = literal.replace("_", "")
1346                    if self.dialect.NUMBERS_CAN_BE_UNDERSCORE_SEPARATED and replaced.isdigit():
1347                        return self._add(TokenType.NUMBER, number_text + replaced)
1348                    if self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT:
1349                        return self._add(TokenType.VAR)
1350
1351                self._advance(-len(literal))
1352                return self._add(TokenType.NUMBER, number_text)
1353            else:
1354                return self._add(TokenType.NUMBER)
1355
1356    def _scan_bits(self) -> None:
1357        self._advance()
1358        value = self._extract_value()
1359        try:
1360            # If `value` can't be converted to a binary, fallback to tokenizing it as an identifier
1361            int(value, 2)
1362            self._add(TokenType.BIT_STRING, value[2:])  # Drop the 0b
1363        except ValueError:
1364            self._add(TokenType.IDENTIFIER)
1365
1366    def _scan_hex(self) -> None:
1367        self._advance()
1368        value = self._extract_value()
1369        try:
1370            # If `value` can't be converted to a hex, fallback to tokenizing it as an identifier
1371            int(value, 16)
1372            self._add(TokenType.HEX_STRING, value[2:])  # Drop the 0x
1373        except ValueError:
1374            self._add(TokenType.IDENTIFIER)
1375
1376    def _extract_value(self) -> str:
1377        while True:
1378            char = self._peek.strip()
1379            if char and char not in self.SINGLE_TOKENS:
1380                self._advance(alnum=True)
1381            else:
1382                break
1383
1384        return self._text
1385
1386    def _scan_string(self, start: str) -> bool:
1387        base = None
1388        token_type = TokenType.STRING
1389
1390        if start in self._QUOTES:
1391            end = self._QUOTES[start]
1392        elif start in self._FORMAT_STRINGS:
1393            end, token_type = self._FORMAT_STRINGS[start]
1394
1395            if token_type == TokenType.HEX_STRING:
1396                base = 16
1397            elif token_type == TokenType.BIT_STRING:
1398                base = 2
1399            elif token_type == TokenType.HEREDOC_STRING:
1400                self._advance()
1401
1402                if self._char == end:
1403                    tag = ""
1404                else:
1405                    tag = self._extract_string(
1406                        end,
1407                        raw_string=True,
1408                        raise_unmatched=not self.HEREDOC_TAG_IS_IDENTIFIER,
1409                    )
1410
1411                if tag and self.HEREDOC_TAG_IS_IDENTIFIER and (self._end or not tag.isidentifier()):
1412                    if not self._end:
1413                        self._advance(-1)
1414
1415                    self._advance(-len(tag))
1416                    self._add(self.HEREDOC_STRING_ALTERNATIVE)
1417                    return True
1418
1419                end = f"{start}{tag}{end}"
1420        else:
1421            return False
1422
1423        self._advance(len(start))
1424        text = self._extract_string(end, raw_string=token_type == TokenType.RAW_STRING)
1425
1426        if base:
1427            try:
1428                int(text, base)
1429            except Exception:
1430                raise TokenError(
1431                    f"Numeric string contains invalid characters from {self._line}:{self._start}"
1432                )
1433
1434        self._add(token_type, text)
1435        return True
1436
1437    def _scan_identifier(self, identifier_end: str) -> None:
1438        self._advance()
1439        text = self._extract_string(
1440            identifier_end, escapes=self._IDENTIFIER_ESCAPES | {identifier_end}
1441        )
1442        self._add(TokenType.IDENTIFIER, text)
1443
1444    def _scan_var(self) -> None:
1445        while True:
1446            char = self._peek.strip()
1447            if char and (char in self.VAR_SINGLE_TOKENS or char not in self.SINGLE_TOKENS):
1448                self._advance(alnum=True)
1449            else:
1450                break
1451
1452        self._add(
1453            TokenType.VAR
1454            if self.tokens and self.tokens[-1].token_type == TokenType.PARAMETER
1455            else self.KEYWORDS.get(self._text.upper(), TokenType.VAR)
1456        )
1457
1458    def _extract_string(
1459        self,
1460        delimiter: str,
1461        escapes: t.Optional[t.Set[str]] = None,
1462        raw_string: bool = False,
1463        raise_unmatched: bool = True,
1464    ) -> str:
1465        text = ""
1466        delim_size = len(delimiter)
1467        escapes = self._STRING_ESCAPES if escapes is None else escapes
1468
1469        while True:
1470            if (
1471                not raw_string
1472                and self.dialect.UNESCAPED_SEQUENCES
1473                and self._peek
1474                and self._char in self.STRING_ESCAPES
1475            ):
1476                unescaped_sequence = self.dialect.UNESCAPED_SEQUENCES.get(self._char + self._peek)
1477                if unescaped_sequence:
1478                    self._advance(2)
1479                    text += unescaped_sequence
1480                    continue
1481            if (
1482                (self.STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS or not raw_string)
1483                and self._char in escapes
1484                and (self._peek == delimiter or self._peek in escapes)
1485                and (self._char not in self._QUOTES or self._char == self._peek)
1486            ):
1487                if self._peek == delimiter:
1488                    text += self._peek
1489                else:
1490                    text += self._char + self._peek
1491
1492                if self._current + 1 < self.size:
1493                    self._advance(2)
1494                else:
1495                    raise TokenError(f"Missing {delimiter} from {self._line}:{self._current}")
1496            else:
1497                if self._chars(delim_size) == delimiter:
1498                    if delim_size > 1:
1499                        self._advance(delim_size - 1)
1500                    break
1501
1502                if self._end:
1503                    if not raise_unmatched:
1504                        return text + self._char
1505
1506                    raise TokenError(f"Missing {delimiter} from {self._line}:{self._start}")
1507
1508                current = self._current - 1
1509                self._advance(alnum=True)
1510                text += self.sql[current : self._current - 1]
1511
1512        return text
1513
1514    def tokenize_rs(self, sql: str) -> t.List[Token]:
1515        if not self._RS_TOKENIZER:
1516            raise SqlglotError("Rust tokenizer is not available")
1517
1518        tokens, error_msg = self._RS_TOKENIZER.tokenize(sql, self._rs_dialect_settings)
1519        for token in tokens:
1520            token.token_type = _ALL_TOKEN_TYPES[token.token_type_index]
1521
1522        # Setting this here so partial token lists can be inspected even if there is a failure
1523        self.tokens = tokens
1524
1525        if error_msg is not None:
1526            raise TokenError(error_msg)
1527
1528        return tokens
Tokenizer( dialect: Union[str, sqlglot.dialects.Dialect, Type[sqlglot.dialects.Dialect], NoneType] = None, use_rs_tokenizer: Optional[bool] = None, **opts: Any)
1021    def __init__(
1022        self,
1023        dialect: DialectType = None,
1024        use_rs_tokenizer: t.Optional[bool] = None,
1025        **opts: t.Any,
1026    ) -> None:
1027        from sqlglot.dialects import Dialect
1028
1029        self.dialect = Dialect.get_or_raise(dialect)
1030
1031        # initialize `use_rs_tokenizer`, and allow it to be overwritten per Tokenizer instance
1032        self.use_rs_tokenizer = (
1033            use_rs_tokenizer if use_rs_tokenizer is not None else USE_RS_TOKENIZER
1034        )
1035
1036        if self.use_rs_tokenizer:
1037            self._rs_dialect_settings = RsTokenizerDialectSettings(
1038                unescaped_sequences=self.dialect.UNESCAPED_SEQUENCES,
1039                identifiers_can_start_with_digit=self.dialect.IDENTIFIERS_CAN_START_WITH_DIGIT,
1040                numbers_can_be_underscore_separated=self.dialect.NUMBERS_CAN_BE_UNDERSCORE_SEPARATED,
1041            )
1042
1043        self.reset()
SINGLE_TOKENS = {'(': <TokenType.L_PAREN: 'L_PAREN'>, ')': <TokenType.R_PAREN: 'R_PAREN'>, '[': <TokenType.L_BRACKET: 'L_BRACKET'>, ']': <TokenType.R_BRACKET: 'R_BRACKET'>, '{': <TokenType.L_BRACE: 'L_BRACE'>, '}': <TokenType.R_BRACE: 'R_BRACE'>, '&': <TokenType.AMP: 'AMP'>, '^': <TokenType.CARET: 'CARET'>, ':': <TokenType.COLON: 'COLON'>, ',': <TokenType.COMMA: 'COMMA'>, '.': <TokenType.DOT: 'DOT'>, '-': <TokenType.DASH: 'DASH'>, '=': <TokenType.EQ: 'EQ'>, '>': <TokenType.GT: 'GT'>, '<': <TokenType.LT: 'LT'>, '%': <TokenType.MOD: 'MOD'>, '!': <TokenType.NOT: 'NOT'>, '|': <TokenType.PIPE: 'PIPE'>, '+': <TokenType.PLUS: 'PLUS'>, ';': <TokenType.SEMICOLON: 'SEMICOLON'>, '/': <TokenType.SLASH: 'SLASH'>, '\\': <TokenType.BACKSLASH: 'BACKSLASH'>, '*': <TokenType.STAR: 'STAR'>, '~': <TokenType.TILDA: 'TILDA'>, '?': <TokenType.PLACEHOLDER: 'PLACEHOLDER'>, '@': <TokenType.PARAMETER: 'PARAMETER'>, '#': <TokenType.HASH: 'HASH'>, "'": <TokenType.UNKNOWN: 'UNKNOWN'>, '`': <TokenType.UNKNOWN: 'UNKNOWN'>, '"': <TokenType.UNKNOWN: 'UNKNOWN'>}
BIT_STRINGS: List[Union[str, Tuple[str, str]]] = []
BYTE_STRINGS: List[Union[str, Tuple[str, str]]] = []
HEX_STRINGS: List[Union[str, Tuple[str, str]]] = []
RAW_STRINGS: List[Union[str, Tuple[str, str]]] = []
HEREDOC_STRINGS: List[Union[str, Tuple[str, str]]] = []
UNICODE_STRINGS: List[Union[str, Tuple[str, str]]] = []
IDENTIFIERS: List[Union[str, Tuple[str, str]]] = ['"']
QUOTES: List[Union[str, Tuple[str, str]]] = ["'"]
STRING_ESCAPES = ["'"]
VAR_SINGLE_TOKENS: Set[str] = set()
IDENTIFIER_ESCAPES: List[str] = []
HEREDOC_TAG_IS_IDENTIFIER = False
HEREDOC_STRING_ALTERNATIVE = <TokenType.VAR: 'VAR'>
STRING_ESCAPES_ALLOWED_IN_RAW_STRINGS = True
NESTED_COMMENTS = True
HINT_START = '/*+'
TOKENS_PRECEDING_HINT = {<TokenType.DELETE: 'DELETE'>, <TokenType.SELECT: 'SELECT'>, <TokenType.INSERT: 'INSERT'>, <TokenType.UPDATE: 'UPDATE'>}
KEYWORDS: Dict[str, TokenType] = {'{%': <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.PIPE_GT: 'PIPE_GT'>, '>=': <TokenType.GTE: 'GTE'>, '<=': <TokenType.LTE: 'LTE'>, '<>': <TokenType.NEQ: 'NEQ'>, '!=': <TokenType.NEQ: 'NEQ'>, ':=': <TokenType.COLON_EQ: 'COLON_EQ'>, '<=>': <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'>, '~~~': <TokenType.GLOB: 'GLOB'>, '~~': <TokenType.LIKE: 'LIKE'>, '~~*': <TokenType.ILIKE: 'ILIKE'>, '~*': <TokenType.IRLIKE: 'IRLIKE'>, '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'>, 'COPY': <TokenType.COPY: 'COPY'>, 'CREATE': <TokenType.CREATE: 'CREATE'>, 'CROSS': <TokenType.CROSS: 'CROSS'>, 'CUBE': <TokenType.CUBE: 'CUBE'>, 'CURRENT_DATE': <TokenType.CURRENT_DATE: 'CURRENT_DATE'>, 'CURRENT_SCHEMA': <TokenType.CURRENT_SCHEMA: 'CURRENT_SCHEMA'>, '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'>, 'ENUM': <TokenType.ENUM: 'ENUM'>, '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'>, 'KILL': <TokenType.KILL: 'KILL'>, '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'>, 'NAMESPACE': <TokenType.NAMESPACE: 'NAMESPACE'>, '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'>, 'RENAME': <TokenType.RENAME: 'RENAME'>, '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'>, 'STRAIGHT_JOIN': <TokenType.STRAIGHT_JOIN: 'STRAIGHT_JOIN'>, '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'>, 'TRUNCATE': <TokenType.TRUNCATE: 'TRUNCATE'>, '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'>, 'INT1': <TokenType.TINYINT: 'TINYINT'>, 'TINYINT': <TokenType.TINYINT: 'TINYINT'>, 'INT16': <TokenType.SMALLINT: 'SMALLINT'>, 'SHORT': <TokenType.SMALLINT: 'SMALLINT'>, 'SMALLINT': <TokenType.SMALLINT: 'SMALLINT'>, 'HUGEINT': <TokenType.INT128: 'INT128'>, 'UHUGEINT': <TokenType.UINT128: 'UINT128'>, 'INT2': <TokenType.SMALLINT: 'SMALLINT'>, 'INTEGER': <TokenType.INT: 'INT'>, 'INT': <TokenType.INT: 'INT'>, 'INT4': <TokenType.INT: 'INT'>, 'INT32': <TokenType.INT: 'INT'>, 'INT64': <TokenType.BIGINT: 'BIGINT'>, 'INT128': <TokenType.INT128: 'INT128'>, 'INT256': <TokenType.INT256: 'INT256'>, 'LONG': <TokenType.BIGINT: 'BIGINT'>, 'BIGINT': <TokenType.BIGINT: 'BIGINT'>, 'INT8': <TokenType.TINYINT: 'TINYINT'>, 'UINT': <TokenType.UINT: 'UINT'>, 'UINT128': <TokenType.UINT128: 'UINT128'>, 'UINT256': <TokenType.UINT256: 'UINT256'>, 'DEC': <TokenType.DECIMAL: 'DECIMAL'>, 'DECIMAL': <TokenType.DECIMAL: 'DECIMAL'>, 'DECIMAL32': <TokenType.DECIMAL32: 'DECIMAL32'>, 'DECIMAL64': <TokenType.DECIMAL64: 'DECIMAL64'>, 'DECIMAL128': <TokenType.DECIMAL128: 'DECIMAL128'>, 'DECIMAL256': <TokenType.DECIMAL256: 'DECIMAL256'>, 'BIGDECIMAL': <TokenType.BIGDECIMAL: 'BIGDECIMAL'>, 'BIGNUMERIC': <TokenType.BIGDECIMAL: 'BIGDECIMAL'>, 'LIST': <TokenType.LIST: 'LIST'>, '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'>, 'JSONB': <TokenType.JSONB: 'JSONB'>, 'CHAR': <TokenType.CHAR: 'CHAR'>, 'CHARACTER': <TokenType.CHAR: 'CHAR'>, 'CHAR VARYING': <TokenType.VARCHAR: 'VARCHAR'>, 'CHARACTER VARYING': <TokenType.VARCHAR: 'VARCHAR'>, 'NCHAR': <TokenType.NCHAR: 'NCHAR'>, 'VARCHAR': <TokenType.VARCHAR: 'VARCHAR'>, 'VARCHAR2': <TokenType.VARCHAR: 'VARCHAR'>, 'NVARCHAR': <TokenType.NVARCHAR: 'NVARCHAR'>, 'NVARCHAR2': <TokenType.NVARCHAR: 'NVARCHAR'>, 'BPCHAR': <TokenType.BPCHAR: 'BPCHAR'>, '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'>, 'TIMESTAMP_LTZ': <TokenType.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>, 'TIMESTAMPNTZ': <TokenType.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>, 'TIMESTAMP_NTZ': <TokenType.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>, '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'>, 'VECTOR': <TokenType.VECTOR: 'VECTOR'>, 'STRUCT': <TokenType.STRUCT: 'STRUCT'>, 'SEQUENCE': <TokenType.SEQUENCE: 'SEQUENCE'>, 'VARIANT': <TokenType.VARIANT: 'VARIANT'>, 'ALTER': <TokenType.ALTER: 'ALTER'>, 'ANALYZE': <TokenType.ANALYZE: 'ANALYZE'>, 'CALL': <TokenType.COMMAND: 'COMMAND'>, 'COMMENT': <TokenType.COMMENT: 'COMMENT'>, 'EXPLAIN': <TokenType.COMMAND: 'COMMAND'>, 'GRANT': <TokenType.GRANT: 'GRANT'>, 'OPTIMIZE': <TokenType.COMMAND: 'COMMAND'>, 'PREPARE': <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'>}
WHITE_SPACE: Dict[Optional[str], TokenType] = {' ': <TokenType.SPACE: 'SPACE'>, '\t': <TokenType.SPACE: 'SPACE'>, '\n': <TokenType.BREAK: 'BREAK'>, '\r': <TokenType.BREAK: 'BREAK'>}
COMMANDS = {<TokenType.COMMAND: 'COMMAND'>, <TokenType.SHOW: 'SHOW'>, <TokenType.RENAME: 'RENAME'>, <TokenType.FETCH: 'FETCH'>, <TokenType.EXECUTE: 'EXECUTE'>}
COMMAND_PREFIX_TOKENS = {<TokenType.SEMICOLON: 'SEMICOLON'>, <TokenType.BEGIN: 'BEGIN'>}
NUMERIC_LITERALS: Dict[str, str] = {}
COMMENTS = ['--', ('/*', '*/')]
dialect
use_rs_tokenizer
def reset(self) -> None:
1045    def reset(self) -> None:
1046        self.sql = ""
1047        self.size = 0
1048        self.tokens: t.List[Token] = []
1049        self._start = 0
1050        self._current = 0
1051        self._line = 1
1052        self._col = 0
1053        self._comments: t.List[str] = []
1054
1055        self._char = ""
1056        self._end = False
1057        self._peek = ""
1058        self._prev_token_line = -1
def tokenize(self, sql: str) -> List[Token]:
1060    def tokenize(self, sql: str) -> t.List[Token]:
1061        """Returns a list of tokens corresponding to the SQL string `sql`."""
1062        if self.use_rs_tokenizer:
1063            return self.tokenize_rs(sql)
1064
1065        self.reset()
1066        self.sql = sql
1067        self.size = len(sql)
1068
1069        try:
1070            self._scan()
1071        except Exception as e:
1072            start = max(self._current - 50, 0)
1073            end = min(self._current + 50, self.size - 1)
1074            context = self.sql[start:end]
1075            raise TokenError(f"Error tokenizing '{context}'") from e
1076
1077        return self.tokens

Returns a list of tokens corresponding to the SQL string sql.

def tokenize_rs(self, sql: str) -> List[Token]:
1514    def tokenize_rs(self, sql: str) -> t.List[Token]:
1515        if not self._RS_TOKENIZER:
1516            raise SqlglotError("Rust tokenizer is not available")
1517
1518        tokens, error_msg = self._RS_TOKENIZER.tokenize(sql, self._rs_dialect_settings)
1519        for token in tokens:
1520            token.token_type = _ALL_TOKEN_TYPES[token.token_type_index]
1521
1522        # Setting this here so partial token lists can be inspected even if there is a failure
1523        self.tokens = tokens
1524
1525        if error_msg is not None:
1526            raise TokenError(error_msg)
1527
1528        return tokens
size
sql
tokens