Edit on GitHub

Expressions

Every AST node in SQLGlot is represented by a subclass of Expression.

This module contains the implementation of all supported Expression types. Additionally, it exposes a number of helper functions, which are mainly used to programmatically build SQL expressions, such as sqlglot.expressions.select.


   1"""
   2## Expressions
   3
   4Every AST node in SQLGlot is represented by a subclass of `Expression`.
   5
   6This module contains the implementation of all supported `Expression` types. Additionally,
   7it exposes a number of helper functions, which are mainly used to programmatically build
   8SQL expressions, such as `sqlglot.expressions.select`.
   9
  10----
  11"""
  12
  13from __future__ import annotations
  14
  15import datetime
  16import math
  17import numbers
  18import re
  19import textwrap
  20import typing as t
  21from collections import deque
  22from copy import deepcopy
  23from decimal import Decimal
  24from enum import auto
  25from functools import reduce
  26
  27from sqlglot.errors import ErrorLevel, ParseError
  28from sqlglot.helper import (
  29    AutoName,
  30    camel_to_snake_case,
  31    ensure_collection,
  32    ensure_list,
  33    seq_get,
  34    subclasses,
  35)
  36from sqlglot.tokens import Token, TokenError
  37
  38if t.TYPE_CHECKING:
  39    from sqlglot._typing import E, Lit
  40    from sqlglot.dialects.dialect import DialectType
  41
  42    Q = t.TypeVar("Q", bound="Query")
  43    S = t.TypeVar("S", bound="SetOperation")
  44
  45
  46class _Expression(type):
  47    def __new__(cls, clsname, bases, attrs):
  48        klass = super().__new__(cls, clsname, bases, attrs)
  49
  50        # When an Expression class is created, its key is automatically set to be
  51        # the lowercase version of the class' name.
  52        klass.key = clsname.lower()
  53
  54        # This is so that docstrings are not inherited in pdoc
  55        klass.__doc__ = klass.__doc__ or ""
  56
  57        return klass
  58
  59
  60SQLGLOT_META = "sqlglot.meta"
  61TABLE_PARTS = ("this", "db", "catalog")
  62COLUMN_PARTS = ("this", "table", "db", "catalog")
  63
  64
  65class Expression(metaclass=_Expression):
  66    """
  67    The base class for all expressions in a syntax tree. Each Expression encapsulates any necessary
  68    context, such as its child expressions, their names (arg keys), and whether a given child expression
  69    is optional or not.
  70
  71    Attributes:
  72        key: a unique key for each class in the Expression hierarchy. This is useful for hashing
  73            and representing expressions as strings.
  74        arg_types: determines the arguments (child nodes) supported by an expression. It maps
  75            arg keys to booleans that indicate whether the corresponding args are optional.
  76        parent: a reference to the parent expression (or None, in case of root expressions).
  77        arg_key: the arg key an expression is associated with, i.e. the name its parent expression
  78            uses to refer to it.
  79        index: the index of an expression if it is inside of a list argument in its parent.
  80        comments: a list of comments that are associated with a given expression. This is used in
  81            order to preserve comments when transpiling SQL code.
  82        type: the `sqlglot.expressions.DataType` type of an expression. This is inferred by the
  83            optimizer, in order to enable some transformations that require type information.
  84        meta: a dictionary that can be used to store useful metadata for a given expression.
  85
  86    Example:
  87        >>> class Foo(Expression):
  88        ...     arg_types = {"this": True, "expression": False}
  89
  90        The above definition informs us that Foo is an Expression that requires an argument called
  91        "this" and may also optionally receive an argument called "expression".
  92
  93    Args:
  94        args: a mapping used for retrieving the arguments of an expression, given their arg keys.
  95    """
  96
  97    key = "expression"
  98    arg_types = {"this": True}
  99    __slots__ = ("args", "parent", "arg_key", "index", "comments", "_type", "_meta", "_hash")
 100
 101    def __init__(self, **args: t.Any):
 102        self.args: t.Dict[str, t.Any] = args
 103        self.parent: t.Optional[Expression] = None
 104        self.arg_key: t.Optional[str] = None
 105        self.index: t.Optional[int] = None
 106        self.comments: t.Optional[t.List[str]] = None
 107        self._type: t.Optional[DataType] = None
 108        self._meta: t.Optional[t.Dict[str, t.Any]] = None
 109        self._hash: t.Optional[int] = None
 110
 111        for arg_key, value in self.args.items():
 112            self._set_parent(arg_key, value)
 113
 114    def __eq__(self, other) -> bool:
 115        return type(self) is type(other) and hash(self) == hash(other)
 116
 117    @property
 118    def hashable_args(self) -> t.Any:
 119        return frozenset(
 120            (k, tuple(_norm_arg(a) for a in v) if type(v) is list else _norm_arg(v))
 121            for k, v in self.args.items()
 122            if not (v is None or v is False or (type(v) is list and not v))
 123        )
 124
 125    def __hash__(self) -> int:
 126        if self._hash is not None:
 127            return self._hash
 128
 129        return hash((self.__class__, self.hashable_args))
 130
 131    @property
 132    def this(self) -> t.Any:
 133        """
 134        Retrieves the argument with key "this".
 135        """
 136        return self.args.get("this")
 137
 138    @property
 139    def expression(self) -> t.Any:
 140        """
 141        Retrieves the argument with key "expression".
 142        """
 143        return self.args.get("expression")
 144
 145    @property
 146    def expressions(self) -> t.List[t.Any]:
 147        """
 148        Retrieves the argument with key "expressions".
 149        """
 150        return self.args.get("expressions") or []
 151
 152    def text(self, key) -> str:
 153        """
 154        Returns a textual representation of the argument corresponding to "key". This can only be used
 155        for args that are strings or leaf Expression instances, such as identifiers and literals.
 156        """
 157        field = self.args.get(key)
 158        if isinstance(field, str):
 159            return field
 160        if isinstance(field, (Identifier, Literal, Var)):
 161            return field.this
 162        if isinstance(field, (Star, Null)):
 163            return field.name
 164        return ""
 165
 166    @property
 167    def is_string(self) -> bool:
 168        """
 169        Checks whether a Literal expression is a string.
 170        """
 171        return isinstance(self, Literal) and self.args["is_string"]
 172
 173    @property
 174    def is_number(self) -> bool:
 175        """
 176        Checks whether a Literal expression is a number.
 177        """
 178        return (isinstance(self, Literal) and not self.args["is_string"]) or (
 179            isinstance(self, Neg) and self.this.is_number
 180        )
 181
 182    def to_py(self) -> t.Any:
 183        """
 184        Returns a Python object equivalent of the SQL node.
 185        """
 186        raise ValueError(f"{self} cannot be converted to a Python object.")
 187
 188    @property
 189    def is_int(self) -> bool:
 190        """
 191        Checks whether an expression is an integer.
 192        """
 193        return self.is_number and isinstance(self.to_py(), int)
 194
 195    @property
 196    def is_star(self) -> bool:
 197        """Checks whether an expression is a star."""
 198        return isinstance(self, Star) or (isinstance(self, Column) and isinstance(self.this, Star))
 199
 200    @property
 201    def alias(self) -> str:
 202        """
 203        Returns the alias of the expression, or an empty string if it's not aliased.
 204        """
 205        if isinstance(self.args.get("alias"), TableAlias):
 206            return self.args["alias"].name
 207        return self.text("alias")
 208
 209    @property
 210    def alias_column_names(self) -> t.List[str]:
 211        table_alias = self.args.get("alias")
 212        if not table_alias:
 213            return []
 214        return [c.name for c in table_alias.args.get("columns") or []]
 215
 216    @property
 217    def name(self) -> str:
 218        return self.text("this")
 219
 220    @property
 221    def alias_or_name(self) -> str:
 222        return self.alias or self.name
 223
 224    @property
 225    def output_name(self) -> str:
 226        """
 227        Name of the output column if this expression is a selection.
 228
 229        If the Expression has no output name, an empty string is returned.
 230
 231        Example:
 232            >>> from sqlglot import parse_one
 233            >>> parse_one("SELECT a").expressions[0].output_name
 234            'a'
 235            >>> parse_one("SELECT b AS c").expressions[0].output_name
 236            'c'
 237            >>> parse_one("SELECT 1 + 2").expressions[0].output_name
 238            ''
 239        """
 240        return ""
 241
 242    @property
 243    def type(self) -> t.Optional[DataType]:
 244        return self._type
 245
 246    @type.setter
 247    def type(self, dtype: t.Optional[DataType | DataType.Type | str]) -> None:
 248        if dtype and not isinstance(dtype, DataType):
 249            dtype = DataType.build(dtype)
 250        self._type = dtype  # type: ignore
 251
 252    def is_type(self, *dtypes) -> bool:
 253        return self.type is not None and self.type.is_type(*dtypes)
 254
 255    def is_leaf(self) -> bool:
 256        return not any(isinstance(v, (Expression, list)) for v in self.args.values())
 257
 258    @property
 259    def meta(self) -> t.Dict[str, t.Any]:
 260        if self._meta is None:
 261            self._meta = {}
 262        return self._meta
 263
 264    def __deepcopy__(self, memo):
 265        root = self.__class__()
 266        stack = [(self, root)]
 267
 268        while stack:
 269            node, copy = stack.pop()
 270
 271            if node.comments is not None:
 272                copy.comments = deepcopy(node.comments)
 273            if node._type is not None:
 274                copy._type = deepcopy(node._type)
 275            if node._meta is not None:
 276                copy._meta = deepcopy(node._meta)
 277            if node._hash is not None:
 278                copy._hash = node._hash
 279
 280            for k, vs in node.args.items():
 281                if hasattr(vs, "parent"):
 282                    stack.append((vs, vs.__class__()))
 283                    copy.set(k, stack[-1][-1])
 284                elif type(vs) is list:
 285                    copy.args[k] = []
 286
 287                    for v in vs:
 288                        if hasattr(v, "parent"):
 289                            stack.append((v, v.__class__()))
 290                            copy.append(k, stack[-1][-1])
 291                        else:
 292                            copy.append(k, v)
 293                else:
 294                    copy.args[k] = vs
 295
 296        return root
 297
 298    def copy(self):
 299        """
 300        Returns a deep copy of the expression.
 301        """
 302        return deepcopy(self)
 303
 304    def add_comments(self, comments: t.Optional[t.List[str]] = None) -> None:
 305        if self.comments is None:
 306            self.comments = []
 307
 308        if comments:
 309            for comment in comments:
 310                _, *meta = comment.split(SQLGLOT_META)
 311                if meta:
 312                    for kv in "".join(meta).split(","):
 313                        k, *v = kv.split("=")
 314                        value = v[0].strip() if v else True
 315                        self.meta[k.strip()] = value
 316                self.comments.append(comment)
 317
 318    def pop_comments(self) -> t.List[str]:
 319        comments = self.comments or []
 320        self.comments = None
 321        return comments
 322
 323    def append(self, arg_key: str, value: t.Any) -> None:
 324        """
 325        Appends value to arg_key if it's a list or sets it as a new list.
 326
 327        Args:
 328            arg_key (str): name of the list expression arg
 329            value (Any): value to append to the list
 330        """
 331        if type(self.args.get(arg_key)) is not list:
 332            self.args[arg_key] = []
 333        self._set_parent(arg_key, value)
 334        values = self.args[arg_key]
 335        if hasattr(value, "parent"):
 336            value.index = len(values)
 337        values.append(value)
 338
 339    def set(
 340        self,
 341        arg_key: str,
 342        value: t.Any,
 343        index: t.Optional[int] = None,
 344        overwrite: bool = True,
 345    ) -> None:
 346        """
 347        Sets arg_key to value.
 348
 349        Args:
 350            arg_key: name of the expression arg.
 351            value: value to set the arg to.
 352            index: if the arg is a list, this specifies what position to add the value in it.
 353            overwrite: assuming an index is given, this determines whether to overwrite the
 354                list entry instead of only inserting a new value (i.e., like list.insert).
 355        """
 356        if index is not None:
 357            expressions = self.args.get(arg_key) or []
 358
 359            if seq_get(expressions, index) is None:
 360                return
 361            if value is None:
 362                expressions.pop(index)
 363                for v in expressions[index:]:
 364                    v.index = v.index - 1
 365                return
 366
 367            if isinstance(value, list):
 368                expressions.pop(index)
 369                expressions[index:index] = value
 370            elif overwrite:
 371                expressions[index] = value
 372            else:
 373                expressions.insert(index, value)
 374
 375            value = expressions
 376        elif value is None:
 377            self.args.pop(arg_key, None)
 378            return
 379
 380        self.args[arg_key] = value
 381        self._set_parent(arg_key, value, index)
 382
 383    def _set_parent(self, arg_key: str, value: t.Any, index: t.Optional[int] = None) -> None:
 384        if hasattr(value, "parent"):
 385            value.parent = self
 386            value.arg_key = arg_key
 387            value.index = index
 388        elif type(value) is list:
 389            for index, v in enumerate(value):
 390                if hasattr(v, "parent"):
 391                    v.parent = self
 392                    v.arg_key = arg_key
 393                    v.index = index
 394
 395    @property
 396    def depth(self) -> int:
 397        """
 398        Returns the depth of this tree.
 399        """
 400        if self.parent:
 401            return self.parent.depth + 1
 402        return 0
 403
 404    def iter_expressions(self, reverse: bool = False) -> t.Iterator[Expression]:
 405        """Yields the key and expression for all arguments, exploding list args."""
 406        # remove tuple when python 3.7 is deprecated
 407        for vs in reversed(tuple(self.args.values())) if reverse else self.args.values():
 408            if type(vs) is list:
 409                for v in reversed(vs) if reverse else vs:
 410                    if hasattr(v, "parent"):
 411                        yield v
 412            else:
 413                if hasattr(vs, "parent"):
 414                    yield vs
 415
 416    def find(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Optional[E]:
 417        """
 418        Returns the first node in this tree which matches at least one of
 419        the specified types.
 420
 421        Args:
 422            expression_types: the expression type(s) to match.
 423            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 424
 425        Returns:
 426            The node which matches the criteria or None if no such node was found.
 427        """
 428        return next(self.find_all(*expression_types, bfs=bfs), None)
 429
 430    def find_all(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Iterator[E]:
 431        """
 432        Returns a generator object which visits all nodes in this tree and only
 433        yields those that match at least one of the specified expression types.
 434
 435        Args:
 436            expression_types: the expression type(s) to match.
 437            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 438
 439        Returns:
 440            The generator object.
 441        """
 442        for expression in self.walk(bfs=bfs):
 443            if isinstance(expression, expression_types):
 444                yield expression
 445
 446    def find_ancestor(self, *expression_types: t.Type[E]) -> t.Optional[E]:
 447        """
 448        Returns a nearest parent matching expression_types.
 449
 450        Args:
 451            expression_types: the expression type(s) to match.
 452
 453        Returns:
 454            The parent node.
 455        """
 456        ancestor = self.parent
 457        while ancestor and not isinstance(ancestor, expression_types):
 458            ancestor = ancestor.parent
 459        return ancestor  # type: ignore
 460
 461    @property
 462    def parent_select(self) -> t.Optional[Select]:
 463        """
 464        Returns the parent select statement.
 465        """
 466        return self.find_ancestor(Select)
 467
 468    @property
 469    def same_parent(self) -> bool:
 470        """Returns if the parent is the same class as itself."""
 471        return type(self.parent) is self.__class__
 472
 473    def root(self) -> Expression:
 474        """
 475        Returns the root expression of this tree.
 476        """
 477        expression = self
 478        while expression.parent:
 479            expression = expression.parent
 480        return expression
 481
 482    def walk(
 483        self, bfs: bool = True, prune: t.Optional[t.Callable[[Expression], bool]] = None
 484    ) -> t.Iterator[Expression]:
 485        """
 486        Returns a generator object which visits all nodes in this tree.
 487
 488        Args:
 489            bfs: if set to True the BFS traversal order will be applied,
 490                otherwise the DFS traversal will be used instead.
 491            prune: callable that returns True if the generator should stop traversing
 492                this branch of the tree.
 493
 494        Returns:
 495            the generator object.
 496        """
 497        if bfs:
 498            yield from self.bfs(prune=prune)
 499        else:
 500            yield from self.dfs(prune=prune)
 501
 502    def dfs(
 503        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 504    ) -> t.Iterator[Expression]:
 505        """
 506        Returns a generator object which visits all nodes in this tree in
 507        the DFS (Depth-first) order.
 508
 509        Returns:
 510            The generator object.
 511        """
 512        stack = [self]
 513
 514        while stack:
 515            node = stack.pop()
 516
 517            yield node
 518
 519            if prune and prune(node):
 520                continue
 521
 522            for v in node.iter_expressions(reverse=True):
 523                stack.append(v)
 524
 525    def bfs(
 526        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 527    ) -> t.Iterator[Expression]:
 528        """
 529        Returns a generator object which visits all nodes in this tree in
 530        the BFS (Breadth-first) order.
 531
 532        Returns:
 533            The generator object.
 534        """
 535        queue = deque([self])
 536
 537        while queue:
 538            node = queue.popleft()
 539
 540            yield node
 541
 542            if prune and prune(node):
 543                continue
 544
 545            for v in node.iter_expressions():
 546                queue.append(v)
 547
 548    def unnest(self):
 549        """
 550        Returns the first non parenthesis child or self.
 551        """
 552        expression = self
 553        while type(expression) is Paren:
 554            expression = expression.this
 555        return expression
 556
 557    def unalias(self):
 558        """
 559        Returns the inner expression if this is an Alias.
 560        """
 561        if isinstance(self, Alias):
 562            return self.this
 563        return self
 564
 565    def unnest_operands(self):
 566        """
 567        Returns unnested operands as a tuple.
 568        """
 569        return tuple(arg.unnest() for arg in self.iter_expressions())
 570
 571    def flatten(self, unnest=True):
 572        """
 573        Returns a generator which yields child nodes whose parents are the same class.
 574
 575        A AND B AND C -> [A, B, C]
 576        """
 577        for node in self.dfs(prune=lambda n: n.parent and type(n) is not self.__class__):
 578            if type(node) is not self.__class__:
 579                yield node.unnest() if unnest and not isinstance(node, Subquery) else node
 580
 581    def __str__(self) -> str:
 582        return self.sql()
 583
 584    def __repr__(self) -> str:
 585        return _to_s(self)
 586
 587    def to_s(self) -> str:
 588        """
 589        Same as __repr__, but includes additional information which can be useful
 590        for debugging, like empty or missing args and the AST nodes' object IDs.
 591        """
 592        return _to_s(self, verbose=True)
 593
 594    def sql(self, dialect: DialectType = None, **opts) -> str:
 595        """
 596        Returns SQL string representation of this tree.
 597
 598        Args:
 599            dialect: the dialect of the output SQL string (eg. "spark", "hive", "presto", "mysql").
 600            opts: other `sqlglot.generator.Generator` options.
 601
 602        Returns:
 603            The SQL string.
 604        """
 605        from sqlglot.dialects import Dialect
 606
 607        return Dialect.get_or_raise(dialect).generate(self, **opts)
 608
 609    def transform(self, fun: t.Callable, *args: t.Any, copy: bool = True, **kwargs) -> Expression:
 610        """
 611        Visits all tree nodes (excluding already transformed ones)
 612        and applies the given transformation function to each node.
 613
 614        Args:
 615            fun: a function which takes a node as an argument and returns a
 616                new transformed node or the same node without modifications. If the function
 617                returns None, then the corresponding node will be removed from the syntax tree.
 618            copy: if set to True a new tree instance is constructed, otherwise the tree is
 619                modified in place.
 620
 621        Returns:
 622            The transformed tree.
 623        """
 624        root = None
 625        new_node = None
 626
 627        for node in (self.copy() if copy else self).dfs(prune=lambda n: n is not new_node):
 628            parent, arg_key, index = node.parent, node.arg_key, node.index
 629            new_node = fun(node, *args, **kwargs)
 630
 631            if not root:
 632                root = new_node
 633            elif new_node is not node:
 634                parent.set(arg_key, new_node, index)
 635
 636        assert root
 637        return root.assert_is(Expression)
 638
 639    @t.overload
 640    def replace(self, expression: E) -> E: ...
 641
 642    @t.overload
 643    def replace(self, expression: None) -> None: ...
 644
 645    def replace(self, expression):
 646        """
 647        Swap out this expression with a new expression.
 648
 649        For example::
 650
 651            >>> tree = Select().select("x").from_("tbl")
 652            >>> tree.find(Column).replace(column("y"))
 653            Column(
 654              this=Identifier(this=y, quoted=False))
 655            >>> tree.sql()
 656            'SELECT y FROM tbl'
 657
 658        Args:
 659            expression: new node
 660
 661        Returns:
 662            The new expression or expressions.
 663        """
 664        parent = self.parent
 665
 666        if not parent or parent is expression:
 667            return expression
 668
 669        key = self.arg_key
 670        value = parent.args.get(key)
 671
 672        if type(expression) is list and isinstance(value, Expression):
 673            # We are trying to replace an Expression with a list, so it's assumed that
 674            # the intention was to really replace the parent of this expression.
 675            value.parent.replace(expression)
 676        else:
 677            parent.set(key, expression, self.index)
 678
 679        if expression is not self:
 680            self.parent = None
 681            self.arg_key = None
 682            self.index = None
 683
 684        return expression
 685
 686    def pop(self: E) -> E:
 687        """
 688        Remove this expression from its AST.
 689
 690        Returns:
 691            The popped expression.
 692        """
 693        self.replace(None)
 694        return self
 695
 696    def assert_is(self, type_: t.Type[E]) -> E:
 697        """
 698        Assert that this `Expression` is an instance of `type_`.
 699
 700        If it is NOT an instance of `type_`, this raises an assertion error.
 701        Otherwise, this returns this expression.
 702
 703        Examples:
 704            This is useful for type security in chained expressions:
 705
 706            >>> import sqlglot
 707            >>> sqlglot.parse_one("SELECT x from y").assert_is(Select).select("z").sql()
 708            'SELECT x, z FROM y'
 709        """
 710        if not isinstance(self, type_):
 711            raise AssertionError(f"{self} is not {type_}.")
 712        return self
 713
 714    def error_messages(self, args: t.Optional[t.Sequence] = None) -> t.List[str]:
 715        """
 716        Checks if this expression is valid (e.g. all mandatory args are set).
 717
 718        Args:
 719            args: a sequence of values that were used to instantiate a Func expression. This is used
 720                to check that the provided arguments don't exceed the function argument limit.
 721
 722        Returns:
 723            A list of error messages for all possible errors that were found.
 724        """
 725        errors: t.List[str] = []
 726
 727        for k in self.args:
 728            if k not in self.arg_types:
 729                errors.append(f"Unexpected keyword: '{k}' for {self.__class__}")
 730        for k, mandatory in self.arg_types.items():
 731            v = self.args.get(k)
 732            if mandatory and (v is None or (isinstance(v, list) and not v)):
 733                errors.append(f"Required keyword: '{k}' missing for {self.__class__}")
 734
 735        if (
 736            args
 737            and isinstance(self, Func)
 738            and len(args) > len(self.arg_types)
 739            and not self.is_var_len_args
 740        ):
 741            errors.append(
 742                f"The number of provided arguments ({len(args)}) is greater than "
 743                f"the maximum number of supported arguments ({len(self.arg_types)})"
 744            )
 745
 746        return errors
 747
 748    def dump(self):
 749        """
 750        Dump this Expression to a JSON-serializable dict.
 751        """
 752        from sqlglot.serde import dump
 753
 754        return dump(self)
 755
 756    @classmethod
 757    def load(cls, obj):
 758        """
 759        Load a dict (as returned by `Expression.dump`) into an Expression instance.
 760        """
 761        from sqlglot.serde import load
 762
 763        return load(obj)
 764
 765    def and_(
 766        self,
 767        *expressions: t.Optional[ExpOrStr],
 768        dialect: DialectType = None,
 769        copy: bool = True,
 770        **opts,
 771    ) -> Condition:
 772        """
 773        AND this condition with one or multiple expressions.
 774
 775        Example:
 776            >>> condition("x=1").and_("y=1").sql()
 777            'x = 1 AND y = 1'
 778
 779        Args:
 780            *expressions: the SQL code strings to parse.
 781                If an `Expression` instance is passed, it will be used as-is.
 782            dialect: the dialect used to parse the input expression.
 783            copy: whether to copy the involved expressions (only applies to Expressions).
 784            opts: other options to use to parse the input expressions.
 785
 786        Returns:
 787            The new And condition.
 788        """
 789        return and_(self, *expressions, dialect=dialect, copy=copy, **opts)
 790
 791    def or_(
 792        self,
 793        *expressions: t.Optional[ExpOrStr],
 794        dialect: DialectType = None,
 795        copy: bool = True,
 796        **opts,
 797    ) -> Condition:
 798        """
 799        OR this condition with one or multiple expressions.
 800
 801        Example:
 802            >>> condition("x=1").or_("y=1").sql()
 803            'x = 1 OR y = 1'
 804
 805        Args:
 806            *expressions: the SQL code strings to parse.
 807                If an `Expression` instance is passed, it will be used as-is.
 808            dialect: the dialect used to parse the input expression.
 809            copy: whether to copy the involved expressions (only applies to Expressions).
 810            opts: other options to use to parse the input expressions.
 811
 812        Returns:
 813            The new Or condition.
 814        """
 815        return or_(self, *expressions, dialect=dialect, copy=copy, **opts)
 816
 817    def not_(self, copy: bool = True):
 818        """
 819        Wrap this condition with NOT.
 820
 821        Example:
 822            >>> condition("x=1").not_().sql()
 823            'NOT x = 1'
 824
 825        Args:
 826            copy: whether to copy this object.
 827
 828        Returns:
 829            The new Not instance.
 830        """
 831        return not_(self, copy=copy)
 832
 833    def as_(
 834        self,
 835        alias: str | Identifier,
 836        quoted: t.Optional[bool] = None,
 837        dialect: DialectType = None,
 838        copy: bool = True,
 839        **opts,
 840    ) -> Alias:
 841        return alias_(self, alias, quoted=quoted, dialect=dialect, copy=copy, **opts)
 842
 843    def _binop(self, klass: t.Type[E], other: t.Any, reverse: bool = False) -> E:
 844        this = self.copy()
 845        other = convert(other, copy=True)
 846        if not isinstance(this, klass) and not isinstance(other, klass):
 847            this = _wrap(this, Binary)
 848            other = _wrap(other, Binary)
 849        if reverse:
 850            return klass(this=other, expression=this)
 851        return klass(this=this, expression=other)
 852
 853    def __getitem__(self, other: ExpOrStr | t.Tuple[ExpOrStr]) -> Bracket:
 854        return Bracket(
 855            this=self.copy(), expressions=[convert(e, copy=True) for e in ensure_list(other)]
 856        )
 857
 858    def __iter__(self) -> t.Iterator:
 859        if "expressions" in self.arg_types:
 860            return iter(self.args.get("expressions") or [])
 861        # We define this because __getitem__ converts Expression into an iterable, which is
 862        # problematic because one can hit infinite loops if they do "for x in some_expr: ..."
 863        # See: https://peps.python.org/pep-0234/
 864        raise TypeError(f"'{self.__class__.__name__}' object is not iterable")
 865
 866    def isin(
 867        self,
 868        *expressions: t.Any,
 869        query: t.Optional[ExpOrStr] = None,
 870        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
 871        copy: bool = True,
 872        **opts,
 873    ) -> In:
 874        subquery = maybe_parse(query, copy=copy, **opts) if query else None
 875        if subquery and not isinstance(subquery, Subquery):
 876            subquery = subquery.subquery(copy=False)
 877
 878        return In(
 879            this=maybe_copy(self, copy),
 880            expressions=[convert(e, copy=copy) for e in expressions],
 881            query=subquery,
 882            unnest=(
 883                Unnest(
 884                    expressions=[
 885                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
 886                        for e in ensure_list(unnest)
 887                    ]
 888                )
 889                if unnest
 890                else None
 891            ),
 892        )
 893
 894    def between(self, low: t.Any, high: t.Any, copy: bool = True, **opts) -> Between:
 895        return Between(
 896            this=maybe_copy(self, copy),
 897            low=convert(low, copy=copy, **opts),
 898            high=convert(high, copy=copy, **opts),
 899        )
 900
 901    def is_(self, other: ExpOrStr) -> Is:
 902        return self._binop(Is, other)
 903
 904    def like(self, other: ExpOrStr) -> Like:
 905        return self._binop(Like, other)
 906
 907    def ilike(self, other: ExpOrStr) -> ILike:
 908        return self._binop(ILike, other)
 909
 910    def eq(self, other: t.Any) -> EQ:
 911        return self._binop(EQ, other)
 912
 913    def neq(self, other: t.Any) -> NEQ:
 914        return self._binop(NEQ, other)
 915
 916    def rlike(self, other: ExpOrStr) -> RegexpLike:
 917        return self._binop(RegexpLike, other)
 918
 919    def div(self, other: ExpOrStr, typed: bool = False, safe: bool = False) -> Div:
 920        div = self._binop(Div, other)
 921        div.args["typed"] = typed
 922        div.args["safe"] = safe
 923        return div
 924
 925    def asc(self, nulls_first: bool = True) -> Ordered:
 926        return Ordered(this=self.copy(), nulls_first=nulls_first)
 927
 928    def desc(self, nulls_first: bool = False) -> Ordered:
 929        return Ordered(this=self.copy(), desc=True, nulls_first=nulls_first)
 930
 931    def __lt__(self, other: t.Any) -> LT:
 932        return self._binop(LT, other)
 933
 934    def __le__(self, other: t.Any) -> LTE:
 935        return self._binop(LTE, other)
 936
 937    def __gt__(self, other: t.Any) -> GT:
 938        return self._binop(GT, other)
 939
 940    def __ge__(self, other: t.Any) -> GTE:
 941        return self._binop(GTE, other)
 942
 943    def __add__(self, other: t.Any) -> Add:
 944        return self._binop(Add, other)
 945
 946    def __radd__(self, other: t.Any) -> Add:
 947        return self._binop(Add, other, reverse=True)
 948
 949    def __sub__(self, other: t.Any) -> Sub:
 950        return self._binop(Sub, other)
 951
 952    def __rsub__(self, other: t.Any) -> Sub:
 953        return self._binop(Sub, other, reverse=True)
 954
 955    def __mul__(self, other: t.Any) -> Mul:
 956        return self._binop(Mul, other)
 957
 958    def __rmul__(self, other: t.Any) -> Mul:
 959        return self._binop(Mul, other, reverse=True)
 960
 961    def __truediv__(self, other: t.Any) -> Div:
 962        return self._binop(Div, other)
 963
 964    def __rtruediv__(self, other: t.Any) -> Div:
 965        return self._binop(Div, other, reverse=True)
 966
 967    def __floordiv__(self, other: t.Any) -> IntDiv:
 968        return self._binop(IntDiv, other)
 969
 970    def __rfloordiv__(self, other: t.Any) -> IntDiv:
 971        return self._binop(IntDiv, other, reverse=True)
 972
 973    def __mod__(self, other: t.Any) -> Mod:
 974        return self._binop(Mod, other)
 975
 976    def __rmod__(self, other: t.Any) -> Mod:
 977        return self._binop(Mod, other, reverse=True)
 978
 979    def __pow__(self, other: t.Any) -> Pow:
 980        return self._binop(Pow, other)
 981
 982    def __rpow__(self, other: t.Any) -> Pow:
 983        return self._binop(Pow, other, reverse=True)
 984
 985    def __and__(self, other: t.Any) -> And:
 986        return self._binop(And, other)
 987
 988    def __rand__(self, other: t.Any) -> And:
 989        return self._binop(And, other, reverse=True)
 990
 991    def __or__(self, other: t.Any) -> Or:
 992        return self._binop(Or, other)
 993
 994    def __ror__(self, other: t.Any) -> Or:
 995        return self._binop(Or, other, reverse=True)
 996
 997    def __neg__(self) -> Neg:
 998        return Neg(this=_wrap(self.copy(), Binary))
 999
1000    def __invert__(self) -> Not:
1001        return not_(self.copy())
1002
1003
1004IntoType = t.Union[
1005    str,
1006    t.Type[Expression],
1007    t.Collection[t.Union[str, t.Type[Expression]]],
1008]
1009ExpOrStr = t.Union[str, Expression]
1010
1011
1012class Condition(Expression):
1013    """Logical conditions like x AND y, or simply x"""
1014
1015
1016class Predicate(Condition):
1017    """Relationships like x = y, x > 1, x >= y."""
1018
1019
1020class DerivedTable(Expression):
1021    @property
1022    def selects(self) -> t.List[Expression]:
1023        return self.this.selects if isinstance(self.this, Query) else []
1024
1025    @property
1026    def named_selects(self) -> t.List[str]:
1027        return [select.output_name for select in self.selects]
1028
1029
1030class Query(Expression):
1031    def subquery(self, alias: t.Optional[ExpOrStr] = None, copy: bool = True) -> Subquery:
1032        """
1033        Returns a `Subquery` that wraps around this query.
1034
1035        Example:
1036            >>> subquery = Select().select("x").from_("tbl").subquery()
1037            >>> Select().select("x").from_(subquery).sql()
1038            'SELECT x FROM (SELECT x FROM tbl)'
1039
1040        Args:
1041            alias: an optional alias for the subquery.
1042            copy: if `False`, modify this expression instance in-place.
1043        """
1044        instance = maybe_copy(self, copy)
1045        if not isinstance(alias, Expression):
1046            alias = TableAlias(this=to_identifier(alias)) if alias else None
1047
1048        return Subquery(this=instance, alias=alias)
1049
1050    def limit(
1051        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1052    ) -> Q:
1053        """
1054        Adds a LIMIT clause to this query.
1055
1056        Example:
1057            >>> select("1").union(select("1")).limit(1).sql()
1058            'SELECT 1 UNION SELECT 1 LIMIT 1'
1059
1060        Args:
1061            expression: the SQL code string to parse.
1062                This can also be an integer.
1063                If a `Limit` instance is passed, it will be used as-is.
1064                If another `Expression` instance is passed, it will be wrapped in a `Limit`.
1065            dialect: the dialect used to parse the input expression.
1066            copy: if `False`, modify this expression instance in-place.
1067            opts: other options to use to parse the input expressions.
1068
1069        Returns:
1070            A limited Select expression.
1071        """
1072        return _apply_builder(
1073            expression=expression,
1074            instance=self,
1075            arg="limit",
1076            into=Limit,
1077            prefix="LIMIT",
1078            dialect=dialect,
1079            copy=copy,
1080            into_arg="expression",
1081            **opts,
1082        )
1083
1084    def offset(
1085        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1086    ) -> Q:
1087        """
1088        Set the OFFSET expression.
1089
1090        Example:
1091            >>> Select().from_("tbl").select("x").offset(10).sql()
1092            'SELECT x FROM tbl OFFSET 10'
1093
1094        Args:
1095            expression: the SQL code string to parse.
1096                This can also be an integer.
1097                If a `Offset` instance is passed, this is used as-is.
1098                If another `Expression` instance is passed, it will be wrapped in a `Offset`.
1099            dialect: the dialect used to parse the input expression.
1100            copy: if `False`, modify this expression instance in-place.
1101            opts: other options to use to parse the input expressions.
1102
1103        Returns:
1104            The modified Select expression.
1105        """
1106        return _apply_builder(
1107            expression=expression,
1108            instance=self,
1109            arg="offset",
1110            into=Offset,
1111            prefix="OFFSET",
1112            dialect=dialect,
1113            copy=copy,
1114            into_arg="expression",
1115            **opts,
1116        )
1117
1118    def order_by(
1119        self: Q,
1120        *expressions: t.Optional[ExpOrStr],
1121        append: bool = True,
1122        dialect: DialectType = None,
1123        copy: bool = True,
1124        **opts,
1125    ) -> Q:
1126        """
1127        Set the ORDER BY expression.
1128
1129        Example:
1130            >>> Select().from_("tbl").select("x").order_by("x DESC").sql()
1131            'SELECT x FROM tbl ORDER BY x DESC'
1132
1133        Args:
1134            *expressions: the SQL code strings to parse.
1135                If a `Group` instance is passed, this is used as-is.
1136                If another `Expression` instance is passed, it will be wrapped in a `Order`.
1137            append: if `True`, add to any existing expressions.
1138                Otherwise, this flattens all the `Order` expression into a single expression.
1139            dialect: the dialect used to parse the input expression.
1140            copy: if `False`, modify this expression instance in-place.
1141            opts: other options to use to parse the input expressions.
1142
1143        Returns:
1144            The modified Select expression.
1145        """
1146        return _apply_child_list_builder(
1147            *expressions,
1148            instance=self,
1149            arg="order",
1150            append=append,
1151            copy=copy,
1152            prefix="ORDER BY",
1153            into=Order,
1154            dialect=dialect,
1155            **opts,
1156        )
1157
1158    @property
1159    def ctes(self) -> t.List[CTE]:
1160        """Returns a list of all the CTEs attached to this query."""
1161        with_ = self.args.get("with")
1162        return with_.expressions if with_ else []
1163
1164    @property
1165    def selects(self) -> t.List[Expression]:
1166        """Returns the query's projections."""
1167        raise NotImplementedError("Query objects must implement `selects`")
1168
1169    @property
1170    def named_selects(self) -> t.List[str]:
1171        """Returns the output names of the query's projections."""
1172        raise NotImplementedError("Query objects must implement `named_selects`")
1173
1174    def select(
1175        self: Q,
1176        *expressions: t.Optional[ExpOrStr],
1177        append: bool = True,
1178        dialect: DialectType = None,
1179        copy: bool = True,
1180        **opts,
1181    ) -> Q:
1182        """
1183        Append to or set the SELECT expressions.
1184
1185        Example:
1186            >>> Select().select("x", "y").sql()
1187            'SELECT x, y'
1188
1189        Args:
1190            *expressions: the SQL code strings to parse.
1191                If an `Expression` instance is passed, it will be used as-is.
1192            append: if `True`, add to any existing expressions.
1193                Otherwise, this resets the expressions.
1194            dialect: the dialect used to parse the input expressions.
1195            copy: if `False`, modify this expression instance in-place.
1196            opts: other options to use to parse the input expressions.
1197
1198        Returns:
1199            The modified Query expression.
1200        """
1201        raise NotImplementedError("Query objects must implement `select`")
1202
1203    def with_(
1204        self: Q,
1205        alias: ExpOrStr,
1206        as_: ExpOrStr,
1207        recursive: t.Optional[bool] = None,
1208        materialized: t.Optional[bool] = None,
1209        append: bool = True,
1210        dialect: DialectType = None,
1211        copy: bool = True,
1212        **opts,
1213    ) -> Q:
1214        """
1215        Append to or set the common table expressions.
1216
1217        Example:
1218            >>> Select().with_("tbl2", as_="SELECT * FROM tbl").select("x").from_("tbl2").sql()
1219            'WITH tbl2 AS (SELECT * FROM tbl) SELECT x FROM tbl2'
1220
1221        Args:
1222            alias: the SQL code string to parse as the table name.
1223                If an `Expression` instance is passed, this is used as-is.
1224            as_: the SQL code string to parse as the table expression.
1225                If an `Expression` instance is passed, it will be used as-is.
1226            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
1227            materialized: set the MATERIALIZED part of the expression.
1228            append: if `True`, add to any existing expressions.
1229                Otherwise, this resets the expressions.
1230            dialect: the dialect used to parse the input expression.
1231            copy: if `False`, modify this expression instance in-place.
1232            opts: other options to use to parse the input expressions.
1233
1234        Returns:
1235            The modified expression.
1236        """
1237        return _apply_cte_builder(
1238            self,
1239            alias,
1240            as_,
1241            recursive=recursive,
1242            materialized=materialized,
1243            append=append,
1244            dialect=dialect,
1245            copy=copy,
1246            **opts,
1247        )
1248
1249    def union(
1250        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1251    ) -> Union:
1252        """
1253        Builds a UNION expression.
1254
1255        Example:
1256            >>> import sqlglot
1257            >>> sqlglot.parse_one("SELECT * FROM foo").union("SELECT * FROM bla").sql()
1258            'SELECT * FROM foo UNION SELECT * FROM bla'
1259
1260        Args:
1261            expression: the SQL code string.
1262                If an `Expression` instance is passed, it will be used as-is.
1263            distinct: set the DISTINCT flag if and only if this is true.
1264            dialect: the dialect used to parse the input expression.
1265            opts: other options to use to parse the input expressions.
1266
1267        Returns:
1268            The new Union expression.
1269        """
1270        return union(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1271
1272    def intersect(
1273        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1274    ) -> Intersect:
1275        """
1276        Builds an INTERSECT expression.
1277
1278        Example:
1279            >>> import sqlglot
1280            >>> sqlglot.parse_one("SELECT * FROM foo").intersect("SELECT * FROM bla").sql()
1281            'SELECT * FROM foo INTERSECT SELECT * FROM bla'
1282
1283        Args:
1284            expression: the SQL code string.
1285                If an `Expression` instance is passed, it will be used as-is.
1286            distinct: set the DISTINCT flag if and only if this is true.
1287            dialect: the dialect used to parse the input expression.
1288            opts: other options to use to parse the input expressions.
1289
1290        Returns:
1291            The new Intersect expression.
1292        """
1293        return intersect(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1294
1295    def except_(
1296        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1297    ) -> Except:
1298        """
1299        Builds an EXCEPT expression.
1300
1301        Example:
1302            >>> import sqlglot
1303            >>> sqlglot.parse_one("SELECT * FROM foo").except_("SELECT * FROM bla").sql()
1304            'SELECT * FROM foo EXCEPT SELECT * FROM bla'
1305
1306        Args:
1307            expression: the SQL code string.
1308                If an `Expression` instance is passed, it will be used as-is.
1309            distinct: set the DISTINCT flag if and only if this is true.
1310            dialect: the dialect used to parse the input expression.
1311            opts: other options to use to parse the input expressions.
1312
1313        Returns:
1314            The new Except expression.
1315        """
1316        return except_(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1317
1318
1319class UDTF(DerivedTable):
1320    @property
1321    def selects(self) -> t.List[Expression]:
1322        alias = self.args.get("alias")
1323        return alias.columns if alias else []
1324
1325
1326class Cache(Expression):
1327    arg_types = {
1328        "this": True,
1329        "lazy": False,
1330        "options": False,
1331        "expression": False,
1332    }
1333
1334
1335class Uncache(Expression):
1336    arg_types = {"this": True, "exists": False}
1337
1338
1339class Refresh(Expression):
1340    pass
1341
1342
1343class DDL(Expression):
1344    @property
1345    def ctes(self) -> t.List[CTE]:
1346        """Returns a list of all the CTEs attached to this statement."""
1347        with_ = self.args.get("with")
1348        return with_.expressions if with_ else []
1349
1350    @property
1351    def selects(self) -> t.List[Expression]:
1352        """If this statement contains a query (e.g. a CTAS), this returns the query's projections."""
1353        return self.expression.selects if isinstance(self.expression, Query) else []
1354
1355    @property
1356    def named_selects(self) -> t.List[str]:
1357        """
1358        If this statement contains a query (e.g. a CTAS), this returns the output
1359        names of the query's projections.
1360        """
1361        return self.expression.named_selects if isinstance(self.expression, Query) else []
1362
1363
1364class DML(Expression):
1365    def returning(
1366        self,
1367        expression: ExpOrStr,
1368        dialect: DialectType = None,
1369        copy: bool = True,
1370        **opts,
1371    ) -> DML:
1372        """
1373        Set the RETURNING expression. Not supported by all dialects.
1374
1375        Example:
1376            >>> delete("tbl").returning("*", dialect="postgres").sql()
1377            'DELETE FROM tbl RETURNING *'
1378
1379        Args:
1380            expression: the SQL code strings to parse.
1381                If an `Expression` instance is passed, it will be used as-is.
1382            dialect: the dialect used to parse the input expressions.
1383            copy: if `False`, modify this expression instance in-place.
1384            opts: other options to use to parse the input expressions.
1385
1386        Returns:
1387            Delete: the modified expression.
1388        """
1389        return _apply_builder(
1390            expression=expression,
1391            instance=self,
1392            arg="returning",
1393            prefix="RETURNING",
1394            dialect=dialect,
1395            copy=copy,
1396            into=Returning,
1397            **opts,
1398        )
1399
1400
1401class Create(DDL):
1402    arg_types = {
1403        "with": False,
1404        "this": True,
1405        "kind": True,
1406        "expression": False,
1407        "exists": False,
1408        "properties": False,
1409        "replace": False,
1410        "refresh": False,
1411        "unique": False,
1412        "indexes": False,
1413        "no_schema_binding": False,
1414        "begin": False,
1415        "end": False,
1416        "clone": False,
1417        "concurrently": False,
1418        "clustered": False,
1419    }
1420
1421    @property
1422    def kind(self) -> t.Optional[str]:
1423        kind = self.args.get("kind")
1424        return kind and kind.upper()
1425
1426
1427class SequenceProperties(Expression):
1428    arg_types = {
1429        "increment": False,
1430        "minvalue": False,
1431        "maxvalue": False,
1432        "cache": False,
1433        "start": False,
1434        "owned": False,
1435        "options": False,
1436    }
1437
1438
1439class TruncateTable(Expression):
1440    arg_types = {
1441        "expressions": True,
1442        "is_database": False,
1443        "exists": False,
1444        "only": False,
1445        "cluster": False,
1446        "identity": False,
1447        "option": False,
1448        "partition": False,
1449    }
1450
1451
1452# https://docs.snowflake.com/en/sql-reference/sql/create-clone
1453# https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_clone_statement
1454# https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_copy
1455class Clone(Expression):
1456    arg_types = {"this": True, "shallow": False, "copy": False}
1457
1458
1459class Describe(Expression):
1460    arg_types = {
1461        "this": True,
1462        "style": False,
1463        "kind": False,
1464        "expressions": False,
1465        "partition": False,
1466    }
1467
1468
1469# https://duckdb.org/docs/guides/meta/summarize.html
1470class Summarize(Expression):
1471    arg_types = {"this": True, "table": False}
1472
1473
1474class Kill(Expression):
1475    arg_types = {"this": True, "kind": False}
1476
1477
1478class Pragma(Expression):
1479    pass
1480
1481
1482class Declare(Expression):
1483    arg_types = {"expressions": True}
1484
1485
1486class DeclareItem(Expression):
1487    arg_types = {"this": True, "kind": True, "default": False}
1488
1489
1490class Set(Expression):
1491    arg_types = {"expressions": False, "unset": False, "tag": False}
1492
1493
1494class Heredoc(Expression):
1495    arg_types = {"this": True, "tag": False}
1496
1497
1498class SetItem(Expression):
1499    arg_types = {
1500        "this": False,
1501        "expressions": False,
1502        "kind": False,
1503        "collate": False,  # MySQL SET NAMES statement
1504        "global": False,
1505    }
1506
1507
1508class Show(Expression):
1509    arg_types = {
1510        "this": True,
1511        "history": False,
1512        "terse": False,
1513        "target": False,
1514        "offset": False,
1515        "starts_with": False,
1516        "limit": False,
1517        "from": False,
1518        "like": False,
1519        "where": False,
1520        "db": False,
1521        "scope": False,
1522        "scope_kind": False,
1523        "full": False,
1524        "mutex": False,
1525        "query": False,
1526        "channel": False,
1527        "global": False,
1528        "log": False,
1529        "position": False,
1530        "types": False,
1531    }
1532
1533
1534class UserDefinedFunction(Expression):
1535    arg_types = {"this": True, "expressions": False, "wrapped": False}
1536
1537
1538class CharacterSet(Expression):
1539    arg_types = {"this": True, "default": False}
1540
1541
1542class With(Expression):
1543    arg_types = {"expressions": True, "recursive": False}
1544
1545    @property
1546    def recursive(self) -> bool:
1547        return bool(self.args.get("recursive"))
1548
1549
1550class WithinGroup(Expression):
1551    arg_types = {"this": True, "expression": False}
1552
1553
1554# clickhouse supports scalar ctes
1555# https://clickhouse.com/docs/en/sql-reference/statements/select/with
1556class CTE(DerivedTable):
1557    arg_types = {
1558        "this": True,
1559        "alias": True,
1560        "scalar": False,
1561        "materialized": False,
1562    }
1563
1564
1565class ProjectionDef(Expression):
1566    arg_types = {"this": True, "expression": True}
1567
1568
1569class TableAlias(Expression):
1570    arg_types = {"this": False, "columns": False}
1571
1572    @property
1573    def columns(self):
1574        return self.args.get("columns") or []
1575
1576
1577class BitString(Condition):
1578    pass
1579
1580
1581class HexString(Condition):
1582    pass
1583
1584
1585class ByteString(Condition):
1586    pass
1587
1588
1589class RawString(Condition):
1590    pass
1591
1592
1593class UnicodeString(Condition):
1594    arg_types = {"this": True, "escape": False}
1595
1596
1597class Column(Condition):
1598    arg_types = {"this": True, "table": False, "db": False, "catalog": False, "join_mark": False}
1599
1600    @property
1601    def table(self) -> str:
1602        return self.text("table")
1603
1604    @property
1605    def db(self) -> str:
1606        return self.text("db")
1607
1608    @property
1609    def catalog(self) -> str:
1610        return self.text("catalog")
1611
1612    @property
1613    def output_name(self) -> str:
1614        return self.name
1615
1616    @property
1617    def parts(self) -> t.List[Identifier]:
1618        """Return the parts of a column in order catalog, db, table, name."""
1619        return [
1620            t.cast(Identifier, self.args[part])
1621            for part in ("catalog", "db", "table", "this")
1622            if self.args.get(part)
1623        ]
1624
1625    def to_dot(self) -> Dot | Identifier:
1626        """Converts the column into a dot expression."""
1627        parts = self.parts
1628        parent = self.parent
1629
1630        while parent:
1631            if isinstance(parent, Dot):
1632                parts.append(parent.expression)
1633            parent = parent.parent
1634
1635        return Dot.build(deepcopy(parts)) if len(parts) > 1 else parts[0]
1636
1637
1638class ColumnPosition(Expression):
1639    arg_types = {"this": False, "position": True}
1640
1641
1642class ColumnDef(Expression):
1643    arg_types = {
1644        "this": True,
1645        "kind": False,
1646        "constraints": False,
1647        "exists": False,
1648        "position": False,
1649    }
1650
1651    @property
1652    def constraints(self) -> t.List[ColumnConstraint]:
1653        return self.args.get("constraints") or []
1654
1655    @property
1656    def kind(self) -> t.Optional[DataType]:
1657        return self.args.get("kind")
1658
1659
1660class AlterColumn(Expression):
1661    arg_types = {
1662        "this": True,
1663        "dtype": False,
1664        "collate": False,
1665        "using": False,
1666        "default": False,
1667        "drop": False,
1668        "comment": False,
1669        "allow_null": False,
1670    }
1671
1672
1673# https://docs.aws.amazon.com/redshift/latest/dg/r_ALTER_TABLE.html
1674class AlterDistStyle(Expression):
1675    pass
1676
1677
1678class AlterSortKey(Expression):
1679    arg_types = {"this": False, "expressions": False, "compound": False}
1680
1681
1682class AlterSet(Expression):
1683    arg_types = {
1684        "expressions": False,
1685        "option": False,
1686        "tablespace": False,
1687        "access_method": False,
1688        "file_format": False,
1689        "copy_options": False,
1690        "tag": False,
1691        "location": False,
1692        "serde": False,
1693    }
1694
1695
1696class RenameColumn(Expression):
1697    arg_types = {"this": True, "to": True, "exists": False}
1698
1699
1700class RenameTable(Expression):
1701    pass
1702
1703
1704class SwapTable(Expression):
1705    pass
1706
1707
1708class Comment(Expression):
1709    arg_types = {
1710        "this": True,
1711        "kind": True,
1712        "expression": True,
1713        "exists": False,
1714        "materialized": False,
1715    }
1716
1717
1718class Comprehension(Expression):
1719    arg_types = {"this": True, "expression": True, "iterator": True, "condition": False}
1720
1721
1722# https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl
1723class MergeTreeTTLAction(Expression):
1724    arg_types = {
1725        "this": True,
1726        "delete": False,
1727        "recompress": False,
1728        "to_disk": False,
1729        "to_volume": False,
1730    }
1731
1732
1733# https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#mergetree-table-ttl
1734class MergeTreeTTL(Expression):
1735    arg_types = {
1736        "expressions": True,
1737        "where": False,
1738        "group": False,
1739        "aggregates": False,
1740    }
1741
1742
1743# https://dev.mysql.com/doc/refman/8.0/en/create-table.html
1744class IndexConstraintOption(Expression):
1745    arg_types = {
1746        "key_block_size": False,
1747        "using": False,
1748        "parser": False,
1749        "comment": False,
1750        "visible": False,
1751        "engine_attr": False,
1752        "secondary_engine_attr": False,
1753    }
1754
1755
1756class ColumnConstraint(Expression):
1757    arg_types = {"this": False, "kind": True}
1758
1759    @property
1760    def kind(self) -> ColumnConstraintKind:
1761        return self.args["kind"]
1762
1763
1764class ColumnConstraintKind(Expression):
1765    pass
1766
1767
1768class AutoIncrementColumnConstraint(ColumnConstraintKind):
1769    pass
1770
1771
1772class PeriodForSystemTimeConstraint(ColumnConstraintKind):
1773    arg_types = {"this": True, "expression": True}
1774
1775
1776class CaseSpecificColumnConstraint(ColumnConstraintKind):
1777    arg_types = {"not_": True}
1778
1779
1780class CharacterSetColumnConstraint(ColumnConstraintKind):
1781    arg_types = {"this": True}
1782
1783
1784class CheckColumnConstraint(ColumnConstraintKind):
1785    arg_types = {"this": True, "enforced": False}
1786
1787
1788class ClusteredColumnConstraint(ColumnConstraintKind):
1789    pass
1790
1791
1792class CollateColumnConstraint(ColumnConstraintKind):
1793    pass
1794
1795
1796class CommentColumnConstraint(ColumnConstraintKind):
1797    pass
1798
1799
1800class CompressColumnConstraint(ColumnConstraintKind):
1801    arg_types = {"this": False}
1802
1803
1804class DateFormatColumnConstraint(ColumnConstraintKind):
1805    arg_types = {"this": True}
1806
1807
1808class DefaultColumnConstraint(ColumnConstraintKind):
1809    pass
1810
1811
1812class EncodeColumnConstraint(ColumnConstraintKind):
1813    pass
1814
1815
1816# https://www.postgresql.org/docs/current/sql-createtable.html#SQL-CREATETABLE-EXCLUDE
1817class ExcludeColumnConstraint(ColumnConstraintKind):
1818    pass
1819
1820
1821class EphemeralColumnConstraint(ColumnConstraintKind):
1822    arg_types = {"this": False}
1823
1824
1825class WithOperator(Expression):
1826    arg_types = {"this": True, "op": True}
1827
1828
1829class GeneratedAsIdentityColumnConstraint(ColumnConstraintKind):
1830    # this: True -> ALWAYS, this: False -> BY DEFAULT
1831    arg_types = {
1832        "this": False,
1833        "expression": False,
1834        "on_null": False,
1835        "start": False,
1836        "increment": False,
1837        "minvalue": False,
1838        "maxvalue": False,
1839        "cycle": False,
1840    }
1841
1842
1843class GeneratedAsRowColumnConstraint(ColumnConstraintKind):
1844    arg_types = {"start": False, "hidden": False}
1845
1846
1847# https://dev.mysql.com/doc/refman/8.0/en/create-table.html
1848# https://github.com/ClickHouse/ClickHouse/blob/master/src/Parsers/ParserCreateQuery.h#L646
1849class IndexColumnConstraint(ColumnConstraintKind):
1850    arg_types = {
1851        "this": False,
1852        "expressions": False,
1853        "kind": False,
1854        "index_type": False,
1855        "options": False,
1856        "expression": False,  # Clickhouse
1857        "granularity": False,
1858    }
1859
1860
1861class InlineLengthColumnConstraint(ColumnConstraintKind):
1862    pass
1863
1864
1865class NonClusteredColumnConstraint(ColumnConstraintKind):
1866    pass
1867
1868
1869class NotForReplicationColumnConstraint(ColumnConstraintKind):
1870    arg_types = {}
1871
1872
1873# https://docs.snowflake.com/en/sql-reference/sql/create-table
1874class MaskingPolicyColumnConstraint(ColumnConstraintKind):
1875    arg_types = {"this": True, "expressions": False}
1876
1877
1878class NotNullColumnConstraint(ColumnConstraintKind):
1879    arg_types = {"allow_null": False}
1880
1881
1882# https://dev.mysql.com/doc/refman/5.7/en/timestamp-initialization.html
1883class OnUpdateColumnConstraint(ColumnConstraintKind):
1884    pass
1885
1886
1887# https://docs.snowflake.com/en/sql-reference/sql/create-table
1888class TagColumnConstraint(ColumnConstraintKind):
1889    arg_types = {"expressions": True}
1890
1891
1892# https://docs.snowflake.com/en/sql-reference/sql/create-external-table#optional-parameters
1893class TransformColumnConstraint(ColumnConstraintKind):
1894    pass
1895
1896
1897class PrimaryKeyColumnConstraint(ColumnConstraintKind):
1898    arg_types = {"desc": False}
1899
1900
1901class TitleColumnConstraint(ColumnConstraintKind):
1902    pass
1903
1904
1905class UniqueColumnConstraint(ColumnConstraintKind):
1906    arg_types = {"this": False, "index_type": False, "on_conflict": False, "nulls": False}
1907
1908
1909class UppercaseColumnConstraint(ColumnConstraintKind):
1910    arg_types: t.Dict[str, t.Any] = {}
1911
1912
1913class PathColumnConstraint(ColumnConstraintKind):
1914    pass
1915
1916
1917# https://docs.snowflake.com/en/sql-reference/sql/create-table
1918class ProjectionPolicyColumnConstraint(ColumnConstraintKind):
1919    pass
1920
1921
1922# computed column expression
1923# https://learn.microsoft.com/en-us/sql/t-sql/statements/create-table-transact-sql?view=sql-server-ver16
1924class ComputedColumnConstraint(ColumnConstraintKind):
1925    arg_types = {"this": True, "persisted": False, "not_null": False}
1926
1927
1928class Constraint(Expression):
1929    arg_types = {"this": True, "expressions": True}
1930
1931
1932class Delete(DML):
1933    arg_types = {
1934        "with": False,
1935        "this": False,
1936        "using": False,
1937        "where": False,
1938        "returning": False,
1939        "limit": False,
1940        "tables": False,  # Multiple-Table Syntax (MySQL)
1941        "cluster": False,  # Clickhouse
1942    }
1943
1944    def delete(
1945        self,
1946        table: ExpOrStr,
1947        dialect: DialectType = None,
1948        copy: bool = True,
1949        **opts,
1950    ) -> Delete:
1951        """
1952        Create a DELETE expression or replace the table on an existing DELETE expression.
1953
1954        Example:
1955            >>> delete("tbl").sql()
1956            'DELETE FROM tbl'
1957
1958        Args:
1959            table: the table from which to delete.
1960            dialect: the dialect used to parse the input expression.
1961            copy: if `False`, modify this expression instance in-place.
1962            opts: other options to use to parse the input expressions.
1963
1964        Returns:
1965            Delete: the modified expression.
1966        """
1967        return _apply_builder(
1968            expression=table,
1969            instance=self,
1970            arg="this",
1971            dialect=dialect,
1972            into=Table,
1973            copy=copy,
1974            **opts,
1975        )
1976
1977    def where(
1978        self,
1979        *expressions: t.Optional[ExpOrStr],
1980        append: bool = True,
1981        dialect: DialectType = None,
1982        copy: bool = True,
1983        **opts,
1984    ) -> Delete:
1985        """
1986        Append to or set the WHERE expressions.
1987
1988        Example:
1989            >>> delete("tbl").where("x = 'a' OR x < 'b'").sql()
1990            "DELETE FROM tbl WHERE x = 'a' OR x < 'b'"
1991
1992        Args:
1993            *expressions: the SQL code strings to parse.
1994                If an `Expression` instance is passed, it will be used as-is.
1995                Multiple expressions are combined with an AND operator.
1996            append: if `True`, AND the new expressions to any existing expression.
1997                Otherwise, this resets the expression.
1998            dialect: the dialect used to parse the input expressions.
1999            copy: if `False`, modify this expression instance in-place.
2000            opts: other options to use to parse the input expressions.
2001
2002        Returns:
2003            Delete: the modified expression.
2004        """
2005        return _apply_conjunction_builder(
2006            *expressions,
2007            instance=self,
2008            arg="where",
2009            append=append,
2010            into=Where,
2011            dialect=dialect,
2012            copy=copy,
2013            **opts,
2014        )
2015
2016
2017class Drop(Expression):
2018    arg_types = {
2019        "this": False,
2020        "kind": False,
2021        "expressions": False,
2022        "exists": False,
2023        "temporary": False,
2024        "materialized": False,
2025        "cascade": False,
2026        "constraints": False,
2027        "purge": False,
2028        "cluster": False,
2029        "concurrently": False,
2030    }
2031
2032    @property
2033    def kind(self) -> t.Optional[str]:
2034        kind = self.args.get("kind")
2035        return kind and kind.upper()
2036
2037
2038class Filter(Expression):
2039    arg_types = {"this": True, "expression": True}
2040
2041
2042class Check(Expression):
2043    pass
2044
2045
2046class Changes(Expression):
2047    arg_types = {"information": True, "at_before": False, "end": False}
2048
2049
2050# https://docs.snowflake.com/en/sql-reference/constructs/connect-by
2051class Connect(Expression):
2052    arg_types = {"start": False, "connect": True, "nocycle": False}
2053
2054
2055class CopyParameter(Expression):
2056    arg_types = {"this": True, "expression": False, "expressions": False}
2057
2058
2059class Copy(DML):
2060    arg_types = {
2061        "this": True,
2062        "kind": True,
2063        "files": True,
2064        "credentials": False,
2065        "format": False,
2066        "params": False,
2067    }
2068
2069
2070class Credentials(Expression):
2071    arg_types = {
2072        "credentials": False,
2073        "encryption": False,
2074        "storage": False,
2075        "iam_role": False,
2076        "region": False,
2077    }
2078
2079
2080class Prior(Expression):
2081    pass
2082
2083
2084class Directory(Expression):
2085    # https://spark.apache.org/docs/3.0.0-preview/sql-ref-syntax-dml-insert-overwrite-directory-hive.html
2086    arg_types = {"this": True, "local": False, "row_format": False}
2087
2088
2089class ForeignKey(Expression):
2090    arg_types = {
2091        "expressions": True,
2092        "reference": False,
2093        "delete": False,
2094        "update": False,
2095    }
2096
2097
2098class ColumnPrefix(Expression):
2099    arg_types = {"this": True, "expression": True}
2100
2101
2102class PrimaryKey(Expression):
2103    arg_types = {"expressions": True, "options": False}
2104
2105
2106# https://www.postgresql.org/docs/9.1/sql-selectinto.html
2107# https://docs.aws.amazon.com/redshift/latest/dg/r_SELECT_INTO.html#r_SELECT_INTO-examples
2108class Into(Expression):
2109    arg_types = {"this": True, "temporary": False, "unlogged": False}
2110
2111
2112class From(Expression):
2113    @property
2114    def name(self) -> str:
2115        return self.this.name
2116
2117    @property
2118    def alias_or_name(self) -> str:
2119        return self.this.alias_or_name
2120
2121
2122class Having(Expression):
2123    pass
2124
2125
2126class Hint(Expression):
2127    arg_types = {"expressions": True}
2128
2129
2130class JoinHint(Expression):
2131    arg_types = {"this": True, "expressions": True}
2132
2133
2134class Identifier(Expression):
2135    arg_types = {"this": True, "quoted": False, "global": False, "temporary": False}
2136
2137    @property
2138    def quoted(self) -> bool:
2139        return bool(self.args.get("quoted"))
2140
2141    @property
2142    def hashable_args(self) -> t.Any:
2143        return (self.this, self.quoted)
2144
2145    @property
2146    def output_name(self) -> str:
2147        return self.name
2148
2149
2150# https://www.postgresql.org/docs/current/indexes-opclass.html
2151class Opclass(Expression):
2152    arg_types = {"this": True, "expression": True}
2153
2154
2155class Index(Expression):
2156    arg_types = {
2157        "this": False,
2158        "table": False,
2159        "unique": False,
2160        "primary": False,
2161        "amp": False,  # teradata
2162        "params": False,
2163    }
2164
2165
2166class IndexParameters(Expression):
2167    arg_types = {
2168        "using": False,
2169        "include": False,
2170        "columns": False,
2171        "with_storage": False,
2172        "partition_by": False,
2173        "tablespace": False,
2174        "where": False,
2175        "on": False,
2176    }
2177
2178
2179class Insert(DDL, DML):
2180    arg_types = {
2181        "hint": False,
2182        "with": False,
2183        "is_function": False,
2184        "this": False,
2185        "expression": False,
2186        "conflict": False,
2187        "returning": False,
2188        "overwrite": False,
2189        "exists": False,
2190        "alternative": False,
2191        "where": False,
2192        "ignore": False,
2193        "by_name": False,
2194        "stored": False,
2195        "partition": False,
2196        "settings": False,
2197        "source": False,
2198    }
2199
2200    def with_(
2201        self,
2202        alias: ExpOrStr,
2203        as_: ExpOrStr,
2204        recursive: t.Optional[bool] = None,
2205        materialized: t.Optional[bool] = None,
2206        append: bool = True,
2207        dialect: DialectType = None,
2208        copy: bool = True,
2209        **opts,
2210    ) -> Insert:
2211        """
2212        Append to or set the common table expressions.
2213
2214        Example:
2215            >>> insert("SELECT x FROM cte", "t").with_("cte", as_="SELECT * FROM tbl").sql()
2216            'WITH cte AS (SELECT * FROM tbl) INSERT INTO t SELECT x FROM cte'
2217
2218        Args:
2219            alias: the SQL code string to parse as the table name.
2220                If an `Expression` instance is passed, this is used as-is.
2221            as_: the SQL code string to parse as the table expression.
2222                If an `Expression` instance is passed, it will be used as-is.
2223            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
2224            materialized: set the MATERIALIZED part of the expression.
2225            append: if `True`, add to any existing expressions.
2226                Otherwise, this resets the expressions.
2227            dialect: the dialect used to parse the input expression.
2228            copy: if `False`, modify this expression instance in-place.
2229            opts: other options to use to parse the input expressions.
2230
2231        Returns:
2232            The modified expression.
2233        """
2234        return _apply_cte_builder(
2235            self,
2236            alias,
2237            as_,
2238            recursive=recursive,
2239            materialized=materialized,
2240            append=append,
2241            dialect=dialect,
2242            copy=copy,
2243            **opts,
2244        )
2245
2246
2247class ConditionalInsert(Expression):
2248    arg_types = {"this": True, "expression": False, "else_": False}
2249
2250
2251class MultitableInserts(Expression):
2252    arg_types = {"expressions": True, "kind": True, "source": True}
2253
2254
2255class OnConflict(Expression):
2256    arg_types = {
2257        "duplicate": False,
2258        "expressions": False,
2259        "action": False,
2260        "conflict_keys": False,
2261        "constraint": False,
2262    }
2263
2264
2265class OnCondition(Expression):
2266    arg_types = {"error": False, "empty": False, "null": False}
2267
2268
2269class Returning(Expression):
2270    arg_types = {"expressions": True, "into": False}
2271
2272
2273# https://dev.mysql.com/doc/refman/8.0/en/charset-introducer.html
2274class Introducer(Expression):
2275    arg_types = {"this": True, "expression": True}
2276
2277
2278# national char, like n'utf8'
2279class National(Expression):
2280    pass
2281
2282
2283class LoadData(Expression):
2284    arg_types = {
2285        "this": True,
2286        "local": False,
2287        "overwrite": False,
2288        "inpath": True,
2289        "partition": False,
2290        "input_format": False,
2291        "serde": False,
2292    }
2293
2294
2295class Partition(Expression):
2296    arg_types = {"expressions": True}
2297
2298
2299class PartitionRange(Expression):
2300    arg_types = {"this": True, "expression": True}
2301
2302
2303# https://clickhouse.com/docs/en/sql-reference/statements/alter/partition#how-to-set-partition-expression
2304class PartitionId(Expression):
2305    pass
2306
2307
2308class Fetch(Expression):
2309    arg_types = {
2310        "direction": False,
2311        "count": False,
2312        "percent": False,
2313        "with_ties": False,
2314    }
2315
2316
2317class Group(Expression):
2318    arg_types = {
2319        "expressions": False,
2320        "grouping_sets": False,
2321        "cube": False,
2322        "rollup": False,
2323        "totals": False,
2324        "all": False,
2325    }
2326
2327
2328class Cube(Expression):
2329    arg_types = {"expressions": False}
2330
2331
2332class Rollup(Expression):
2333    arg_types = {"expressions": False}
2334
2335
2336class GroupingSets(Expression):
2337    arg_types = {"expressions": True}
2338
2339
2340class Lambda(Expression):
2341    arg_types = {"this": True, "expressions": True}
2342
2343
2344class Limit(Expression):
2345    arg_types = {"this": False, "expression": True, "offset": False, "expressions": False}
2346
2347
2348class Literal(Condition):
2349    arg_types = {"this": True, "is_string": True}
2350
2351    @property
2352    def hashable_args(self) -> t.Any:
2353        return (self.this, self.args.get("is_string"))
2354
2355    @classmethod
2356    def number(cls, number) -> Literal:
2357        return cls(this=str(number), is_string=False)
2358
2359    @classmethod
2360    def string(cls, string) -> Literal:
2361        return cls(this=str(string), is_string=True)
2362
2363    @property
2364    def output_name(self) -> str:
2365        return self.name
2366
2367    def to_py(self) -> int | str | Decimal:
2368        if self.is_number:
2369            try:
2370                return int(self.this)
2371            except ValueError:
2372                return Decimal(self.this)
2373        return self.this
2374
2375
2376class Join(Expression):
2377    arg_types = {
2378        "this": True,
2379        "on": False,
2380        "side": False,
2381        "kind": False,
2382        "using": False,
2383        "method": False,
2384        "global": False,
2385        "hint": False,
2386        "match_condition": False,  # Snowflake
2387    }
2388
2389    @property
2390    def method(self) -> str:
2391        return self.text("method").upper()
2392
2393    @property
2394    def kind(self) -> str:
2395        return self.text("kind").upper()
2396
2397    @property
2398    def side(self) -> str:
2399        return self.text("side").upper()
2400
2401    @property
2402    def hint(self) -> str:
2403        return self.text("hint").upper()
2404
2405    @property
2406    def alias_or_name(self) -> str:
2407        return self.this.alias_or_name
2408
2409    def on(
2410        self,
2411        *expressions: t.Optional[ExpOrStr],
2412        append: bool = True,
2413        dialect: DialectType = None,
2414        copy: bool = True,
2415        **opts,
2416    ) -> Join:
2417        """
2418        Append to or set the ON expressions.
2419
2420        Example:
2421            >>> import sqlglot
2422            >>> sqlglot.parse_one("JOIN x", into=Join).on("y = 1").sql()
2423            'JOIN x ON y = 1'
2424
2425        Args:
2426            *expressions: the SQL code strings to parse.
2427                If an `Expression` instance is passed, it will be used as-is.
2428                Multiple expressions are combined with an AND operator.
2429            append: if `True`, AND the new expressions to any existing expression.
2430                Otherwise, this resets the expression.
2431            dialect: the dialect used to parse the input expressions.
2432            copy: if `False`, modify this expression instance in-place.
2433            opts: other options to use to parse the input expressions.
2434
2435        Returns:
2436            The modified Join expression.
2437        """
2438        join = _apply_conjunction_builder(
2439            *expressions,
2440            instance=self,
2441            arg="on",
2442            append=append,
2443            dialect=dialect,
2444            copy=copy,
2445            **opts,
2446        )
2447
2448        if join.kind == "CROSS":
2449            join.set("kind", None)
2450
2451        return join
2452
2453    def using(
2454        self,
2455        *expressions: t.Optional[ExpOrStr],
2456        append: bool = True,
2457        dialect: DialectType = None,
2458        copy: bool = True,
2459        **opts,
2460    ) -> Join:
2461        """
2462        Append to or set the USING expressions.
2463
2464        Example:
2465            >>> import sqlglot
2466            >>> sqlglot.parse_one("JOIN x", into=Join).using("foo", "bla").sql()
2467            'JOIN x USING (foo, bla)'
2468
2469        Args:
2470            *expressions: the SQL code strings to parse.
2471                If an `Expression` instance is passed, it will be used as-is.
2472            append: if `True`, concatenate the new expressions to the existing "using" list.
2473                Otherwise, this resets the expression.
2474            dialect: the dialect used to parse the input expressions.
2475            copy: if `False`, modify this expression instance in-place.
2476            opts: other options to use to parse the input expressions.
2477
2478        Returns:
2479            The modified Join expression.
2480        """
2481        join = _apply_list_builder(
2482            *expressions,
2483            instance=self,
2484            arg="using",
2485            append=append,
2486            dialect=dialect,
2487            copy=copy,
2488            **opts,
2489        )
2490
2491        if join.kind == "CROSS":
2492            join.set("kind", None)
2493
2494        return join
2495
2496
2497class Lateral(UDTF):
2498    arg_types = {
2499        "this": True,
2500        "view": False,
2501        "outer": False,
2502        "alias": False,
2503        "cross_apply": False,  # True -> CROSS APPLY, False -> OUTER APPLY
2504    }
2505
2506
2507class MatchRecognizeMeasure(Expression):
2508    arg_types = {
2509        "this": True,
2510        "window_frame": False,
2511    }
2512
2513
2514class MatchRecognize(Expression):
2515    arg_types = {
2516        "partition_by": False,
2517        "order": False,
2518        "measures": False,
2519        "rows": False,
2520        "after": False,
2521        "pattern": False,
2522        "define": False,
2523        "alias": False,
2524    }
2525
2526
2527# Clickhouse FROM FINAL modifier
2528# https://clickhouse.com/docs/en/sql-reference/statements/select/from/#final-modifier
2529class Final(Expression):
2530    pass
2531
2532
2533class Offset(Expression):
2534    arg_types = {"this": False, "expression": True, "expressions": False}
2535
2536
2537class Order(Expression):
2538    arg_types = {"this": False, "expressions": True, "siblings": False}
2539
2540
2541# https://clickhouse.com/docs/en/sql-reference/statements/select/order-by#order-by-expr-with-fill-modifier
2542class WithFill(Expression):
2543    arg_types = {
2544        "from": False,
2545        "to": False,
2546        "step": False,
2547        "interpolate": False,
2548    }
2549
2550
2551# hive specific sorts
2552# https://cwiki.apache.org/confluence/display/Hive/LanguageManual+SortBy
2553class Cluster(Order):
2554    pass
2555
2556
2557class Distribute(Order):
2558    pass
2559
2560
2561class Sort(Order):
2562    pass
2563
2564
2565class Ordered(Expression):
2566    arg_types = {"this": True, "desc": False, "nulls_first": True, "with_fill": False}
2567
2568
2569class Property(Expression):
2570    arg_types = {"this": True, "value": True}
2571
2572
2573class AllowedValuesProperty(Expression):
2574    arg_types = {"expressions": True}
2575
2576
2577class AlgorithmProperty(Property):
2578    arg_types = {"this": True}
2579
2580
2581class AutoIncrementProperty(Property):
2582    arg_types = {"this": True}
2583
2584
2585# https://docs.aws.amazon.com/prescriptive-guidance/latest/materialized-views-redshift/refreshing-materialized-views.html
2586class AutoRefreshProperty(Property):
2587    arg_types = {"this": True}
2588
2589
2590class BackupProperty(Property):
2591    arg_types = {"this": True}
2592
2593
2594class BlockCompressionProperty(Property):
2595    arg_types = {
2596        "autotemp": False,
2597        "always": False,
2598        "default": False,
2599        "manual": False,
2600        "never": False,
2601    }
2602
2603
2604class CharacterSetProperty(Property):
2605    arg_types = {"this": True, "default": True}
2606
2607
2608class ChecksumProperty(Property):
2609    arg_types = {"on": False, "default": False}
2610
2611
2612class CollateProperty(Property):
2613    arg_types = {"this": True, "default": False}
2614
2615
2616class CopyGrantsProperty(Property):
2617    arg_types = {}
2618
2619
2620class DataBlocksizeProperty(Property):
2621    arg_types = {
2622        "size": False,
2623        "units": False,
2624        "minimum": False,
2625        "maximum": False,
2626        "default": False,
2627    }
2628
2629
2630class DataDeletionProperty(Property):
2631    arg_types = {"on": True, "filter_col": False, "retention_period": False}
2632
2633
2634class DefinerProperty(Property):
2635    arg_types = {"this": True}
2636
2637
2638class DistKeyProperty(Property):
2639    arg_types = {"this": True}
2640
2641
2642# https://docs.starrocks.io/docs/sql-reference/sql-statements/data-definition/CREATE_TABLE/#distribution_desc
2643# https://doris.apache.org/docs/sql-manual/sql-statements/Data-Definition-Statements/Create/CREATE-TABLE?_highlight=create&_highlight=table#distribution_desc
2644class DistributedByProperty(Property):
2645    arg_types = {"expressions": False, "kind": True, "buckets": False, "order": False}
2646
2647
2648class DistStyleProperty(Property):
2649    arg_types = {"this": True}
2650
2651
2652class DuplicateKeyProperty(Property):
2653    arg_types = {"expressions": True}
2654
2655
2656class EngineProperty(Property):
2657    arg_types = {"this": True}
2658
2659
2660class HeapProperty(Property):
2661    arg_types = {}
2662
2663
2664class ToTableProperty(Property):
2665    arg_types = {"this": True}
2666
2667
2668class ExecuteAsProperty(Property):
2669    arg_types = {"this": True}
2670
2671
2672class ExternalProperty(Property):
2673    arg_types = {"this": False}
2674
2675
2676class FallbackProperty(Property):
2677    arg_types = {"no": True, "protection": False}
2678
2679
2680class FileFormatProperty(Property):
2681    arg_types = {"this": True}
2682
2683
2684class FreespaceProperty(Property):
2685    arg_types = {"this": True, "percent": False}
2686
2687
2688class GlobalProperty(Property):
2689    arg_types = {}
2690
2691
2692class IcebergProperty(Property):
2693    arg_types = {}
2694
2695
2696class InheritsProperty(Property):
2697    arg_types = {"expressions": True}
2698
2699
2700class InputModelProperty(Property):
2701    arg_types = {"this": True}
2702
2703
2704class OutputModelProperty(Property):
2705    arg_types = {"this": True}
2706
2707
2708class IsolatedLoadingProperty(Property):
2709    arg_types = {"no": False, "concurrent": False, "target": False}
2710
2711
2712class JournalProperty(Property):
2713    arg_types = {
2714        "no": False,
2715        "dual": False,
2716        "before": False,
2717        "local": False,
2718        "after": False,
2719    }
2720
2721
2722class LanguageProperty(Property):
2723    arg_types = {"this": True}
2724
2725
2726# spark ddl
2727class ClusteredByProperty(Property):
2728    arg_types = {"expressions": True, "sorted_by": False, "buckets": True}
2729
2730
2731class DictProperty(Property):
2732    arg_types = {"this": True, "kind": True, "settings": False}
2733
2734
2735class DictSubProperty(Property):
2736    pass
2737
2738
2739class DictRange(Property):
2740    arg_types = {"this": True, "min": True, "max": True}
2741
2742
2743class DynamicProperty(Property):
2744    arg_types = {}
2745
2746
2747# Clickhouse CREATE ... ON CLUSTER modifier
2748# https://clickhouse.com/docs/en/sql-reference/distributed-ddl
2749class OnCluster(Property):
2750    arg_types = {"this": True}
2751
2752
2753# Clickhouse EMPTY table "property"
2754class EmptyProperty(Property):
2755    arg_types = {}
2756
2757
2758class LikeProperty(Property):
2759    arg_types = {"this": True, "expressions": False}
2760
2761
2762class LocationProperty(Property):
2763    arg_types = {"this": True}
2764
2765
2766class LockProperty(Property):
2767    arg_types = {"this": True}
2768
2769
2770class LockingProperty(Property):
2771    arg_types = {
2772        "this": False,
2773        "kind": True,
2774        "for_or_in": False,
2775        "lock_type": True,
2776        "override": False,
2777    }
2778
2779
2780class LogProperty(Property):
2781    arg_types = {"no": True}
2782
2783
2784class MaterializedProperty(Property):
2785    arg_types = {"this": False}
2786
2787
2788class MergeBlockRatioProperty(Property):
2789    arg_types = {"this": False, "no": False, "default": False, "percent": False}
2790
2791
2792class NoPrimaryIndexProperty(Property):
2793    arg_types = {}
2794
2795
2796class OnProperty(Property):
2797    arg_types = {"this": True}
2798
2799
2800class OnCommitProperty(Property):
2801    arg_types = {"delete": False}
2802
2803
2804class PartitionedByProperty(Property):
2805    arg_types = {"this": True}
2806
2807
2808# https://www.postgresql.org/docs/current/sql-createtable.html
2809class PartitionBoundSpec(Expression):
2810    # this -> IN / MODULUS, expression -> REMAINDER, from_expressions -> FROM (...), to_expressions -> TO (...)
2811    arg_types = {
2812        "this": False,
2813        "expression": False,
2814        "from_expressions": False,
2815        "to_expressions": False,
2816    }
2817
2818
2819class PartitionedOfProperty(Property):
2820    # this -> parent_table (schema), expression -> FOR VALUES ... / DEFAULT
2821    arg_types = {"this": True, "expression": True}
2822
2823
2824class StreamingTableProperty(Property):
2825    arg_types = {}
2826
2827
2828class RemoteWithConnectionModelProperty(Property):
2829    arg_types = {"this": True}
2830
2831
2832class ReturnsProperty(Property):
2833    arg_types = {"this": False, "is_table": False, "table": False, "null": False}
2834
2835
2836class StrictProperty(Property):
2837    arg_types = {}
2838
2839
2840class RowFormatProperty(Property):
2841    arg_types = {"this": True}
2842
2843
2844class RowFormatDelimitedProperty(Property):
2845    # https://cwiki.apache.org/confluence/display/hive/languagemanual+dml
2846    arg_types = {
2847        "fields": False,
2848        "escaped": False,
2849        "collection_items": False,
2850        "map_keys": False,
2851        "lines": False,
2852        "null": False,
2853        "serde": False,
2854    }
2855
2856
2857class RowFormatSerdeProperty(Property):
2858    arg_types = {"this": True, "serde_properties": False}
2859
2860
2861# https://spark.apache.org/docs/3.1.2/sql-ref-syntax-qry-select-transform.html
2862class QueryTransform(Expression):
2863    arg_types = {
2864        "expressions": True,
2865        "command_script": True,
2866        "schema": False,
2867        "row_format_before": False,
2868        "record_writer": False,
2869        "row_format_after": False,
2870        "record_reader": False,
2871    }
2872
2873
2874class SampleProperty(Property):
2875    arg_types = {"this": True}
2876
2877
2878# https://prestodb.io/docs/current/sql/create-view.html#synopsis
2879class SecurityProperty(Property):
2880    arg_types = {"this": True}
2881
2882
2883class SchemaCommentProperty(Property):
2884    arg_types = {"this": True}
2885
2886
2887class SerdeProperties(Property):
2888    arg_types = {"expressions": True, "with": False}
2889
2890
2891class SetProperty(Property):
2892    arg_types = {"multi": True}
2893
2894
2895class SharingProperty(Property):
2896    arg_types = {"this": False}
2897
2898
2899class SetConfigProperty(Property):
2900    arg_types = {"this": True}
2901
2902
2903class SettingsProperty(Property):
2904    arg_types = {"expressions": True}
2905
2906
2907class SortKeyProperty(Property):
2908    arg_types = {"this": True, "compound": False}
2909
2910
2911class SqlReadWriteProperty(Property):
2912    arg_types = {"this": True}
2913
2914
2915class SqlSecurityProperty(Property):
2916    arg_types = {"definer": True}
2917
2918
2919class StabilityProperty(Property):
2920    arg_types = {"this": True}
2921
2922
2923class TemporaryProperty(Property):
2924    arg_types = {"this": False}
2925
2926
2927class SecureProperty(Property):
2928    arg_types = {}
2929
2930
2931class TransformModelProperty(Property):
2932    arg_types = {"expressions": True}
2933
2934
2935class TransientProperty(Property):
2936    arg_types = {"this": False}
2937
2938
2939class UnloggedProperty(Property):
2940    arg_types = {}
2941
2942
2943# https://learn.microsoft.com/en-us/sql/t-sql/statements/create-view-transact-sql?view=sql-server-ver16
2944class ViewAttributeProperty(Property):
2945    arg_types = {"this": True}
2946
2947
2948class VolatileProperty(Property):
2949    arg_types = {"this": False}
2950
2951
2952class WithDataProperty(Property):
2953    arg_types = {"no": True, "statistics": False}
2954
2955
2956class WithJournalTableProperty(Property):
2957    arg_types = {"this": True}
2958
2959
2960class WithSchemaBindingProperty(Property):
2961    arg_types = {"this": True}
2962
2963
2964class WithSystemVersioningProperty(Property):
2965    arg_types = {
2966        "on": False,
2967        "this": False,
2968        "data_consistency": False,
2969        "retention_period": False,
2970        "with": True,
2971    }
2972
2973
2974class Properties(Expression):
2975    arg_types = {"expressions": True}
2976
2977    NAME_TO_PROPERTY = {
2978        "ALGORITHM": AlgorithmProperty,
2979        "AUTO_INCREMENT": AutoIncrementProperty,
2980        "CHARACTER SET": CharacterSetProperty,
2981        "CLUSTERED_BY": ClusteredByProperty,
2982        "COLLATE": CollateProperty,
2983        "COMMENT": SchemaCommentProperty,
2984        "DEFINER": DefinerProperty,
2985        "DISTKEY": DistKeyProperty,
2986        "DISTRIBUTED_BY": DistributedByProperty,
2987        "DISTSTYLE": DistStyleProperty,
2988        "ENGINE": EngineProperty,
2989        "EXECUTE AS": ExecuteAsProperty,
2990        "FORMAT": FileFormatProperty,
2991        "LANGUAGE": LanguageProperty,
2992        "LOCATION": LocationProperty,
2993        "LOCK": LockProperty,
2994        "PARTITIONED_BY": PartitionedByProperty,
2995        "RETURNS": ReturnsProperty,
2996        "ROW_FORMAT": RowFormatProperty,
2997        "SORTKEY": SortKeyProperty,
2998    }
2999
3000    PROPERTY_TO_NAME = {v: k for k, v in NAME_TO_PROPERTY.items()}
3001
3002    # CREATE property locations
3003    # Form: schema specified
3004    #   create [POST_CREATE]
3005    #     table a [POST_NAME]
3006    #     (b int) [POST_SCHEMA]
3007    #     with ([POST_WITH])
3008    #     index (b) [POST_INDEX]
3009    #
3010    # Form: alias selection
3011    #   create [POST_CREATE]
3012    #     table a [POST_NAME]
3013    #     as [POST_ALIAS] (select * from b) [POST_EXPRESSION]
3014    #     index (c) [POST_INDEX]
3015    class Location(AutoName):
3016        POST_CREATE = auto()
3017        POST_NAME = auto()
3018        POST_SCHEMA = auto()
3019        POST_WITH = auto()
3020        POST_ALIAS = auto()
3021        POST_EXPRESSION = auto()
3022        POST_INDEX = auto()
3023        UNSUPPORTED = auto()
3024
3025    @classmethod
3026    def from_dict(cls, properties_dict: t.Dict) -> Properties:
3027        expressions = []
3028        for key, value in properties_dict.items():
3029            property_cls = cls.NAME_TO_PROPERTY.get(key.upper())
3030            if property_cls:
3031                expressions.append(property_cls(this=convert(value)))
3032            else:
3033                expressions.append(Property(this=Literal.string(key), value=convert(value)))
3034
3035        return cls(expressions=expressions)
3036
3037
3038class Qualify(Expression):
3039    pass
3040
3041
3042class InputOutputFormat(Expression):
3043    arg_types = {"input_format": False, "output_format": False}
3044
3045
3046# https://www.ibm.com/docs/en/ias?topic=procedures-return-statement-in-sql
3047class Return(Expression):
3048    pass
3049
3050
3051class Reference(Expression):
3052    arg_types = {"this": True, "expressions": False, "options": False}
3053
3054
3055class Tuple(Expression):
3056    arg_types = {"expressions": False}
3057
3058    def isin(
3059        self,
3060        *expressions: t.Any,
3061        query: t.Optional[ExpOrStr] = None,
3062        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
3063        copy: bool = True,
3064        **opts,
3065    ) -> In:
3066        return In(
3067            this=maybe_copy(self, copy),
3068            expressions=[convert(e, copy=copy) for e in expressions],
3069            query=maybe_parse(query, copy=copy, **opts) if query else None,
3070            unnest=(
3071                Unnest(
3072                    expressions=[
3073                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
3074                        for e in ensure_list(unnest)
3075                    ]
3076                )
3077                if unnest
3078                else None
3079            ),
3080        )
3081
3082
3083QUERY_MODIFIERS = {
3084    "match": False,
3085    "laterals": False,
3086    "joins": False,
3087    "connect": False,
3088    "pivots": False,
3089    "prewhere": False,
3090    "where": False,
3091    "group": False,
3092    "having": False,
3093    "qualify": False,
3094    "windows": False,
3095    "distribute": False,
3096    "sort": False,
3097    "cluster": False,
3098    "order": False,
3099    "limit": False,
3100    "offset": False,
3101    "locks": False,
3102    "sample": False,
3103    "settings": False,
3104    "format": False,
3105    "options": False,
3106}
3107
3108
3109# https://learn.microsoft.com/en-us/sql/t-sql/queries/option-clause-transact-sql?view=sql-server-ver16
3110# https://learn.microsoft.com/en-us/sql/t-sql/queries/hints-transact-sql-query?view=sql-server-ver16
3111class QueryOption(Expression):
3112    arg_types = {"this": True, "expression": False}
3113
3114
3115# https://learn.microsoft.com/en-us/sql/t-sql/queries/hints-transact-sql-table?view=sql-server-ver16
3116class WithTableHint(Expression):
3117    arg_types = {"expressions": True}
3118
3119
3120# https://dev.mysql.com/doc/refman/8.0/en/index-hints.html
3121class IndexTableHint(Expression):
3122    arg_types = {"this": True, "expressions": False, "target": False}
3123
3124
3125# https://docs.snowflake.com/en/sql-reference/constructs/at-before
3126class HistoricalData(Expression):
3127    arg_types = {"this": True, "kind": True, "expression": True}
3128
3129
3130class Table(Expression):
3131    arg_types = {
3132        "this": False,
3133        "alias": False,
3134        "db": False,
3135        "catalog": False,
3136        "laterals": False,
3137        "joins": False,
3138        "pivots": False,
3139        "hints": False,
3140        "system_time": False,
3141        "version": False,
3142        "format": False,
3143        "pattern": False,
3144        "ordinality": False,
3145        "when": False,
3146        "only": False,
3147        "partition": False,
3148        "changes": False,
3149        "rows_from": False,
3150        "sample": False,
3151    }
3152
3153    @property
3154    def name(self) -> str:
3155        if isinstance(self.this, Func):
3156            return ""
3157        return self.this.name
3158
3159    @property
3160    def db(self) -> str:
3161        return self.text("db")
3162
3163    @property
3164    def catalog(self) -> str:
3165        return self.text("catalog")
3166
3167    @property
3168    def selects(self) -> t.List[Expression]:
3169        return []
3170
3171    @property
3172    def named_selects(self) -> t.List[str]:
3173        return []
3174
3175    @property
3176    def parts(self) -> t.List[Expression]:
3177        """Return the parts of a table in order catalog, db, table."""
3178        parts: t.List[Expression] = []
3179
3180        for arg in ("catalog", "db", "this"):
3181            part = self.args.get(arg)
3182
3183            if isinstance(part, Dot):
3184                parts.extend(part.flatten())
3185            elif isinstance(part, Expression):
3186                parts.append(part)
3187
3188        return parts
3189
3190    def to_column(self, copy: bool = True) -> Alias | Column | Dot:
3191        parts = self.parts
3192        col = column(*reversed(parts[0:4]), fields=parts[4:], copy=copy)  # type: ignore
3193        alias = self.args.get("alias")
3194        if alias:
3195            col = alias_(col, alias.this, copy=copy)
3196        return col
3197
3198
3199class SetOperation(Query):
3200    arg_types = {
3201        "with": False,
3202        "this": True,
3203        "expression": True,
3204        "distinct": False,
3205        "by_name": False,
3206        **QUERY_MODIFIERS,
3207    }
3208
3209    def select(
3210        self: S,
3211        *expressions: t.Optional[ExpOrStr],
3212        append: bool = True,
3213        dialect: DialectType = None,
3214        copy: bool = True,
3215        **opts,
3216    ) -> S:
3217        this = maybe_copy(self, copy)
3218        this.this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3219        this.expression.unnest().select(
3220            *expressions, append=append, dialect=dialect, copy=False, **opts
3221        )
3222        return this
3223
3224    @property
3225    def named_selects(self) -> t.List[str]:
3226        return self.this.unnest().named_selects
3227
3228    @property
3229    def is_star(self) -> bool:
3230        return self.this.is_star or self.expression.is_star
3231
3232    @property
3233    def selects(self) -> t.List[Expression]:
3234        return self.this.unnest().selects
3235
3236    @property
3237    def left(self) -> Query:
3238        return self.this
3239
3240    @property
3241    def right(self) -> Query:
3242        return self.expression
3243
3244
3245class Union(SetOperation):
3246    pass
3247
3248
3249class Except(SetOperation):
3250    pass
3251
3252
3253class Intersect(SetOperation):
3254    pass
3255
3256
3257class Update(Expression):
3258    arg_types = {
3259        "with": False,
3260        "this": False,
3261        "expressions": True,
3262        "from": False,
3263        "where": False,
3264        "returning": False,
3265        "order": False,
3266        "limit": False,
3267    }
3268
3269
3270class Values(UDTF):
3271    arg_types = {"expressions": True, "alias": False}
3272
3273
3274class Var(Expression):
3275    pass
3276
3277
3278class Version(Expression):
3279    """
3280    Time travel, iceberg, bigquery etc
3281    https://trino.io/docs/current/connector/iceberg.html?highlight=snapshot#using-snapshots
3282    https://www.databricks.com/blog/2019/02/04/introducing-delta-time-travel-for-large-scale-data-lakes.html
3283    https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#for_system_time_as_of
3284    https://learn.microsoft.com/en-us/sql/relational-databases/tables/querying-data-in-a-system-versioned-temporal-table?view=sql-server-ver16
3285    this is either TIMESTAMP or VERSION
3286    kind is ("AS OF", "BETWEEN")
3287    """
3288
3289    arg_types = {"this": True, "kind": True, "expression": False}
3290
3291
3292class Schema(Expression):
3293    arg_types = {"this": False, "expressions": False}
3294
3295
3296# https://dev.mysql.com/doc/refman/8.0/en/select.html
3297# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/SELECT.html
3298class Lock(Expression):
3299    arg_types = {"update": True, "expressions": False, "wait": False}
3300
3301
3302class Select(Query):
3303    arg_types = {
3304        "with": False,
3305        "kind": False,
3306        "expressions": False,
3307        "hint": False,
3308        "distinct": False,
3309        "into": False,
3310        "from": False,
3311        **QUERY_MODIFIERS,
3312    }
3313
3314    def from_(
3315        self, expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
3316    ) -> Select:
3317        """
3318        Set the FROM expression.
3319
3320        Example:
3321            >>> Select().from_("tbl").select("x").sql()
3322            'SELECT x FROM tbl'
3323
3324        Args:
3325            expression : the SQL code strings to parse.
3326                If a `From` instance is passed, this is used as-is.
3327                If another `Expression` instance is passed, it will be wrapped in a `From`.
3328            dialect: the dialect used to parse the input expression.
3329            copy: if `False`, modify this expression instance in-place.
3330            opts: other options to use to parse the input expressions.
3331
3332        Returns:
3333            The modified Select expression.
3334        """
3335        return _apply_builder(
3336            expression=expression,
3337            instance=self,
3338            arg="from",
3339            into=From,
3340            prefix="FROM",
3341            dialect=dialect,
3342            copy=copy,
3343            **opts,
3344        )
3345
3346    def group_by(
3347        self,
3348        *expressions: t.Optional[ExpOrStr],
3349        append: bool = True,
3350        dialect: DialectType = None,
3351        copy: bool = True,
3352        **opts,
3353    ) -> Select:
3354        """
3355        Set the GROUP BY expression.
3356
3357        Example:
3358            >>> Select().from_("tbl").select("x", "COUNT(1)").group_by("x").sql()
3359            'SELECT x, COUNT(1) FROM tbl GROUP BY x'
3360
3361        Args:
3362            *expressions: the SQL code strings to parse.
3363                If a `Group` instance is passed, this is used as-is.
3364                If another `Expression` instance is passed, it will be wrapped in a `Group`.
3365                If nothing is passed in then a group by is not applied to the expression
3366            append: if `True`, add to any existing expressions.
3367                Otherwise, this flattens all the `Group` expression into a single expression.
3368            dialect: the dialect used to parse the input expression.
3369            copy: if `False`, modify this expression instance in-place.
3370            opts: other options to use to parse the input expressions.
3371
3372        Returns:
3373            The modified Select expression.
3374        """
3375        if not expressions:
3376            return self if not copy else self.copy()
3377
3378        return _apply_child_list_builder(
3379            *expressions,
3380            instance=self,
3381            arg="group",
3382            append=append,
3383            copy=copy,
3384            prefix="GROUP BY",
3385            into=Group,
3386            dialect=dialect,
3387            **opts,
3388        )
3389
3390    def sort_by(
3391        self,
3392        *expressions: t.Optional[ExpOrStr],
3393        append: bool = True,
3394        dialect: DialectType = None,
3395        copy: bool = True,
3396        **opts,
3397    ) -> Select:
3398        """
3399        Set the SORT BY expression.
3400
3401        Example:
3402            >>> Select().from_("tbl").select("x").sort_by("x DESC").sql(dialect="hive")
3403            'SELECT x FROM tbl SORT BY x DESC'
3404
3405        Args:
3406            *expressions: the SQL code strings to parse.
3407                If a `Group` instance is passed, this is used as-is.
3408                If another `Expression` instance is passed, it will be wrapped in a `SORT`.
3409            append: if `True`, add to any existing expressions.
3410                Otherwise, this flattens all the `Order` expression into a single expression.
3411            dialect: the dialect used to parse the input expression.
3412            copy: if `False`, modify this expression instance in-place.
3413            opts: other options to use to parse the input expressions.
3414
3415        Returns:
3416            The modified Select expression.
3417        """
3418        return _apply_child_list_builder(
3419            *expressions,
3420            instance=self,
3421            arg="sort",
3422            append=append,
3423            copy=copy,
3424            prefix="SORT BY",
3425            into=Sort,
3426            dialect=dialect,
3427            **opts,
3428        )
3429
3430    def cluster_by(
3431        self,
3432        *expressions: t.Optional[ExpOrStr],
3433        append: bool = True,
3434        dialect: DialectType = None,
3435        copy: bool = True,
3436        **opts,
3437    ) -> Select:
3438        """
3439        Set the CLUSTER BY expression.
3440
3441        Example:
3442            >>> Select().from_("tbl").select("x").cluster_by("x DESC").sql(dialect="hive")
3443            'SELECT x FROM tbl CLUSTER BY x DESC'
3444
3445        Args:
3446            *expressions: the SQL code strings to parse.
3447                If a `Group` instance is passed, this is used as-is.
3448                If another `Expression` instance is passed, it will be wrapped in a `Cluster`.
3449            append: if `True`, add to any existing expressions.
3450                Otherwise, this flattens all the `Order` expression into a single expression.
3451            dialect: the dialect used to parse the input expression.
3452            copy: if `False`, modify this expression instance in-place.
3453            opts: other options to use to parse the input expressions.
3454
3455        Returns:
3456            The modified Select expression.
3457        """
3458        return _apply_child_list_builder(
3459            *expressions,
3460            instance=self,
3461            arg="cluster",
3462            append=append,
3463            copy=copy,
3464            prefix="CLUSTER BY",
3465            into=Cluster,
3466            dialect=dialect,
3467            **opts,
3468        )
3469
3470    def select(
3471        self,
3472        *expressions: t.Optional[ExpOrStr],
3473        append: bool = True,
3474        dialect: DialectType = None,
3475        copy: bool = True,
3476        **opts,
3477    ) -> Select:
3478        return _apply_list_builder(
3479            *expressions,
3480            instance=self,
3481            arg="expressions",
3482            append=append,
3483            dialect=dialect,
3484            into=Expression,
3485            copy=copy,
3486            **opts,
3487        )
3488
3489    def lateral(
3490        self,
3491        *expressions: t.Optional[ExpOrStr],
3492        append: bool = True,
3493        dialect: DialectType = None,
3494        copy: bool = True,
3495        **opts,
3496    ) -> Select:
3497        """
3498        Append to or set the LATERAL expressions.
3499
3500        Example:
3501            >>> Select().select("x").lateral("OUTER explode(y) tbl2 AS z").from_("tbl").sql()
3502            'SELECT x FROM tbl LATERAL VIEW OUTER EXPLODE(y) tbl2 AS z'
3503
3504        Args:
3505            *expressions: the SQL code strings to parse.
3506                If an `Expression` instance is passed, it will be used as-is.
3507            append: if `True`, add to any existing expressions.
3508                Otherwise, this resets the expressions.
3509            dialect: the dialect used to parse the input expressions.
3510            copy: if `False`, modify this expression instance in-place.
3511            opts: other options to use to parse the input expressions.
3512
3513        Returns:
3514            The modified Select expression.
3515        """
3516        return _apply_list_builder(
3517            *expressions,
3518            instance=self,
3519            arg="laterals",
3520            append=append,
3521            into=Lateral,
3522            prefix="LATERAL VIEW",
3523            dialect=dialect,
3524            copy=copy,
3525            **opts,
3526        )
3527
3528    def join(
3529        self,
3530        expression: ExpOrStr,
3531        on: t.Optional[ExpOrStr] = None,
3532        using: t.Optional[ExpOrStr | t.Collection[ExpOrStr]] = None,
3533        append: bool = True,
3534        join_type: t.Optional[str] = None,
3535        join_alias: t.Optional[Identifier | str] = None,
3536        dialect: DialectType = None,
3537        copy: bool = True,
3538        **opts,
3539    ) -> Select:
3540        """
3541        Append to or set the JOIN expressions.
3542
3543        Example:
3544            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y").sql()
3545            'SELECT * FROM tbl JOIN tbl2 ON tbl1.y = tbl2.y'
3546
3547            >>> Select().select("1").from_("a").join("b", using=["x", "y", "z"]).sql()
3548            'SELECT 1 FROM a JOIN b USING (x, y, z)'
3549
3550            Use `join_type` to change the type of join:
3551
3552            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y", join_type="left outer").sql()
3553            'SELECT * FROM tbl LEFT OUTER JOIN tbl2 ON tbl1.y = tbl2.y'
3554
3555        Args:
3556            expression: the SQL code string to parse.
3557                If an `Expression` instance is passed, it will be used as-is.
3558            on: optionally specify the join "on" criteria as a SQL string.
3559                If an `Expression` instance is passed, it will be used as-is.
3560            using: optionally specify the join "using" criteria as a SQL string.
3561                If an `Expression` instance is passed, it will be used as-is.
3562            append: if `True`, add to any existing expressions.
3563                Otherwise, this resets the expressions.
3564            join_type: if set, alter the parsed join type.
3565            join_alias: an optional alias for the joined source.
3566            dialect: the dialect used to parse the input expressions.
3567            copy: if `False`, modify this expression instance in-place.
3568            opts: other options to use to parse the input expressions.
3569
3570        Returns:
3571            Select: the modified expression.
3572        """
3573        parse_args: t.Dict[str, t.Any] = {"dialect": dialect, **opts}
3574
3575        try:
3576            expression = maybe_parse(expression, into=Join, prefix="JOIN", **parse_args)
3577        except ParseError:
3578            expression = maybe_parse(expression, into=(Join, Expression), **parse_args)
3579
3580        join = expression if isinstance(expression, Join) else Join(this=expression)
3581
3582        if isinstance(join.this, Select):
3583            join.this.replace(join.this.subquery())
3584
3585        if join_type:
3586            method: t.Optional[Token]
3587            side: t.Optional[Token]
3588            kind: t.Optional[Token]
3589
3590            method, side, kind = maybe_parse(join_type, into="JOIN_TYPE", **parse_args)  # type: ignore
3591
3592            if method:
3593                join.set("method", method.text)
3594            if side:
3595                join.set("side", side.text)
3596            if kind:
3597                join.set("kind", kind.text)
3598
3599        if on:
3600            on = and_(*ensure_list(on), dialect=dialect, copy=copy, **opts)
3601            join.set("on", on)
3602
3603        if using:
3604            join = _apply_list_builder(
3605                *ensure_list(using),
3606                instance=join,
3607                arg="using",
3608                append=append,
3609                copy=copy,
3610                into=Identifier,
3611                **opts,
3612            )
3613
3614        if join_alias:
3615            join.set("this", alias_(join.this, join_alias, table=True))
3616
3617        return _apply_list_builder(
3618            join,
3619            instance=self,
3620            arg="joins",
3621            append=append,
3622            copy=copy,
3623            **opts,
3624        )
3625
3626    def where(
3627        self,
3628        *expressions: t.Optional[ExpOrStr],
3629        append: bool = True,
3630        dialect: DialectType = None,
3631        copy: bool = True,
3632        **opts,
3633    ) -> Select:
3634        """
3635        Append to or set the WHERE expressions.
3636
3637        Example:
3638            >>> Select().select("x").from_("tbl").where("x = 'a' OR x < 'b'").sql()
3639            "SELECT x FROM tbl WHERE x = 'a' OR x < 'b'"
3640
3641        Args:
3642            *expressions: the SQL code strings to parse.
3643                If an `Expression` instance is passed, it will be used as-is.
3644                Multiple expressions are combined with an AND operator.
3645            append: if `True`, AND the new expressions to any existing expression.
3646                Otherwise, this resets the expression.
3647            dialect: the dialect used to parse the input expressions.
3648            copy: if `False`, modify this expression instance in-place.
3649            opts: other options to use to parse the input expressions.
3650
3651        Returns:
3652            Select: the modified expression.
3653        """
3654        return _apply_conjunction_builder(
3655            *expressions,
3656            instance=self,
3657            arg="where",
3658            append=append,
3659            into=Where,
3660            dialect=dialect,
3661            copy=copy,
3662            **opts,
3663        )
3664
3665    def having(
3666        self,
3667        *expressions: t.Optional[ExpOrStr],
3668        append: bool = True,
3669        dialect: DialectType = None,
3670        copy: bool = True,
3671        **opts,
3672    ) -> Select:
3673        """
3674        Append to or set the HAVING expressions.
3675
3676        Example:
3677            >>> Select().select("x", "COUNT(y)").from_("tbl").group_by("x").having("COUNT(y) > 3").sql()
3678            'SELECT x, COUNT(y) FROM tbl GROUP BY x HAVING COUNT(y) > 3'
3679
3680        Args:
3681            *expressions: the SQL code strings to parse.
3682                If an `Expression` instance is passed, it will be used as-is.
3683                Multiple expressions are combined with an AND operator.
3684            append: if `True`, AND the new expressions to any existing expression.
3685                Otherwise, this resets the expression.
3686            dialect: the dialect used to parse the input expressions.
3687            copy: if `False`, modify this expression instance in-place.
3688            opts: other options to use to parse the input expressions.
3689
3690        Returns:
3691            The modified Select expression.
3692        """
3693        return _apply_conjunction_builder(
3694            *expressions,
3695            instance=self,
3696            arg="having",
3697            append=append,
3698            into=Having,
3699            dialect=dialect,
3700            copy=copy,
3701            **opts,
3702        )
3703
3704    def window(
3705        self,
3706        *expressions: t.Optional[ExpOrStr],
3707        append: bool = True,
3708        dialect: DialectType = None,
3709        copy: bool = True,
3710        **opts,
3711    ) -> Select:
3712        return _apply_list_builder(
3713            *expressions,
3714            instance=self,
3715            arg="windows",
3716            append=append,
3717            into=Window,
3718            dialect=dialect,
3719            copy=copy,
3720            **opts,
3721        )
3722
3723    def qualify(
3724        self,
3725        *expressions: t.Optional[ExpOrStr],
3726        append: bool = True,
3727        dialect: DialectType = None,
3728        copy: bool = True,
3729        **opts,
3730    ) -> Select:
3731        return _apply_conjunction_builder(
3732            *expressions,
3733            instance=self,
3734            arg="qualify",
3735            append=append,
3736            into=Qualify,
3737            dialect=dialect,
3738            copy=copy,
3739            **opts,
3740        )
3741
3742    def distinct(
3743        self, *ons: t.Optional[ExpOrStr], distinct: bool = True, copy: bool = True
3744    ) -> Select:
3745        """
3746        Set the OFFSET expression.
3747
3748        Example:
3749            >>> Select().from_("tbl").select("x").distinct().sql()
3750            'SELECT DISTINCT x FROM tbl'
3751
3752        Args:
3753            ons: the expressions to distinct on
3754            distinct: whether the Select should be distinct
3755            copy: if `False`, modify this expression instance in-place.
3756
3757        Returns:
3758            Select: the modified expression.
3759        """
3760        instance = maybe_copy(self, copy)
3761        on = Tuple(expressions=[maybe_parse(on, copy=copy) for on in ons if on]) if ons else None
3762        instance.set("distinct", Distinct(on=on) if distinct else None)
3763        return instance
3764
3765    def ctas(
3766        self,
3767        table: ExpOrStr,
3768        properties: t.Optional[t.Dict] = None,
3769        dialect: DialectType = None,
3770        copy: bool = True,
3771        **opts,
3772    ) -> Create:
3773        """
3774        Convert this expression to a CREATE TABLE AS statement.
3775
3776        Example:
3777            >>> Select().select("*").from_("tbl").ctas("x").sql()
3778            'CREATE TABLE x AS SELECT * FROM tbl'
3779
3780        Args:
3781            table: the SQL code string to parse as the table name.
3782                If another `Expression` instance is passed, it will be used as-is.
3783            properties: an optional mapping of table properties
3784            dialect: the dialect used to parse the input table.
3785            copy: if `False`, modify this expression instance in-place.
3786            opts: other options to use to parse the input table.
3787
3788        Returns:
3789            The new Create expression.
3790        """
3791        instance = maybe_copy(self, copy)
3792        table_expression = maybe_parse(table, into=Table, dialect=dialect, **opts)
3793
3794        properties_expression = None
3795        if properties:
3796            properties_expression = Properties.from_dict(properties)
3797
3798        return Create(
3799            this=table_expression,
3800            kind="TABLE",
3801            expression=instance,
3802            properties=properties_expression,
3803        )
3804
3805    def lock(self, update: bool = True, copy: bool = True) -> Select:
3806        """
3807        Set the locking read mode for this expression.
3808
3809        Examples:
3810            >>> Select().select("x").from_("tbl").where("x = 'a'").lock().sql("mysql")
3811            "SELECT x FROM tbl WHERE x = 'a' FOR UPDATE"
3812
3813            >>> Select().select("x").from_("tbl").where("x = 'a'").lock(update=False).sql("mysql")
3814            "SELECT x FROM tbl WHERE x = 'a' FOR SHARE"
3815
3816        Args:
3817            update: if `True`, the locking type will be `FOR UPDATE`, else it will be `FOR SHARE`.
3818            copy: if `False`, modify this expression instance in-place.
3819
3820        Returns:
3821            The modified expression.
3822        """
3823        inst = maybe_copy(self, copy)
3824        inst.set("locks", [Lock(update=update)])
3825
3826        return inst
3827
3828    def hint(self, *hints: ExpOrStr, dialect: DialectType = None, copy: bool = True) -> Select:
3829        """
3830        Set hints for this expression.
3831
3832        Examples:
3833            >>> Select().select("x").from_("tbl").hint("BROADCAST(y)").sql(dialect="spark")
3834            'SELECT /*+ BROADCAST(y) */ x FROM tbl'
3835
3836        Args:
3837            hints: The SQL code strings to parse as the hints.
3838                If an `Expression` instance is passed, it will be used as-is.
3839            dialect: The dialect used to parse the hints.
3840            copy: If `False`, modify this expression instance in-place.
3841
3842        Returns:
3843            The modified expression.
3844        """
3845        inst = maybe_copy(self, copy)
3846        inst.set(
3847            "hint", Hint(expressions=[maybe_parse(h, copy=copy, dialect=dialect) for h in hints])
3848        )
3849
3850        return inst
3851
3852    @property
3853    def named_selects(self) -> t.List[str]:
3854        return [e.output_name for e in self.expressions if e.alias_or_name]
3855
3856    @property
3857    def is_star(self) -> bool:
3858        return any(expression.is_star for expression in self.expressions)
3859
3860    @property
3861    def selects(self) -> t.List[Expression]:
3862        return self.expressions
3863
3864
3865UNWRAPPED_QUERIES = (Select, SetOperation)
3866
3867
3868class Subquery(DerivedTable, Query):
3869    arg_types = {
3870        "this": True,
3871        "alias": False,
3872        "with": False,
3873        **QUERY_MODIFIERS,
3874    }
3875
3876    def unnest(self):
3877        """Returns the first non subquery."""
3878        expression = self
3879        while isinstance(expression, Subquery):
3880            expression = expression.this
3881        return expression
3882
3883    def unwrap(self) -> Subquery:
3884        expression = self
3885        while expression.same_parent and expression.is_wrapper:
3886            expression = t.cast(Subquery, expression.parent)
3887        return expression
3888
3889    def select(
3890        self,
3891        *expressions: t.Optional[ExpOrStr],
3892        append: bool = True,
3893        dialect: DialectType = None,
3894        copy: bool = True,
3895        **opts,
3896    ) -> Subquery:
3897        this = maybe_copy(self, copy)
3898        this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3899        return this
3900
3901    @property
3902    def is_wrapper(self) -> bool:
3903        """
3904        Whether this Subquery acts as a simple wrapper around another expression.
3905
3906        SELECT * FROM (((SELECT * FROM t)))
3907                      ^
3908                      This corresponds to a "wrapper" Subquery node
3909        """
3910        return all(v is None for k, v in self.args.items() if k != "this")
3911
3912    @property
3913    def is_star(self) -> bool:
3914        return self.this.is_star
3915
3916    @property
3917    def output_name(self) -> str:
3918        return self.alias
3919
3920
3921class TableSample(Expression):
3922    arg_types = {
3923        "expressions": False,
3924        "method": False,
3925        "bucket_numerator": False,
3926        "bucket_denominator": False,
3927        "bucket_field": False,
3928        "percent": False,
3929        "rows": False,
3930        "size": False,
3931        "seed": False,
3932    }
3933
3934
3935class Tag(Expression):
3936    """Tags are used for generating arbitrary sql like SELECT <span>x</span>."""
3937
3938    arg_types = {
3939        "this": False,
3940        "prefix": False,
3941        "postfix": False,
3942    }
3943
3944
3945# Represents both the standard SQL PIVOT operator and DuckDB's "simplified" PIVOT syntax
3946# https://duckdb.org/docs/sql/statements/pivot
3947class Pivot(Expression):
3948    arg_types = {
3949        "this": False,
3950        "alias": False,
3951        "expressions": False,
3952        "field": False,
3953        "unpivot": False,
3954        "using": False,
3955        "group": False,
3956        "columns": False,
3957        "include_nulls": False,
3958        "default_on_null": False,
3959    }
3960
3961    @property
3962    def unpivot(self) -> bool:
3963        return bool(self.args.get("unpivot"))
3964
3965
3966class Window(Condition):
3967    arg_types = {
3968        "this": True,
3969        "partition_by": False,
3970        "order": False,
3971        "spec": False,
3972        "alias": False,
3973        "over": False,
3974        "first": False,
3975    }
3976
3977
3978class WindowSpec(Expression):
3979    arg_types = {
3980        "kind": False,
3981        "start": False,
3982        "start_side": False,
3983        "end": False,
3984        "end_side": False,
3985    }
3986
3987
3988class PreWhere(Expression):
3989    pass
3990
3991
3992class Where(Expression):
3993    pass
3994
3995
3996class Star(Expression):
3997    arg_types = {"except": False, "replace": False, "rename": False}
3998
3999    @property
4000    def name(self) -> str:
4001        return "*"
4002
4003    @property
4004    def output_name(self) -> str:
4005        return self.name
4006
4007
4008class Parameter(Condition):
4009    arg_types = {"this": True, "expression": False}
4010
4011
4012class SessionParameter(Condition):
4013    arg_types = {"this": True, "kind": False}
4014
4015
4016class Placeholder(Condition):
4017    arg_types = {"this": False, "kind": False}
4018
4019    @property
4020    def name(self) -> str:
4021        return self.this or "?"
4022
4023
4024class Null(Condition):
4025    arg_types: t.Dict[str, t.Any] = {}
4026
4027    @property
4028    def name(self) -> str:
4029        return "NULL"
4030
4031    def to_py(self) -> Lit[None]:
4032        return None
4033
4034
4035class Boolean(Condition):
4036    def to_py(self) -> bool:
4037        return self.this
4038
4039
4040class DataTypeParam(Expression):
4041    arg_types = {"this": True, "expression": False}
4042
4043    @property
4044    def name(self) -> str:
4045        return self.this.name
4046
4047
4048# The `nullable` arg is helpful when transpiling types from other dialects to ClickHouse, which
4049# assumes non-nullable types by default. Values `None` and `True` mean the type is nullable.
4050class DataType(Expression):
4051    arg_types = {
4052        "this": True,
4053        "expressions": False,
4054        "nested": False,
4055        "values": False,
4056        "prefix": False,
4057        "kind": False,
4058        "nullable": False,
4059    }
4060
4061    class Type(AutoName):
4062        ARRAY = auto()
4063        AGGREGATEFUNCTION = auto()
4064        SIMPLEAGGREGATEFUNCTION = auto()
4065        BIGDECIMAL = auto()
4066        BIGINT = auto()
4067        BIGSERIAL = auto()
4068        BINARY = auto()
4069        BIT = auto()
4070        BOOLEAN = auto()
4071        BPCHAR = auto()
4072        CHAR = auto()
4073        DATE = auto()
4074        DATE32 = auto()
4075        DATEMULTIRANGE = auto()
4076        DATERANGE = auto()
4077        DATETIME = auto()
4078        DATETIME64 = auto()
4079        DECIMAL = auto()
4080        DECIMAL32 = auto()
4081        DECIMAL64 = auto()
4082        DECIMAL128 = auto()
4083        DOUBLE = auto()
4084        ENUM = auto()
4085        ENUM8 = auto()
4086        ENUM16 = auto()
4087        FIXEDSTRING = auto()
4088        FLOAT = auto()
4089        GEOGRAPHY = auto()
4090        GEOMETRY = auto()
4091        HLLSKETCH = auto()
4092        HSTORE = auto()
4093        IMAGE = auto()
4094        INET = auto()
4095        INT = auto()
4096        INT128 = auto()
4097        INT256 = auto()
4098        INT4MULTIRANGE = auto()
4099        INT4RANGE = auto()
4100        INT8MULTIRANGE = auto()
4101        INT8RANGE = auto()
4102        INTERVAL = auto()
4103        IPADDRESS = auto()
4104        IPPREFIX = auto()
4105        IPV4 = auto()
4106        IPV6 = auto()
4107        JSON = auto()
4108        JSONB = auto()
4109        LIST = auto()
4110        LONGBLOB = auto()
4111        LONGTEXT = auto()
4112        LOWCARDINALITY = auto()
4113        MAP = auto()
4114        MEDIUMBLOB = auto()
4115        MEDIUMINT = auto()
4116        MEDIUMTEXT = auto()
4117        MONEY = auto()
4118        NAME = auto()
4119        NCHAR = auto()
4120        NESTED = auto()
4121        NULL = auto()
4122        NUMMULTIRANGE = auto()
4123        NUMRANGE = auto()
4124        NVARCHAR = auto()
4125        OBJECT = auto()
4126        ROWVERSION = auto()
4127        SERIAL = auto()
4128        SET = auto()
4129        SMALLINT = auto()
4130        SMALLMONEY = auto()
4131        SMALLSERIAL = auto()
4132        STRUCT = auto()
4133        SUPER = auto()
4134        TEXT = auto()
4135        TINYBLOB = auto()
4136        TINYTEXT = auto()
4137        TIME = auto()
4138        TIMETZ = auto()
4139        TIMESTAMP = auto()
4140        TIMESTAMPNTZ = auto()
4141        TIMESTAMPLTZ = auto()
4142        TIMESTAMPTZ = auto()
4143        TIMESTAMP_S = auto()
4144        TIMESTAMP_MS = auto()
4145        TIMESTAMP_NS = auto()
4146        TINYINT = auto()
4147        TSMULTIRANGE = auto()
4148        TSRANGE = auto()
4149        TSTZMULTIRANGE = auto()
4150        TSTZRANGE = auto()
4151        UBIGINT = auto()
4152        UINT = auto()
4153        UINT128 = auto()
4154        UINT256 = auto()
4155        UMEDIUMINT = auto()
4156        UDECIMAL = auto()
4157        UNIQUEIDENTIFIER = auto()
4158        UNKNOWN = auto()  # Sentinel value, useful for type annotation
4159        USERDEFINED = "USER-DEFINED"
4160        USMALLINT = auto()
4161        UTINYINT = auto()
4162        UUID = auto()
4163        VARBINARY = auto()
4164        VARCHAR = auto()
4165        VARIANT = auto()
4166        VECTOR = auto()
4167        XML = auto()
4168        YEAR = auto()
4169        TDIGEST = auto()
4170
4171    STRUCT_TYPES = {
4172        Type.NESTED,
4173        Type.OBJECT,
4174        Type.STRUCT,
4175    }
4176
4177    ARRAY_TYPES = {
4178        Type.ARRAY,
4179        Type.LIST,
4180    }
4181
4182    NESTED_TYPES = {
4183        *STRUCT_TYPES,
4184        *ARRAY_TYPES,
4185        Type.MAP,
4186    }
4187
4188    TEXT_TYPES = {
4189        Type.CHAR,
4190        Type.NCHAR,
4191        Type.NVARCHAR,
4192        Type.TEXT,
4193        Type.VARCHAR,
4194        Type.NAME,
4195    }
4196
4197    SIGNED_INTEGER_TYPES = {
4198        Type.BIGINT,
4199        Type.INT,
4200        Type.INT128,
4201        Type.INT256,
4202        Type.MEDIUMINT,
4203        Type.SMALLINT,
4204        Type.TINYINT,
4205    }
4206
4207    UNSIGNED_INTEGER_TYPES = {
4208        Type.UBIGINT,
4209        Type.UINT,
4210        Type.UINT128,
4211        Type.UINT256,
4212        Type.UMEDIUMINT,
4213        Type.USMALLINT,
4214        Type.UTINYINT,
4215    }
4216
4217    INTEGER_TYPES = {
4218        *SIGNED_INTEGER_TYPES,
4219        *UNSIGNED_INTEGER_TYPES,
4220        Type.BIT,
4221    }
4222
4223    FLOAT_TYPES = {
4224        Type.DOUBLE,
4225        Type.FLOAT,
4226    }
4227
4228    REAL_TYPES = {
4229        *FLOAT_TYPES,
4230        Type.BIGDECIMAL,
4231        Type.DECIMAL,
4232        Type.DECIMAL32,
4233        Type.DECIMAL64,
4234        Type.DECIMAL128,
4235        Type.MONEY,
4236        Type.SMALLMONEY,
4237        Type.UDECIMAL,
4238    }
4239
4240    NUMERIC_TYPES = {
4241        *INTEGER_TYPES,
4242        *REAL_TYPES,
4243    }
4244
4245    TEMPORAL_TYPES = {
4246        Type.DATE,
4247        Type.DATE32,
4248        Type.DATETIME,
4249        Type.DATETIME64,
4250        Type.TIME,
4251        Type.TIMESTAMP,
4252        Type.TIMESTAMPNTZ,
4253        Type.TIMESTAMPLTZ,
4254        Type.TIMESTAMPTZ,
4255        Type.TIMESTAMP_MS,
4256        Type.TIMESTAMP_NS,
4257        Type.TIMESTAMP_S,
4258        Type.TIMETZ,
4259    }
4260
4261    @classmethod
4262    def build(
4263        cls,
4264        dtype: DATA_TYPE,
4265        dialect: DialectType = None,
4266        udt: bool = False,
4267        copy: bool = True,
4268        **kwargs,
4269    ) -> DataType:
4270        """
4271        Constructs a DataType object.
4272
4273        Args:
4274            dtype: the data type of interest.
4275            dialect: the dialect to use for parsing `dtype`, in case it's a string.
4276            udt: when set to True, `dtype` will be used as-is if it can't be parsed into a
4277                DataType, thus creating a user-defined type.
4278            copy: whether to copy the data type.
4279            kwargs: additional arguments to pass in the constructor of DataType.
4280
4281        Returns:
4282            The constructed DataType object.
4283        """
4284        from sqlglot import parse_one
4285
4286        if isinstance(dtype, str):
4287            if dtype.upper() == "UNKNOWN":
4288                return DataType(this=DataType.Type.UNKNOWN, **kwargs)
4289
4290            try:
4291                data_type_exp = parse_one(
4292                    dtype, read=dialect, into=DataType, error_level=ErrorLevel.IGNORE
4293                )
4294            except ParseError:
4295                if udt:
4296                    return DataType(this=DataType.Type.USERDEFINED, kind=dtype, **kwargs)
4297                raise
4298        elif isinstance(dtype, DataType.Type):
4299            data_type_exp = DataType(this=dtype)
4300        elif isinstance(dtype, DataType):
4301            return maybe_copy(dtype, copy)
4302        else:
4303            raise ValueError(f"Invalid data type: {type(dtype)}. Expected str or DataType.Type")
4304
4305        return DataType(**{**data_type_exp.args, **kwargs})
4306
4307    def is_type(self, *dtypes: DATA_TYPE, check_nullable: bool = False) -> bool:
4308        """
4309        Checks whether this DataType matches one of the provided data types. Nested types or precision
4310        will be compared using "structural equivalence" semantics, so e.g. array<int> != array<float>.
4311
4312        Args:
4313            dtypes: the data types to compare this DataType to.
4314            check_nullable: whether to take the NULLABLE type constructor into account for the comparison.
4315                If false, it means that NULLABLE<INT> is equivalent to INT.
4316
4317        Returns:
4318            True, if and only if there is a type in `dtypes` which is equal to this DataType.
4319        """
4320        self_is_nullable = self.args.get("nullable")
4321        for dtype in dtypes:
4322            other_type = DataType.build(dtype, copy=False, udt=True)
4323            other_is_nullable = other_type.args.get("nullable")
4324            if (
4325                other_type.expressions
4326                or (check_nullable and (self_is_nullable or other_is_nullable))
4327                or self.this == DataType.Type.USERDEFINED
4328                or other_type.this == DataType.Type.USERDEFINED
4329            ):
4330                matches = self == other_type
4331            else:
4332                matches = self.this == other_type.this
4333
4334            if matches:
4335                return True
4336        return False
4337
4338
4339DATA_TYPE = t.Union[str, DataType, DataType.Type]
4340
4341
4342# https://www.postgresql.org/docs/15/datatype-pseudo.html
4343class PseudoType(DataType):
4344    arg_types = {"this": True}
4345
4346
4347# https://www.postgresql.org/docs/15/datatype-oid.html
4348class ObjectIdentifier(DataType):
4349    arg_types = {"this": True}
4350
4351
4352# WHERE x <OP> EXISTS|ALL|ANY|SOME(SELECT ...)
4353class SubqueryPredicate(Predicate):
4354    pass
4355
4356
4357class All(SubqueryPredicate):
4358    pass
4359
4360
4361class Any(SubqueryPredicate):
4362    pass
4363
4364
4365class Exists(SubqueryPredicate):
4366    pass
4367
4368
4369# Commands to interact with the databases or engines. For most of the command
4370# expressions we parse whatever comes after the command's name as a string.
4371class Command(Expression):
4372    arg_types = {"this": True, "expression": False}
4373
4374
4375class Transaction(Expression):
4376    arg_types = {"this": False, "modes": False, "mark": False}
4377
4378
4379class Commit(Expression):
4380    arg_types = {"chain": False, "this": False, "durability": False}
4381
4382
4383class Rollback(Expression):
4384    arg_types = {"savepoint": False, "this": False}
4385
4386
4387class Alter(Expression):
4388    arg_types = {
4389        "this": True,
4390        "kind": True,
4391        "actions": True,
4392        "exists": False,
4393        "only": False,
4394        "options": False,
4395        "cluster": False,
4396        "not_valid": False,
4397    }
4398
4399
4400class AddConstraint(Expression):
4401    arg_types = {"expressions": True}
4402
4403
4404class DropPartition(Expression):
4405    arg_types = {"expressions": True, "exists": False}
4406
4407
4408# https://clickhouse.com/docs/en/sql-reference/statements/alter/partition#replace-partition
4409class ReplacePartition(Expression):
4410    arg_types = {"expression": True, "source": True}
4411
4412
4413# Binary expressions like (ADD a b)
4414class Binary(Condition):
4415    arg_types = {"this": True, "expression": True}
4416
4417    @property
4418    def left(self) -> Expression:
4419        return self.this
4420
4421    @property
4422    def right(self) -> Expression:
4423        return self.expression
4424
4425
4426class Add(Binary):
4427    pass
4428
4429
4430class Connector(Binary):
4431    pass
4432
4433
4434class And(Connector):
4435    pass
4436
4437
4438class Or(Connector):
4439    pass
4440
4441
4442class BitwiseAnd(Binary):
4443    pass
4444
4445
4446class BitwiseLeftShift(Binary):
4447    pass
4448
4449
4450class BitwiseOr(Binary):
4451    pass
4452
4453
4454class BitwiseRightShift(Binary):
4455    pass
4456
4457
4458class BitwiseXor(Binary):
4459    pass
4460
4461
4462class Div(Binary):
4463    arg_types = {"this": True, "expression": True, "typed": False, "safe": False}
4464
4465
4466class Overlaps(Binary):
4467    pass
4468
4469
4470class Dot(Binary):
4471    @property
4472    def is_star(self) -> bool:
4473        return self.expression.is_star
4474
4475    @property
4476    def name(self) -> str:
4477        return self.expression.name
4478
4479    @property
4480    def output_name(self) -> str:
4481        return self.name
4482
4483    @classmethod
4484    def build(self, expressions: t.Sequence[Expression]) -> Dot:
4485        """Build a Dot object with a sequence of expressions."""
4486        if len(expressions) < 2:
4487            raise ValueError("Dot requires >= 2 expressions.")
4488
4489        return t.cast(Dot, reduce(lambda x, y: Dot(this=x, expression=y), expressions))
4490
4491    @property
4492    def parts(self) -> t.List[Expression]:
4493        """Return the parts of a table / column in order catalog, db, table."""
4494        this, *parts = self.flatten()
4495
4496        parts.reverse()
4497
4498        for arg in COLUMN_PARTS:
4499            part = this.args.get(arg)
4500
4501            if isinstance(part, Expression):
4502                parts.append(part)
4503
4504        parts.reverse()
4505        return parts
4506
4507
4508class DPipe(Binary):
4509    arg_types = {"this": True, "expression": True, "safe": False}
4510
4511
4512class EQ(Binary, Predicate):
4513    pass
4514
4515
4516class NullSafeEQ(Binary, Predicate):
4517    pass
4518
4519
4520class NullSafeNEQ(Binary, Predicate):
4521    pass
4522
4523
4524# Represents e.g. := in DuckDB which is mostly used for setting parameters
4525class PropertyEQ(Binary):
4526    pass
4527
4528
4529class Distance(Binary):
4530    pass
4531
4532
4533class Escape(Binary):
4534    pass
4535
4536
4537class Glob(Binary, Predicate):
4538    pass
4539
4540
4541class GT(Binary, Predicate):
4542    pass
4543
4544
4545class GTE(Binary, Predicate):
4546    pass
4547
4548
4549class ILike(Binary, Predicate):
4550    pass
4551
4552
4553class ILikeAny(Binary, Predicate):
4554    pass
4555
4556
4557class IntDiv(Binary):
4558    pass
4559
4560
4561class Is(Binary, Predicate):
4562    pass
4563
4564
4565class Kwarg(Binary):
4566    """Kwarg in special functions like func(kwarg => y)."""
4567
4568
4569class Like(Binary, Predicate):
4570    pass
4571
4572
4573class LikeAny(Binary, Predicate):
4574    pass
4575
4576
4577class LT(Binary, Predicate):
4578    pass
4579
4580
4581class LTE(Binary, Predicate):
4582    pass
4583
4584
4585class Mod(Binary):
4586    pass
4587
4588
4589class Mul(Binary):
4590    pass
4591
4592
4593class NEQ(Binary, Predicate):
4594    pass
4595
4596
4597# https://www.postgresql.org/docs/current/ddl-schemas.html#DDL-SCHEMAS-PATH
4598class Operator(Binary):
4599    arg_types = {"this": True, "operator": True, "expression": True}
4600
4601
4602class SimilarTo(Binary, Predicate):
4603    pass
4604
4605
4606class Slice(Binary):
4607    arg_types = {"this": False, "expression": False}
4608
4609
4610class Sub(Binary):
4611    pass
4612
4613
4614# Unary Expressions
4615# (NOT a)
4616class Unary(Condition):
4617    pass
4618
4619
4620class BitwiseNot(Unary):
4621    pass
4622
4623
4624class Not(Unary):
4625    pass
4626
4627
4628class Paren(Unary):
4629    @property
4630    def output_name(self) -> str:
4631        return self.this.name
4632
4633
4634class Neg(Unary):
4635    def to_py(self) -> int | Decimal:
4636        if self.is_number:
4637            return self.this.to_py() * -1
4638        return super().to_py()
4639
4640
4641class Alias(Expression):
4642    arg_types = {"this": True, "alias": False}
4643
4644    @property
4645    def output_name(self) -> str:
4646        return self.alias
4647
4648
4649# BigQuery requires the UNPIVOT column list aliases to be either strings or ints, but
4650# other dialects require identifiers. This enables us to transpile between them easily.
4651class PivotAlias(Alias):
4652    pass
4653
4654
4655# Represents Snowflake's ANY [ ORDER BY ... ] syntax
4656# https://docs.snowflake.com/en/sql-reference/constructs/pivot
4657class PivotAny(Expression):
4658    arg_types = {"this": False}
4659
4660
4661class Aliases(Expression):
4662    arg_types = {"this": True, "expressions": True}
4663
4664    @property
4665    def aliases(self):
4666        return self.expressions
4667
4668
4669# https://docs.aws.amazon.com/redshift/latest/dg/query-super.html
4670class AtIndex(Expression):
4671    arg_types = {"this": True, "expression": True}
4672
4673
4674class AtTimeZone(Expression):
4675    arg_types = {"this": True, "zone": True}
4676
4677
4678class FromTimeZone(Expression):
4679    arg_types = {"this": True, "zone": True}
4680
4681
4682class Between(Predicate):
4683    arg_types = {"this": True, "low": True, "high": True}
4684
4685
4686class Bracket(Condition):
4687    # https://cloud.google.com/bigquery/docs/reference/standard-sql/operators#array_subscript_operator
4688    arg_types = {
4689        "this": True,
4690        "expressions": True,
4691        "offset": False,
4692        "safe": False,
4693        "returns_list_for_maps": False,
4694    }
4695
4696    @property
4697    def output_name(self) -> str:
4698        if len(self.expressions) == 1:
4699            return self.expressions[0].output_name
4700
4701        return super().output_name
4702
4703
4704class Distinct(Expression):
4705    arg_types = {"expressions": False, "on": False}
4706
4707
4708class In(Predicate):
4709    arg_types = {
4710        "this": True,
4711        "expressions": False,
4712        "query": False,
4713        "unnest": False,
4714        "field": False,
4715        "is_global": False,
4716    }
4717
4718
4719# https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#for-in
4720class ForIn(Expression):
4721    arg_types = {"this": True, "expression": True}
4722
4723
4724class TimeUnit(Expression):
4725    """Automatically converts unit arg into a var."""
4726
4727    arg_types = {"unit": False}
4728
4729    UNABBREVIATED_UNIT_NAME = {
4730        "D": "DAY",
4731        "H": "HOUR",
4732        "M": "MINUTE",
4733        "MS": "MILLISECOND",
4734        "NS": "NANOSECOND",
4735        "Q": "QUARTER",
4736        "S": "SECOND",
4737        "US": "MICROSECOND",
4738        "W": "WEEK",
4739        "Y": "YEAR",
4740    }
4741
4742    VAR_LIKE = (Column, Literal, Var)
4743
4744    def __init__(self, **args):
4745        unit = args.get("unit")
4746        if isinstance(unit, self.VAR_LIKE):
4747            args["unit"] = Var(
4748                this=(self.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
4749            )
4750        elif isinstance(unit, Week):
4751            unit.set("this", Var(this=unit.this.name.upper()))
4752
4753        super().__init__(**args)
4754
4755    @property
4756    def unit(self) -> t.Optional[Var | IntervalSpan]:
4757        return self.args.get("unit")
4758
4759
4760class IntervalOp(TimeUnit):
4761    arg_types = {"unit": False, "expression": True}
4762
4763    def interval(self):
4764        return Interval(
4765            this=self.expression.copy(),
4766            unit=self.unit.copy() if self.unit else None,
4767        )
4768
4769
4770# https://www.oracletutorial.com/oracle-basics/oracle-interval/
4771# https://trino.io/docs/current/language/types.html#interval-day-to-second
4772# https://docs.databricks.com/en/sql/language-manual/data-types/interval-type.html
4773class IntervalSpan(DataType):
4774    arg_types = {"this": True, "expression": True}
4775
4776
4777class Interval(TimeUnit):
4778    arg_types = {"this": False, "unit": False}
4779
4780
4781class IgnoreNulls(Expression):
4782    pass
4783
4784
4785class RespectNulls(Expression):
4786    pass
4787
4788
4789# https://cloud.google.com/bigquery/docs/reference/standard-sql/aggregate-function-calls#max_min_clause
4790class HavingMax(Expression):
4791    arg_types = {"this": True, "expression": True, "max": True}
4792
4793
4794# Functions
4795class Func(Condition):
4796    """
4797    The base class for all function expressions.
4798
4799    Attributes:
4800        is_var_len_args (bool): if set to True the last argument defined in arg_types will be
4801            treated as a variable length argument and the argument's value will be stored as a list.
4802        _sql_names (list): the SQL name (1st item in the list) and aliases (subsequent items) for this
4803            function expression. These values are used to map this node to a name during parsing as
4804            well as to provide the function's name during SQL string generation. By default the SQL
4805            name is set to the expression's class name transformed to snake case.
4806    """
4807
4808    is_var_len_args = False
4809
4810    @classmethod
4811    def from_arg_list(cls, args):
4812        if cls.is_var_len_args:
4813            all_arg_keys = list(cls.arg_types)
4814            # If this function supports variable length argument treat the last argument as such.
4815            non_var_len_arg_keys = all_arg_keys[:-1] if cls.is_var_len_args else all_arg_keys
4816            num_non_var = len(non_var_len_arg_keys)
4817
4818            args_dict = {arg_key: arg for arg, arg_key in zip(args, non_var_len_arg_keys)}
4819            args_dict[all_arg_keys[-1]] = args[num_non_var:]
4820        else:
4821            args_dict = {arg_key: arg for arg, arg_key in zip(args, cls.arg_types)}
4822
4823        return cls(**args_dict)
4824
4825    @classmethod
4826    def sql_names(cls):
4827        if cls is Func:
4828            raise NotImplementedError(
4829                "SQL name is only supported by concrete function implementations"
4830            )
4831        if "_sql_names" not in cls.__dict__:
4832            cls._sql_names = [camel_to_snake_case(cls.__name__)]
4833        return cls._sql_names
4834
4835    @classmethod
4836    def sql_name(cls):
4837        return cls.sql_names()[0]
4838
4839    @classmethod
4840    def default_parser_mappings(cls):
4841        return {name: cls.from_arg_list for name in cls.sql_names()}
4842
4843
4844class AggFunc(Func):
4845    pass
4846
4847
4848class ParameterizedAgg(AggFunc):
4849    arg_types = {"this": True, "expressions": True, "params": True}
4850
4851
4852class Abs(Func):
4853    pass
4854
4855
4856class ArgMax(AggFunc):
4857    arg_types = {"this": True, "expression": True, "count": False}
4858    _sql_names = ["ARG_MAX", "ARGMAX", "MAX_BY"]
4859
4860
4861class ArgMin(AggFunc):
4862    arg_types = {"this": True, "expression": True, "count": False}
4863    _sql_names = ["ARG_MIN", "ARGMIN", "MIN_BY"]
4864
4865
4866class ApproxTopK(AggFunc):
4867    arg_types = {"this": True, "expression": False, "counters": False}
4868
4869
4870class Flatten(Func):
4871    pass
4872
4873
4874# https://spark.apache.org/docs/latest/api/sql/index.html#transform
4875class Transform(Func):
4876    arg_types = {"this": True, "expression": True}
4877
4878
4879class Anonymous(Func):
4880    arg_types = {"this": True, "expressions": False}
4881    is_var_len_args = True
4882
4883    @property
4884    def name(self) -> str:
4885        return self.this if isinstance(self.this, str) else self.this.name
4886
4887
4888class AnonymousAggFunc(AggFunc):
4889    arg_types = {"this": True, "expressions": False}
4890    is_var_len_args = True
4891
4892
4893# https://clickhouse.com/docs/en/sql-reference/aggregate-functions/combinators
4894class CombinedAggFunc(AnonymousAggFunc):
4895    arg_types = {"this": True, "expressions": False, "parts": True}
4896
4897
4898class CombinedParameterizedAgg(ParameterizedAgg):
4899    arg_types = {"this": True, "expressions": True, "params": True, "parts": True}
4900
4901
4902# https://docs.snowflake.com/en/sql-reference/functions/hll
4903# https://docs.aws.amazon.com/redshift/latest/dg/r_HLL_function.html
4904class Hll(AggFunc):
4905    arg_types = {"this": True, "expressions": False}
4906    is_var_len_args = True
4907
4908
4909class ApproxDistinct(AggFunc):
4910    arg_types = {"this": True, "accuracy": False}
4911    _sql_names = ["APPROX_DISTINCT", "APPROX_COUNT_DISTINCT"]
4912
4913
4914class Array(Func):
4915    arg_types = {"expressions": False, "bracket_notation": False}
4916    is_var_len_args = True
4917
4918
4919# https://docs.snowflake.com/en/sql-reference/functions/to_array
4920class ToArray(Func):
4921    pass
4922
4923
4924# https://materialize.com/docs/sql/types/list/
4925class List(Func):
4926    arg_types = {"expressions": False}
4927    is_var_len_args = True
4928
4929
4930# String pad, kind True -> LPAD, False -> RPAD
4931class Pad(Func):
4932    arg_types = {"this": True, "expression": True, "fill_pattern": False, "is_left": True}
4933
4934
4935# https://docs.snowflake.com/en/sql-reference/functions/to_char
4936# https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/TO_CHAR-number.html
4937class ToChar(Func):
4938    arg_types = {"this": True, "format": False, "nlsparam": False}
4939
4940
4941# https://docs.snowflake.com/en/sql-reference/functions/to_decimal
4942# https://docs.oracle.com/en/database/oracle/oracle-database/23/sqlrf/TO_NUMBER.html
4943class ToNumber(Func):
4944    arg_types = {
4945        "this": True,
4946        "format": False,
4947        "nlsparam": False,
4948        "precision": False,
4949        "scale": False,
4950    }
4951
4952
4953# https://learn.microsoft.com/en-us/sql/t-sql/functions/cast-and-convert-transact-sql?view=sql-server-ver16#syntax
4954class Convert(Func):
4955    arg_types = {"this": True, "expression": True, "style": False}
4956
4957
4958class ConvertTimezone(Func):
4959    arg_types = {"source_tz": False, "target_tz": True, "timestamp": True}
4960
4961
4962class GenerateSeries(Func):
4963    arg_types = {"start": True, "end": True, "step": False, "is_end_exclusive": False}
4964
4965
4966# Postgres' GENERATE_SERIES function returns a row set, i.e. it implicitly explodes when it's
4967# used in a projection, so this expression is a helper that facilitates transpilation to other
4968# dialects. For example, we'd generate UNNEST(GENERATE_SERIES(...)) in DuckDB
4969class ExplodingGenerateSeries(GenerateSeries):
4970    pass
4971
4972
4973class ArrayAgg(AggFunc):
4974    arg_types = {"this": True, "nulls_excluded": False}
4975
4976
4977class ArrayUniqueAgg(AggFunc):
4978    pass
4979
4980
4981class ArrayAll(Func):
4982    arg_types = {"this": True, "expression": True}
4983
4984
4985# Represents Python's `any(f(x) for x in array)`, where `array` is `this` and `f` is `expression`
4986class ArrayAny(Func):
4987    arg_types = {"this": True, "expression": True}
4988
4989
4990class ArrayConcat(Func):
4991    _sql_names = ["ARRAY_CONCAT", "ARRAY_CAT"]
4992    arg_types = {"this": True, "expressions": False}
4993    is_var_len_args = True
4994
4995
4996class ArrayConstructCompact(Func):
4997    arg_types = {"expressions": True}
4998    is_var_len_args = True
4999
5000
5001class ArrayContains(Binary, Func):
5002    _sql_names = ["ARRAY_CONTAINS", "ARRAY_HAS"]
5003
5004
5005class ArrayContainsAll(Binary, Func):
5006    _sql_names = ["ARRAY_CONTAINS_ALL", "ARRAY_HAS_ALL"]
5007
5008
5009class ArrayFilter(Func):
5010    arg_types = {"this": True, "expression": True}
5011    _sql_names = ["FILTER", "ARRAY_FILTER"]
5012
5013
5014class ArrayToString(Func):
5015    arg_types = {"this": True, "expression": True, "null": False}
5016    _sql_names = ["ARRAY_TO_STRING", "ARRAY_JOIN"]
5017
5018
5019class StringToArray(Func):
5020    arg_types = {"this": True, "expression": True, "null": False}
5021    _sql_names = ["STRING_TO_ARRAY", "SPLIT_BY_STRING"]
5022
5023
5024class ArrayOverlaps(Binary, Func):
5025    pass
5026
5027
5028class ArraySize(Func):
5029    arg_types = {"this": True, "expression": False}
5030    _sql_names = ["ARRAY_SIZE", "ARRAY_LENGTH"]
5031
5032
5033class ArraySort(Func):
5034    arg_types = {"this": True, "expression": False}
5035
5036
5037class ArraySum(Func):
5038    arg_types = {"this": True, "expression": False}
5039
5040
5041class ArrayUnionAgg(AggFunc):
5042    pass
5043
5044
5045class Avg(AggFunc):
5046    pass
5047
5048
5049class AnyValue(AggFunc):
5050    pass
5051
5052
5053class Lag(AggFunc):
5054    arg_types = {"this": True, "offset": False, "default": False}
5055
5056
5057class Lead(AggFunc):
5058    arg_types = {"this": True, "offset": False, "default": False}
5059
5060
5061# some dialects have a distinction between first and first_value, usually first is an aggregate func
5062# and first_value is a window func
5063class First(AggFunc):
5064    pass
5065
5066
5067class Last(AggFunc):
5068    pass
5069
5070
5071class FirstValue(AggFunc):
5072    pass
5073
5074
5075class LastValue(AggFunc):
5076    pass
5077
5078
5079class NthValue(AggFunc):
5080    arg_types = {"this": True, "offset": True}
5081
5082
5083class Case(Func):
5084    arg_types = {"this": False, "ifs": True, "default": False}
5085
5086    def when(self, condition: ExpOrStr, then: ExpOrStr, copy: bool = True, **opts) -> Case:
5087        instance = maybe_copy(self, copy)
5088        instance.append(
5089            "ifs",
5090            If(
5091                this=maybe_parse(condition, copy=copy, **opts),
5092                true=maybe_parse(then, copy=copy, **opts),
5093            ),
5094        )
5095        return instance
5096
5097    def else_(self, condition: ExpOrStr, copy: bool = True, **opts) -> Case:
5098        instance = maybe_copy(self, copy)
5099        instance.set("default", maybe_parse(condition, copy=copy, **opts))
5100        return instance
5101
5102
5103class Cast(Func):
5104    arg_types = {
5105        "this": True,
5106        "to": True,
5107        "format": False,
5108        "safe": False,
5109        "action": False,
5110    }
5111
5112    @property
5113    def name(self) -> str:
5114        return self.this.name
5115
5116    @property
5117    def to(self) -> DataType:
5118        return self.args["to"]
5119
5120    @property
5121    def output_name(self) -> str:
5122        return self.name
5123
5124    def is_type(self, *dtypes: DATA_TYPE) -> bool:
5125        """
5126        Checks whether this Cast's DataType matches one of the provided data types. Nested types
5127        like arrays or structs will be compared using "structural equivalence" semantics, so e.g.
5128        array<int> != array<float>.
5129
5130        Args:
5131            dtypes: the data types to compare this Cast's DataType to.
5132
5133        Returns:
5134            True, if and only if there is a type in `dtypes` which is equal to this Cast's DataType.
5135        """
5136        return self.to.is_type(*dtypes)
5137
5138
5139class TryCast(Cast):
5140    pass
5141
5142
5143class Try(Func):
5144    pass
5145
5146
5147class CastToStrType(Func):
5148    arg_types = {"this": True, "to": True}
5149
5150
5151class Collate(Binary, Func):
5152    pass
5153
5154
5155class Ceil(Func):
5156    arg_types = {"this": True, "decimals": False}
5157    _sql_names = ["CEIL", "CEILING"]
5158
5159
5160class Coalesce(Func):
5161    arg_types = {"this": True, "expressions": False, "is_nvl": False}
5162    is_var_len_args = True
5163    _sql_names = ["COALESCE", "IFNULL", "NVL"]
5164
5165
5166class Chr(Func):
5167    arg_types = {"expressions": True, "charset": False}
5168    is_var_len_args = True
5169    _sql_names = ["CHR", "CHAR"]
5170
5171
5172class Concat(Func):
5173    arg_types = {"expressions": True, "safe": False, "coalesce": False}
5174    is_var_len_args = True
5175
5176
5177class ConcatWs(Concat):
5178    _sql_names = ["CONCAT_WS"]
5179
5180
5181# https://docs.oracle.com/cd/B13789_01/server.101/b10759/operators004.htm#i1035022
5182class ConnectByRoot(Func):
5183    pass
5184
5185
5186class Count(AggFunc):
5187    arg_types = {"this": False, "expressions": False, "big_int": False}
5188    is_var_len_args = True
5189
5190
5191class CountIf(AggFunc):
5192    _sql_names = ["COUNT_IF", "COUNTIF"]
5193
5194
5195# cube root
5196class Cbrt(Func):
5197    pass
5198
5199
5200class CurrentDate(Func):
5201    arg_types = {"this": False}
5202
5203
5204class CurrentDatetime(Func):
5205    arg_types = {"this": False}
5206
5207
5208class CurrentTime(Func):
5209    arg_types = {"this": False}
5210
5211
5212class CurrentTimestamp(Func):
5213    arg_types = {"this": False, "sysdate": False}
5214
5215
5216class CurrentUser(Func):
5217    arg_types = {"this": False}
5218
5219
5220class DateAdd(Func, IntervalOp):
5221    arg_types = {"this": True, "expression": True, "unit": False}
5222
5223
5224class DateSub(Func, IntervalOp):
5225    arg_types = {"this": True, "expression": True, "unit": False}
5226
5227
5228class DateDiff(Func, TimeUnit):
5229    _sql_names = ["DATEDIFF", "DATE_DIFF"]
5230    arg_types = {"this": True, "expression": True, "unit": False}
5231
5232
5233class DateTrunc(Func):
5234    arg_types = {"unit": True, "this": True, "zone": False}
5235
5236    def __init__(self, **args):
5237        unit = args.get("unit")
5238        if isinstance(unit, TimeUnit.VAR_LIKE):
5239            args["unit"] = Literal.string(
5240                (TimeUnit.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
5241            )
5242        elif isinstance(unit, Week):
5243            unit.set("this", Literal.string(unit.this.name.upper()))
5244
5245        super().__init__(**args)
5246
5247    @property
5248    def unit(self) -> Expression:
5249        return self.args["unit"]
5250
5251
5252# https://cloud.google.com/bigquery/docs/reference/standard-sql/datetime_functions#datetime
5253# expression can either be time_expr or time_zone
5254class Datetime(Func):
5255    arg_types = {"this": True, "expression": False}
5256
5257
5258class DatetimeAdd(Func, IntervalOp):
5259    arg_types = {"this": True, "expression": True, "unit": False}
5260
5261
5262class DatetimeSub(Func, IntervalOp):
5263    arg_types = {"this": True, "expression": True, "unit": False}
5264
5265
5266class DatetimeDiff(Func, TimeUnit):
5267    arg_types = {"this": True, "expression": True, "unit": False}
5268
5269
5270class DatetimeTrunc(Func, TimeUnit):
5271    arg_types = {"this": True, "unit": True, "zone": False}
5272
5273
5274class DayOfWeek(Func):
5275    _sql_names = ["DAY_OF_WEEK", "DAYOFWEEK"]
5276
5277
5278# https://duckdb.org/docs/sql/functions/datepart.html#part-specifiers-only-usable-as-date-part-specifiers
5279# ISO day of week function in duckdb is ISODOW
5280class DayOfWeekIso(Func):
5281    _sql_names = ["DAYOFWEEK_ISO", "ISODOW"]
5282
5283
5284class DayOfMonth(Func):
5285    _sql_names = ["DAY_OF_MONTH", "DAYOFMONTH"]
5286
5287
5288class DayOfYear(Func):
5289    _sql_names = ["DAY_OF_YEAR", "DAYOFYEAR"]
5290
5291
5292class ToDays(Func):
5293    pass
5294
5295
5296class WeekOfYear(Func):
5297    _sql_names = ["WEEK_OF_YEAR", "WEEKOFYEAR"]
5298
5299
5300class MonthsBetween(Func):
5301    arg_types = {"this": True, "expression": True, "roundoff": False}
5302
5303
5304class LastDay(Func, TimeUnit):
5305    _sql_names = ["LAST_DAY", "LAST_DAY_OF_MONTH"]
5306    arg_types = {"this": True, "unit": False}
5307
5308
5309class Extract(Func):
5310    arg_types = {"this": True, "expression": True}
5311
5312
5313class Timestamp(Func):
5314    arg_types = {"this": False, "zone": False, "with_tz": False}
5315
5316
5317class TimestampAdd(Func, TimeUnit):
5318    arg_types = {"this": True, "expression": True, "unit": False}
5319
5320
5321class TimestampSub(Func, TimeUnit):
5322    arg_types = {"this": True, "expression": True, "unit": False}
5323
5324
5325class TimestampDiff(Func, TimeUnit):
5326    _sql_names = ["TIMESTAMPDIFF", "TIMESTAMP_DIFF"]
5327    arg_types = {"this": True, "expression": True, "unit": False}
5328
5329
5330class TimestampTrunc(Func, TimeUnit):
5331    arg_types = {"this": True, "unit": True, "zone": False}
5332
5333
5334class TimeAdd(Func, TimeUnit):
5335    arg_types = {"this": True, "expression": True, "unit": False}
5336
5337
5338class TimeSub(Func, TimeUnit):
5339    arg_types = {"this": True, "expression": True, "unit": False}
5340
5341
5342class TimeDiff(Func, TimeUnit):
5343    arg_types = {"this": True, "expression": True, "unit": False}
5344
5345
5346class TimeTrunc(Func, TimeUnit):
5347    arg_types = {"this": True, "unit": True, "zone": False}
5348
5349
5350class DateFromParts(Func):
5351    _sql_names = ["DATE_FROM_PARTS", "DATEFROMPARTS"]
5352    arg_types = {"year": True, "month": True, "day": True}
5353
5354
5355class TimeFromParts(Func):
5356    _sql_names = ["TIME_FROM_PARTS", "TIMEFROMPARTS"]
5357    arg_types = {
5358        "hour": True,
5359        "min": True,
5360        "sec": True,
5361        "nano": False,
5362        "fractions": False,
5363        "precision": False,
5364    }
5365
5366
5367class DateStrToDate(Func):
5368    pass
5369
5370
5371class DateToDateStr(Func):
5372    pass
5373
5374
5375class DateToDi(Func):
5376    pass
5377
5378
5379# https://cloud.google.com/bigquery/docs/reference/standard-sql/date_functions#date
5380class Date(Func):
5381    arg_types = {"this": False, "zone": False, "expressions": False}
5382    is_var_len_args = True
5383
5384
5385class Day(Func):
5386    pass
5387
5388
5389class Decode(Func):
5390    arg_types = {"this": True, "charset": True, "replace": False}
5391
5392
5393class DiToDate(Func):
5394    pass
5395
5396
5397class Encode(Func):
5398    arg_types = {"this": True, "charset": True}
5399
5400
5401class Exp(Func):
5402    pass
5403
5404
5405# https://docs.snowflake.com/en/sql-reference/functions/flatten
5406class Explode(Func):
5407    arg_types = {"this": True, "expressions": False}
5408    is_var_len_args = True
5409
5410
5411# https://spark.apache.org/docs/latest/api/sql/#inline
5412class Inline(Func):
5413    pass
5414
5415
5416class ExplodeOuter(Explode):
5417    pass
5418
5419
5420class Posexplode(Explode):
5421    pass
5422
5423
5424class PosexplodeOuter(Posexplode, ExplodeOuter):
5425    pass
5426
5427
5428class Unnest(Func, UDTF):
5429    arg_types = {
5430        "expressions": True,
5431        "alias": False,
5432        "offset": False,
5433        "explode_array": False,
5434    }
5435
5436    @property
5437    def selects(self) -> t.List[Expression]:
5438        columns = super().selects
5439        offset = self.args.get("offset")
5440        if offset:
5441            columns = columns + [to_identifier("offset") if offset is True else offset]
5442        return columns
5443
5444
5445class Floor(Func):
5446    arg_types = {"this": True, "decimals": False}
5447
5448
5449class FromBase64(Func):
5450    pass
5451
5452
5453class ToBase64(Func):
5454    pass
5455
5456
5457# https://trino.io/docs/current/functions/datetime.html#from_iso8601_timestamp
5458class FromISO8601Timestamp(Func):
5459    _sql_names = ["FROM_ISO8601_TIMESTAMP"]
5460
5461
5462class GapFill(Func):
5463    arg_types = {
5464        "this": True,
5465        "ts_column": True,
5466        "bucket_width": True,
5467        "partitioning_columns": False,
5468        "value_columns": False,
5469        "origin": False,
5470        "ignore_nulls": False,
5471    }
5472
5473
5474# https://cloud.google.com/bigquery/docs/reference/standard-sql/array_functions#generate_date_array
5475class GenerateDateArray(Func):
5476    arg_types = {"start": True, "end": True, "step": False}
5477
5478
5479# https://cloud.google.com/bigquery/docs/reference/standard-sql/array_functions#generate_timestamp_array
5480class GenerateTimestampArray(Func):
5481    arg_types = {"start": True, "end": True, "step": True}
5482
5483
5484class Greatest(Func):
5485    arg_types = {"this": True, "expressions": False}
5486    is_var_len_args = True
5487
5488
5489class GroupConcat(AggFunc):
5490    arg_types = {"this": True, "separator": False}
5491
5492
5493class Hex(Func):
5494    pass
5495
5496
5497class LowerHex(Hex):
5498    pass
5499
5500
5501class Xor(Connector, Func):
5502    arg_types = {"this": False, "expression": False, "expressions": False}
5503
5504
5505class If(Func):
5506    arg_types = {"this": True, "true": True, "false": False}
5507    _sql_names = ["IF", "IIF"]
5508
5509
5510class Nullif(Func):
5511    arg_types = {"this": True, "expression": True}
5512
5513
5514class Initcap(Func):
5515    arg_types = {"this": True, "expression": False}
5516
5517
5518class IsNan(Func):
5519    _sql_names = ["IS_NAN", "ISNAN"]
5520
5521
5522class IsInf(Func):
5523    _sql_names = ["IS_INF", "ISINF"]
5524
5525
5526# https://www.postgresql.org/docs/current/functions-json.html
5527class JSON(Expression):
5528    arg_types = {"this": False, "with": False, "unique": False}
5529
5530
5531class JSONPath(Expression):
5532    arg_types = {"expressions": True, "escape": False}
5533
5534    @property
5535    def output_name(self) -> str:
5536        last_segment = self.expressions[-1].this
5537        return last_segment if isinstance(last_segment, str) else ""
5538
5539
5540class JSONPathPart(Expression):
5541    arg_types = {}
5542
5543
5544class JSONPathFilter(JSONPathPart):
5545    arg_types = {"this": True}
5546
5547
5548class JSONPathKey(JSONPathPart):
5549    arg_types = {"this": True}
5550
5551
5552class JSONPathRecursive(JSONPathPart):
5553    arg_types = {"this": False}
5554
5555
5556class JSONPathRoot(JSONPathPart):
5557    pass
5558
5559
5560class JSONPathScript(JSONPathPart):
5561    arg_types = {"this": True}
5562
5563
5564class JSONPathSlice(JSONPathPart):
5565    arg_types = {"start": False, "end": False, "step": False}
5566
5567
5568class JSONPathSelector(JSONPathPart):
5569    arg_types = {"this": True}
5570
5571
5572class JSONPathSubscript(JSONPathPart):
5573    arg_types = {"this": True}
5574
5575
5576class JSONPathUnion(JSONPathPart):
5577    arg_types = {"expressions": True}
5578
5579
5580class JSONPathWildcard(JSONPathPart):
5581    pass
5582
5583
5584class FormatJson(Expression):
5585    pass
5586
5587
5588class JSONKeyValue(Expression):
5589    arg_types = {"this": True, "expression": True}
5590
5591
5592class JSONObject(Func):
5593    arg_types = {
5594        "expressions": False,
5595        "null_handling": False,
5596        "unique_keys": False,
5597        "return_type": False,
5598        "encoding": False,
5599    }
5600
5601
5602class JSONObjectAgg(AggFunc):
5603    arg_types = {
5604        "expressions": False,
5605        "null_handling": False,
5606        "unique_keys": False,
5607        "return_type": False,
5608        "encoding": False,
5609    }
5610
5611
5612# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_ARRAY.html
5613class JSONArray(Func):
5614    arg_types = {
5615        "expressions": True,
5616        "null_handling": False,
5617        "return_type": False,
5618        "strict": False,
5619    }
5620
5621
5622# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_ARRAYAGG.html
5623class JSONArrayAgg(Func):
5624    arg_types = {
5625        "this": True,
5626        "order": False,
5627        "null_handling": False,
5628        "return_type": False,
5629        "strict": False,
5630    }
5631
5632
5633class JSONExists(Func):
5634    arg_types = {"this": True, "path": True, "passing": False, "on_condition": False}
5635
5636
5637# https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_TABLE.html
5638# Note: parsing of JSON column definitions is currently incomplete.
5639class JSONColumnDef(Expression):
5640    arg_types = {"this": False, "kind": False, "path": False, "nested_schema": False}
5641
5642
5643class JSONSchema(Expression):
5644    arg_types = {"expressions": True}
5645
5646
5647# https://dev.mysql.com/doc/refman/8.4/en/json-search-functions.html#function_json-value
5648class JSONValue(Expression):
5649    arg_types = {
5650        "this": True,
5651        "path": True,
5652        "returning": False,
5653        "on_condition": False,
5654    }
5655
5656
5657# # https://docs.oracle.com/en/database/oracle/oracle-database/19/sqlrf/JSON_TABLE.html
5658class JSONTable(Func):
5659    arg_types = {
5660        "this": True,
5661        "schema": True,
5662        "path": False,
5663        "error_handling": False,
5664        "empty_handling": False,
5665    }
5666
5667
5668# https://docs.snowflake.com/en/sql-reference/functions/object_insert
5669class ObjectInsert(Func):
5670    arg_types = {
5671        "this": True,
5672        "key": True,
5673        "value": True,
5674        "update_flag": False,
5675    }
5676
5677
5678class OpenJSONColumnDef(Expression):
5679    arg_types = {"this": True, "kind": True, "path": False, "as_json": False}
5680
5681
5682class OpenJSON(Func):
5683    arg_types = {"this": True, "path": False, "expressions": False}
5684
5685
5686class JSONBContains(Binary, Func):
5687    _sql_names = ["JSONB_CONTAINS"]
5688
5689
5690class JSONExtract(Binary, Func):
5691    arg_types = {
5692        "this": True,
5693        "expression": True,
5694        "only_json_types": False,
5695        "expressions": False,
5696        "variant_extract": False,
5697    }
5698    _sql_names = ["JSON_EXTRACT"]
5699    is_var_len_args = True
5700
5701    @property
5702    def output_name(self) -> str:
5703        return self.expression.output_name if not self.expressions else ""
5704
5705
5706class JSONExtractScalar(Binary, Func):
5707    arg_types = {"this": True, "expression": True, "only_json_types": False, "expressions": False}
5708    _sql_names = ["JSON_EXTRACT_SCALAR"]
5709    is_var_len_args = True
5710
5711    @property
5712    def output_name(self) -> str:
5713        return self.expression.output_name
5714
5715
5716class JSONBExtract(Binary, Func):
5717    _sql_names = ["JSONB_EXTRACT"]
5718
5719
5720class JSONBExtractScalar(Binary, Func):
5721    _sql_names = ["JSONB_EXTRACT_SCALAR"]
5722
5723
5724class JSONFormat(Func):
5725    arg_types = {"this": False, "options": False}
5726    _sql_names = ["JSON_FORMAT"]
5727
5728
5729# https://dev.mysql.com/doc/refman/8.0/en/json-search-functions.html#operator_member-of
5730class JSONArrayContains(Binary, Predicate, Func):
5731    _sql_names = ["JSON_ARRAY_CONTAINS"]
5732
5733
5734class ParseJSON(Func):
5735    # BigQuery, Snowflake have PARSE_JSON, Presto has JSON_PARSE
5736    # Snowflake also has TRY_PARSE_JSON, which is represented using `safe`
5737    _sql_names = ["PARSE_JSON", "JSON_PARSE"]
5738    arg_types = {"this": True, "expression": False, "safe": False}
5739
5740
5741class Least(Func):
5742    arg_types = {"this": True, "expressions": False}
5743    is_var_len_args = True
5744
5745
5746class Left(Func):
5747    arg_types = {"this": True, "expression": True}
5748
5749
5750class Right(Func):
5751    arg_types = {"this": True, "expression": True}
5752
5753
5754class Length(Func):
5755    arg_types = {"this": True, "binary": False}
5756    _sql_names = ["LENGTH", "LEN"]
5757
5758
5759class Levenshtein(Func):
5760    arg_types = {
5761        "this": True,
5762        "expression": False,
5763        "ins_cost": False,
5764        "del_cost": False,
5765        "sub_cost": False,
5766    }
5767
5768
5769class Ln(Func):
5770    pass
5771
5772
5773class Log(Func):
5774    arg_types = {"this": True, "expression": False}
5775
5776
5777class LogicalOr(AggFunc):
5778    _sql_names = ["LOGICAL_OR", "BOOL_OR", "BOOLOR_AGG"]
5779
5780
5781class LogicalAnd(AggFunc):
5782    _sql_names = ["LOGICAL_AND", "BOOL_AND", "BOOLAND_AGG"]
5783
5784
5785class Lower(Func):
5786    _sql_names = ["LOWER", "LCASE"]
5787
5788
5789class Map(Func):
5790    arg_types = {"keys": False, "values": False}
5791
5792    @property
5793    def keys(self) -> t.List[Expression]:
5794        keys = self.args.get("keys")
5795        return keys.expressions if keys else []
5796
5797    @property
5798    def values(self) -> t.List[Expression]:
5799        values = self.args.get("values")
5800        return values.expressions if values else []
5801
5802
5803# Represents the MAP {...} syntax in DuckDB - basically convert a struct to a MAP
5804class ToMap(Func):
5805    pass
5806
5807
5808class MapFromEntries(Func):
5809    pass
5810
5811
5812# https://learn.microsoft.com/en-us/sql/t-sql/language-elements/scope-resolution-operator-transact-sql?view=sql-server-ver16
5813class ScopeResolution(Expression):
5814    arg_types = {"this": False, "expression": True}
5815
5816
5817class Stream(Expression):
5818    pass
5819
5820
5821class StarMap(Func):
5822    pass
5823
5824
5825class VarMap(Func):
5826    arg_types = {"keys": True, "values": True}
5827    is_var_len_args = True
5828
5829    @property
5830    def keys(self) -> t.List[Expression]:
5831        return self.args["keys"].expressions
5832
5833    @property
5834    def values(self) -> t.List[Expression]:
5835        return self.args["values"].expressions
5836
5837
5838# https://dev.mysql.com/doc/refman/8.0/en/fulltext-search.html
5839class MatchAgainst(Func):
5840    arg_types = {"this": True, "expressions": True, "modifier": False}
5841
5842
5843class Max(AggFunc):
5844    arg_types = {"this": True, "expressions": False}
5845    is_var_len_args = True
5846
5847
5848class MD5(Func):
5849    _sql_names = ["MD5"]
5850
5851
5852# Represents the variant of the MD5 function that returns a binary value
5853class MD5Digest(Func):
5854    _sql_names = ["MD5_DIGEST"]
5855
5856
5857class Min(AggFunc):
5858    arg_types = {"this": True, "expressions": False}
5859    is_var_len_args = True
5860
5861
5862class Month(Func):
5863    pass
5864
5865
5866class AddMonths(Func):
5867    arg_types = {"this": True, "expression": True}
5868
5869
5870class Nvl2(Func):
5871    arg_types = {"this": True, "true": True, "false": False}
5872
5873
5874class Normalize(Func):
5875    arg_types = {"this": True, "form": False}
5876
5877
5878# https://cloud.google.com/bigquery/docs/reference/standard-sql/bigqueryml-syntax-predict#mlpredict_function
5879class Predict(Func):
5880    arg_types = {"this": True, "expression": True, "params_struct": False}
5881
5882
5883class Pow(Binary, Func):
5884    _sql_names = ["POWER", "POW"]
5885
5886
5887class PercentileCont(AggFunc):
5888    arg_types = {"this": True, "expression": False}
5889
5890
5891class PercentileDisc(AggFunc):
5892    arg_types = {"this": True, "expression": False}
5893
5894
5895class Quantile(AggFunc):
5896    arg_types = {"this": True, "quantile": True}
5897
5898
5899class ApproxQuantile(Quantile):
5900    arg_types = {"this": True, "quantile": True, "accuracy": False, "weight": False}
5901
5902
5903class Quarter(Func):
5904    pass
5905
5906
5907# https://docs.teradata.com/r/Enterprise_IntelliFlex_VMware/SQL-Functions-Expressions-and-Predicates/Arithmetic-Trigonometric-Hyperbolic-Operators/Functions/RANDOM/RANDOM-Function-Syntax
5908# teradata lower and upper bounds
5909class Rand(Func):
5910    _sql_names = ["RAND", "RANDOM"]
5911    arg_types = {"this": False, "lower": False, "upper": False}
5912
5913
5914class Randn(Func):
5915    arg_types = {"this": False}
5916
5917
5918class RangeN(Func):
5919    arg_types = {"this": True, "expressions": True, "each": False}
5920
5921
5922class ReadCSV(Func):
5923    _sql_names = ["READ_CSV"]
5924    is_var_len_args = True
5925    arg_types = {"this": True, "expressions": False}
5926
5927
5928class Reduce(Func):
5929    arg_types = {"this": True, "initial": True, "merge": True, "finish": False}
5930
5931
5932class RegexpExtract(Func):
5933    arg_types = {
5934        "this": True,
5935        "expression": True,
5936        "position": False,
5937        "occurrence": False,
5938        "parameters": False,
5939        "group": False,
5940    }
5941
5942
5943class RegexpReplace(Func):
5944    arg_types = {
5945        "this": True,
5946        "expression": True,
5947        "replacement": False,
5948        "position": False,
5949        "occurrence": False,
5950        "modifiers": False,
5951    }
5952
5953
5954class RegexpLike(Binary, Func):
5955    arg_types = {"this": True, "expression": True, "flag": False}
5956
5957
5958class RegexpILike(Binary, Func):
5959    arg_types = {"this": True, "expression": True, "flag": False}
5960
5961
5962# https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.split.html
5963# limit is the number of times a pattern is applied
5964class RegexpSplit(Func):
5965    arg_types = {"this": True, "expression": True, "limit": False}
5966
5967
5968class Repeat(Func):
5969    arg_types = {"this": True, "times": True}
5970
5971
5972# https://learn.microsoft.com/en-us/sql/t-sql/functions/round-transact-sql?view=sql-server-ver16
5973# tsql third argument function == trunctaion if not 0
5974class Round(Func):
5975    arg_types = {"this": True, "decimals": False, "truncate": False}
5976
5977
5978class RowNumber(Func):
5979    arg_types: t.Dict[str, t.Any] = {}
5980
5981
5982class SafeDivide(Func):
5983    arg_types = {"this": True, "expression": True}
5984
5985
5986class SHA(Func):
5987    _sql_names = ["SHA", "SHA1"]
5988
5989
5990class SHA2(Func):
5991    _sql_names = ["SHA2"]
5992    arg_types = {"this": True, "length": False}
5993
5994
5995class Sign(Func):
5996    _sql_names = ["SIGN", "SIGNUM"]
5997
5998
5999class SortArray(Func):
6000    arg_types = {"this": True, "asc": False}
6001
6002
6003class Split(Func):
6004    arg_types = {"this": True, "expression": True, "limit": False}
6005
6006
6007# Start may be omitted in the case of postgres
6008# https://www.postgresql.org/docs/9.1/functions-string.html @ Table 9-6
6009class Substring(Func):
6010    arg_types = {"this": True, "start": False, "length": False}
6011
6012
6013class StandardHash(Func):
6014    arg_types = {"this": True, "expression": False}
6015
6016
6017class StartsWith(Func):
6018    _sql_names = ["STARTS_WITH", "STARTSWITH"]
6019    arg_types = {"this": True, "expression": True}
6020
6021
6022class StrPosition(Func):
6023    arg_types = {
6024        "this": True,
6025        "substr": True,
6026        "position": False,
6027        "instance": False,
6028    }
6029
6030
6031class StrToDate(Func):
6032    arg_types = {"this": True, "format": False, "safe": False}
6033
6034
6035class StrToTime(Func):
6036    arg_types = {"this": True, "format": True, "zone": False, "safe": False}
6037
6038
6039# Spark allows unix_timestamp()
6040# https://spark.apache.org/docs/3.1.3/api/python/reference/api/pyspark.sql.functions.unix_timestamp.html
6041class StrToUnix(Func):
6042    arg_types = {"this": False, "format": False}
6043
6044
6045# https://prestodb.io/docs/current/functions/string.html
6046# https://spark.apache.org/docs/latest/api/sql/index.html#str_to_map
6047class StrToMap(Func):
6048    arg_types = {
6049        "this": True,
6050        "pair_delim": False,
6051        "key_value_delim": False,
6052        "duplicate_resolution_callback": False,
6053    }
6054
6055
6056class NumberToStr(Func):
6057    arg_types = {"this": True, "format": True, "culture": False}
6058
6059
6060class FromBase(Func):
6061    arg_types = {"this": True, "expression": True}
6062
6063
6064class Struct(Func):
6065    arg_types = {"expressions": False}
6066    is_var_len_args = True
6067
6068
6069class StructExtract(Func):
6070    arg_types = {"this": True, "expression": True}
6071
6072
6073# https://learn.microsoft.com/en-us/sql/t-sql/functions/stuff-transact-sql?view=sql-server-ver16
6074# https://docs.snowflake.com/en/sql-reference/functions/insert
6075class Stuff(Func):
6076    _sql_names = ["STUFF", "INSERT"]
6077    arg_types = {"this": True, "start": True, "length": True, "expression": True}
6078
6079
6080class Sum(AggFunc):
6081    pass
6082
6083
6084class Sqrt(Func):
6085    pass
6086
6087
6088class Stddev(AggFunc):
6089    _sql_names = ["STDDEV", "STDEV"]
6090
6091
6092class StddevPop(AggFunc):
6093    pass
6094
6095
6096class StddevSamp(AggFunc):
6097    pass
6098
6099
6100# https://cloud.google.com/bigquery/docs/reference/standard-sql/time_functions#time
6101class Time(Func):
6102    arg_types = {"this": False, "zone": False}
6103
6104
6105class TimeToStr(Func):
6106    arg_types = {"this": True, "format": True, "culture": False, "zone": False}
6107
6108
6109class TimeToTimeStr(Func):
6110    pass
6111
6112
6113class TimeToUnix(Func):
6114    pass
6115
6116
6117class TimeStrToDate(Func):
6118    pass
6119
6120
6121class TimeStrToTime(Func):
6122    arg_types = {"this": True, "zone": False}
6123
6124
6125class TimeStrToUnix(Func):
6126    pass
6127
6128
6129class Trim(Func):
6130    arg_types = {
6131        "this": True,
6132        "expression": False,
6133        "position": False,
6134        "collation": False,
6135    }
6136
6137
6138class TsOrDsAdd(Func, TimeUnit):
6139    # return_type is used to correctly cast the arguments of this expression when transpiling it
6140    arg_types = {"this": True, "expression": True, "unit": False, "return_type": False}
6141
6142    @property
6143    def return_type(self) -> DataType:
6144        return DataType.build(self.args.get("return_type") or DataType.Type.DATE)
6145
6146
6147class TsOrDsDiff(Func, TimeUnit):
6148    arg_types = {"this": True, "expression": True, "unit": False}
6149
6150
6151class TsOrDsToDateStr(Func):
6152    pass
6153
6154
6155class TsOrDsToDate(Func):
6156    arg_types = {"this": True, "format": False, "safe": False}
6157
6158
6159class TsOrDsToTime(Func):
6160    pass
6161
6162
6163class TsOrDsToTimestamp(Func):
6164    pass
6165
6166
6167class TsOrDiToDi(Func):
6168    pass
6169
6170
6171class Unhex(Func):
6172    pass
6173
6174
6175# https://cloud.google.com/bigquery/docs/reference/standard-sql/date_functions#unix_date
6176class UnixDate(Func):
6177    pass
6178
6179
6180class UnixToStr(Func):
6181    arg_types = {"this": True, "format": False}
6182
6183
6184# https://prestodb.io/docs/current/functions/datetime.html
6185# presto has weird zone/hours/minutes
6186class UnixToTime(Func):
6187    arg_types = {
6188        "this": True,
6189        "scale": False,
6190        "zone": False,
6191        "hours": False,
6192        "minutes": False,
6193        "format": False,
6194    }
6195
6196    SECONDS = Literal.number(0)
6197    DECIS = Literal.number(1)
6198    CENTIS = Literal.number(2)
6199    MILLIS = Literal.number(3)
6200    DECIMILLIS = Literal.number(4)
6201    CENTIMILLIS = Literal.number(5)
6202    MICROS = Literal.number(6)
6203    DECIMICROS = Literal.number(7)
6204    CENTIMICROS = Literal.number(8)
6205    NANOS = Literal.number(9)
6206
6207
6208class UnixToTimeStr(Func):
6209    pass
6210
6211
6212class UnpackColumns(Func):
6213    pass
6214
6215
6216class Uuid(Func):
6217    _sql_names = ["UUID", "GEN_RANDOM_UUID", "GENERATE_UUID", "UUID_STRING"]
6218
6219    arg_types = {"this": False, "name": False}
6220
6221
6222class TimestampFromParts(Func):
6223    _sql_names = ["TIMESTAMP_FROM_PARTS", "TIMESTAMPFROMPARTS"]
6224    arg_types = {
6225        "year": True,
6226        "month": True,
6227        "day": True,
6228        "hour": True,
6229        "min": True,
6230        "sec": True,
6231        "nano": False,
6232        "zone": False,
6233        "milli": False,
6234    }
6235
6236
6237class Upper(Func):
6238    _sql_names = ["UPPER", "UCASE"]
6239
6240
6241class Corr(Binary, AggFunc):
6242    pass
6243
6244
6245class Variance(AggFunc):
6246    _sql_names = ["VARIANCE", "VARIANCE_SAMP", "VAR_SAMP"]
6247
6248
6249class VariancePop(AggFunc):
6250    _sql_names = ["VARIANCE_POP", "VAR_POP"]
6251
6252
6253class CovarSamp(Binary, AggFunc):
6254    pass
6255
6256
6257class CovarPop(Binary, AggFunc):
6258    pass
6259
6260
6261class Week(Func):
6262    arg_types = {"this": True, "mode": False}
6263
6264
6265class XMLTable(Func):
6266    arg_types = {"this": True, "passing": False, "columns": False, "by_ref": False}
6267
6268
6269class Year(Func):
6270    pass
6271
6272
6273class Use(Expression):
6274    arg_types = {"this": True, "kind": False}
6275
6276
6277class Merge(Expression):
6278    arg_types = {
6279        "this": True,
6280        "using": True,
6281        "on": True,
6282        "expressions": True,
6283        "with": False,
6284        "returning": False,
6285    }
6286
6287
6288class When(Func):
6289    arg_types = {"matched": True, "source": False, "condition": False, "then": True}
6290
6291
6292# https://docs.oracle.com/javadb/10.8.3.0/ref/rrefsqljnextvaluefor.html
6293# https://learn.microsoft.com/en-us/sql/t-sql/functions/next-value-for-transact-sql?view=sql-server-ver16
6294class NextValueFor(Func):
6295    arg_types = {"this": True, "order": False}
6296
6297
6298# Refers to a trailing semi-colon. This is only used to preserve trailing comments
6299# select 1; -- my comment
6300class Semicolon(Expression):
6301    arg_types = {}
6302
6303
6304def _norm_arg(arg):
6305    return arg.lower() if type(arg) is str else arg
6306
6307
6308ALL_FUNCTIONS = subclasses(__name__, Func, (AggFunc, Anonymous, Func))
6309FUNCTION_BY_NAME = {name: func for func in ALL_FUNCTIONS for name in func.sql_names()}
6310
6311JSON_PATH_PARTS = subclasses(__name__, JSONPathPart, (JSONPathPart,))
6312
6313PERCENTILES = (PercentileCont, PercentileDisc)
6314
6315
6316# Helpers
6317@t.overload
6318def maybe_parse(
6319    sql_or_expression: ExpOrStr,
6320    *,
6321    into: t.Type[E],
6322    dialect: DialectType = None,
6323    prefix: t.Optional[str] = None,
6324    copy: bool = False,
6325    **opts,
6326) -> E: ...
6327
6328
6329@t.overload
6330def maybe_parse(
6331    sql_or_expression: str | E,
6332    *,
6333    into: t.Optional[IntoType] = None,
6334    dialect: DialectType = None,
6335    prefix: t.Optional[str] = None,
6336    copy: bool = False,
6337    **opts,
6338) -> E: ...
6339
6340
6341def maybe_parse(
6342    sql_or_expression: ExpOrStr,
6343    *,
6344    into: t.Optional[IntoType] = None,
6345    dialect: DialectType = None,
6346    prefix: t.Optional[str] = None,
6347    copy: bool = False,
6348    **opts,
6349) -> Expression:
6350    """Gracefully handle a possible string or expression.
6351
6352    Example:
6353        >>> maybe_parse("1")
6354        Literal(this=1, is_string=False)
6355        >>> maybe_parse(to_identifier("x"))
6356        Identifier(this=x, quoted=False)
6357
6358    Args:
6359        sql_or_expression: the SQL code string or an expression
6360        into: the SQLGlot Expression to parse into
6361        dialect: the dialect used to parse the input expressions (in the case that an
6362            input expression is a SQL string).
6363        prefix: a string to prefix the sql with before it gets parsed
6364            (automatically includes a space)
6365        copy: whether to copy the expression.
6366        **opts: other options to use to parse the input expressions (again, in the case
6367            that an input expression is a SQL string).
6368
6369    Returns:
6370        Expression: the parsed or given expression.
6371    """
6372    if isinstance(sql_or_expression, Expression):
6373        if copy:
6374            return sql_or_expression.copy()
6375        return sql_or_expression
6376
6377    if sql_or_expression is None:
6378        raise ParseError("SQL cannot be None")
6379
6380    import sqlglot
6381
6382    sql = str(sql_or_expression)
6383    if prefix:
6384        sql = f"{prefix} {sql}"
6385
6386    return sqlglot.parse_one(sql, read=dialect, into=into, **opts)
6387
6388
6389@t.overload
6390def maybe_copy(instance: None, copy: bool = True) -> None: ...
6391
6392
6393@t.overload
6394def maybe_copy(instance: E, copy: bool = True) -> E: ...
6395
6396
6397def maybe_copy(instance, copy=True):
6398    return instance.copy() if copy and instance else instance
6399
6400
6401def _to_s(node: t.Any, verbose: bool = False, level: int = 0) -> str:
6402    """Generate a textual representation of an Expression tree"""
6403    indent = "\n" + ("  " * (level + 1))
6404    delim = f",{indent}"
6405
6406    if isinstance(node, Expression):
6407        args = {k: v for k, v in node.args.items() if (v is not None and v != []) or verbose}
6408
6409        if (node.type or verbose) and not isinstance(node, DataType):
6410            args["_type"] = node.type
6411        if node.comments or verbose:
6412            args["_comments"] = node.comments
6413
6414        if verbose:
6415            args["_id"] = id(node)
6416
6417        # Inline leaves for a more compact representation
6418        if node.is_leaf():
6419            indent = ""
6420            delim = ", "
6421
6422        items = delim.join([f"{k}={_to_s(v, verbose, level + 1)}" for k, v in args.items()])
6423        return f"{node.__class__.__name__}({indent}{items})"
6424
6425    if isinstance(node, list):
6426        items = delim.join(_to_s(i, verbose, level + 1) for i in node)
6427        items = f"{indent}{items}" if items else ""
6428        return f"[{items}]"
6429
6430    # Indent multiline strings to match the current level
6431    return indent.join(textwrap.dedent(str(node).strip("\n")).splitlines())
6432
6433
6434def _is_wrong_expression(expression, into):
6435    return isinstance(expression, Expression) and not isinstance(expression, into)
6436
6437
6438def _apply_builder(
6439    expression,
6440    instance,
6441    arg,
6442    copy=True,
6443    prefix=None,
6444    into=None,
6445    dialect=None,
6446    into_arg="this",
6447    **opts,
6448):
6449    if _is_wrong_expression(expression, into):
6450        expression = into(**{into_arg: expression})
6451    instance = maybe_copy(instance, copy)
6452    expression = maybe_parse(
6453        sql_or_expression=expression,
6454        prefix=prefix,
6455        into=into,
6456        dialect=dialect,
6457        **opts,
6458    )
6459    instance.set(arg, expression)
6460    return instance
6461
6462
6463def _apply_child_list_builder(
6464    *expressions,
6465    instance,
6466    arg,
6467    append=True,
6468    copy=True,
6469    prefix=None,
6470    into=None,
6471    dialect=None,
6472    properties=None,
6473    **opts,
6474):
6475    instance = maybe_copy(instance, copy)
6476    parsed = []
6477    properties = {} if properties is None else properties
6478
6479    for expression in expressions:
6480        if expression is not None:
6481            if _is_wrong_expression(expression, into):
6482                expression = into(expressions=[expression])
6483
6484            expression = maybe_parse(
6485                expression,
6486                into=into,
6487                dialect=dialect,
6488                prefix=prefix,
6489                **opts,
6490            )
6491            for k, v in expression.args.items():
6492                if k == "expressions":
6493                    parsed.extend(v)
6494                else:
6495                    properties[k] = v
6496
6497    existing = instance.args.get(arg)
6498    if append and existing:
6499        parsed = existing.expressions + parsed
6500
6501    child = into(expressions=parsed)
6502    for k, v in properties.items():
6503        child.set(k, v)
6504    instance.set(arg, child)
6505
6506    return instance
6507
6508
6509def _apply_list_builder(
6510    *expressions,
6511    instance,
6512    arg,
6513    append=True,
6514    copy=True,
6515    prefix=None,
6516    into=None,
6517    dialect=None,
6518    **opts,
6519):
6520    inst = maybe_copy(instance, copy)
6521
6522    expressions = [
6523        maybe_parse(
6524            sql_or_expression=expression,
6525            into=into,
6526            prefix=prefix,
6527            dialect=dialect,
6528            **opts,
6529        )
6530        for expression in expressions
6531        if expression is not None
6532    ]
6533
6534    existing_expressions = inst.args.get(arg)
6535    if append and existing_expressions:
6536        expressions = existing_expressions + expressions
6537
6538    inst.set(arg, expressions)
6539    return inst
6540
6541
6542def _apply_conjunction_builder(
6543    *expressions,
6544    instance,
6545    arg,
6546    into=None,
6547    append=True,
6548    copy=True,
6549    dialect=None,
6550    **opts,
6551):
6552    expressions = [exp for exp in expressions if exp is not None and exp != ""]
6553    if not expressions:
6554        return instance
6555
6556    inst = maybe_copy(instance, copy)
6557
6558    existing = inst.args.get(arg)
6559    if append and existing is not None:
6560        expressions = [existing.this if into else existing] + list(expressions)
6561
6562    node = and_(*expressions, dialect=dialect, copy=copy, **opts)
6563
6564    inst.set(arg, into(this=node) if into else node)
6565    return inst
6566
6567
6568def _apply_cte_builder(
6569    instance: E,
6570    alias: ExpOrStr,
6571    as_: ExpOrStr,
6572    recursive: t.Optional[bool] = None,
6573    materialized: t.Optional[bool] = None,
6574    append: bool = True,
6575    dialect: DialectType = None,
6576    copy: bool = True,
6577    **opts,
6578) -> E:
6579    alias_expression = maybe_parse(alias, dialect=dialect, into=TableAlias, **opts)
6580    as_expression = maybe_parse(as_, dialect=dialect, **opts)
6581    cte = CTE(this=as_expression, alias=alias_expression, materialized=materialized)
6582    return _apply_child_list_builder(
6583        cte,
6584        instance=instance,
6585        arg="with",
6586        append=append,
6587        copy=copy,
6588        into=With,
6589        properties={"recursive": recursive or False},
6590    )
6591
6592
6593def _combine(
6594    expressions: t.Sequence[t.Optional[ExpOrStr]],
6595    operator: t.Type[Connector],
6596    dialect: DialectType = None,
6597    copy: bool = True,
6598    **opts,
6599) -> Expression:
6600    conditions = [
6601        condition(expression, dialect=dialect, copy=copy, **opts)
6602        for expression in expressions
6603        if expression is not None
6604    ]
6605
6606    this, *rest = conditions
6607    if rest:
6608        this = _wrap(this, Connector)
6609    for expression in rest:
6610        this = operator(this=this, expression=_wrap(expression, Connector))
6611
6612    return this
6613
6614
6615def _wrap(expression: E, kind: t.Type[Expression]) -> E | Paren:
6616    return Paren(this=expression) if isinstance(expression, kind) else expression
6617
6618
6619def union(
6620    left: ExpOrStr,
6621    right: ExpOrStr,
6622    distinct: bool = True,
6623    dialect: DialectType = None,
6624    copy: bool = True,
6625    **opts,
6626) -> Union:
6627    """
6628    Initializes a syntax tree from one UNION expression.
6629
6630    Example:
6631        >>> union("SELECT * FROM foo", "SELECT * FROM bla").sql()
6632        'SELECT * FROM foo UNION SELECT * FROM bla'
6633
6634    Args:
6635        left: the SQL code string corresponding to the left-hand side.
6636            If an `Expression` instance is passed, it will be used as-is.
6637        right: the SQL code string corresponding to the right-hand side.
6638            If an `Expression` instance is passed, it will be used as-is.
6639        distinct: set the DISTINCT flag if and only if this is true.
6640        dialect: the dialect used to parse the input expression.
6641        copy: whether to copy the expression.
6642        opts: other options to use to parse the input expressions.
6643
6644    Returns:
6645        The new Union instance.
6646    """
6647    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6648    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6649
6650    return Union(this=left, expression=right, distinct=distinct)
6651
6652
6653def intersect(
6654    left: ExpOrStr,
6655    right: ExpOrStr,
6656    distinct: bool = True,
6657    dialect: DialectType = None,
6658    copy: bool = True,
6659    **opts,
6660) -> Intersect:
6661    """
6662    Initializes a syntax tree from one INTERSECT expression.
6663
6664    Example:
6665        >>> intersect("SELECT * FROM foo", "SELECT * FROM bla").sql()
6666        'SELECT * FROM foo INTERSECT SELECT * FROM bla'
6667
6668    Args:
6669        left: the SQL code string corresponding to the left-hand side.
6670            If an `Expression` instance is passed, it will be used as-is.
6671        right: the SQL code string corresponding to the right-hand side.
6672            If an `Expression` instance is passed, it will be used as-is.
6673        distinct: set the DISTINCT flag if and only if this is true.
6674        dialect: the dialect used to parse the input expression.
6675        copy: whether to copy the expression.
6676        opts: other options to use to parse the input expressions.
6677
6678    Returns:
6679        The new Intersect instance.
6680    """
6681    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6682    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6683
6684    return Intersect(this=left, expression=right, distinct=distinct)
6685
6686
6687def except_(
6688    left: ExpOrStr,
6689    right: ExpOrStr,
6690    distinct: bool = True,
6691    dialect: DialectType = None,
6692    copy: bool = True,
6693    **opts,
6694) -> Except:
6695    """
6696    Initializes a syntax tree from one EXCEPT expression.
6697
6698    Example:
6699        >>> except_("SELECT * FROM foo", "SELECT * FROM bla").sql()
6700        'SELECT * FROM foo EXCEPT SELECT * FROM bla'
6701
6702    Args:
6703        left: the SQL code string corresponding to the left-hand side.
6704            If an `Expression` instance is passed, it will be used as-is.
6705        right: the SQL code string corresponding to the right-hand side.
6706            If an `Expression` instance is passed, it will be used as-is.
6707        distinct: set the DISTINCT flag if and only if this is true.
6708        dialect: the dialect used to parse the input expression.
6709        copy: whether to copy the expression.
6710        opts: other options to use to parse the input expressions.
6711
6712    Returns:
6713        The new Except instance.
6714    """
6715    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6716    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6717
6718    return Except(this=left, expression=right, distinct=distinct)
6719
6720
6721def select(*expressions: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6722    """
6723    Initializes a syntax tree from one or multiple SELECT expressions.
6724
6725    Example:
6726        >>> select("col1", "col2").from_("tbl").sql()
6727        'SELECT col1, col2 FROM tbl'
6728
6729    Args:
6730        *expressions: the SQL code string to parse as the expressions of a
6731            SELECT statement. If an Expression instance is passed, this is used as-is.
6732        dialect: the dialect used to parse the input expressions (in the case that an
6733            input expression is a SQL string).
6734        **opts: other options to use to parse the input expressions (again, in the case
6735            that an input expression is a SQL string).
6736
6737    Returns:
6738        Select: the syntax tree for the SELECT statement.
6739    """
6740    return Select().select(*expressions, dialect=dialect, **opts)
6741
6742
6743def from_(expression: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6744    """
6745    Initializes a syntax tree from a FROM expression.
6746
6747    Example:
6748        >>> from_("tbl").select("col1", "col2").sql()
6749        'SELECT col1, col2 FROM tbl'
6750
6751    Args:
6752        *expression: the SQL code string to parse as the FROM expressions of a
6753            SELECT statement. If an Expression instance is passed, this is used as-is.
6754        dialect: the dialect used to parse the input expression (in the case that the
6755            input expression is a SQL string).
6756        **opts: other options to use to parse the input expressions (again, in the case
6757            that the input expression is a SQL string).
6758
6759    Returns:
6760        Select: the syntax tree for the SELECT statement.
6761    """
6762    return Select().from_(expression, dialect=dialect, **opts)
6763
6764
6765def update(
6766    table: str | Table,
6767    properties: dict,
6768    where: t.Optional[ExpOrStr] = None,
6769    from_: t.Optional[ExpOrStr] = None,
6770    dialect: DialectType = None,
6771    **opts,
6772) -> Update:
6773    """
6774    Creates an update statement.
6775
6776    Example:
6777        >>> update("my_table", {"x": 1, "y": "2", "z": None}, from_="baz", where="id > 1").sql()
6778        "UPDATE my_table SET x = 1, y = '2', z = NULL FROM baz WHERE id > 1"
6779
6780    Args:
6781        *properties: dictionary of properties to set which are
6782            auto converted to sql objects eg None -> NULL
6783        where: sql conditional parsed into a WHERE statement
6784        from_: sql statement parsed into a FROM statement
6785        dialect: the dialect used to parse the input expressions.
6786        **opts: other options to use to parse the input expressions.
6787
6788    Returns:
6789        Update: the syntax tree for the UPDATE statement.
6790    """
6791    update_expr = Update(this=maybe_parse(table, into=Table, dialect=dialect))
6792    update_expr.set(
6793        "expressions",
6794        [
6795            EQ(this=maybe_parse(k, dialect=dialect, **opts), expression=convert(v))
6796            for k, v in properties.items()
6797        ],
6798    )
6799    if from_:
6800        update_expr.set(
6801            "from",
6802            maybe_parse(from_, into=From, dialect=dialect, prefix="FROM", **opts),
6803        )
6804    if isinstance(where, Condition):
6805        where = Where(this=where)
6806    if where:
6807        update_expr.set(
6808            "where",
6809            maybe_parse(where, into=Where, dialect=dialect, prefix="WHERE", **opts),
6810        )
6811    return update_expr
6812
6813
6814def delete(
6815    table: ExpOrStr,
6816    where: t.Optional[ExpOrStr] = None,
6817    returning: t.Optional[ExpOrStr] = None,
6818    dialect: DialectType = None,
6819    **opts,
6820) -> Delete:
6821    """
6822    Builds a delete statement.
6823
6824    Example:
6825        >>> delete("my_table", where="id > 1").sql()
6826        'DELETE FROM my_table WHERE id > 1'
6827
6828    Args:
6829        where: sql conditional parsed into a WHERE statement
6830        returning: sql conditional parsed into a RETURNING statement
6831        dialect: the dialect used to parse the input expressions.
6832        **opts: other options to use to parse the input expressions.
6833
6834    Returns:
6835        Delete: the syntax tree for the DELETE statement.
6836    """
6837    delete_expr = Delete().delete(table, dialect=dialect, copy=False, **opts)
6838    if where:
6839        delete_expr = delete_expr.where(where, dialect=dialect, copy=False, **opts)
6840    if returning:
6841        delete_expr = t.cast(
6842            Delete, delete_expr.returning(returning, dialect=dialect, copy=False, **opts)
6843        )
6844    return delete_expr
6845
6846
6847def insert(
6848    expression: ExpOrStr,
6849    into: ExpOrStr,
6850    columns: t.Optional[t.Sequence[str | Identifier]] = None,
6851    overwrite: t.Optional[bool] = None,
6852    returning: t.Optional[ExpOrStr] = None,
6853    dialect: DialectType = None,
6854    copy: bool = True,
6855    **opts,
6856) -> Insert:
6857    """
6858    Builds an INSERT statement.
6859
6860    Example:
6861        >>> insert("VALUES (1, 2, 3)", "tbl").sql()
6862        'INSERT INTO tbl VALUES (1, 2, 3)'
6863
6864    Args:
6865        expression: the sql string or expression of the INSERT statement
6866        into: the tbl to insert data to.
6867        columns: optionally the table's column names.
6868        overwrite: whether to INSERT OVERWRITE or not.
6869        returning: sql conditional parsed into a RETURNING statement
6870        dialect: the dialect used to parse the input expressions.
6871        copy: whether to copy the expression.
6872        **opts: other options to use to parse the input expressions.
6873
6874    Returns:
6875        Insert: the syntax tree for the INSERT statement.
6876    """
6877    expr = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
6878    this: Table | Schema = maybe_parse(into, into=Table, dialect=dialect, copy=copy, **opts)
6879
6880    if columns:
6881        this = Schema(this=this, expressions=[to_identifier(c, copy=copy) for c in columns])
6882
6883    insert = Insert(this=this, expression=expr, overwrite=overwrite)
6884
6885    if returning:
6886        insert = t.cast(Insert, insert.returning(returning, dialect=dialect, copy=False, **opts))
6887
6888    return insert
6889
6890
6891def merge(
6892    *when_exprs: ExpOrStr,
6893    into: ExpOrStr,
6894    using: ExpOrStr,
6895    on: ExpOrStr,
6896    dialect: DialectType = None,
6897    copy: bool = True,
6898    **opts,
6899) -> Merge:
6900    """
6901    Builds a MERGE statement.
6902
6903    Example:
6904        >>> merge("WHEN MATCHED THEN UPDATE SET col1 = source_table.col1",
6905        ...       "WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)",
6906        ...       into="my_table",
6907        ...       using="source_table",
6908        ...       on="my_table.id = source_table.id").sql()
6909        'MERGE INTO my_table USING source_table ON my_table.id = source_table.id WHEN MATCHED THEN UPDATE SET col1 = source_table.col1 WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)'
6910
6911    Args:
6912        *when_exprs: The WHEN clauses specifying actions for matched and unmatched rows.
6913        into: The target table to merge data into.
6914        using: The source table to merge data from.
6915        on: The join condition for the merge.
6916        dialect: The dialect used to parse the input expressions.
6917        copy: Whether to copy the expression.
6918        **opts: Other options to use to parse the input expressions.
6919
6920    Returns:
6921        Merge: The syntax tree for the MERGE statement.
6922    """
6923    return Merge(
6924        this=maybe_parse(into, dialect=dialect, copy=copy, **opts),
6925        using=maybe_parse(using, dialect=dialect, copy=copy, **opts),
6926        on=maybe_parse(on, dialect=dialect, copy=copy, **opts),
6927        expressions=[
6928            maybe_parse(when_expr, dialect=dialect, copy=copy, into=When, **opts)
6929            for when_expr in when_exprs
6930        ],
6931    )
6932
6933
6934def condition(
6935    expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
6936) -> Condition:
6937    """
6938    Initialize a logical condition expression.
6939
6940    Example:
6941        >>> condition("x=1").sql()
6942        'x = 1'
6943
6944        This is helpful for composing larger logical syntax trees:
6945        >>> where = condition("x=1")
6946        >>> where = where.and_("y=1")
6947        >>> Select().from_("tbl").select("*").where(where).sql()
6948        'SELECT * FROM tbl WHERE x = 1 AND y = 1'
6949
6950    Args:
6951        *expression: the SQL code string to parse.
6952            If an Expression instance is passed, this is used as-is.
6953        dialect: the dialect used to parse the input expression (in the case that the
6954            input expression is a SQL string).
6955        copy: Whether to copy `expression` (only applies to expressions).
6956        **opts: other options to use to parse the input expressions (again, in the case
6957            that the input expression is a SQL string).
6958
6959    Returns:
6960        The new Condition instance
6961    """
6962    return maybe_parse(
6963        expression,
6964        into=Condition,
6965        dialect=dialect,
6966        copy=copy,
6967        **opts,
6968    )
6969
6970
6971def and_(
6972    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6973) -> Condition:
6974    """
6975    Combine multiple conditions with an AND logical operator.
6976
6977    Example:
6978        >>> and_("x=1", and_("y=1", "z=1")).sql()
6979        'x = 1 AND (y = 1 AND z = 1)'
6980
6981    Args:
6982        *expressions: the SQL code strings to parse.
6983            If an Expression instance is passed, this is used as-is.
6984        dialect: the dialect used to parse the input expression.
6985        copy: whether to copy `expressions` (only applies to Expressions).
6986        **opts: other options to use to parse the input expressions.
6987
6988    Returns:
6989        The new condition
6990    """
6991    return t.cast(Condition, _combine(expressions, And, dialect, copy=copy, **opts))
6992
6993
6994def or_(
6995    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6996) -> Condition:
6997    """
6998    Combine multiple conditions with an OR logical operator.
6999
7000    Example:
7001        >>> or_("x=1", or_("y=1", "z=1")).sql()
7002        'x = 1 OR (y = 1 OR z = 1)'
7003
7004    Args:
7005        *expressions: the SQL code strings to parse.
7006            If an Expression instance is passed, this is used as-is.
7007        dialect: the dialect used to parse the input expression.
7008        copy: whether to copy `expressions` (only applies to Expressions).
7009        **opts: other options to use to parse the input expressions.
7010
7011    Returns:
7012        The new condition
7013    """
7014    return t.cast(Condition, _combine(expressions, Or, dialect, copy=copy, **opts))
7015
7016
7017def xor(
7018    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
7019) -> Condition:
7020    """
7021    Combine multiple conditions with an XOR logical operator.
7022
7023    Example:
7024        >>> xor("x=1", xor("y=1", "z=1")).sql()
7025        'x = 1 XOR (y = 1 XOR z = 1)'
7026
7027    Args:
7028        *expressions: the SQL code strings to parse.
7029            If an Expression instance is passed, this is used as-is.
7030        dialect: the dialect used to parse the input expression.
7031        copy: whether to copy `expressions` (only applies to Expressions).
7032        **opts: other options to use to parse the input expressions.
7033
7034    Returns:
7035        The new condition
7036    """
7037    return t.cast(Condition, _combine(expressions, Xor, dialect, copy=copy, **opts))
7038
7039
7040def not_(expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts) -> Not:
7041    """
7042    Wrap a condition with a NOT operator.
7043
7044    Example:
7045        >>> not_("this_suit='black'").sql()
7046        "NOT this_suit = 'black'"
7047
7048    Args:
7049        expression: the SQL code string to parse.
7050            If an Expression instance is passed, this is used as-is.
7051        dialect: the dialect used to parse the input expression.
7052        copy: whether to copy the expression or not.
7053        **opts: other options to use to parse the input expressions.
7054
7055    Returns:
7056        The new condition.
7057    """
7058    this = condition(
7059        expression,
7060        dialect=dialect,
7061        copy=copy,
7062        **opts,
7063    )
7064    return Not(this=_wrap(this, Connector))
7065
7066
7067def paren(expression: ExpOrStr, copy: bool = True) -> Paren:
7068    """
7069    Wrap an expression in parentheses.
7070
7071    Example:
7072        >>> paren("5 + 3").sql()
7073        '(5 + 3)'
7074
7075    Args:
7076        expression: the SQL code string to parse.
7077            If an Expression instance is passed, this is used as-is.
7078        copy: whether to copy the expression or not.
7079
7080    Returns:
7081        The wrapped expression.
7082    """
7083    return Paren(this=maybe_parse(expression, copy=copy))
7084
7085
7086SAFE_IDENTIFIER_RE: t.Pattern[str] = re.compile(r"^[_a-zA-Z][\w]*$")
7087
7088
7089@t.overload
7090def to_identifier(name: None, quoted: t.Optional[bool] = None, copy: bool = True) -> None: ...
7091
7092
7093@t.overload
7094def to_identifier(
7095    name: str | Identifier, quoted: t.Optional[bool] = None, copy: bool = True
7096) -> Identifier: ...
7097
7098
7099def to_identifier(name, quoted=None, copy=True):
7100    """Builds an identifier.
7101
7102    Args:
7103        name: The name to turn into an identifier.
7104        quoted: Whether to force quote the identifier.
7105        copy: Whether to copy name if it's an Identifier.
7106
7107    Returns:
7108        The identifier ast node.
7109    """
7110
7111    if name is None:
7112        return None
7113
7114    if isinstance(name, Identifier):
7115        identifier = maybe_copy(name, copy)
7116    elif isinstance(name, str):
7117        identifier = Identifier(
7118            this=name,
7119            quoted=not SAFE_IDENTIFIER_RE.match(name) if quoted is None else quoted,
7120        )
7121    else:
7122        raise ValueError(f"Name needs to be a string or an Identifier, got: {name.__class__}")
7123    return identifier
7124
7125
7126def parse_identifier(name: str | Identifier, dialect: DialectType = None) -> Identifier:
7127    """
7128    Parses a given string into an identifier.
7129
7130    Args:
7131        name: The name to parse into an identifier.
7132        dialect: The dialect to parse against.
7133
7134    Returns:
7135        The identifier ast node.
7136    """
7137    try:
7138        expression = maybe_parse(name, dialect=dialect, into=Identifier)
7139    except (ParseError, TokenError):
7140        expression = to_identifier(name)
7141
7142    return expression
7143
7144
7145INTERVAL_STRING_RE = re.compile(r"\s*([0-9]+)\s*([a-zA-Z]+)\s*")
7146
7147
7148def to_interval(interval: str | Literal) -> Interval:
7149    """Builds an interval expression from a string like '1 day' or '5 months'."""
7150    if isinstance(interval, Literal):
7151        if not interval.is_string:
7152            raise ValueError("Invalid interval string.")
7153
7154        interval = interval.this
7155
7156    interval_parts = INTERVAL_STRING_RE.match(interval)  # type: ignore
7157
7158    if not interval_parts:
7159        raise ValueError("Invalid interval string.")
7160
7161    return Interval(
7162        this=Literal.string(interval_parts.group(1)),
7163        unit=Var(this=interval_parts.group(2).upper()),
7164    )
7165
7166
7167def to_table(
7168    sql_path: str | Table, dialect: DialectType = None, copy: bool = True, **kwargs
7169) -> Table:
7170    """
7171    Create a table expression from a `[catalog].[schema].[table]` sql path. Catalog and schema are optional.
7172    If a table is passed in then that table is returned.
7173
7174    Args:
7175        sql_path: a `[catalog].[schema].[table]` string.
7176        dialect: the source dialect according to which the table name will be parsed.
7177        copy: Whether to copy a table if it is passed in.
7178        kwargs: the kwargs to instantiate the resulting `Table` expression with.
7179
7180    Returns:
7181        A table expression.
7182    """
7183    if isinstance(sql_path, Table):
7184        return maybe_copy(sql_path, copy=copy)
7185
7186    table = maybe_parse(sql_path, into=Table, dialect=dialect)
7187
7188    for k, v in kwargs.items():
7189        table.set(k, v)
7190
7191    return table
7192
7193
7194def to_column(
7195    sql_path: str | Column,
7196    quoted: t.Optional[bool] = None,
7197    dialect: DialectType = None,
7198    copy: bool = True,
7199    **kwargs,
7200) -> Column:
7201    """
7202    Create a column from a `[table].[column]` sql path. Table is optional.
7203    If a column is passed in then that column is returned.
7204
7205    Args:
7206        sql_path: a `[table].[column]` string.
7207        quoted: Whether or not to force quote identifiers.
7208        dialect: the source dialect according to which the column name will be parsed.
7209        copy: Whether to copy a column if it is passed in.
7210        kwargs: the kwargs to instantiate the resulting `Column` expression with.
7211
7212    Returns:
7213        A column expression.
7214    """
7215    if isinstance(sql_path, Column):
7216        return maybe_copy(sql_path, copy=copy)
7217
7218    try:
7219        col = maybe_parse(sql_path, into=Column, dialect=dialect)
7220    except ParseError:
7221        return column(*reversed(sql_path.split(".")), quoted=quoted, **kwargs)
7222
7223    for k, v in kwargs.items():
7224        col.set(k, v)
7225
7226    if quoted:
7227        for i in col.find_all(Identifier):
7228            i.set("quoted", True)
7229
7230    return col
7231
7232
7233def alias_(
7234    expression: ExpOrStr,
7235    alias: t.Optional[str | Identifier],
7236    table: bool | t.Sequence[str | Identifier] = False,
7237    quoted: t.Optional[bool] = None,
7238    dialect: DialectType = None,
7239    copy: bool = True,
7240    **opts,
7241):
7242    """Create an Alias expression.
7243
7244    Example:
7245        >>> alias_('foo', 'bar').sql()
7246        'foo AS bar'
7247
7248        >>> alias_('(select 1, 2)', 'bar', table=['a', 'b']).sql()
7249        '(SELECT 1, 2) AS bar(a, b)'
7250
7251    Args:
7252        expression: the SQL code strings to parse.
7253            If an Expression instance is passed, this is used as-is.
7254        alias: the alias name to use. If the name has
7255            special characters it is quoted.
7256        table: Whether to create a table alias, can also be a list of columns.
7257        quoted: whether to quote the alias
7258        dialect: the dialect used to parse the input expression.
7259        copy: Whether to copy the expression.
7260        **opts: other options to use to parse the input expressions.
7261
7262    Returns:
7263        Alias: the aliased expression
7264    """
7265    exp = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
7266    alias = to_identifier(alias, quoted=quoted)
7267
7268    if table:
7269        table_alias = TableAlias(this=alias)
7270        exp.set("alias", table_alias)
7271
7272        if not isinstance(table, bool):
7273            for column in table:
7274                table_alias.append("columns", to_identifier(column, quoted=quoted))
7275
7276        return exp
7277
7278    # We don't set the "alias" arg for Window expressions, because that would add an IDENTIFIER node in
7279    # the AST, representing a "named_window" [1] construct (eg. bigquery). What we want is an ALIAS node
7280    # for the complete Window expression.
7281    #
7282    # [1]: https://cloud.google.com/bigquery/docs/reference/standard-sql/window-function-calls
7283
7284    if "alias" in exp.arg_types and not isinstance(exp, Window):
7285        exp.set("alias", alias)
7286        return exp
7287    return Alias(this=exp, alias=alias)
7288
7289
7290def subquery(
7291    expression: ExpOrStr,
7292    alias: t.Optional[Identifier | str] = None,
7293    dialect: DialectType = None,
7294    **opts,
7295) -> Select:
7296    """
7297    Build a subquery expression that's selected from.
7298
7299    Example:
7300        >>> subquery('select x from tbl', 'bar').select('x').sql()
7301        'SELECT x FROM (SELECT x FROM tbl) AS bar'
7302
7303    Args:
7304        expression: the SQL code strings to parse.
7305            If an Expression instance is passed, this is used as-is.
7306        alias: the alias name to use.
7307        dialect: the dialect used to parse the input expression.
7308        **opts: other options to use to parse the input expressions.
7309
7310    Returns:
7311        A new Select instance with the subquery expression included.
7312    """
7313
7314    expression = maybe_parse(expression, dialect=dialect, **opts).subquery(alias, **opts)
7315    return Select().from_(expression, dialect=dialect, **opts)
7316
7317
7318@t.overload
7319def column(
7320    col: str | Identifier,
7321    table: t.Optional[str | Identifier] = None,
7322    db: t.Optional[str | Identifier] = None,
7323    catalog: t.Optional[str | Identifier] = None,
7324    *,
7325    fields: t.Collection[t.Union[str, Identifier]],
7326    quoted: t.Optional[bool] = None,
7327    copy: bool = True,
7328) -> Dot:
7329    pass
7330
7331
7332@t.overload
7333def column(
7334    col: str | Identifier,
7335    table: t.Optional[str | Identifier] = None,
7336    db: t.Optional[str | Identifier] = None,
7337    catalog: t.Optional[str | Identifier] = None,
7338    *,
7339    fields: Lit[None] = None,
7340    quoted: t.Optional[bool] = None,
7341    copy: bool = True,
7342) -> Column:
7343    pass
7344
7345
7346def column(
7347    col,
7348    table=None,
7349    db=None,
7350    catalog=None,
7351    *,
7352    fields=None,
7353    quoted=None,
7354    copy=True,
7355):
7356    """
7357    Build a Column.
7358
7359    Args:
7360        col: Column name.
7361        table: Table name.
7362        db: Database name.
7363        catalog: Catalog name.
7364        fields: Additional fields using dots.
7365        quoted: Whether to force quotes on the column's identifiers.
7366        copy: Whether to copy identifiers if passed in.
7367
7368    Returns:
7369        The new Column instance.
7370    """
7371    this = Column(
7372        this=to_identifier(col, quoted=quoted, copy=copy),
7373        table=to_identifier(table, quoted=quoted, copy=copy),
7374        db=to_identifier(db, quoted=quoted, copy=copy),
7375        catalog=to_identifier(catalog, quoted=quoted, copy=copy),
7376    )
7377
7378    if fields:
7379        this = Dot.build(
7380            (this, *(to_identifier(field, quoted=quoted, copy=copy) for field in fields))
7381        )
7382    return this
7383
7384
7385def cast(
7386    expression: ExpOrStr, to: DATA_TYPE, copy: bool = True, dialect: DialectType = None, **opts
7387) -> Cast:
7388    """Cast an expression to a data type.
7389
7390    Example:
7391        >>> cast('x + 1', 'int').sql()
7392        'CAST(x + 1 AS INT)'
7393
7394    Args:
7395        expression: The expression to cast.
7396        to: The datatype to cast to.
7397        copy: Whether to copy the supplied expressions.
7398        dialect: The target dialect. This is used to prevent a re-cast in the following scenario:
7399            - The expression to be cast is already a exp.Cast expression
7400            - The existing cast is to a type that is logically equivalent to new type
7401
7402            For example, if :expression='CAST(x as DATETIME)' and :to=Type.TIMESTAMP,
7403            but in the target dialect DATETIME is mapped to TIMESTAMP, then we will NOT return `CAST(x (as DATETIME) as TIMESTAMP)`
7404            and instead just return the original expression `CAST(x as DATETIME)`.
7405
7406            This is to prevent it being output as a double cast `CAST(x (as TIMESTAMP) as TIMESTAMP)` once the DATETIME -> TIMESTAMP
7407            mapping is applied in the target dialect generator.
7408
7409    Returns:
7410        The new Cast instance.
7411    """
7412    expr = maybe_parse(expression, copy=copy, dialect=dialect, **opts)
7413    data_type = DataType.build(to, copy=copy, dialect=dialect, **opts)
7414
7415    # dont re-cast if the expression is already a cast to the correct type
7416    if isinstance(expr, Cast):
7417        from sqlglot.dialects.dialect import Dialect
7418
7419        target_dialect = Dialect.get_or_raise(dialect)
7420        type_mapping = target_dialect.generator_class.TYPE_MAPPING
7421
7422        existing_cast_type: DataType.Type = expr.to.this
7423        new_cast_type: DataType.Type = data_type.this
7424        types_are_equivalent = type_mapping.get(
7425            existing_cast_type, existing_cast_type
7426        ) == type_mapping.get(new_cast_type, new_cast_type)
7427        if expr.is_type(data_type) or types_are_equivalent:
7428            return expr
7429
7430    expr = Cast(this=expr, to=data_type)
7431    expr.type = data_type
7432
7433    return expr
7434
7435
7436def table_(
7437    table: Identifier | str,
7438    db: t.Optional[Identifier | str] = None,
7439    catalog: t.Optional[Identifier | str] = None,
7440    quoted: t.Optional[bool] = None,
7441    alias: t.Optional[Identifier | str] = None,
7442) -> Table:
7443    """Build a Table.
7444
7445    Args:
7446        table: Table name.
7447        db: Database name.
7448        catalog: Catalog name.
7449        quote: Whether to force quotes on the table's identifiers.
7450        alias: Table's alias.
7451
7452    Returns:
7453        The new Table instance.
7454    """
7455    return Table(
7456        this=to_identifier(table, quoted=quoted) if table else None,
7457        db=to_identifier(db, quoted=quoted) if db else None,
7458        catalog=to_identifier(catalog, quoted=quoted) if catalog else None,
7459        alias=TableAlias(this=to_identifier(alias)) if alias else None,
7460    )
7461
7462
7463def values(
7464    values: t.Iterable[t.Tuple[t.Any, ...]],
7465    alias: t.Optional[str] = None,
7466    columns: t.Optional[t.Iterable[str] | t.Dict[str, DataType]] = None,
7467) -> Values:
7468    """Build VALUES statement.
7469
7470    Example:
7471        >>> values([(1, '2')]).sql()
7472        "VALUES (1, '2')"
7473
7474    Args:
7475        values: values statements that will be converted to SQL
7476        alias: optional alias
7477        columns: Optional list of ordered column names or ordered dictionary of column names to types.
7478         If either are provided then an alias is also required.
7479
7480    Returns:
7481        Values: the Values expression object
7482    """
7483    if columns and not alias:
7484        raise ValueError("Alias is required when providing columns")
7485
7486    return Values(
7487        expressions=[convert(tup) for tup in values],
7488        alias=(
7489            TableAlias(this=to_identifier(alias), columns=[to_identifier(x) for x in columns])
7490            if columns
7491            else (TableAlias(this=to_identifier(alias)) if alias else None)
7492        ),
7493    )
7494
7495
7496def var(name: t.Optional[ExpOrStr]) -> Var:
7497    """Build a SQL variable.
7498
7499    Example:
7500        >>> repr(var('x'))
7501        'Var(this=x)'
7502
7503        >>> repr(var(column('x', table='y')))
7504        'Var(this=x)'
7505
7506    Args:
7507        name: The name of the var or an expression who's name will become the var.
7508
7509    Returns:
7510        The new variable node.
7511    """
7512    if not name:
7513        raise ValueError("Cannot convert empty name into var.")
7514
7515    if isinstance(name, Expression):
7516        name = name.name
7517    return Var(this=name)
7518
7519
7520def rename_table(
7521    old_name: str | Table,
7522    new_name: str | Table,
7523    dialect: DialectType = None,
7524) -> Alter:
7525    """Build ALTER TABLE... RENAME... expression
7526
7527    Args:
7528        old_name: The old name of the table
7529        new_name: The new name of the table
7530        dialect: The dialect to parse the table.
7531
7532    Returns:
7533        Alter table expression
7534    """
7535    old_table = to_table(old_name, dialect=dialect)
7536    new_table = to_table(new_name, dialect=dialect)
7537    return Alter(
7538        this=old_table,
7539        kind="TABLE",
7540        actions=[
7541            RenameTable(this=new_table),
7542        ],
7543    )
7544
7545
7546def rename_column(
7547    table_name: str | Table,
7548    old_column_name: str | Column,
7549    new_column_name: str | Column,
7550    exists: t.Optional[bool] = None,
7551    dialect: DialectType = None,
7552) -> Alter:
7553    """Build ALTER TABLE... RENAME COLUMN... expression
7554
7555    Args:
7556        table_name: Name of the table
7557        old_column: The old name of the column
7558        new_column: The new name of the column
7559        exists: Whether to add the `IF EXISTS` clause
7560        dialect: The dialect to parse the table/column.
7561
7562    Returns:
7563        Alter table expression
7564    """
7565    table = to_table(table_name, dialect=dialect)
7566    old_column = to_column(old_column_name, dialect=dialect)
7567    new_column = to_column(new_column_name, dialect=dialect)
7568    return Alter(
7569        this=table,
7570        kind="TABLE",
7571        actions=[
7572            RenameColumn(this=old_column, to=new_column, exists=exists),
7573        ],
7574    )
7575
7576
7577def convert(value: t.Any, copy: bool = False) -> Expression:
7578    """Convert a python value into an expression object.
7579
7580    Raises an error if a conversion is not possible.
7581
7582    Args:
7583        value: A python object.
7584        copy: Whether to copy `value` (only applies to Expressions and collections).
7585
7586    Returns:
7587        The equivalent expression object.
7588    """
7589    if isinstance(value, Expression):
7590        return maybe_copy(value, copy)
7591    if isinstance(value, str):
7592        return Literal.string(value)
7593    if isinstance(value, bool):
7594        return Boolean(this=value)
7595    if value is None or (isinstance(value, float) and math.isnan(value)):
7596        return null()
7597    if isinstance(value, numbers.Number):
7598        return Literal.number(value)
7599    if isinstance(value, bytes):
7600        return HexString(this=value.hex())
7601    if isinstance(value, datetime.datetime):
7602        datetime_literal = Literal.string(value.isoformat(sep=" "))
7603
7604        tz = None
7605        if value.tzinfo:
7606            # this works for zoneinfo.ZoneInfo, pytz.timezone and datetime.datetime.utc to return IANA timezone names like "America/Los_Angeles"
7607            # instead of abbreviations like "PDT". This is for consistency with other timezone handling functions in SQLGlot
7608            tz = Literal.string(str(value.tzinfo))
7609
7610        return TimeStrToTime(this=datetime_literal, zone=tz)
7611    if isinstance(value, datetime.date):
7612        date_literal = Literal.string(value.strftime("%Y-%m-%d"))
7613        return DateStrToDate(this=date_literal)
7614    if isinstance(value, tuple):
7615        if hasattr(value, "_fields"):
7616            return Struct(
7617                expressions=[
7618                    PropertyEQ(
7619                        this=to_identifier(k), expression=convert(getattr(value, k), copy=copy)
7620                    )
7621                    for k in value._fields
7622                ]
7623            )
7624        return Tuple(expressions=[convert(v, copy=copy) for v in value])
7625    if isinstance(value, list):
7626        return Array(expressions=[convert(v, copy=copy) for v in value])
7627    if isinstance(value, dict):
7628        return Map(
7629            keys=Array(expressions=[convert(k, copy=copy) for k in value]),
7630            values=Array(expressions=[convert(v, copy=copy) for v in value.values()]),
7631        )
7632    if hasattr(value, "__dict__"):
7633        return Struct(
7634            expressions=[
7635                PropertyEQ(this=to_identifier(k), expression=convert(v, copy=copy))
7636                for k, v in value.__dict__.items()
7637            ]
7638        )
7639    raise ValueError(f"Cannot convert {value}")
7640
7641
7642def replace_children(expression: Expression, fun: t.Callable, *args, **kwargs) -> None:
7643    """
7644    Replace children of an expression with the result of a lambda fun(child) -> exp.
7645    """
7646    for k, v in tuple(expression.args.items()):
7647        is_list_arg = type(v) is list
7648
7649        child_nodes = v if is_list_arg else [v]
7650        new_child_nodes = []
7651
7652        for cn in child_nodes:
7653            if isinstance(cn, Expression):
7654                for child_node in ensure_collection(fun(cn, *args, **kwargs)):
7655                    new_child_nodes.append(child_node)
7656            else:
7657                new_child_nodes.append(cn)
7658
7659        expression.set(k, new_child_nodes if is_list_arg else seq_get(new_child_nodes, 0))
7660
7661
7662def replace_tree(
7663    expression: Expression,
7664    fun: t.Callable,
7665    prune: t.Optional[t.Callable[[Expression], bool]] = None,
7666) -> Expression:
7667    """
7668    Replace an entire tree with the result of function calls on each node.
7669
7670    This will be traversed in reverse dfs, so leaves first.
7671    If new nodes are created as a result of function calls, they will also be traversed.
7672    """
7673    stack = list(expression.dfs(prune=prune))
7674
7675    while stack:
7676        node = stack.pop()
7677        new_node = fun(node)
7678
7679        if new_node is not node:
7680            node.replace(new_node)
7681
7682            if isinstance(new_node, Expression):
7683                stack.append(new_node)
7684
7685    return new_node
7686
7687
7688def column_table_names(expression: Expression, exclude: str = "") -> t.Set[str]:
7689    """
7690    Return all table names referenced through columns in an expression.
7691
7692    Example:
7693        >>> import sqlglot
7694        >>> sorted(column_table_names(sqlglot.parse_one("a.b AND c.d AND c.e")))
7695        ['a', 'c']
7696
7697    Args:
7698        expression: expression to find table names.
7699        exclude: a table name to exclude
7700
7701    Returns:
7702        A list of unique names.
7703    """
7704    return {
7705        table
7706        for table in (column.table for column in expression.find_all(Column))
7707        if table and table != exclude
7708    }
7709
7710
7711def table_name(table: Table | str, dialect: DialectType = None, identify: bool = False) -> str:
7712    """Get the full name of a table as a string.
7713
7714    Args:
7715        table: Table expression node or string.
7716        dialect: The dialect to generate the table name for.
7717        identify: Determines when an identifier should be quoted. Possible values are:
7718            False (default): Never quote, except in cases where it's mandatory by the dialect.
7719            True: Always quote.
7720
7721    Examples:
7722        >>> from sqlglot import exp, parse_one
7723        >>> table_name(parse_one("select * from a.b.c").find(exp.Table))
7724        'a.b.c'
7725
7726    Returns:
7727        The table name.
7728    """
7729
7730    table = maybe_parse(table, into=Table, dialect=dialect)
7731
7732    if not table:
7733        raise ValueError(f"Cannot parse {table}")
7734
7735    return ".".join(
7736        (
7737            part.sql(dialect=dialect, identify=True, copy=False)
7738            if identify or not SAFE_IDENTIFIER_RE.match(part.name)
7739            else part.name
7740        )
7741        for part in table.parts
7742    )
7743
7744
7745def normalize_table_name(table: str | Table, dialect: DialectType = None, copy: bool = True) -> str:
7746    """Returns a case normalized table name without quotes.
7747
7748    Args:
7749        table: the table to normalize
7750        dialect: the dialect to use for normalization rules
7751        copy: whether to copy the expression.
7752
7753    Examples:
7754        >>> normalize_table_name("`A-B`.c", dialect="bigquery")
7755        'A-B.c'
7756    """
7757    from sqlglot.optimizer.normalize_identifiers import normalize_identifiers
7758
7759    return ".".join(
7760        p.name
7761        for p in normalize_identifiers(
7762            to_table(table, dialect=dialect, copy=copy), dialect=dialect
7763        ).parts
7764    )
7765
7766
7767def replace_tables(
7768    expression: E, mapping: t.Dict[str, str], dialect: DialectType = None, copy: bool = True
7769) -> E:
7770    """Replace all tables in expression according to the mapping.
7771
7772    Args:
7773        expression: expression node to be transformed and replaced.
7774        mapping: mapping of table names.
7775        dialect: the dialect of the mapping table
7776        copy: whether to copy the expression.
7777
7778    Examples:
7779        >>> from sqlglot import exp, parse_one
7780        >>> replace_tables(parse_one("select * from a.b"), {"a.b": "c"}).sql()
7781        'SELECT * FROM c /* a.b */'
7782
7783    Returns:
7784        The mapped expression.
7785    """
7786
7787    mapping = {normalize_table_name(k, dialect=dialect): v for k, v in mapping.items()}
7788
7789    def _replace_tables(node: Expression) -> Expression:
7790        if isinstance(node, Table):
7791            original = normalize_table_name(node, dialect=dialect)
7792            new_name = mapping.get(original)
7793
7794            if new_name:
7795                table = to_table(
7796                    new_name,
7797                    **{k: v for k, v in node.args.items() if k not in TABLE_PARTS},
7798                    dialect=dialect,
7799                )
7800                table.add_comments([original])
7801                return table
7802        return node
7803
7804    return expression.transform(_replace_tables, copy=copy)  # type: ignore
7805
7806
7807def replace_placeholders(expression: Expression, *args, **kwargs) -> Expression:
7808    """Replace placeholders in an expression.
7809
7810    Args:
7811        expression: expression node to be transformed and replaced.
7812        args: positional names that will substitute unnamed placeholders in the given order.
7813        kwargs: keyword arguments that will substitute named placeholders.
7814
7815    Examples:
7816        >>> from sqlglot import exp, parse_one
7817        >>> replace_placeholders(
7818        ...     parse_one("select * from :tbl where ? = ?"),
7819        ...     exp.to_identifier("str_col"), "b", tbl=exp.to_identifier("foo")
7820        ... ).sql()
7821        "SELECT * FROM foo WHERE str_col = 'b'"
7822
7823    Returns:
7824        The mapped expression.
7825    """
7826
7827    def _replace_placeholders(node: Expression, args, **kwargs) -> Expression:
7828        if isinstance(node, Placeholder):
7829            if node.this:
7830                new_name = kwargs.get(node.this)
7831                if new_name is not None:
7832                    return convert(new_name)
7833            else:
7834                try:
7835                    return convert(next(args))
7836                except StopIteration:
7837                    pass
7838        return node
7839
7840    return expression.transform(_replace_placeholders, iter(args), **kwargs)
7841
7842
7843def expand(
7844    expression: Expression,
7845    sources: t.Dict[str, Query],
7846    dialect: DialectType = None,
7847    copy: bool = True,
7848) -> Expression:
7849    """Transforms an expression by expanding all referenced sources into subqueries.
7850
7851    Examples:
7852        >>> from sqlglot import parse_one
7853        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y")}).sql()
7854        'SELECT * FROM (SELECT * FROM y) AS z /* source: x */'
7855
7856        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y"), "y": parse_one("select * from z")}).sql()
7857        'SELECT * FROM (SELECT * FROM (SELECT * FROM z) AS y /* source: y */) AS z /* source: x */'
7858
7859    Args:
7860        expression: The expression to expand.
7861        sources: A dictionary of name to Queries.
7862        dialect: The dialect of the sources dict.
7863        copy: Whether to copy the expression during transformation. Defaults to True.
7864
7865    Returns:
7866        The transformed expression.
7867    """
7868    sources = {normalize_table_name(k, dialect=dialect): v for k, v in sources.items()}
7869
7870    def _expand(node: Expression):
7871        if isinstance(node, Table):
7872            name = normalize_table_name(node, dialect=dialect)
7873            source = sources.get(name)
7874            if source:
7875                subquery = source.subquery(node.alias or name)
7876                subquery.comments = [f"source: {name}"]
7877                return subquery.transform(_expand, copy=False)
7878        return node
7879
7880    return expression.transform(_expand, copy=copy)
7881
7882
7883def func(name: str, *args, copy: bool = True, dialect: DialectType = None, **kwargs) -> Func:
7884    """
7885    Returns a Func expression.
7886
7887    Examples:
7888        >>> func("abs", 5).sql()
7889        'ABS(5)'
7890
7891        >>> func("cast", this=5, to=DataType.build("DOUBLE")).sql()
7892        'CAST(5 AS DOUBLE)'
7893
7894    Args:
7895        name: the name of the function to build.
7896        args: the args used to instantiate the function of interest.
7897        copy: whether to copy the argument expressions.
7898        dialect: the source dialect.
7899        kwargs: the kwargs used to instantiate the function of interest.
7900
7901    Note:
7902        The arguments `args` and `kwargs` are mutually exclusive.
7903
7904    Returns:
7905        An instance of the function of interest, or an anonymous function, if `name` doesn't
7906        correspond to an existing `sqlglot.expressions.Func` class.
7907    """
7908    if args and kwargs:
7909        raise ValueError("Can't use both args and kwargs to instantiate a function.")
7910
7911    from sqlglot.dialects.dialect import Dialect
7912
7913    dialect = Dialect.get_or_raise(dialect)
7914
7915    converted: t.List[Expression] = [maybe_parse(arg, dialect=dialect, copy=copy) for arg in args]
7916    kwargs = {key: maybe_parse(value, dialect=dialect, copy=copy) for key, value in kwargs.items()}
7917
7918    constructor = dialect.parser_class.FUNCTIONS.get(name.upper())
7919    if constructor:
7920        if converted:
7921            if "dialect" in constructor.__code__.co_varnames:
7922                function = constructor(converted, dialect=dialect)
7923            else:
7924                function = constructor(converted)
7925        elif constructor.__name__ == "from_arg_list":
7926            function = constructor.__self__(**kwargs)  # type: ignore
7927        else:
7928            constructor = FUNCTION_BY_NAME.get(name.upper())
7929            if constructor:
7930                function = constructor(**kwargs)
7931            else:
7932                raise ValueError(
7933                    f"Unable to convert '{name}' into a Func. Either manually construct "
7934                    "the Func expression of interest or parse the function call."
7935                )
7936    else:
7937        kwargs = kwargs or {"expressions": converted}
7938        function = Anonymous(this=name, **kwargs)
7939
7940    for error_message in function.error_messages(converted):
7941        raise ValueError(error_message)
7942
7943    return function
7944
7945
7946def case(
7947    expression: t.Optional[ExpOrStr] = None,
7948    **opts,
7949) -> Case:
7950    """
7951    Initialize a CASE statement.
7952
7953    Example:
7954        case().when("a = 1", "foo").else_("bar")
7955
7956    Args:
7957        expression: Optionally, the input expression (not all dialects support this)
7958        **opts: Extra keyword arguments for parsing `expression`
7959    """
7960    if expression is not None:
7961        this = maybe_parse(expression, **opts)
7962    else:
7963        this = None
7964    return Case(this=this, ifs=[])
7965
7966
7967def array(
7968    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7969) -> Array:
7970    """
7971    Returns an array.
7972
7973    Examples:
7974        >>> array(1, 'x').sql()
7975        'ARRAY(1, x)'
7976
7977    Args:
7978        expressions: the expressions to add to the array.
7979        copy: whether to copy the argument expressions.
7980        dialect: the source dialect.
7981        kwargs: the kwargs used to instantiate the function of interest.
7982
7983    Returns:
7984        An array expression.
7985    """
7986    return Array(
7987        expressions=[
7988            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
7989            for expression in expressions
7990        ]
7991    )
7992
7993
7994def tuple_(
7995    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7996) -> Tuple:
7997    """
7998    Returns an tuple.
7999
8000    Examples:
8001        >>> tuple_(1, 'x').sql()
8002        '(1, x)'
8003
8004    Args:
8005        expressions: the expressions to add to the tuple.
8006        copy: whether to copy the argument expressions.
8007        dialect: the source dialect.
8008        kwargs: the kwargs used to instantiate the function of interest.
8009
8010    Returns:
8011        A tuple expression.
8012    """
8013    return Tuple(
8014        expressions=[
8015            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
8016            for expression in expressions
8017        ]
8018    )
8019
8020
8021def true() -> Boolean:
8022    """
8023    Returns a true Boolean expression.
8024    """
8025    return Boolean(this=True)
8026
8027
8028def false() -> Boolean:
8029    """
8030    Returns a false Boolean expression.
8031    """
8032    return Boolean(this=False)
8033
8034
8035def null() -> Null:
8036    """
8037    Returns a Null expression.
8038    """
8039    return Null()
8040
8041
8042NONNULL_CONSTANTS = (
8043    Literal,
8044    Boolean,
8045)
8046
8047CONSTANTS = (
8048    Literal,
8049    Boolean,
8050    Null,
8051)
SQLGLOT_META = 'sqlglot.meta'
TABLE_PARTS = ('this', 'db', 'catalog')
COLUMN_PARTS = ('this', 'table', 'db', 'catalog')
class Expression:
  66class Expression(metaclass=_Expression):
  67    """
  68    The base class for all expressions in a syntax tree. Each Expression encapsulates any necessary
  69    context, such as its child expressions, their names (arg keys), and whether a given child expression
  70    is optional or not.
  71
  72    Attributes:
  73        key: a unique key for each class in the Expression hierarchy. This is useful for hashing
  74            and representing expressions as strings.
  75        arg_types: determines the arguments (child nodes) supported by an expression. It maps
  76            arg keys to booleans that indicate whether the corresponding args are optional.
  77        parent: a reference to the parent expression (or None, in case of root expressions).
  78        arg_key: the arg key an expression is associated with, i.e. the name its parent expression
  79            uses to refer to it.
  80        index: the index of an expression if it is inside of a list argument in its parent.
  81        comments: a list of comments that are associated with a given expression. This is used in
  82            order to preserve comments when transpiling SQL code.
  83        type: the `sqlglot.expressions.DataType` type of an expression. This is inferred by the
  84            optimizer, in order to enable some transformations that require type information.
  85        meta: a dictionary that can be used to store useful metadata for a given expression.
  86
  87    Example:
  88        >>> class Foo(Expression):
  89        ...     arg_types = {"this": True, "expression": False}
  90
  91        The above definition informs us that Foo is an Expression that requires an argument called
  92        "this" and may also optionally receive an argument called "expression".
  93
  94    Args:
  95        args: a mapping used for retrieving the arguments of an expression, given their arg keys.
  96    """
  97
  98    key = "expression"
  99    arg_types = {"this": True}
 100    __slots__ = ("args", "parent", "arg_key", "index", "comments", "_type", "_meta", "_hash")
 101
 102    def __init__(self, **args: t.Any):
 103        self.args: t.Dict[str, t.Any] = args
 104        self.parent: t.Optional[Expression] = None
 105        self.arg_key: t.Optional[str] = None
 106        self.index: t.Optional[int] = None
 107        self.comments: t.Optional[t.List[str]] = None
 108        self._type: t.Optional[DataType] = None
 109        self._meta: t.Optional[t.Dict[str, t.Any]] = None
 110        self._hash: t.Optional[int] = None
 111
 112        for arg_key, value in self.args.items():
 113            self._set_parent(arg_key, value)
 114
 115    def __eq__(self, other) -> bool:
 116        return type(self) is type(other) and hash(self) == hash(other)
 117
 118    @property
 119    def hashable_args(self) -> t.Any:
 120        return frozenset(
 121            (k, tuple(_norm_arg(a) for a in v) if type(v) is list else _norm_arg(v))
 122            for k, v in self.args.items()
 123            if not (v is None or v is False or (type(v) is list and not v))
 124        )
 125
 126    def __hash__(self) -> int:
 127        if self._hash is not None:
 128            return self._hash
 129
 130        return hash((self.__class__, self.hashable_args))
 131
 132    @property
 133    def this(self) -> t.Any:
 134        """
 135        Retrieves the argument with key "this".
 136        """
 137        return self.args.get("this")
 138
 139    @property
 140    def expression(self) -> t.Any:
 141        """
 142        Retrieves the argument with key "expression".
 143        """
 144        return self.args.get("expression")
 145
 146    @property
 147    def expressions(self) -> t.List[t.Any]:
 148        """
 149        Retrieves the argument with key "expressions".
 150        """
 151        return self.args.get("expressions") or []
 152
 153    def text(self, key) -> str:
 154        """
 155        Returns a textual representation of the argument corresponding to "key". This can only be used
 156        for args that are strings or leaf Expression instances, such as identifiers and literals.
 157        """
 158        field = self.args.get(key)
 159        if isinstance(field, str):
 160            return field
 161        if isinstance(field, (Identifier, Literal, Var)):
 162            return field.this
 163        if isinstance(field, (Star, Null)):
 164            return field.name
 165        return ""
 166
 167    @property
 168    def is_string(self) -> bool:
 169        """
 170        Checks whether a Literal expression is a string.
 171        """
 172        return isinstance(self, Literal) and self.args["is_string"]
 173
 174    @property
 175    def is_number(self) -> bool:
 176        """
 177        Checks whether a Literal expression is a number.
 178        """
 179        return (isinstance(self, Literal) and not self.args["is_string"]) or (
 180            isinstance(self, Neg) and self.this.is_number
 181        )
 182
 183    def to_py(self) -> t.Any:
 184        """
 185        Returns a Python object equivalent of the SQL node.
 186        """
 187        raise ValueError(f"{self} cannot be converted to a Python object.")
 188
 189    @property
 190    def is_int(self) -> bool:
 191        """
 192        Checks whether an expression is an integer.
 193        """
 194        return self.is_number and isinstance(self.to_py(), int)
 195
 196    @property
 197    def is_star(self) -> bool:
 198        """Checks whether an expression is a star."""
 199        return isinstance(self, Star) or (isinstance(self, Column) and isinstance(self.this, Star))
 200
 201    @property
 202    def alias(self) -> str:
 203        """
 204        Returns the alias of the expression, or an empty string if it's not aliased.
 205        """
 206        if isinstance(self.args.get("alias"), TableAlias):
 207            return self.args["alias"].name
 208        return self.text("alias")
 209
 210    @property
 211    def alias_column_names(self) -> t.List[str]:
 212        table_alias = self.args.get("alias")
 213        if not table_alias:
 214            return []
 215        return [c.name for c in table_alias.args.get("columns") or []]
 216
 217    @property
 218    def name(self) -> str:
 219        return self.text("this")
 220
 221    @property
 222    def alias_or_name(self) -> str:
 223        return self.alias or self.name
 224
 225    @property
 226    def output_name(self) -> str:
 227        """
 228        Name of the output column if this expression is a selection.
 229
 230        If the Expression has no output name, an empty string is returned.
 231
 232        Example:
 233            >>> from sqlglot import parse_one
 234            >>> parse_one("SELECT a").expressions[0].output_name
 235            'a'
 236            >>> parse_one("SELECT b AS c").expressions[0].output_name
 237            'c'
 238            >>> parse_one("SELECT 1 + 2").expressions[0].output_name
 239            ''
 240        """
 241        return ""
 242
 243    @property
 244    def type(self) -> t.Optional[DataType]:
 245        return self._type
 246
 247    @type.setter
 248    def type(self, dtype: t.Optional[DataType | DataType.Type | str]) -> None:
 249        if dtype and not isinstance(dtype, DataType):
 250            dtype = DataType.build(dtype)
 251        self._type = dtype  # type: ignore
 252
 253    def is_type(self, *dtypes) -> bool:
 254        return self.type is not None and self.type.is_type(*dtypes)
 255
 256    def is_leaf(self) -> bool:
 257        return not any(isinstance(v, (Expression, list)) for v in self.args.values())
 258
 259    @property
 260    def meta(self) -> t.Dict[str, t.Any]:
 261        if self._meta is None:
 262            self._meta = {}
 263        return self._meta
 264
 265    def __deepcopy__(self, memo):
 266        root = self.__class__()
 267        stack = [(self, root)]
 268
 269        while stack:
 270            node, copy = stack.pop()
 271
 272            if node.comments is not None:
 273                copy.comments = deepcopy(node.comments)
 274            if node._type is not None:
 275                copy._type = deepcopy(node._type)
 276            if node._meta is not None:
 277                copy._meta = deepcopy(node._meta)
 278            if node._hash is not None:
 279                copy._hash = node._hash
 280
 281            for k, vs in node.args.items():
 282                if hasattr(vs, "parent"):
 283                    stack.append((vs, vs.__class__()))
 284                    copy.set(k, stack[-1][-1])
 285                elif type(vs) is list:
 286                    copy.args[k] = []
 287
 288                    for v in vs:
 289                        if hasattr(v, "parent"):
 290                            stack.append((v, v.__class__()))
 291                            copy.append(k, stack[-1][-1])
 292                        else:
 293                            copy.append(k, v)
 294                else:
 295                    copy.args[k] = vs
 296
 297        return root
 298
 299    def copy(self):
 300        """
 301        Returns a deep copy of the expression.
 302        """
 303        return deepcopy(self)
 304
 305    def add_comments(self, comments: t.Optional[t.List[str]] = None) -> None:
 306        if self.comments is None:
 307            self.comments = []
 308
 309        if comments:
 310            for comment in comments:
 311                _, *meta = comment.split(SQLGLOT_META)
 312                if meta:
 313                    for kv in "".join(meta).split(","):
 314                        k, *v = kv.split("=")
 315                        value = v[0].strip() if v else True
 316                        self.meta[k.strip()] = value
 317                self.comments.append(comment)
 318
 319    def pop_comments(self) -> t.List[str]:
 320        comments = self.comments or []
 321        self.comments = None
 322        return comments
 323
 324    def append(self, arg_key: str, value: t.Any) -> None:
 325        """
 326        Appends value to arg_key if it's a list or sets it as a new list.
 327
 328        Args:
 329            arg_key (str): name of the list expression arg
 330            value (Any): value to append to the list
 331        """
 332        if type(self.args.get(arg_key)) is not list:
 333            self.args[arg_key] = []
 334        self._set_parent(arg_key, value)
 335        values = self.args[arg_key]
 336        if hasattr(value, "parent"):
 337            value.index = len(values)
 338        values.append(value)
 339
 340    def set(
 341        self,
 342        arg_key: str,
 343        value: t.Any,
 344        index: t.Optional[int] = None,
 345        overwrite: bool = True,
 346    ) -> None:
 347        """
 348        Sets arg_key to value.
 349
 350        Args:
 351            arg_key: name of the expression arg.
 352            value: value to set the arg to.
 353            index: if the arg is a list, this specifies what position to add the value in it.
 354            overwrite: assuming an index is given, this determines whether to overwrite the
 355                list entry instead of only inserting a new value (i.e., like list.insert).
 356        """
 357        if index is not None:
 358            expressions = self.args.get(arg_key) or []
 359
 360            if seq_get(expressions, index) is None:
 361                return
 362            if value is None:
 363                expressions.pop(index)
 364                for v in expressions[index:]:
 365                    v.index = v.index - 1
 366                return
 367
 368            if isinstance(value, list):
 369                expressions.pop(index)
 370                expressions[index:index] = value
 371            elif overwrite:
 372                expressions[index] = value
 373            else:
 374                expressions.insert(index, value)
 375
 376            value = expressions
 377        elif value is None:
 378            self.args.pop(arg_key, None)
 379            return
 380
 381        self.args[arg_key] = value
 382        self._set_parent(arg_key, value, index)
 383
 384    def _set_parent(self, arg_key: str, value: t.Any, index: t.Optional[int] = None) -> None:
 385        if hasattr(value, "parent"):
 386            value.parent = self
 387            value.arg_key = arg_key
 388            value.index = index
 389        elif type(value) is list:
 390            for index, v in enumerate(value):
 391                if hasattr(v, "parent"):
 392                    v.parent = self
 393                    v.arg_key = arg_key
 394                    v.index = index
 395
 396    @property
 397    def depth(self) -> int:
 398        """
 399        Returns the depth of this tree.
 400        """
 401        if self.parent:
 402            return self.parent.depth + 1
 403        return 0
 404
 405    def iter_expressions(self, reverse: bool = False) -> t.Iterator[Expression]:
 406        """Yields the key and expression for all arguments, exploding list args."""
 407        # remove tuple when python 3.7 is deprecated
 408        for vs in reversed(tuple(self.args.values())) if reverse else self.args.values():
 409            if type(vs) is list:
 410                for v in reversed(vs) if reverse else vs:
 411                    if hasattr(v, "parent"):
 412                        yield v
 413            else:
 414                if hasattr(vs, "parent"):
 415                    yield vs
 416
 417    def find(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Optional[E]:
 418        """
 419        Returns the first node in this tree which matches at least one of
 420        the specified types.
 421
 422        Args:
 423            expression_types: the expression type(s) to match.
 424            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 425
 426        Returns:
 427            The node which matches the criteria or None if no such node was found.
 428        """
 429        return next(self.find_all(*expression_types, bfs=bfs), None)
 430
 431    def find_all(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Iterator[E]:
 432        """
 433        Returns a generator object which visits all nodes in this tree and only
 434        yields those that match at least one of the specified expression types.
 435
 436        Args:
 437            expression_types: the expression type(s) to match.
 438            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
 439
 440        Returns:
 441            The generator object.
 442        """
 443        for expression in self.walk(bfs=bfs):
 444            if isinstance(expression, expression_types):
 445                yield expression
 446
 447    def find_ancestor(self, *expression_types: t.Type[E]) -> t.Optional[E]:
 448        """
 449        Returns a nearest parent matching expression_types.
 450
 451        Args:
 452            expression_types: the expression type(s) to match.
 453
 454        Returns:
 455            The parent node.
 456        """
 457        ancestor = self.parent
 458        while ancestor and not isinstance(ancestor, expression_types):
 459            ancestor = ancestor.parent
 460        return ancestor  # type: ignore
 461
 462    @property
 463    def parent_select(self) -> t.Optional[Select]:
 464        """
 465        Returns the parent select statement.
 466        """
 467        return self.find_ancestor(Select)
 468
 469    @property
 470    def same_parent(self) -> bool:
 471        """Returns if the parent is the same class as itself."""
 472        return type(self.parent) is self.__class__
 473
 474    def root(self) -> Expression:
 475        """
 476        Returns the root expression of this tree.
 477        """
 478        expression = self
 479        while expression.parent:
 480            expression = expression.parent
 481        return expression
 482
 483    def walk(
 484        self, bfs: bool = True, prune: t.Optional[t.Callable[[Expression], bool]] = None
 485    ) -> t.Iterator[Expression]:
 486        """
 487        Returns a generator object which visits all nodes in this tree.
 488
 489        Args:
 490            bfs: if set to True the BFS traversal order will be applied,
 491                otherwise the DFS traversal will be used instead.
 492            prune: callable that returns True if the generator should stop traversing
 493                this branch of the tree.
 494
 495        Returns:
 496            the generator object.
 497        """
 498        if bfs:
 499            yield from self.bfs(prune=prune)
 500        else:
 501            yield from self.dfs(prune=prune)
 502
 503    def dfs(
 504        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 505    ) -> t.Iterator[Expression]:
 506        """
 507        Returns a generator object which visits all nodes in this tree in
 508        the DFS (Depth-first) order.
 509
 510        Returns:
 511            The generator object.
 512        """
 513        stack = [self]
 514
 515        while stack:
 516            node = stack.pop()
 517
 518            yield node
 519
 520            if prune and prune(node):
 521                continue
 522
 523            for v in node.iter_expressions(reverse=True):
 524                stack.append(v)
 525
 526    def bfs(
 527        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
 528    ) -> t.Iterator[Expression]:
 529        """
 530        Returns a generator object which visits all nodes in this tree in
 531        the BFS (Breadth-first) order.
 532
 533        Returns:
 534            The generator object.
 535        """
 536        queue = deque([self])
 537
 538        while queue:
 539            node = queue.popleft()
 540
 541            yield node
 542
 543            if prune and prune(node):
 544                continue
 545
 546            for v in node.iter_expressions():
 547                queue.append(v)
 548
 549    def unnest(self):
 550        """
 551        Returns the first non parenthesis child or self.
 552        """
 553        expression = self
 554        while type(expression) is Paren:
 555            expression = expression.this
 556        return expression
 557
 558    def unalias(self):
 559        """
 560        Returns the inner expression if this is an Alias.
 561        """
 562        if isinstance(self, Alias):
 563            return self.this
 564        return self
 565
 566    def unnest_operands(self):
 567        """
 568        Returns unnested operands as a tuple.
 569        """
 570        return tuple(arg.unnest() for arg in self.iter_expressions())
 571
 572    def flatten(self, unnest=True):
 573        """
 574        Returns a generator which yields child nodes whose parents are the same class.
 575
 576        A AND B AND C -> [A, B, C]
 577        """
 578        for node in self.dfs(prune=lambda n: n.parent and type(n) is not self.__class__):
 579            if type(node) is not self.__class__:
 580                yield node.unnest() if unnest and not isinstance(node, Subquery) else node
 581
 582    def __str__(self) -> str:
 583        return self.sql()
 584
 585    def __repr__(self) -> str:
 586        return _to_s(self)
 587
 588    def to_s(self) -> str:
 589        """
 590        Same as __repr__, but includes additional information which can be useful
 591        for debugging, like empty or missing args and the AST nodes' object IDs.
 592        """
 593        return _to_s(self, verbose=True)
 594
 595    def sql(self, dialect: DialectType = None, **opts) -> str:
 596        """
 597        Returns SQL string representation of this tree.
 598
 599        Args:
 600            dialect: the dialect of the output SQL string (eg. "spark", "hive", "presto", "mysql").
 601            opts: other `sqlglot.generator.Generator` options.
 602
 603        Returns:
 604            The SQL string.
 605        """
 606        from sqlglot.dialects import Dialect
 607
 608        return Dialect.get_or_raise(dialect).generate(self, **opts)
 609
 610    def transform(self, fun: t.Callable, *args: t.Any, copy: bool = True, **kwargs) -> Expression:
 611        """
 612        Visits all tree nodes (excluding already transformed ones)
 613        and applies the given transformation function to each node.
 614
 615        Args:
 616            fun: a function which takes a node as an argument and returns a
 617                new transformed node or the same node without modifications. If the function
 618                returns None, then the corresponding node will be removed from the syntax tree.
 619            copy: if set to True a new tree instance is constructed, otherwise the tree is
 620                modified in place.
 621
 622        Returns:
 623            The transformed tree.
 624        """
 625        root = None
 626        new_node = None
 627
 628        for node in (self.copy() if copy else self).dfs(prune=lambda n: n is not new_node):
 629            parent, arg_key, index = node.parent, node.arg_key, node.index
 630            new_node = fun(node, *args, **kwargs)
 631
 632            if not root:
 633                root = new_node
 634            elif new_node is not node:
 635                parent.set(arg_key, new_node, index)
 636
 637        assert root
 638        return root.assert_is(Expression)
 639
 640    @t.overload
 641    def replace(self, expression: E) -> E: ...
 642
 643    @t.overload
 644    def replace(self, expression: None) -> None: ...
 645
 646    def replace(self, expression):
 647        """
 648        Swap out this expression with a new expression.
 649
 650        For example::
 651
 652            >>> tree = Select().select("x").from_("tbl")
 653            >>> tree.find(Column).replace(column("y"))
 654            Column(
 655              this=Identifier(this=y, quoted=False))
 656            >>> tree.sql()
 657            'SELECT y FROM tbl'
 658
 659        Args:
 660            expression: new node
 661
 662        Returns:
 663            The new expression or expressions.
 664        """
 665        parent = self.parent
 666
 667        if not parent or parent is expression:
 668            return expression
 669
 670        key = self.arg_key
 671        value = parent.args.get(key)
 672
 673        if type(expression) is list and isinstance(value, Expression):
 674            # We are trying to replace an Expression with a list, so it's assumed that
 675            # the intention was to really replace the parent of this expression.
 676            value.parent.replace(expression)
 677        else:
 678            parent.set(key, expression, self.index)
 679
 680        if expression is not self:
 681            self.parent = None
 682            self.arg_key = None
 683            self.index = None
 684
 685        return expression
 686
 687    def pop(self: E) -> E:
 688        """
 689        Remove this expression from its AST.
 690
 691        Returns:
 692            The popped expression.
 693        """
 694        self.replace(None)
 695        return self
 696
 697    def assert_is(self, type_: t.Type[E]) -> E:
 698        """
 699        Assert that this `Expression` is an instance of `type_`.
 700
 701        If it is NOT an instance of `type_`, this raises an assertion error.
 702        Otherwise, this returns this expression.
 703
 704        Examples:
 705            This is useful for type security in chained expressions:
 706
 707            >>> import sqlglot
 708            >>> sqlglot.parse_one("SELECT x from y").assert_is(Select).select("z").sql()
 709            'SELECT x, z FROM y'
 710        """
 711        if not isinstance(self, type_):
 712            raise AssertionError(f"{self} is not {type_}.")
 713        return self
 714
 715    def error_messages(self, args: t.Optional[t.Sequence] = None) -> t.List[str]:
 716        """
 717        Checks if this expression is valid (e.g. all mandatory args are set).
 718
 719        Args:
 720            args: a sequence of values that were used to instantiate a Func expression. This is used
 721                to check that the provided arguments don't exceed the function argument limit.
 722
 723        Returns:
 724            A list of error messages for all possible errors that were found.
 725        """
 726        errors: t.List[str] = []
 727
 728        for k in self.args:
 729            if k not in self.arg_types:
 730                errors.append(f"Unexpected keyword: '{k}' for {self.__class__}")
 731        for k, mandatory in self.arg_types.items():
 732            v = self.args.get(k)
 733            if mandatory and (v is None or (isinstance(v, list) and not v)):
 734                errors.append(f"Required keyword: '{k}' missing for {self.__class__}")
 735
 736        if (
 737            args
 738            and isinstance(self, Func)
 739            and len(args) > len(self.arg_types)
 740            and not self.is_var_len_args
 741        ):
 742            errors.append(
 743                f"The number of provided arguments ({len(args)}) is greater than "
 744                f"the maximum number of supported arguments ({len(self.arg_types)})"
 745            )
 746
 747        return errors
 748
 749    def dump(self):
 750        """
 751        Dump this Expression to a JSON-serializable dict.
 752        """
 753        from sqlglot.serde import dump
 754
 755        return dump(self)
 756
 757    @classmethod
 758    def load(cls, obj):
 759        """
 760        Load a dict (as returned by `Expression.dump`) into an Expression instance.
 761        """
 762        from sqlglot.serde import load
 763
 764        return load(obj)
 765
 766    def and_(
 767        self,
 768        *expressions: t.Optional[ExpOrStr],
 769        dialect: DialectType = None,
 770        copy: bool = True,
 771        **opts,
 772    ) -> Condition:
 773        """
 774        AND this condition with one or multiple expressions.
 775
 776        Example:
 777            >>> condition("x=1").and_("y=1").sql()
 778            'x = 1 AND y = 1'
 779
 780        Args:
 781            *expressions: the SQL code strings to parse.
 782                If an `Expression` instance is passed, it will be used as-is.
 783            dialect: the dialect used to parse the input expression.
 784            copy: whether to copy the involved expressions (only applies to Expressions).
 785            opts: other options to use to parse the input expressions.
 786
 787        Returns:
 788            The new And condition.
 789        """
 790        return and_(self, *expressions, dialect=dialect, copy=copy, **opts)
 791
 792    def or_(
 793        self,
 794        *expressions: t.Optional[ExpOrStr],
 795        dialect: DialectType = None,
 796        copy: bool = True,
 797        **opts,
 798    ) -> Condition:
 799        """
 800        OR this condition with one or multiple expressions.
 801
 802        Example:
 803            >>> condition("x=1").or_("y=1").sql()
 804            'x = 1 OR y = 1'
 805
 806        Args:
 807            *expressions: the SQL code strings to parse.
 808                If an `Expression` instance is passed, it will be used as-is.
 809            dialect: the dialect used to parse the input expression.
 810            copy: whether to copy the involved expressions (only applies to Expressions).
 811            opts: other options to use to parse the input expressions.
 812
 813        Returns:
 814            The new Or condition.
 815        """
 816        return or_(self, *expressions, dialect=dialect, copy=copy, **opts)
 817
 818    def not_(self, copy: bool = True):
 819        """
 820        Wrap this condition with NOT.
 821
 822        Example:
 823            >>> condition("x=1").not_().sql()
 824            'NOT x = 1'
 825
 826        Args:
 827            copy: whether to copy this object.
 828
 829        Returns:
 830            The new Not instance.
 831        """
 832        return not_(self, copy=copy)
 833
 834    def as_(
 835        self,
 836        alias: str | Identifier,
 837        quoted: t.Optional[bool] = None,
 838        dialect: DialectType = None,
 839        copy: bool = True,
 840        **opts,
 841    ) -> Alias:
 842        return alias_(self, alias, quoted=quoted, dialect=dialect, copy=copy, **opts)
 843
 844    def _binop(self, klass: t.Type[E], other: t.Any, reverse: bool = False) -> E:
 845        this = self.copy()
 846        other = convert(other, copy=True)
 847        if not isinstance(this, klass) and not isinstance(other, klass):
 848            this = _wrap(this, Binary)
 849            other = _wrap(other, Binary)
 850        if reverse:
 851            return klass(this=other, expression=this)
 852        return klass(this=this, expression=other)
 853
 854    def __getitem__(self, other: ExpOrStr | t.Tuple[ExpOrStr]) -> Bracket:
 855        return Bracket(
 856            this=self.copy(), expressions=[convert(e, copy=True) for e in ensure_list(other)]
 857        )
 858
 859    def __iter__(self) -> t.Iterator:
 860        if "expressions" in self.arg_types:
 861            return iter(self.args.get("expressions") or [])
 862        # We define this because __getitem__ converts Expression into an iterable, which is
 863        # problematic because one can hit infinite loops if they do "for x in some_expr: ..."
 864        # See: https://peps.python.org/pep-0234/
 865        raise TypeError(f"'{self.__class__.__name__}' object is not iterable")
 866
 867    def isin(
 868        self,
 869        *expressions: t.Any,
 870        query: t.Optional[ExpOrStr] = None,
 871        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
 872        copy: bool = True,
 873        **opts,
 874    ) -> In:
 875        subquery = maybe_parse(query, copy=copy, **opts) if query else None
 876        if subquery and not isinstance(subquery, Subquery):
 877            subquery = subquery.subquery(copy=False)
 878
 879        return In(
 880            this=maybe_copy(self, copy),
 881            expressions=[convert(e, copy=copy) for e in expressions],
 882            query=subquery,
 883            unnest=(
 884                Unnest(
 885                    expressions=[
 886                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
 887                        for e in ensure_list(unnest)
 888                    ]
 889                )
 890                if unnest
 891                else None
 892            ),
 893        )
 894
 895    def between(self, low: t.Any, high: t.Any, copy: bool = True, **opts) -> Between:
 896        return Between(
 897            this=maybe_copy(self, copy),
 898            low=convert(low, copy=copy, **opts),
 899            high=convert(high, copy=copy, **opts),
 900        )
 901
 902    def is_(self, other: ExpOrStr) -> Is:
 903        return self._binop(Is, other)
 904
 905    def like(self, other: ExpOrStr) -> Like:
 906        return self._binop(Like, other)
 907
 908    def ilike(self, other: ExpOrStr) -> ILike:
 909        return self._binop(ILike, other)
 910
 911    def eq(self, other: t.Any) -> EQ:
 912        return self._binop(EQ, other)
 913
 914    def neq(self, other: t.Any) -> NEQ:
 915        return self._binop(NEQ, other)
 916
 917    def rlike(self, other: ExpOrStr) -> RegexpLike:
 918        return self._binop(RegexpLike, other)
 919
 920    def div(self, other: ExpOrStr, typed: bool = False, safe: bool = False) -> Div:
 921        div = self._binop(Div, other)
 922        div.args["typed"] = typed
 923        div.args["safe"] = safe
 924        return div
 925
 926    def asc(self, nulls_first: bool = True) -> Ordered:
 927        return Ordered(this=self.copy(), nulls_first=nulls_first)
 928
 929    def desc(self, nulls_first: bool = False) -> Ordered:
 930        return Ordered(this=self.copy(), desc=True, nulls_first=nulls_first)
 931
 932    def __lt__(self, other: t.Any) -> LT:
 933        return self._binop(LT, other)
 934
 935    def __le__(self, other: t.Any) -> LTE:
 936        return self._binop(LTE, other)
 937
 938    def __gt__(self, other: t.Any) -> GT:
 939        return self._binop(GT, other)
 940
 941    def __ge__(self, other: t.Any) -> GTE:
 942        return self._binop(GTE, other)
 943
 944    def __add__(self, other: t.Any) -> Add:
 945        return self._binop(Add, other)
 946
 947    def __radd__(self, other: t.Any) -> Add:
 948        return self._binop(Add, other, reverse=True)
 949
 950    def __sub__(self, other: t.Any) -> Sub:
 951        return self._binop(Sub, other)
 952
 953    def __rsub__(self, other: t.Any) -> Sub:
 954        return self._binop(Sub, other, reverse=True)
 955
 956    def __mul__(self, other: t.Any) -> Mul:
 957        return self._binop(Mul, other)
 958
 959    def __rmul__(self, other: t.Any) -> Mul:
 960        return self._binop(Mul, other, reverse=True)
 961
 962    def __truediv__(self, other: t.Any) -> Div:
 963        return self._binop(Div, other)
 964
 965    def __rtruediv__(self, other: t.Any) -> Div:
 966        return self._binop(Div, other, reverse=True)
 967
 968    def __floordiv__(self, other: t.Any) -> IntDiv:
 969        return self._binop(IntDiv, other)
 970
 971    def __rfloordiv__(self, other: t.Any) -> IntDiv:
 972        return self._binop(IntDiv, other, reverse=True)
 973
 974    def __mod__(self, other: t.Any) -> Mod:
 975        return self._binop(Mod, other)
 976
 977    def __rmod__(self, other: t.Any) -> Mod:
 978        return self._binop(Mod, other, reverse=True)
 979
 980    def __pow__(self, other: t.Any) -> Pow:
 981        return self._binop(Pow, other)
 982
 983    def __rpow__(self, other: t.Any) -> Pow:
 984        return self._binop(Pow, other, reverse=True)
 985
 986    def __and__(self, other: t.Any) -> And:
 987        return self._binop(And, other)
 988
 989    def __rand__(self, other: t.Any) -> And:
 990        return self._binop(And, other, reverse=True)
 991
 992    def __or__(self, other: t.Any) -> Or:
 993        return self._binop(Or, other)
 994
 995    def __ror__(self, other: t.Any) -> Or:
 996        return self._binop(Or, other, reverse=True)
 997
 998    def __neg__(self) -> Neg:
 999        return Neg(this=_wrap(self.copy(), Binary))
1000
1001    def __invert__(self) -> Not:
1002        return not_(self.copy())

The base class for all expressions in a syntax tree. Each Expression encapsulates any necessary context, such as its child expressions, their names (arg keys), and whether a given child expression is optional or not.

Attributes:
  • key: a unique key for each class in the Expression hierarchy. This is useful for hashing and representing expressions as strings.
  • arg_types: determines the arguments (child nodes) supported by an expression. It maps arg keys to booleans that indicate whether the corresponding args are optional.
  • parent: a reference to the parent expression (or None, in case of root expressions).
  • arg_key: the arg key an expression is associated with, i.e. the name its parent expression uses to refer to it.
  • index: the index of an expression if it is inside of a list argument in its parent.
  • comments: a list of comments that are associated with a given expression. This is used in order to preserve comments when transpiling SQL code.
  • type: the sqlglot.expressions.DataType type of an expression. This is inferred by the optimizer, in order to enable some transformations that require type information.
  • meta: a dictionary that can be used to store useful metadata for a given expression.
Example:
>>> class Foo(Expression):
...     arg_types = {"this": True, "expression": False}

The above definition informs us that Foo is an Expression that requires an argument called "this" and may also optionally receive an argument called "expression".

Arguments:
  • args: a mapping used for retrieving the arguments of an expression, given their arg keys.
Expression(**args: Any)
102    def __init__(self, **args: t.Any):
103        self.args: t.Dict[str, t.Any] = args
104        self.parent: t.Optional[Expression] = None
105        self.arg_key: t.Optional[str] = None
106        self.index: t.Optional[int] = None
107        self.comments: t.Optional[t.List[str]] = None
108        self._type: t.Optional[DataType] = None
109        self._meta: t.Optional[t.Dict[str, t.Any]] = None
110        self._hash: t.Optional[int] = None
111
112        for arg_key, value in self.args.items():
113            self._set_parent(arg_key, value)
key = 'expression'
arg_types = {'this': True}
args: Dict[str, Any]
parent: Optional[Expression]
arg_key: Optional[str]
index: Optional[int]
comments: Optional[List[str]]
hashable_args: Any
118    @property
119    def hashable_args(self) -> t.Any:
120        return frozenset(
121            (k, tuple(_norm_arg(a) for a in v) if type(v) is list else _norm_arg(v))
122            for k, v in self.args.items()
123            if not (v is None or v is False or (type(v) is list and not v))
124        )
this: Any
132    @property
133    def this(self) -> t.Any:
134        """
135        Retrieves the argument with key "this".
136        """
137        return self.args.get("this")

Retrieves the argument with key "this".

expression: Any
139    @property
140    def expression(self) -> t.Any:
141        """
142        Retrieves the argument with key "expression".
143        """
144        return self.args.get("expression")

Retrieves the argument with key "expression".

expressions: List[Any]
146    @property
147    def expressions(self) -> t.List[t.Any]:
148        """
149        Retrieves the argument with key "expressions".
150        """
151        return self.args.get("expressions") or []

Retrieves the argument with key "expressions".

def text(self, key) -> str:
153    def text(self, key) -> str:
154        """
155        Returns a textual representation of the argument corresponding to "key". This can only be used
156        for args that are strings or leaf Expression instances, such as identifiers and literals.
157        """
158        field = self.args.get(key)
159        if isinstance(field, str):
160            return field
161        if isinstance(field, (Identifier, Literal, Var)):
162            return field.this
163        if isinstance(field, (Star, Null)):
164            return field.name
165        return ""

Returns a textual representation of the argument corresponding to "key". This can only be used for args that are strings or leaf Expression instances, such as identifiers and literals.

is_string: bool
167    @property
168    def is_string(self) -> bool:
169        """
170        Checks whether a Literal expression is a string.
171        """
172        return isinstance(self, Literal) and self.args["is_string"]

Checks whether a Literal expression is a string.

is_number: bool
174    @property
175    def is_number(self) -> bool:
176        """
177        Checks whether a Literal expression is a number.
178        """
179        return (isinstance(self, Literal) and not self.args["is_string"]) or (
180            isinstance(self, Neg) and self.this.is_number
181        )

Checks whether a Literal expression is a number.

def to_py(self) -> Any:
183    def to_py(self) -> t.Any:
184        """
185        Returns a Python object equivalent of the SQL node.
186        """
187        raise ValueError(f"{self} cannot be converted to a Python object.")

Returns a Python object equivalent of the SQL node.

is_int: bool
189    @property
190    def is_int(self) -> bool:
191        """
192        Checks whether an expression is an integer.
193        """
194        return self.is_number and isinstance(self.to_py(), int)

Checks whether an expression is an integer.

is_star: bool
196    @property
197    def is_star(self) -> bool:
198        """Checks whether an expression is a star."""
199        return isinstance(self, Star) or (isinstance(self, Column) and isinstance(self.this, Star))

Checks whether an expression is a star.

alias: str
201    @property
202    def alias(self) -> str:
203        """
204        Returns the alias of the expression, or an empty string if it's not aliased.
205        """
206        if isinstance(self.args.get("alias"), TableAlias):
207            return self.args["alias"].name
208        return self.text("alias")

Returns the alias of the expression, or an empty string if it's not aliased.

alias_column_names: List[str]
210    @property
211    def alias_column_names(self) -> t.List[str]:
212        table_alias = self.args.get("alias")
213        if not table_alias:
214            return []
215        return [c.name for c in table_alias.args.get("columns") or []]
name: str
217    @property
218    def name(self) -> str:
219        return self.text("this")
alias_or_name: str
221    @property
222    def alias_or_name(self) -> str:
223        return self.alias or self.name
output_name: str
225    @property
226    def output_name(self) -> str:
227        """
228        Name of the output column if this expression is a selection.
229
230        If the Expression has no output name, an empty string is returned.
231
232        Example:
233            >>> from sqlglot import parse_one
234            >>> parse_one("SELECT a").expressions[0].output_name
235            'a'
236            >>> parse_one("SELECT b AS c").expressions[0].output_name
237            'c'
238            >>> parse_one("SELECT 1 + 2").expressions[0].output_name
239            ''
240        """
241        return ""

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
type: Optional[DataType]
243    @property
244    def type(self) -> t.Optional[DataType]:
245        return self._type
def is_type(self, *dtypes) -> bool:
253    def is_type(self, *dtypes) -> bool:
254        return self.type is not None and self.type.is_type(*dtypes)
def is_leaf(self) -> bool:
256    def is_leaf(self) -> bool:
257        return not any(isinstance(v, (Expression, list)) for v in self.args.values())
meta: Dict[str, Any]
259    @property
260    def meta(self) -> t.Dict[str, t.Any]:
261        if self._meta is None:
262            self._meta = {}
263        return self._meta
def copy(self):
299    def copy(self):
300        """
301        Returns a deep copy of the expression.
302        """
303        return deepcopy(self)

Returns a deep copy of the expression.

def add_comments(self, comments: Optional[List[str]] = None) -> None:
305    def add_comments(self, comments: t.Optional[t.List[str]] = None) -> None:
306        if self.comments is None:
307            self.comments = []
308
309        if comments:
310            for comment in comments:
311                _, *meta = comment.split(SQLGLOT_META)
312                if meta:
313                    for kv in "".join(meta).split(","):
314                        k, *v = kv.split("=")
315                        value = v[0].strip() if v else True
316                        self.meta[k.strip()] = value
317                self.comments.append(comment)
def pop_comments(self) -> List[str]:
319    def pop_comments(self) -> t.List[str]:
320        comments = self.comments or []
321        self.comments = None
322        return comments
def append(self, arg_key: str, value: Any) -> None:
324    def append(self, arg_key: str, value: t.Any) -> None:
325        """
326        Appends value to arg_key if it's a list or sets it as a new list.
327
328        Args:
329            arg_key (str): name of the list expression arg
330            value (Any): value to append to the list
331        """
332        if type(self.args.get(arg_key)) is not list:
333            self.args[arg_key] = []
334        self._set_parent(arg_key, value)
335        values = self.args[arg_key]
336        if hasattr(value, "parent"):
337            value.index = len(values)
338        values.append(value)

Appends value to arg_key if it's a list or sets it as a new list.

Arguments:
  • arg_key (str): name of the list expression arg
  • value (Any): value to append to the list
def set( self, arg_key: str, value: Any, index: Optional[int] = None, overwrite: bool = True) -> None:
340    def set(
341        self,
342        arg_key: str,
343        value: t.Any,
344        index: t.Optional[int] = None,
345        overwrite: bool = True,
346    ) -> None:
347        """
348        Sets arg_key to value.
349
350        Args:
351            arg_key: name of the expression arg.
352            value: value to set the arg to.
353            index: if the arg is a list, this specifies what position to add the value in it.
354            overwrite: assuming an index is given, this determines whether to overwrite the
355                list entry instead of only inserting a new value (i.e., like list.insert).
356        """
357        if index is not None:
358            expressions = self.args.get(arg_key) or []
359
360            if seq_get(expressions, index) is None:
361                return
362            if value is None:
363                expressions.pop(index)
364                for v in expressions[index:]:
365                    v.index = v.index - 1
366                return
367
368            if isinstance(value, list):
369                expressions.pop(index)
370                expressions[index:index] = value
371            elif overwrite:
372                expressions[index] = value
373            else:
374                expressions.insert(index, value)
375
376            value = expressions
377        elif value is None:
378            self.args.pop(arg_key, None)
379            return
380
381        self.args[arg_key] = value
382        self._set_parent(arg_key, value, index)

Sets arg_key to value.

Arguments:
  • arg_key: name of the expression arg.
  • value: value to set the arg to.
  • index: if the arg is a list, this specifies what position to add the value in it.
  • overwrite: assuming an index is given, this determines whether to overwrite the list entry instead of only inserting a new value (i.e., like list.insert).
depth: int
396    @property
397    def depth(self) -> int:
398        """
399        Returns the depth of this tree.
400        """
401        if self.parent:
402            return self.parent.depth + 1
403        return 0

Returns the depth of this tree.

def iter_expressions(self, reverse: bool = False) -> Iterator[Expression]:
405    def iter_expressions(self, reverse: bool = False) -> t.Iterator[Expression]:
406        """Yields the key and expression for all arguments, exploding list args."""
407        # remove tuple when python 3.7 is deprecated
408        for vs in reversed(tuple(self.args.values())) if reverse else self.args.values():
409            if type(vs) is list:
410                for v in reversed(vs) if reverse else vs:
411                    if hasattr(v, "parent"):
412                        yield v
413            else:
414                if hasattr(vs, "parent"):
415                    yield vs

Yields the key and expression for all arguments, exploding list args.

def find(self, *expression_types: Type[~E], bfs: bool = True) -> Optional[~E]:
417    def find(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Optional[E]:
418        """
419        Returns the first node in this tree which matches at least one of
420        the specified types.
421
422        Args:
423            expression_types: the expression type(s) to match.
424            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
425
426        Returns:
427            The node which matches the criteria or None if no such node was found.
428        """
429        return next(self.find_all(*expression_types, bfs=bfs), None)

Returns the first node in this tree which matches at least one of the specified types.

Arguments:
  • expression_types: the expression type(s) to match.
  • bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
Returns:

The node which matches the criteria or None if no such node was found.

def find_all(self, *expression_types: Type[~E], bfs: bool = True) -> Iterator[~E]:
431    def find_all(self, *expression_types: t.Type[E], bfs: bool = True) -> t.Iterator[E]:
432        """
433        Returns a generator object which visits all nodes in this tree and only
434        yields those that match at least one of the specified expression types.
435
436        Args:
437            expression_types: the expression type(s) to match.
438            bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
439
440        Returns:
441            The generator object.
442        """
443        for expression in self.walk(bfs=bfs):
444            if isinstance(expression, expression_types):
445                yield expression

Returns a generator object which visits all nodes in this tree and only yields those that match at least one of the specified expression types.

Arguments:
  • expression_types: the expression type(s) to match.
  • bfs: whether to search the AST using the BFS algorithm (DFS is used if false).
Returns:

The generator object.

def find_ancestor(self, *expression_types: Type[~E]) -> Optional[~E]:
447    def find_ancestor(self, *expression_types: t.Type[E]) -> t.Optional[E]:
448        """
449        Returns a nearest parent matching expression_types.
450
451        Args:
452            expression_types: the expression type(s) to match.
453
454        Returns:
455            The parent node.
456        """
457        ancestor = self.parent
458        while ancestor and not isinstance(ancestor, expression_types):
459            ancestor = ancestor.parent
460        return ancestor  # type: ignore

Returns a nearest parent matching expression_types.

Arguments:
  • expression_types: the expression type(s) to match.
Returns:

The parent node.

parent_select: Optional[Select]
462    @property
463    def parent_select(self) -> t.Optional[Select]:
464        """
465        Returns the parent select statement.
466        """
467        return self.find_ancestor(Select)

Returns the parent select statement.

same_parent: bool
469    @property
470    def same_parent(self) -> bool:
471        """Returns if the parent is the same class as itself."""
472        return type(self.parent) is self.__class__

Returns if the parent is the same class as itself.

def root(self) -> Expression:
474    def root(self) -> Expression:
475        """
476        Returns the root expression of this tree.
477        """
478        expression = self
479        while expression.parent:
480            expression = expression.parent
481        return expression

Returns the root expression of this tree.

def walk( self, bfs: bool = True, prune: Optional[Callable[[Expression], bool]] = None) -> Iterator[Expression]:
483    def walk(
484        self, bfs: bool = True, prune: t.Optional[t.Callable[[Expression], bool]] = None
485    ) -> t.Iterator[Expression]:
486        """
487        Returns a generator object which visits all nodes in this tree.
488
489        Args:
490            bfs: if set to True the BFS traversal order will be applied,
491                otherwise the DFS traversal will be used instead.
492            prune: callable that returns True if the generator should stop traversing
493                this branch of the tree.
494
495        Returns:
496            the generator object.
497        """
498        if bfs:
499            yield from self.bfs(prune=prune)
500        else:
501            yield from self.dfs(prune=prune)

Returns a generator object which visits all nodes in this tree.

Arguments:
  • bfs: if set to True the BFS traversal order will be applied, otherwise the DFS traversal will be used instead.
  • prune: callable that returns True if the generator should stop traversing this branch of the tree.
Returns:

the generator object.

def dfs( self, prune: Optional[Callable[[Expression], bool]] = None) -> Iterator[Expression]:
503    def dfs(
504        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
505    ) -> t.Iterator[Expression]:
506        """
507        Returns a generator object which visits all nodes in this tree in
508        the DFS (Depth-first) order.
509
510        Returns:
511            The generator object.
512        """
513        stack = [self]
514
515        while stack:
516            node = stack.pop()
517
518            yield node
519
520            if prune and prune(node):
521                continue
522
523            for v in node.iter_expressions(reverse=True):
524                stack.append(v)

Returns a generator object which visits all nodes in this tree in the DFS (Depth-first) order.

Returns:

The generator object.

def bfs( self, prune: Optional[Callable[[Expression], bool]] = None) -> Iterator[Expression]:
526    def bfs(
527        self, prune: t.Optional[t.Callable[[Expression], bool]] = None
528    ) -> t.Iterator[Expression]:
529        """
530        Returns a generator object which visits all nodes in this tree in
531        the BFS (Breadth-first) order.
532
533        Returns:
534            The generator object.
535        """
536        queue = deque([self])
537
538        while queue:
539            node = queue.popleft()
540
541            yield node
542
543            if prune and prune(node):
544                continue
545
546            for v in node.iter_expressions():
547                queue.append(v)

Returns a generator object which visits all nodes in this tree in the BFS (Breadth-first) order.

Returns:

The generator object.

def unnest(self):
549    def unnest(self):
550        """
551        Returns the first non parenthesis child or self.
552        """
553        expression = self
554        while type(expression) is Paren:
555            expression = expression.this
556        return expression

Returns the first non parenthesis child or self.

def unalias(self):
558    def unalias(self):
559        """
560        Returns the inner expression if this is an Alias.
561        """
562        if isinstance(self, Alias):
563            return self.this
564        return self

Returns the inner expression if this is an Alias.

def unnest_operands(self):
566    def unnest_operands(self):
567        """
568        Returns unnested operands as a tuple.
569        """
570        return tuple(arg.unnest() for arg in self.iter_expressions())

Returns unnested operands as a tuple.

def flatten(self, unnest=True):
572    def flatten(self, unnest=True):
573        """
574        Returns a generator which yields child nodes whose parents are the same class.
575
576        A AND B AND C -> [A, B, C]
577        """
578        for node in self.dfs(prune=lambda n: n.parent and type(n) is not self.__class__):
579            if type(node) is not self.__class__:
580                yield node.unnest() if unnest and not isinstance(node, Subquery) else node

Returns a generator which yields child nodes whose parents are the same class.

A AND B AND C -> [A, B, C]

def to_s(self) -> str:
588    def to_s(self) -> str:
589        """
590        Same as __repr__, but includes additional information which can be useful
591        for debugging, like empty or missing args and the AST nodes' object IDs.
592        """
593        return _to_s(self, verbose=True)

Same as __repr__, but includes additional information which can be useful for debugging, like empty or missing args and the AST nodes' object IDs.

def sql( self, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> str:
595    def sql(self, dialect: DialectType = None, **opts) -> str:
596        """
597        Returns SQL string representation of this tree.
598
599        Args:
600            dialect: the dialect of the output SQL string (eg. "spark", "hive", "presto", "mysql").
601            opts: other `sqlglot.generator.Generator` options.
602
603        Returns:
604            The SQL string.
605        """
606        from sqlglot.dialects import Dialect
607
608        return Dialect.get_or_raise(dialect).generate(self, **opts)

Returns SQL string representation of this tree.

Arguments:
  • dialect: the dialect of the output SQL string (eg. "spark", "hive", "presto", "mysql").
  • opts: other sqlglot.generator.Generator options.
Returns:

The SQL string.

def transform( self, fun: Callable, *args: Any, copy: bool = True, **kwargs) -> Expression:
610    def transform(self, fun: t.Callable, *args: t.Any, copy: bool = True, **kwargs) -> Expression:
611        """
612        Visits all tree nodes (excluding already transformed ones)
613        and applies the given transformation function to each node.
614
615        Args:
616            fun: a function which takes a node as an argument and returns a
617                new transformed node or the same node without modifications. If the function
618                returns None, then the corresponding node will be removed from the syntax tree.
619            copy: if set to True a new tree instance is constructed, otherwise the tree is
620                modified in place.
621
622        Returns:
623            The transformed tree.
624        """
625        root = None
626        new_node = None
627
628        for node in (self.copy() if copy else self).dfs(prune=lambda n: n is not new_node):
629            parent, arg_key, index = node.parent, node.arg_key, node.index
630            new_node = fun(node, *args, **kwargs)
631
632            if not root:
633                root = new_node
634            elif new_node is not node:
635                parent.set(arg_key, new_node, index)
636
637        assert root
638        return root.assert_is(Expression)

Visits all tree nodes (excluding already transformed ones) and applies the given transformation function to each node.

Arguments:
  • fun: a function which takes a node as an argument and returns a new transformed node or the same node without modifications. If the function returns None, then the corresponding node will be removed from the syntax tree.
  • copy: if set to True a new tree instance is constructed, otherwise the tree is modified in place.
Returns:

The transformed tree.

def replace(self, expression):
646    def replace(self, expression):
647        """
648        Swap out this expression with a new expression.
649
650        For example::
651
652            >>> tree = Select().select("x").from_("tbl")
653            >>> tree.find(Column).replace(column("y"))
654            Column(
655              this=Identifier(this=y, quoted=False))
656            >>> tree.sql()
657            'SELECT y FROM tbl'
658
659        Args:
660            expression: new node
661
662        Returns:
663            The new expression or expressions.
664        """
665        parent = self.parent
666
667        if not parent or parent is expression:
668            return expression
669
670        key = self.arg_key
671        value = parent.args.get(key)
672
673        if type(expression) is list and isinstance(value, Expression):
674            # We are trying to replace an Expression with a list, so it's assumed that
675            # the intention was to really replace the parent of this expression.
676            value.parent.replace(expression)
677        else:
678            parent.set(key, expression, self.index)
679
680        if expression is not self:
681            self.parent = None
682            self.arg_key = None
683            self.index = None
684
685        return expression

Swap out this expression with a new expression.

For example::

>>> tree = Select().select("x").from_("tbl")
>>> tree.find(Column).replace(column("y"))
Column(
  this=Identifier(this=y, quoted=False))
>>> tree.sql()
'SELECT y FROM tbl'
Arguments:
  • expression: new node
Returns:

The new expression or expressions.

def pop(self: ~E) -> ~E:
687    def pop(self: E) -> E:
688        """
689        Remove this expression from its AST.
690
691        Returns:
692            The popped expression.
693        """
694        self.replace(None)
695        return self

Remove this expression from its AST.

Returns:

The popped expression.

def assert_is(self, type_: Type[~E]) -> ~E:
697    def assert_is(self, type_: t.Type[E]) -> E:
698        """
699        Assert that this `Expression` is an instance of `type_`.
700
701        If it is NOT an instance of `type_`, this raises an assertion error.
702        Otherwise, this returns this expression.
703
704        Examples:
705            This is useful for type security in chained expressions:
706
707            >>> import sqlglot
708            >>> sqlglot.parse_one("SELECT x from y").assert_is(Select).select("z").sql()
709            'SELECT x, z FROM y'
710        """
711        if not isinstance(self, type_):
712            raise AssertionError(f"{self} is not {type_}.")
713        return self

Assert that this Expression is an instance of type_.

If it is NOT an instance of type_, this raises an assertion error. Otherwise, this returns this expression.

Examples:

This is useful for type security in chained expressions:

>>> import sqlglot
>>> sqlglot.parse_one("SELECT x from y").assert_is(Select).select("z").sql()
'SELECT x, z FROM y'
def error_messages(self, args: Optional[Sequence] = None) -> List[str]:
715    def error_messages(self, args: t.Optional[t.Sequence] = None) -> t.List[str]:
716        """
717        Checks if this expression is valid (e.g. all mandatory args are set).
718
719        Args:
720            args: a sequence of values that were used to instantiate a Func expression. This is used
721                to check that the provided arguments don't exceed the function argument limit.
722
723        Returns:
724            A list of error messages for all possible errors that were found.
725        """
726        errors: t.List[str] = []
727
728        for k in self.args:
729            if k not in self.arg_types:
730                errors.append(f"Unexpected keyword: '{k}' for {self.__class__}")
731        for k, mandatory in self.arg_types.items():
732            v = self.args.get(k)
733            if mandatory and (v is None or (isinstance(v, list) and not v)):
734                errors.append(f"Required keyword: '{k}' missing for {self.__class__}")
735
736        if (
737            args
738            and isinstance(self, Func)
739            and len(args) > len(self.arg_types)
740            and not self.is_var_len_args
741        ):
742            errors.append(
743                f"The number of provided arguments ({len(args)}) is greater than "
744                f"the maximum number of supported arguments ({len(self.arg_types)})"
745            )
746
747        return errors

Checks if this expression is valid (e.g. all mandatory args are set).

Arguments:
  • args: a sequence of values that were used to instantiate a Func expression. This is used to check that the provided arguments don't exceed the function argument limit.
Returns:

A list of error messages for all possible errors that were found.

def dump(self):
749    def dump(self):
750        """
751        Dump this Expression to a JSON-serializable dict.
752        """
753        from sqlglot.serde import dump
754
755        return dump(self)

Dump this Expression to a JSON-serializable dict.

@classmethod
def load(cls, obj):
757    @classmethod
758    def load(cls, obj):
759        """
760        Load a dict (as returned by `Expression.dump`) into an Expression instance.
761        """
762        from sqlglot.serde import load
763
764        return load(obj)

Load a dict (as returned by Expression.dump) into an Expression instance.

def and_( self, *expressions: Union[str, Expression, NoneType], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
766    def and_(
767        self,
768        *expressions: t.Optional[ExpOrStr],
769        dialect: DialectType = None,
770        copy: bool = True,
771        **opts,
772    ) -> Condition:
773        """
774        AND this condition with one or multiple expressions.
775
776        Example:
777            >>> condition("x=1").and_("y=1").sql()
778            'x = 1 AND y = 1'
779
780        Args:
781            *expressions: the SQL code strings to parse.
782                If an `Expression` instance is passed, it will be used as-is.
783            dialect: the dialect used to parse the input expression.
784            copy: whether to copy the involved expressions (only applies to Expressions).
785            opts: other options to use to parse the input expressions.
786
787        Returns:
788            The new And condition.
789        """
790        return and_(self, *expressions, dialect=dialect, copy=copy, **opts)

AND this condition with one or multiple expressions.

Example:
>>> condition("x=1").and_("y=1").sql()
'x = 1 AND y = 1'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the involved expressions (only applies to Expressions).
  • opts: other options to use to parse the input expressions.
Returns:

The new And condition.

def or_( self, *expressions: Union[str, Expression, NoneType], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
792    def or_(
793        self,
794        *expressions: t.Optional[ExpOrStr],
795        dialect: DialectType = None,
796        copy: bool = True,
797        **opts,
798    ) -> Condition:
799        """
800        OR this condition with one or multiple expressions.
801
802        Example:
803            >>> condition("x=1").or_("y=1").sql()
804            'x = 1 OR y = 1'
805
806        Args:
807            *expressions: the SQL code strings to parse.
808                If an `Expression` instance is passed, it will be used as-is.
809            dialect: the dialect used to parse the input expression.
810            copy: whether to copy the involved expressions (only applies to Expressions).
811            opts: other options to use to parse the input expressions.
812
813        Returns:
814            The new Or condition.
815        """
816        return or_(self, *expressions, dialect=dialect, copy=copy, **opts)

OR this condition with one or multiple expressions.

Example:
>>> condition("x=1").or_("y=1").sql()
'x = 1 OR y = 1'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the involved expressions (only applies to Expressions).
  • opts: other options to use to parse the input expressions.
Returns:

The new Or condition.

def not_(self, copy: bool = True):
818    def not_(self, copy: bool = True):
819        """
820        Wrap this condition with NOT.
821
822        Example:
823            >>> condition("x=1").not_().sql()
824            'NOT x = 1'
825
826        Args:
827            copy: whether to copy this object.
828
829        Returns:
830            The new Not instance.
831        """
832        return not_(self, copy=copy)

Wrap this condition with NOT.

Example:
>>> condition("x=1").not_().sql()
'NOT x = 1'
Arguments:
  • copy: whether to copy this object.
Returns:

The new Not instance.

def as_( self, alias: str | Identifier, quoted: Optional[bool] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Alias:
834    def as_(
835        self,
836        alias: str | Identifier,
837        quoted: t.Optional[bool] = None,
838        dialect: DialectType = None,
839        copy: bool = True,
840        **opts,
841    ) -> Alias:
842        return alias_(self, alias, quoted=quoted, dialect=dialect, copy=copy, **opts)
def isin( self, *expressions: Any, query: Union[str, Expression, NoneType] = None, unnest: Union[str, Expression, NoneType, Collection[Union[str, Expression]]] = None, copy: bool = True, **opts) -> In:
867    def isin(
868        self,
869        *expressions: t.Any,
870        query: t.Optional[ExpOrStr] = None,
871        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
872        copy: bool = True,
873        **opts,
874    ) -> In:
875        subquery = maybe_parse(query, copy=copy, **opts) if query else None
876        if subquery and not isinstance(subquery, Subquery):
877            subquery = subquery.subquery(copy=False)
878
879        return In(
880            this=maybe_copy(self, copy),
881            expressions=[convert(e, copy=copy) for e in expressions],
882            query=subquery,
883            unnest=(
884                Unnest(
885                    expressions=[
886                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
887                        for e in ensure_list(unnest)
888                    ]
889                )
890                if unnest
891                else None
892            ),
893        )
def between( self, low: Any, high: Any, copy: bool = True, **opts) -> Between:
895    def between(self, low: t.Any, high: t.Any, copy: bool = True, **opts) -> Between:
896        return Between(
897            this=maybe_copy(self, copy),
898            low=convert(low, copy=copy, **opts),
899            high=convert(high, copy=copy, **opts),
900        )
def is_( self, other: Union[str, Expression]) -> Is:
902    def is_(self, other: ExpOrStr) -> Is:
903        return self._binop(Is, other)
def like( self, other: Union[str, Expression]) -> Like:
905    def like(self, other: ExpOrStr) -> Like:
906        return self._binop(Like, other)
def ilike( self, other: Union[str, Expression]) -> ILike:
908    def ilike(self, other: ExpOrStr) -> ILike:
909        return self._binop(ILike, other)
def eq(self, other: Any) -> EQ:
911    def eq(self, other: t.Any) -> EQ:
912        return self._binop(EQ, other)
def neq(self, other: Any) -> NEQ:
914    def neq(self, other: t.Any) -> NEQ:
915        return self._binop(NEQ, other)
def rlike( self, other: Union[str, Expression]) -> RegexpLike:
917    def rlike(self, other: ExpOrStr) -> RegexpLike:
918        return self._binop(RegexpLike, other)
def div( self, other: Union[str, Expression], typed: bool = False, safe: bool = False) -> Div:
920    def div(self, other: ExpOrStr, typed: bool = False, safe: bool = False) -> Div:
921        div = self._binop(Div, other)
922        div.args["typed"] = typed
923        div.args["safe"] = safe
924        return div
def asc(self, nulls_first: bool = True) -> Ordered:
926    def asc(self, nulls_first: bool = True) -> Ordered:
927        return Ordered(this=self.copy(), nulls_first=nulls_first)
def desc(self, nulls_first: bool = False) -> Ordered:
929    def desc(self, nulls_first: bool = False) -> Ordered:
930        return Ordered(this=self.copy(), desc=True, nulls_first=nulls_first)
IntoType = typing.Union[str, typing.Type[Expression], typing.Collection[typing.Union[str, typing.Type[Expression]]]]
ExpOrStr = typing.Union[str, Expression]
class Condition(Expression):
1013class Condition(Expression):
1014    """Logical conditions like x AND y, or simply x"""

Logical conditions like x AND y, or simply x

key = 'condition'
class Predicate(Condition):
1017class Predicate(Condition):
1018    """Relationships like x = y, x > 1, x >= y."""

Relationships like x = y, x > 1, x >= y.

key = 'predicate'
class DerivedTable(Expression):
1021class DerivedTable(Expression):
1022    @property
1023    def selects(self) -> t.List[Expression]:
1024        return self.this.selects if isinstance(self.this, Query) else []
1025
1026    @property
1027    def named_selects(self) -> t.List[str]:
1028        return [select.output_name for select in self.selects]
selects: List[Expression]
1022    @property
1023    def selects(self) -> t.List[Expression]:
1024        return self.this.selects if isinstance(self.this, Query) else []
named_selects: List[str]
1026    @property
1027    def named_selects(self) -> t.List[str]:
1028        return [select.output_name for select in self.selects]
key = 'derivedtable'
class Query(Expression):
1031class Query(Expression):
1032    def subquery(self, alias: t.Optional[ExpOrStr] = None, copy: bool = True) -> Subquery:
1033        """
1034        Returns a `Subquery` that wraps around this query.
1035
1036        Example:
1037            >>> subquery = Select().select("x").from_("tbl").subquery()
1038            >>> Select().select("x").from_(subquery).sql()
1039            'SELECT x FROM (SELECT x FROM tbl)'
1040
1041        Args:
1042            alias: an optional alias for the subquery.
1043            copy: if `False`, modify this expression instance in-place.
1044        """
1045        instance = maybe_copy(self, copy)
1046        if not isinstance(alias, Expression):
1047            alias = TableAlias(this=to_identifier(alias)) if alias else None
1048
1049        return Subquery(this=instance, alias=alias)
1050
1051    def limit(
1052        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1053    ) -> Q:
1054        """
1055        Adds a LIMIT clause to this query.
1056
1057        Example:
1058            >>> select("1").union(select("1")).limit(1).sql()
1059            'SELECT 1 UNION SELECT 1 LIMIT 1'
1060
1061        Args:
1062            expression: the SQL code string to parse.
1063                This can also be an integer.
1064                If a `Limit` instance is passed, it will be used as-is.
1065                If another `Expression` instance is passed, it will be wrapped in a `Limit`.
1066            dialect: the dialect used to parse the input expression.
1067            copy: if `False`, modify this expression instance in-place.
1068            opts: other options to use to parse the input expressions.
1069
1070        Returns:
1071            A limited Select expression.
1072        """
1073        return _apply_builder(
1074            expression=expression,
1075            instance=self,
1076            arg="limit",
1077            into=Limit,
1078            prefix="LIMIT",
1079            dialect=dialect,
1080            copy=copy,
1081            into_arg="expression",
1082            **opts,
1083        )
1084
1085    def offset(
1086        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1087    ) -> Q:
1088        """
1089        Set the OFFSET expression.
1090
1091        Example:
1092            >>> Select().from_("tbl").select("x").offset(10).sql()
1093            'SELECT x FROM tbl OFFSET 10'
1094
1095        Args:
1096            expression: the SQL code string to parse.
1097                This can also be an integer.
1098                If a `Offset` instance is passed, this is used as-is.
1099                If another `Expression` instance is passed, it will be wrapped in a `Offset`.
1100            dialect: the dialect used to parse the input expression.
1101            copy: if `False`, modify this expression instance in-place.
1102            opts: other options to use to parse the input expressions.
1103
1104        Returns:
1105            The modified Select expression.
1106        """
1107        return _apply_builder(
1108            expression=expression,
1109            instance=self,
1110            arg="offset",
1111            into=Offset,
1112            prefix="OFFSET",
1113            dialect=dialect,
1114            copy=copy,
1115            into_arg="expression",
1116            **opts,
1117        )
1118
1119    def order_by(
1120        self: Q,
1121        *expressions: t.Optional[ExpOrStr],
1122        append: bool = True,
1123        dialect: DialectType = None,
1124        copy: bool = True,
1125        **opts,
1126    ) -> Q:
1127        """
1128        Set the ORDER BY expression.
1129
1130        Example:
1131            >>> Select().from_("tbl").select("x").order_by("x DESC").sql()
1132            'SELECT x FROM tbl ORDER BY x DESC'
1133
1134        Args:
1135            *expressions: the SQL code strings to parse.
1136                If a `Group` instance is passed, this is used as-is.
1137                If another `Expression` instance is passed, it will be wrapped in a `Order`.
1138            append: if `True`, add to any existing expressions.
1139                Otherwise, this flattens all the `Order` expression into a single expression.
1140            dialect: the dialect used to parse the input expression.
1141            copy: if `False`, modify this expression instance in-place.
1142            opts: other options to use to parse the input expressions.
1143
1144        Returns:
1145            The modified Select expression.
1146        """
1147        return _apply_child_list_builder(
1148            *expressions,
1149            instance=self,
1150            arg="order",
1151            append=append,
1152            copy=copy,
1153            prefix="ORDER BY",
1154            into=Order,
1155            dialect=dialect,
1156            **opts,
1157        )
1158
1159    @property
1160    def ctes(self) -> t.List[CTE]:
1161        """Returns a list of all the CTEs attached to this query."""
1162        with_ = self.args.get("with")
1163        return with_.expressions if with_ else []
1164
1165    @property
1166    def selects(self) -> t.List[Expression]:
1167        """Returns the query's projections."""
1168        raise NotImplementedError("Query objects must implement `selects`")
1169
1170    @property
1171    def named_selects(self) -> t.List[str]:
1172        """Returns the output names of the query's projections."""
1173        raise NotImplementedError("Query objects must implement `named_selects`")
1174
1175    def select(
1176        self: Q,
1177        *expressions: t.Optional[ExpOrStr],
1178        append: bool = True,
1179        dialect: DialectType = None,
1180        copy: bool = True,
1181        **opts,
1182    ) -> Q:
1183        """
1184        Append to or set the SELECT expressions.
1185
1186        Example:
1187            >>> Select().select("x", "y").sql()
1188            'SELECT x, y'
1189
1190        Args:
1191            *expressions: the SQL code strings to parse.
1192                If an `Expression` instance is passed, it will be used as-is.
1193            append: if `True`, add to any existing expressions.
1194                Otherwise, this resets the expressions.
1195            dialect: the dialect used to parse the input expressions.
1196            copy: if `False`, modify this expression instance in-place.
1197            opts: other options to use to parse the input expressions.
1198
1199        Returns:
1200            The modified Query expression.
1201        """
1202        raise NotImplementedError("Query objects must implement `select`")
1203
1204    def with_(
1205        self: Q,
1206        alias: ExpOrStr,
1207        as_: ExpOrStr,
1208        recursive: t.Optional[bool] = None,
1209        materialized: t.Optional[bool] = None,
1210        append: bool = True,
1211        dialect: DialectType = None,
1212        copy: bool = True,
1213        **opts,
1214    ) -> Q:
1215        """
1216        Append to or set the common table expressions.
1217
1218        Example:
1219            >>> Select().with_("tbl2", as_="SELECT * FROM tbl").select("x").from_("tbl2").sql()
1220            'WITH tbl2 AS (SELECT * FROM tbl) SELECT x FROM tbl2'
1221
1222        Args:
1223            alias: the SQL code string to parse as the table name.
1224                If an `Expression` instance is passed, this is used as-is.
1225            as_: the SQL code string to parse as the table expression.
1226                If an `Expression` instance is passed, it will be used as-is.
1227            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
1228            materialized: set the MATERIALIZED part of the expression.
1229            append: if `True`, add to any existing expressions.
1230                Otherwise, this resets the expressions.
1231            dialect: the dialect used to parse the input expression.
1232            copy: if `False`, modify this expression instance in-place.
1233            opts: other options to use to parse the input expressions.
1234
1235        Returns:
1236            The modified expression.
1237        """
1238        return _apply_cte_builder(
1239            self,
1240            alias,
1241            as_,
1242            recursive=recursive,
1243            materialized=materialized,
1244            append=append,
1245            dialect=dialect,
1246            copy=copy,
1247            **opts,
1248        )
1249
1250    def union(
1251        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1252    ) -> Union:
1253        """
1254        Builds a UNION expression.
1255
1256        Example:
1257            >>> import sqlglot
1258            >>> sqlglot.parse_one("SELECT * FROM foo").union("SELECT * FROM bla").sql()
1259            'SELECT * FROM foo UNION SELECT * FROM bla'
1260
1261        Args:
1262            expression: the SQL code string.
1263                If an `Expression` instance is passed, it will be used as-is.
1264            distinct: set the DISTINCT flag if and only if this is true.
1265            dialect: the dialect used to parse the input expression.
1266            opts: other options to use to parse the input expressions.
1267
1268        Returns:
1269            The new Union expression.
1270        """
1271        return union(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1272
1273    def intersect(
1274        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1275    ) -> Intersect:
1276        """
1277        Builds an INTERSECT expression.
1278
1279        Example:
1280            >>> import sqlglot
1281            >>> sqlglot.parse_one("SELECT * FROM foo").intersect("SELECT * FROM bla").sql()
1282            'SELECT * FROM foo INTERSECT SELECT * FROM bla'
1283
1284        Args:
1285            expression: the SQL code string.
1286                If an `Expression` instance is passed, it will be used as-is.
1287            distinct: set the DISTINCT flag if and only if this is true.
1288            dialect: the dialect used to parse the input expression.
1289            opts: other options to use to parse the input expressions.
1290
1291        Returns:
1292            The new Intersect expression.
1293        """
1294        return intersect(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
1295
1296    def except_(
1297        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1298    ) -> Except:
1299        """
1300        Builds an EXCEPT expression.
1301
1302        Example:
1303            >>> import sqlglot
1304            >>> sqlglot.parse_one("SELECT * FROM foo").except_("SELECT * FROM bla").sql()
1305            'SELECT * FROM foo EXCEPT SELECT * FROM bla'
1306
1307        Args:
1308            expression: the SQL code string.
1309                If an `Expression` instance is passed, it will be used as-is.
1310            distinct: set the DISTINCT flag if and only if this is true.
1311            dialect: the dialect used to parse the input expression.
1312            opts: other options to use to parse the input expressions.
1313
1314        Returns:
1315            The new Except expression.
1316        """
1317        return except_(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)
def subquery( self, alias: Union[str, Expression, NoneType] = None, copy: bool = True) -> Subquery:
1032    def subquery(self, alias: t.Optional[ExpOrStr] = None, copy: bool = True) -> Subquery:
1033        """
1034        Returns a `Subquery` that wraps around this query.
1035
1036        Example:
1037            >>> subquery = Select().select("x").from_("tbl").subquery()
1038            >>> Select().select("x").from_(subquery).sql()
1039            'SELECT x FROM (SELECT x FROM tbl)'
1040
1041        Args:
1042            alias: an optional alias for the subquery.
1043            copy: if `False`, modify this expression instance in-place.
1044        """
1045        instance = maybe_copy(self, copy)
1046        if not isinstance(alias, Expression):
1047            alias = TableAlias(this=to_identifier(alias)) if alias else None
1048
1049        return Subquery(this=instance, alias=alias)

Returns a Subquery that wraps around this query.

Example:
>>> subquery = Select().select("x").from_("tbl").subquery()
>>> Select().select("x").from_(subquery).sql()
'SELECT x FROM (SELECT x FROM tbl)'
Arguments:
  • alias: an optional alias for the subquery.
  • copy: if False, modify this expression instance in-place.
def limit( self: ~Q, expression: Union[str, Expression, int], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~Q:
1051    def limit(
1052        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1053    ) -> Q:
1054        """
1055        Adds a LIMIT clause to this query.
1056
1057        Example:
1058            >>> select("1").union(select("1")).limit(1).sql()
1059            'SELECT 1 UNION SELECT 1 LIMIT 1'
1060
1061        Args:
1062            expression: the SQL code string to parse.
1063                This can also be an integer.
1064                If a `Limit` instance is passed, it will be used as-is.
1065                If another `Expression` instance is passed, it will be wrapped in a `Limit`.
1066            dialect: the dialect used to parse the input expression.
1067            copy: if `False`, modify this expression instance in-place.
1068            opts: other options to use to parse the input expressions.
1069
1070        Returns:
1071            A limited Select expression.
1072        """
1073        return _apply_builder(
1074            expression=expression,
1075            instance=self,
1076            arg="limit",
1077            into=Limit,
1078            prefix="LIMIT",
1079            dialect=dialect,
1080            copy=copy,
1081            into_arg="expression",
1082            **opts,
1083        )

Adds a LIMIT clause to this query.

Example:
>>> select("1").union(select("1")).limit(1).sql()
'SELECT 1 UNION SELECT 1 LIMIT 1'
Arguments:
  • expression: the SQL code string to parse. This can also be an integer. If a Limit instance is passed, it will be used as-is. If another Expression instance is passed, it will be wrapped in a Limit.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

A limited Select expression.

def offset( self: ~Q, expression: Union[str, Expression, int], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~Q:
1085    def offset(
1086        self: Q, expression: ExpOrStr | int, dialect: DialectType = None, copy: bool = True, **opts
1087    ) -> Q:
1088        """
1089        Set the OFFSET expression.
1090
1091        Example:
1092            >>> Select().from_("tbl").select("x").offset(10).sql()
1093            'SELECT x FROM tbl OFFSET 10'
1094
1095        Args:
1096            expression: the SQL code string to parse.
1097                This can also be an integer.
1098                If a `Offset` instance is passed, this is used as-is.
1099                If another `Expression` instance is passed, it will be wrapped in a `Offset`.
1100            dialect: the dialect used to parse the input expression.
1101            copy: if `False`, modify this expression instance in-place.
1102            opts: other options to use to parse the input expressions.
1103
1104        Returns:
1105            The modified Select expression.
1106        """
1107        return _apply_builder(
1108            expression=expression,
1109            instance=self,
1110            arg="offset",
1111            into=Offset,
1112            prefix="OFFSET",
1113            dialect=dialect,
1114            copy=copy,
1115            into_arg="expression",
1116            **opts,
1117        )

Set the OFFSET expression.

Example:
>>> Select().from_("tbl").select("x").offset(10).sql()
'SELECT x FROM tbl OFFSET 10'
Arguments:
  • expression: the SQL code string to parse. This can also be an integer. If a Offset instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a Offset.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def order_by( self: ~Q, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~Q:
1119    def order_by(
1120        self: Q,
1121        *expressions: t.Optional[ExpOrStr],
1122        append: bool = True,
1123        dialect: DialectType = None,
1124        copy: bool = True,
1125        **opts,
1126    ) -> Q:
1127        """
1128        Set the ORDER BY expression.
1129
1130        Example:
1131            >>> Select().from_("tbl").select("x").order_by("x DESC").sql()
1132            'SELECT x FROM tbl ORDER BY x DESC'
1133
1134        Args:
1135            *expressions: the SQL code strings to parse.
1136                If a `Group` instance is passed, this is used as-is.
1137                If another `Expression` instance is passed, it will be wrapped in a `Order`.
1138            append: if `True`, add to any existing expressions.
1139                Otherwise, this flattens all the `Order` expression into a single expression.
1140            dialect: the dialect used to parse the input expression.
1141            copy: if `False`, modify this expression instance in-place.
1142            opts: other options to use to parse the input expressions.
1143
1144        Returns:
1145            The modified Select expression.
1146        """
1147        return _apply_child_list_builder(
1148            *expressions,
1149            instance=self,
1150            arg="order",
1151            append=append,
1152            copy=copy,
1153            prefix="ORDER BY",
1154            into=Order,
1155            dialect=dialect,
1156            **opts,
1157        )

Set the ORDER BY expression.

Example:
>>> Select().from_("tbl").select("x").order_by("x DESC").sql()
'SELECT x FROM tbl ORDER BY x DESC'
Arguments:
  • *expressions: the SQL code strings to parse. If a Group instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a Order.
  • append: if True, add to any existing expressions. Otherwise, this flattens all the Order expression into a single expression.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

ctes: List[CTE]
1159    @property
1160    def ctes(self) -> t.List[CTE]:
1161        """Returns a list of all the CTEs attached to this query."""
1162        with_ = self.args.get("with")
1163        return with_.expressions if with_ else []

Returns a list of all the CTEs attached to this query.

selects: List[Expression]
1165    @property
1166    def selects(self) -> t.List[Expression]:
1167        """Returns the query's projections."""
1168        raise NotImplementedError("Query objects must implement `selects`")

Returns the query's projections.

named_selects: List[str]
1170    @property
1171    def named_selects(self) -> t.List[str]:
1172        """Returns the output names of the query's projections."""
1173        raise NotImplementedError("Query objects must implement `named_selects`")

Returns the output names of the query's projections.

def select( self: ~Q, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~Q:
1175    def select(
1176        self: Q,
1177        *expressions: t.Optional[ExpOrStr],
1178        append: bool = True,
1179        dialect: DialectType = None,
1180        copy: bool = True,
1181        **opts,
1182    ) -> Q:
1183        """
1184        Append to or set the SELECT expressions.
1185
1186        Example:
1187            >>> Select().select("x", "y").sql()
1188            'SELECT x, y'
1189
1190        Args:
1191            *expressions: the SQL code strings to parse.
1192                If an `Expression` instance is passed, it will be used as-is.
1193            append: if `True`, add to any existing expressions.
1194                Otherwise, this resets the expressions.
1195            dialect: the dialect used to parse the input expressions.
1196            copy: if `False`, modify this expression instance in-place.
1197            opts: other options to use to parse the input expressions.
1198
1199        Returns:
1200            The modified Query expression.
1201        """
1202        raise NotImplementedError("Query objects must implement `select`")

Append to or set the SELECT expressions.

Example:
>>> Select().select("x", "y").sql()
'SELECT x, y'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Query expression.

def with_( self: ~Q, alias: Union[str, Expression], as_: Union[str, Expression], recursive: Optional[bool] = None, materialized: Optional[bool] = None, append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~Q:
1204    def with_(
1205        self: Q,
1206        alias: ExpOrStr,
1207        as_: ExpOrStr,
1208        recursive: t.Optional[bool] = None,
1209        materialized: t.Optional[bool] = None,
1210        append: bool = True,
1211        dialect: DialectType = None,
1212        copy: bool = True,
1213        **opts,
1214    ) -> Q:
1215        """
1216        Append to or set the common table expressions.
1217
1218        Example:
1219            >>> Select().with_("tbl2", as_="SELECT * FROM tbl").select("x").from_("tbl2").sql()
1220            'WITH tbl2 AS (SELECT * FROM tbl) SELECT x FROM tbl2'
1221
1222        Args:
1223            alias: the SQL code string to parse as the table name.
1224                If an `Expression` instance is passed, this is used as-is.
1225            as_: the SQL code string to parse as the table expression.
1226                If an `Expression` instance is passed, it will be used as-is.
1227            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
1228            materialized: set the MATERIALIZED part of the expression.
1229            append: if `True`, add to any existing expressions.
1230                Otherwise, this resets the expressions.
1231            dialect: the dialect used to parse the input expression.
1232            copy: if `False`, modify this expression instance in-place.
1233            opts: other options to use to parse the input expressions.
1234
1235        Returns:
1236            The modified expression.
1237        """
1238        return _apply_cte_builder(
1239            self,
1240            alias,
1241            as_,
1242            recursive=recursive,
1243            materialized=materialized,
1244            append=append,
1245            dialect=dialect,
1246            copy=copy,
1247            **opts,
1248        )

Append to or set the common table expressions.

Example:
>>> Select().with_("tbl2", as_="SELECT * FROM tbl").select("x").from_("tbl2").sql()
'WITH tbl2 AS (SELECT * FROM tbl) SELECT x FROM tbl2'
Arguments:
  • alias: the SQL code string to parse as the table name. If an Expression instance is passed, this is used as-is.
  • as_: the SQL code string to parse as the table expression. If an Expression instance is passed, it will be used as-is.
  • recursive: set the RECURSIVE part of the expression. Defaults to False.
  • materialized: set the MATERIALIZED part of the expression.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified expression.

def union( self, expression: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Union:
1250    def union(
1251        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1252    ) -> Union:
1253        """
1254        Builds a UNION expression.
1255
1256        Example:
1257            >>> import sqlglot
1258            >>> sqlglot.parse_one("SELECT * FROM foo").union("SELECT * FROM bla").sql()
1259            'SELECT * FROM foo UNION SELECT * FROM bla'
1260
1261        Args:
1262            expression: the SQL code string.
1263                If an `Expression` instance is passed, it will be used as-is.
1264            distinct: set the DISTINCT flag if and only if this is true.
1265            dialect: the dialect used to parse the input expression.
1266            opts: other options to use to parse the input expressions.
1267
1268        Returns:
1269            The new Union expression.
1270        """
1271        return union(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)

Builds a UNION expression.

Example:
>>> import sqlglot
>>> sqlglot.parse_one("SELECT * FROM foo").union("SELECT * FROM bla").sql()
'SELECT * FROM foo UNION SELECT * FROM bla'
Arguments:
  • expression: the SQL code string. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Union expression.

def intersect( self, expression: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Intersect:
1273    def intersect(
1274        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1275    ) -> Intersect:
1276        """
1277        Builds an INTERSECT expression.
1278
1279        Example:
1280            >>> import sqlglot
1281            >>> sqlglot.parse_one("SELECT * FROM foo").intersect("SELECT * FROM bla").sql()
1282            'SELECT * FROM foo INTERSECT SELECT * FROM bla'
1283
1284        Args:
1285            expression: the SQL code string.
1286                If an `Expression` instance is passed, it will be used as-is.
1287            distinct: set the DISTINCT flag if and only if this is true.
1288            dialect: the dialect used to parse the input expression.
1289            opts: other options to use to parse the input expressions.
1290
1291        Returns:
1292            The new Intersect expression.
1293        """
1294        return intersect(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)

Builds an INTERSECT expression.

Example:
>>> import sqlglot
>>> sqlglot.parse_one("SELECT * FROM foo").intersect("SELECT * FROM bla").sql()
'SELECT * FROM foo INTERSECT SELECT * FROM bla'
Arguments:
  • expression: the SQL code string. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Intersect expression.

def except_( self, expression: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Except:
1296    def except_(
1297        self, expression: ExpOrStr, distinct: bool = True, dialect: DialectType = None, **opts
1298    ) -> Except:
1299        """
1300        Builds an EXCEPT expression.
1301
1302        Example:
1303            >>> import sqlglot
1304            >>> sqlglot.parse_one("SELECT * FROM foo").except_("SELECT * FROM bla").sql()
1305            'SELECT * FROM foo EXCEPT SELECT * FROM bla'
1306
1307        Args:
1308            expression: the SQL code string.
1309                If an `Expression` instance is passed, it will be used as-is.
1310            distinct: set the DISTINCT flag if and only if this is true.
1311            dialect: the dialect used to parse the input expression.
1312            opts: other options to use to parse the input expressions.
1313
1314        Returns:
1315            The new Except expression.
1316        """
1317        return except_(left=self, right=expression, distinct=distinct, dialect=dialect, **opts)

Builds an EXCEPT expression.

Example:
>>> import sqlglot
>>> sqlglot.parse_one("SELECT * FROM foo").except_("SELECT * FROM bla").sql()
'SELECT * FROM foo EXCEPT SELECT * FROM bla'
Arguments:
  • expression: the SQL code string. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Except expression.

key = 'query'
class UDTF(DerivedTable):
1320class UDTF(DerivedTable):
1321    @property
1322    def selects(self) -> t.List[Expression]:
1323        alias = self.args.get("alias")
1324        return alias.columns if alias else []
selects: List[Expression]
1321    @property
1322    def selects(self) -> t.List[Expression]:
1323        alias = self.args.get("alias")
1324        return alias.columns if alias else []
key = 'udtf'
class Cache(Expression):
1327class Cache(Expression):
1328    arg_types = {
1329        "this": True,
1330        "lazy": False,
1331        "options": False,
1332        "expression": False,
1333    }
arg_types = {'this': True, 'lazy': False, 'options': False, 'expression': False}
key = 'cache'
class Uncache(Expression):
1336class Uncache(Expression):
1337    arg_types = {"this": True, "exists": False}
arg_types = {'this': True, 'exists': False}
key = 'uncache'
class Refresh(Expression):
1340class Refresh(Expression):
1341    pass
key = 'refresh'
class DDL(Expression):
1344class DDL(Expression):
1345    @property
1346    def ctes(self) -> t.List[CTE]:
1347        """Returns a list of all the CTEs attached to this statement."""
1348        with_ = self.args.get("with")
1349        return with_.expressions if with_ else []
1350
1351    @property
1352    def selects(self) -> t.List[Expression]:
1353        """If this statement contains a query (e.g. a CTAS), this returns the query's projections."""
1354        return self.expression.selects if isinstance(self.expression, Query) else []
1355
1356    @property
1357    def named_selects(self) -> t.List[str]:
1358        """
1359        If this statement contains a query (e.g. a CTAS), this returns the output
1360        names of the query's projections.
1361        """
1362        return self.expression.named_selects if isinstance(self.expression, Query) else []
ctes: List[CTE]
1345    @property
1346    def ctes(self) -> t.List[CTE]:
1347        """Returns a list of all the CTEs attached to this statement."""
1348        with_ = self.args.get("with")
1349        return with_.expressions if with_ else []

Returns a list of all the CTEs attached to this statement.

selects: List[Expression]
1351    @property
1352    def selects(self) -> t.List[Expression]:
1353        """If this statement contains a query (e.g. a CTAS), this returns the query's projections."""
1354        return self.expression.selects if isinstance(self.expression, Query) else []

If this statement contains a query (e.g. a CTAS), this returns the query's projections.

named_selects: List[str]
1356    @property
1357    def named_selects(self) -> t.List[str]:
1358        """
1359        If this statement contains a query (e.g. a CTAS), this returns the output
1360        names of the query's projections.
1361        """
1362        return self.expression.named_selects if isinstance(self.expression, Query) else []

If this statement contains a query (e.g. a CTAS), this returns the output names of the query's projections.

key = 'ddl'
class DML(Expression):
1365class DML(Expression):
1366    def returning(
1367        self,
1368        expression: ExpOrStr,
1369        dialect: DialectType = None,
1370        copy: bool = True,
1371        **opts,
1372    ) -> DML:
1373        """
1374        Set the RETURNING expression. Not supported by all dialects.
1375
1376        Example:
1377            >>> delete("tbl").returning("*", dialect="postgres").sql()
1378            'DELETE FROM tbl RETURNING *'
1379
1380        Args:
1381            expression: the SQL code strings to parse.
1382                If an `Expression` instance is passed, it will be used as-is.
1383            dialect: the dialect used to parse the input expressions.
1384            copy: if `False`, modify this expression instance in-place.
1385            opts: other options to use to parse the input expressions.
1386
1387        Returns:
1388            Delete: the modified expression.
1389        """
1390        return _apply_builder(
1391            expression=expression,
1392            instance=self,
1393            arg="returning",
1394            prefix="RETURNING",
1395            dialect=dialect,
1396            copy=copy,
1397            into=Returning,
1398            **opts,
1399        )
def returning( self, expression: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> DML:
1366    def returning(
1367        self,
1368        expression: ExpOrStr,
1369        dialect: DialectType = None,
1370        copy: bool = True,
1371        **opts,
1372    ) -> DML:
1373        """
1374        Set the RETURNING expression. Not supported by all dialects.
1375
1376        Example:
1377            >>> delete("tbl").returning("*", dialect="postgres").sql()
1378            'DELETE FROM tbl RETURNING *'
1379
1380        Args:
1381            expression: the SQL code strings to parse.
1382                If an `Expression` instance is passed, it will be used as-is.
1383            dialect: the dialect used to parse the input expressions.
1384            copy: if `False`, modify this expression instance in-place.
1385            opts: other options to use to parse the input expressions.
1386
1387        Returns:
1388            Delete: the modified expression.
1389        """
1390        return _apply_builder(
1391            expression=expression,
1392            instance=self,
1393            arg="returning",
1394            prefix="RETURNING",
1395            dialect=dialect,
1396            copy=copy,
1397            into=Returning,
1398            **opts,
1399        )

Set the RETURNING expression. Not supported by all dialects.

Example:
>>> delete("tbl").returning("*", dialect="postgres").sql()
'DELETE FROM tbl RETURNING *'
Arguments:
  • expression: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

Delete: the modified expression.

key = 'dml'
class Create(DDL):
1402class Create(DDL):
1403    arg_types = {
1404        "with": False,
1405        "this": True,
1406        "kind": True,
1407        "expression": False,
1408        "exists": False,
1409        "properties": False,
1410        "replace": False,
1411        "refresh": False,
1412        "unique": False,
1413        "indexes": False,
1414        "no_schema_binding": False,
1415        "begin": False,
1416        "end": False,
1417        "clone": False,
1418        "concurrently": False,
1419        "clustered": False,
1420    }
1421
1422    @property
1423    def kind(self) -> t.Optional[str]:
1424        kind = self.args.get("kind")
1425        return kind and kind.upper()
arg_types = {'with': False, 'this': True, 'kind': True, 'expression': False, 'exists': False, 'properties': False, 'replace': False, 'refresh': False, 'unique': False, 'indexes': False, 'no_schema_binding': False, 'begin': False, 'end': False, 'clone': False, 'concurrently': False, 'clustered': False}
kind: Optional[str]
1422    @property
1423    def kind(self) -> t.Optional[str]:
1424        kind = self.args.get("kind")
1425        return kind and kind.upper()
key = 'create'
class SequenceProperties(Expression):
1428class SequenceProperties(Expression):
1429    arg_types = {
1430        "increment": False,
1431        "minvalue": False,
1432        "maxvalue": False,
1433        "cache": False,
1434        "start": False,
1435        "owned": False,
1436        "options": False,
1437    }
arg_types = {'increment': False, 'minvalue': False, 'maxvalue': False, 'cache': False, 'start': False, 'owned': False, 'options': False}
key = 'sequenceproperties'
class TruncateTable(Expression):
1440class TruncateTable(Expression):
1441    arg_types = {
1442        "expressions": True,
1443        "is_database": False,
1444        "exists": False,
1445        "only": False,
1446        "cluster": False,
1447        "identity": False,
1448        "option": False,
1449        "partition": False,
1450    }
arg_types = {'expressions': True, 'is_database': False, 'exists': False, 'only': False, 'cluster': False, 'identity': False, 'option': False, 'partition': False}
key = 'truncatetable'
class Clone(Expression):
1456class Clone(Expression):
1457    arg_types = {"this": True, "shallow": False, "copy": False}
arg_types = {'this': True, 'shallow': False, 'copy': False}
key = 'clone'
class Describe(Expression):
1460class Describe(Expression):
1461    arg_types = {
1462        "this": True,
1463        "style": False,
1464        "kind": False,
1465        "expressions": False,
1466        "partition": False,
1467    }
arg_types = {'this': True, 'style': False, 'kind': False, 'expressions': False, 'partition': False}
key = 'describe'
class Summarize(Expression):
1471class Summarize(Expression):
1472    arg_types = {"this": True, "table": False}
arg_types = {'this': True, 'table': False}
key = 'summarize'
class Kill(Expression):
1475class Kill(Expression):
1476    arg_types = {"this": True, "kind": False}
arg_types = {'this': True, 'kind': False}
key = 'kill'
class Pragma(Expression):
1479class Pragma(Expression):
1480    pass
key = 'pragma'
class Declare(Expression):
1483class Declare(Expression):
1484    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'declare'
class DeclareItem(Expression):
1487class DeclareItem(Expression):
1488    arg_types = {"this": True, "kind": True, "default": False}
arg_types = {'this': True, 'kind': True, 'default': False}
key = 'declareitem'
class Set(Expression):
1491class Set(Expression):
1492    arg_types = {"expressions": False, "unset": False, "tag": False}
arg_types = {'expressions': False, 'unset': False, 'tag': False}
key = 'set'
class Heredoc(Expression):
1495class Heredoc(Expression):
1496    arg_types = {"this": True, "tag": False}
arg_types = {'this': True, 'tag': False}
key = 'heredoc'
class SetItem(Expression):
1499class SetItem(Expression):
1500    arg_types = {
1501        "this": False,
1502        "expressions": False,
1503        "kind": False,
1504        "collate": False,  # MySQL SET NAMES statement
1505        "global": False,
1506    }
arg_types = {'this': False, 'expressions': False, 'kind': False, 'collate': False, 'global': False}
key = 'setitem'
class Show(Expression):
1509class Show(Expression):
1510    arg_types = {
1511        "this": True,
1512        "history": False,
1513        "terse": False,
1514        "target": False,
1515        "offset": False,
1516        "starts_with": False,
1517        "limit": False,
1518        "from": False,
1519        "like": False,
1520        "where": False,
1521        "db": False,
1522        "scope": False,
1523        "scope_kind": False,
1524        "full": False,
1525        "mutex": False,
1526        "query": False,
1527        "channel": False,
1528        "global": False,
1529        "log": False,
1530        "position": False,
1531        "types": False,
1532    }
arg_types = {'this': True, 'history': False, 'terse': False, 'target': False, 'offset': False, 'starts_with': False, 'limit': False, 'from': False, 'like': False, 'where': False, 'db': False, 'scope': False, 'scope_kind': False, 'full': False, 'mutex': False, 'query': False, 'channel': False, 'global': False, 'log': False, 'position': False, 'types': False}
key = 'show'
class UserDefinedFunction(Expression):
1535class UserDefinedFunction(Expression):
1536    arg_types = {"this": True, "expressions": False, "wrapped": False}
arg_types = {'this': True, 'expressions': False, 'wrapped': False}
key = 'userdefinedfunction'
class CharacterSet(Expression):
1539class CharacterSet(Expression):
1540    arg_types = {"this": True, "default": False}
arg_types = {'this': True, 'default': False}
key = 'characterset'
class With(Expression):
1543class With(Expression):
1544    arg_types = {"expressions": True, "recursive": False}
1545
1546    @property
1547    def recursive(self) -> bool:
1548        return bool(self.args.get("recursive"))
arg_types = {'expressions': True, 'recursive': False}
recursive: bool
1546    @property
1547    def recursive(self) -> bool:
1548        return bool(self.args.get("recursive"))
key = 'with'
class WithinGroup(Expression):
1551class WithinGroup(Expression):
1552    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'withingroup'
class CTE(DerivedTable):
1557class CTE(DerivedTable):
1558    arg_types = {
1559        "this": True,
1560        "alias": True,
1561        "scalar": False,
1562        "materialized": False,
1563    }
arg_types = {'this': True, 'alias': True, 'scalar': False, 'materialized': False}
key = 'cte'
class ProjectionDef(Expression):
1566class ProjectionDef(Expression):
1567    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'projectiondef'
class TableAlias(Expression):
1570class TableAlias(Expression):
1571    arg_types = {"this": False, "columns": False}
1572
1573    @property
1574    def columns(self):
1575        return self.args.get("columns") or []
arg_types = {'this': False, 'columns': False}
columns
1573    @property
1574    def columns(self):
1575        return self.args.get("columns") or []
key = 'tablealias'
class BitString(Condition):
1578class BitString(Condition):
1579    pass
key = 'bitstring'
class HexString(Condition):
1582class HexString(Condition):
1583    pass
key = 'hexstring'
class ByteString(Condition):
1586class ByteString(Condition):
1587    pass
key = 'bytestring'
class RawString(Condition):
1590class RawString(Condition):
1591    pass
key = 'rawstring'
class UnicodeString(Condition):
1594class UnicodeString(Condition):
1595    arg_types = {"this": True, "escape": False}
arg_types = {'this': True, 'escape': False}
key = 'unicodestring'
class Column(Condition):
1598class Column(Condition):
1599    arg_types = {"this": True, "table": False, "db": False, "catalog": False, "join_mark": False}
1600
1601    @property
1602    def table(self) -> str:
1603        return self.text("table")
1604
1605    @property
1606    def db(self) -> str:
1607        return self.text("db")
1608
1609    @property
1610    def catalog(self) -> str:
1611        return self.text("catalog")
1612
1613    @property
1614    def output_name(self) -> str:
1615        return self.name
1616
1617    @property
1618    def parts(self) -> t.List[Identifier]:
1619        """Return the parts of a column in order catalog, db, table, name."""
1620        return [
1621            t.cast(Identifier, self.args[part])
1622            for part in ("catalog", "db", "table", "this")
1623            if self.args.get(part)
1624        ]
1625
1626    def to_dot(self) -> Dot | Identifier:
1627        """Converts the column into a dot expression."""
1628        parts = self.parts
1629        parent = self.parent
1630
1631        while parent:
1632            if isinstance(parent, Dot):
1633                parts.append(parent.expression)
1634            parent = parent.parent
1635
1636        return Dot.build(deepcopy(parts)) if len(parts) > 1 else parts[0]
arg_types = {'this': True, 'table': False, 'db': False, 'catalog': False, 'join_mark': False}
table: str
1601    @property
1602    def table(self) -> str:
1603        return self.text("table")
db: str
1605    @property
1606    def db(self) -> str:
1607        return self.text("db")
catalog: str
1609    @property
1610    def catalog(self) -> str:
1611        return self.text("catalog")
output_name: str
1613    @property
1614    def output_name(self) -> str:
1615        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
parts: List[Identifier]
1617    @property
1618    def parts(self) -> t.List[Identifier]:
1619        """Return the parts of a column in order catalog, db, table, name."""
1620        return [
1621            t.cast(Identifier, self.args[part])
1622            for part in ("catalog", "db", "table", "this")
1623            if self.args.get(part)
1624        ]

Return the parts of a column in order catalog, db, table, name.

def to_dot(self) -> Dot | Identifier:
1626    def to_dot(self) -> Dot | Identifier:
1627        """Converts the column into a dot expression."""
1628        parts = self.parts
1629        parent = self.parent
1630
1631        while parent:
1632            if isinstance(parent, Dot):
1633                parts.append(parent.expression)
1634            parent = parent.parent
1635
1636        return Dot.build(deepcopy(parts)) if len(parts) > 1 else parts[0]

Converts the column into a dot expression.

key = 'column'
class ColumnPosition(Expression):
1639class ColumnPosition(Expression):
1640    arg_types = {"this": False, "position": True}
arg_types = {'this': False, 'position': True}
key = 'columnposition'
class ColumnDef(Expression):
1643class ColumnDef(Expression):
1644    arg_types = {
1645        "this": True,
1646        "kind": False,
1647        "constraints": False,
1648        "exists": False,
1649        "position": False,
1650    }
1651
1652    @property
1653    def constraints(self) -> t.List[ColumnConstraint]:
1654        return self.args.get("constraints") or []
1655
1656    @property
1657    def kind(self) -> t.Optional[DataType]:
1658        return self.args.get("kind")
arg_types = {'this': True, 'kind': False, 'constraints': False, 'exists': False, 'position': False}
constraints: List[ColumnConstraint]
1652    @property
1653    def constraints(self) -> t.List[ColumnConstraint]:
1654        return self.args.get("constraints") or []
kind: Optional[DataType]
1656    @property
1657    def kind(self) -> t.Optional[DataType]:
1658        return self.args.get("kind")
key = 'columndef'
class AlterColumn(Expression):
1661class AlterColumn(Expression):
1662    arg_types = {
1663        "this": True,
1664        "dtype": False,
1665        "collate": False,
1666        "using": False,
1667        "default": False,
1668        "drop": False,
1669        "comment": False,
1670        "allow_null": False,
1671    }
arg_types = {'this': True, 'dtype': False, 'collate': False, 'using': False, 'default': False, 'drop': False, 'comment': False, 'allow_null': False}
key = 'altercolumn'
class AlterDistStyle(Expression):
1675class AlterDistStyle(Expression):
1676    pass
key = 'alterdiststyle'
class AlterSortKey(Expression):
1679class AlterSortKey(Expression):
1680    arg_types = {"this": False, "expressions": False, "compound": False}
arg_types = {'this': False, 'expressions': False, 'compound': False}
key = 'altersortkey'
class AlterSet(Expression):
1683class AlterSet(Expression):
1684    arg_types = {
1685        "expressions": False,
1686        "option": False,
1687        "tablespace": False,
1688        "access_method": False,
1689        "file_format": False,
1690        "copy_options": False,
1691        "tag": False,
1692        "location": False,
1693        "serde": False,
1694    }
arg_types = {'expressions': False, 'option': False, 'tablespace': False, 'access_method': False, 'file_format': False, 'copy_options': False, 'tag': False, 'location': False, 'serde': False}
key = 'alterset'
class RenameColumn(Expression):
1697class RenameColumn(Expression):
1698    arg_types = {"this": True, "to": True, "exists": False}
arg_types = {'this': True, 'to': True, 'exists': False}
key = 'renamecolumn'
class RenameTable(Expression):
1701class RenameTable(Expression):
1702    pass
key = 'renametable'
class SwapTable(Expression):
1705class SwapTable(Expression):
1706    pass
key = 'swaptable'
class Comment(Expression):
1709class Comment(Expression):
1710    arg_types = {
1711        "this": True,
1712        "kind": True,
1713        "expression": True,
1714        "exists": False,
1715        "materialized": False,
1716    }
arg_types = {'this': True, 'kind': True, 'expression': True, 'exists': False, 'materialized': False}
key = 'comment'
class Comprehension(Expression):
1719class Comprehension(Expression):
1720    arg_types = {"this": True, "expression": True, "iterator": True, "condition": False}
arg_types = {'this': True, 'expression': True, 'iterator': True, 'condition': False}
key = 'comprehension'
class MergeTreeTTLAction(Expression):
1724class MergeTreeTTLAction(Expression):
1725    arg_types = {
1726        "this": True,
1727        "delete": False,
1728        "recompress": False,
1729        "to_disk": False,
1730        "to_volume": False,
1731    }
arg_types = {'this': True, 'delete': False, 'recompress': False, 'to_disk': False, 'to_volume': False}
key = 'mergetreettlaction'
class MergeTreeTTL(Expression):
1735class MergeTreeTTL(Expression):
1736    arg_types = {
1737        "expressions": True,
1738        "where": False,
1739        "group": False,
1740        "aggregates": False,
1741    }
arg_types = {'expressions': True, 'where': False, 'group': False, 'aggregates': False}
key = 'mergetreettl'
class IndexConstraintOption(Expression):
1745class IndexConstraintOption(Expression):
1746    arg_types = {
1747        "key_block_size": False,
1748        "using": False,
1749        "parser": False,
1750        "comment": False,
1751        "visible": False,
1752        "engine_attr": False,
1753        "secondary_engine_attr": False,
1754    }
arg_types = {'key_block_size': False, 'using': False, 'parser': False, 'comment': False, 'visible': False, 'engine_attr': False, 'secondary_engine_attr': False}
key = 'indexconstraintoption'
class ColumnConstraint(Expression):
1757class ColumnConstraint(Expression):
1758    arg_types = {"this": False, "kind": True}
1759
1760    @property
1761    def kind(self) -> ColumnConstraintKind:
1762        return self.args["kind"]
arg_types = {'this': False, 'kind': True}
kind: ColumnConstraintKind
1760    @property
1761    def kind(self) -> ColumnConstraintKind:
1762        return self.args["kind"]
key = 'columnconstraint'
class ColumnConstraintKind(Expression):
1765class ColumnConstraintKind(Expression):
1766    pass
key = 'columnconstraintkind'
class AutoIncrementColumnConstraint(ColumnConstraintKind):
1769class AutoIncrementColumnConstraint(ColumnConstraintKind):
1770    pass
key = 'autoincrementcolumnconstraint'
class PeriodForSystemTimeConstraint(ColumnConstraintKind):
1773class PeriodForSystemTimeConstraint(ColumnConstraintKind):
1774    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'periodforsystemtimeconstraint'
class CaseSpecificColumnConstraint(ColumnConstraintKind):
1777class CaseSpecificColumnConstraint(ColumnConstraintKind):
1778    arg_types = {"not_": True}
arg_types = {'not_': True}
key = 'casespecificcolumnconstraint'
class CharacterSetColumnConstraint(ColumnConstraintKind):
1781class CharacterSetColumnConstraint(ColumnConstraintKind):
1782    arg_types = {"this": True}
arg_types = {'this': True}
key = 'charactersetcolumnconstraint'
class CheckColumnConstraint(ColumnConstraintKind):
1785class CheckColumnConstraint(ColumnConstraintKind):
1786    arg_types = {"this": True, "enforced": False}
arg_types = {'this': True, 'enforced': False}
key = 'checkcolumnconstraint'
class ClusteredColumnConstraint(ColumnConstraintKind):
1789class ClusteredColumnConstraint(ColumnConstraintKind):
1790    pass
key = 'clusteredcolumnconstraint'
class CollateColumnConstraint(ColumnConstraintKind):
1793class CollateColumnConstraint(ColumnConstraintKind):
1794    pass
key = 'collatecolumnconstraint'
class CommentColumnConstraint(ColumnConstraintKind):
1797class CommentColumnConstraint(ColumnConstraintKind):
1798    pass
key = 'commentcolumnconstraint'
class CompressColumnConstraint(ColumnConstraintKind):
1801class CompressColumnConstraint(ColumnConstraintKind):
1802    arg_types = {"this": False}
arg_types = {'this': False}
key = 'compresscolumnconstraint'
class DateFormatColumnConstraint(ColumnConstraintKind):
1805class DateFormatColumnConstraint(ColumnConstraintKind):
1806    arg_types = {"this": True}
arg_types = {'this': True}
key = 'dateformatcolumnconstraint'
class DefaultColumnConstraint(ColumnConstraintKind):
1809class DefaultColumnConstraint(ColumnConstraintKind):
1810    pass
key = 'defaultcolumnconstraint'
class EncodeColumnConstraint(ColumnConstraintKind):
1813class EncodeColumnConstraint(ColumnConstraintKind):
1814    pass
key = 'encodecolumnconstraint'
class ExcludeColumnConstraint(ColumnConstraintKind):
1818class ExcludeColumnConstraint(ColumnConstraintKind):
1819    pass
key = 'excludecolumnconstraint'
class EphemeralColumnConstraint(ColumnConstraintKind):
1822class EphemeralColumnConstraint(ColumnConstraintKind):
1823    arg_types = {"this": False}
arg_types = {'this': False}
key = 'ephemeralcolumnconstraint'
class WithOperator(Expression):
1826class WithOperator(Expression):
1827    arg_types = {"this": True, "op": True}
arg_types = {'this': True, 'op': True}
key = 'withoperator'
class GeneratedAsIdentityColumnConstraint(ColumnConstraintKind):
1830class GeneratedAsIdentityColumnConstraint(ColumnConstraintKind):
1831    # this: True -> ALWAYS, this: False -> BY DEFAULT
1832    arg_types = {
1833        "this": False,
1834        "expression": False,
1835        "on_null": False,
1836        "start": False,
1837        "increment": False,
1838        "minvalue": False,
1839        "maxvalue": False,
1840        "cycle": False,
1841    }
arg_types = {'this': False, 'expression': False, 'on_null': False, 'start': False, 'increment': False, 'minvalue': False, 'maxvalue': False, 'cycle': False}
key = 'generatedasidentitycolumnconstraint'
class GeneratedAsRowColumnConstraint(ColumnConstraintKind):
1844class GeneratedAsRowColumnConstraint(ColumnConstraintKind):
1845    arg_types = {"start": False, "hidden": False}
arg_types = {'start': False, 'hidden': False}
key = 'generatedasrowcolumnconstraint'
class IndexColumnConstraint(ColumnConstraintKind):
1850class IndexColumnConstraint(ColumnConstraintKind):
1851    arg_types = {
1852        "this": False,
1853        "expressions": False,
1854        "kind": False,
1855        "index_type": False,
1856        "options": False,
1857        "expression": False,  # Clickhouse
1858        "granularity": False,
1859    }
arg_types = {'this': False, 'expressions': False, 'kind': False, 'index_type': False, 'options': False, 'expression': False, 'granularity': False}
key = 'indexcolumnconstraint'
class InlineLengthColumnConstraint(ColumnConstraintKind):
1862class InlineLengthColumnConstraint(ColumnConstraintKind):
1863    pass
key = 'inlinelengthcolumnconstraint'
class NonClusteredColumnConstraint(ColumnConstraintKind):
1866class NonClusteredColumnConstraint(ColumnConstraintKind):
1867    pass
key = 'nonclusteredcolumnconstraint'
class NotForReplicationColumnConstraint(ColumnConstraintKind):
1870class NotForReplicationColumnConstraint(ColumnConstraintKind):
1871    arg_types = {}
arg_types = {}
key = 'notforreplicationcolumnconstraint'
class MaskingPolicyColumnConstraint(ColumnConstraintKind):
1875class MaskingPolicyColumnConstraint(ColumnConstraintKind):
1876    arg_types = {"this": True, "expressions": False}
arg_types = {'this': True, 'expressions': False}
key = 'maskingpolicycolumnconstraint'
class NotNullColumnConstraint(ColumnConstraintKind):
1879class NotNullColumnConstraint(ColumnConstraintKind):
1880    arg_types = {"allow_null": False}
arg_types = {'allow_null': False}
key = 'notnullcolumnconstraint'
class OnUpdateColumnConstraint(ColumnConstraintKind):
1884class OnUpdateColumnConstraint(ColumnConstraintKind):
1885    pass
key = 'onupdatecolumnconstraint'
class TagColumnConstraint(ColumnConstraintKind):
1889class TagColumnConstraint(ColumnConstraintKind):
1890    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'tagcolumnconstraint'
class TransformColumnConstraint(ColumnConstraintKind):
1894class TransformColumnConstraint(ColumnConstraintKind):
1895    pass
key = 'transformcolumnconstraint'
class PrimaryKeyColumnConstraint(ColumnConstraintKind):
1898class PrimaryKeyColumnConstraint(ColumnConstraintKind):
1899    arg_types = {"desc": False}
arg_types = {'desc': False}
key = 'primarykeycolumnconstraint'
class TitleColumnConstraint(ColumnConstraintKind):
1902class TitleColumnConstraint(ColumnConstraintKind):
1903    pass
key = 'titlecolumnconstraint'
class UniqueColumnConstraint(ColumnConstraintKind):
1906class UniqueColumnConstraint(ColumnConstraintKind):
1907    arg_types = {"this": False, "index_type": False, "on_conflict": False, "nulls": False}
arg_types = {'this': False, 'index_type': False, 'on_conflict': False, 'nulls': False}
key = 'uniquecolumnconstraint'
class UppercaseColumnConstraint(ColumnConstraintKind):
1910class UppercaseColumnConstraint(ColumnConstraintKind):
1911    arg_types: t.Dict[str, t.Any] = {}
arg_types: Dict[str, Any] = {}
key = 'uppercasecolumnconstraint'
class PathColumnConstraint(ColumnConstraintKind):
1914class PathColumnConstraint(ColumnConstraintKind):
1915    pass
key = 'pathcolumnconstraint'
class ProjectionPolicyColumnConstraint(ColumnConstraintKind):
1919class ProjectionPolicyColumnConstraint(ColumnConstraintKind):
1920    pass
key = 'projectionpolicycolumnconstraint'
class ComputedColumnConstraint(ColumnConstraintKind):
1925class ComputedColumnConstraint(ColumnConstraintKind):
1926    arg_types = {"this": True, "persisted": False, "not_null": False}
arg_types = {'this': True, 'persisted': False, 'not_null': False}
key = 'computedcolumnconstraint'
class Constraint(Expression):
1929class Constraint(Expression):
1930    arg_types = {"this": True, "expressions": True}
arg_types = {'this': True, 'expressions': True}
key = 'constraint'
class Delete(DML):
1933class Delete(DML):
1934    arg_types = {
1935        "with": False,
1936        "this": False,
1937        "using": False,
1938        "where": False,
1939        "returning": False,
1940        "limit": False,
1941        "tables": False,  # Multiple-Table Syntax (MySQL)
1942        "cluster": False,  # Clickhouse
1943    }
1944
1945    def delete(
1946        self,
1947        table: ExpOrStr,
1948        dialect: DialectType = None,
1949        copy: bool = True,
1950        **opts,
1951    ) -> Delete:
1952        """
1953        Create a DELETE expression or replace the table on an existing DELETE expression.
1954
1955        Example:
1956            >>> delete("tbl").sql()
1957            'DELETE FROM tbl'
1958
1959        Args:
1960            table: the table from which to delete.
1961            dialect: the dialect used to parse the input expression.
1962            copy: if `False`, modify this expression instance in-place.
1963            opts: other options to use to parse the input expressions.
1964
1965        Returns:
1966            Delete: the modified expression.
1967        """
1968        return _apply_builder(
1969            expression=table,
1970            instance=self,
1971            arg="this",
1972            dialect=dialect,
1973            into=Table,
1974            copy=copy,
1975            **opts,
1976        )
1977
1978    def where(
1979        self,
1980        *expressions: t.Optional[ExpOrStr],
1981        append: bool = True,
1982        dialect: DialectType = None,
1983        copy: bool = True,
1984        **opts,
1985    ) -> Delete:
1986        """
1987        Append to or set the WHERE expressions.
1988
1989        Example:
1990            >>> delete("tbl").where("x = 'a' OR x < 'b'").sql()
1991            "DELETE FROM tbl WHERE x = 'a' OR x < 'b'"
1992
1993        Args:
1994            *expressions: the SQL code strings to parse.
1995                If an `Expression` instance is passed, it will be used as-is.
1996                Multiple expressions are combined with an AND operator.
1997            append: if `True`, AND the new expressions to any existing expression.
1998                Otherwise, this resets the expression.
1999            dialect: the dialect used to parse the input expressions.
2000            copy: if `False`, modify this expression instance in-place.
2001            opts: other options to use to parse the input expressions.
2002
2003        Returns:
2004            Delete: the modified expression.
2005        """
2006        return _apply_conjunction_builder(
2007            *expressions,
2008            instance=self,
2009            arg="where",
2010            append=append,
2011            into=Where,
2012            dialect=dialect,
2013            copy=copy,
2014            **opts,
2015        )
arg_types = {'with': False, 'this': False, 'using': False, 'where': False, 'returning': False, 'limit': False, 'tables': False, 'cluster': False}
def delete( self, table: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Delete:
1945    def delete(
1946        self,
1947        table: ExpOrStr,
1948        dialect: DialectType = None,
1949        copy: bool = True,
1950        **opts,
1951    ) -> Delete:
1952        """
1953        Create a DELETE expression or replace the table on an existing DELETE expression.
1954
1955        Example:
1956            >>> delete("tbl").sql()
1957            'DELETE FROM tbl'
1958
1959        Args:
1960            table: the table from which to delete.
1961            dialect: the dialect used to parse the input expression.
1962            copy: if `False`, modify this expression instance in-place.
1963            opts: other options to use to parse the input expressions.
1964
1965        Returns:
1966            Delete: the modified expression.
1967        """
1968        return _apply_builder(
1969            expression=table,
1970            instance=self,
1971            arg="this",
1972            dialect=dialect,
1973            into=Table,
1974            copy=copy,
1975            **opts,
1976        )

Create a DELETE expression or replace the table on an existing DELETE expression.

Example:
>>> delete("tbl").sql()
'DELETE FROM tbl'
Arguments:
  • table: the table from which to delete.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

Delete: the modified expression.

def where( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Delete:
1978    def where(
1979        self,
1980        *expressions: t.Optional[ExpOrStr],
1981        append: bool = True,
1982        dialect: DialectType = None,
1983        copy: bool = True,
1984        **opts,
1985    ) -> Delete:
1986        """
1987        Append to or set the WHERE expressions.
1988
1989        Example:
1990            >>> delete("tbl").where("x = 'a' OR x < 'b'").sql()
1991            "DELETE FROM tbl WHERE x = 'a' OR x < 'b'"
1992
1993        Args:
1994            *expressions: the SQL code strings to parse.
1995                If an `Expression` instance is passed, it will be used as-is.
1996                Multiple expressions are combined with an AND operator.
1997            append: if `True`, AND the new expressions to any existing expression.
1998                Otherwise, this resets the expression.
1999            dialect: the dialect used to parse the input expressions.
2000            copy: if `False`, modify this expression instance in-place.
2001            opts: other options to use to parse the input expressions.
2002
2003        Returns:
2004            Delete: the modified expression.
2005        """
2006        return _apply_conjunction_builder(
2007            *expressions,
2008            instance=self,
2009            arg="where",
2010            append=append,
2011            into=Where,
2012            dialect=dialect,
2013            copy=copy,
2014            **opts,
2015        )

Append to or set the WHERE expressions.

Example:
>>> delete("tbl").where("x = 'a' OR x < 'b'").sql()
"DELETE FROM tbl WHERE x = 'a' OR x < 'b'"
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is. Multiple expressions are combined with an AND operator.
  • append: if True, AND the new expressions to any existing expression. Otherwise, this resets the expression.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

Delete: the modified expression.

key = 'delete'
class Drop(Expression):
2018class Drop(Expression):
2019    arg_types = {
2020        "this": False,
2021        "kind": False,
2022        "expressions": False,
2023        "exists": False,
2024        "temporary": False,
2025        "materialized": False,
2026        "cascade": False,
2027        "constraints": False,
2028        "purge": False,
2029        "cluster": False,
2030        "concurrently": False,
2031    }
2032
2033    @property
2034    def kind(self) -> t.Optional[str]:
2035        kind = self.args.get("kind")
2036        return kind and kind.upper()
arg_types = {'this': False, 'kind': False, 'expressions': False, 'exists': False, 'temporary': False, 'materialized': False, 'cascade': False, 'constraints': False, 'purge': False, 'cluster': False, 'concurrently': False}
kind: Optional[str]
2033    @property
2034    def kind(self) -> t.Optional[str]:
2035        kind = self.args.get("kind")
2036        return kind and kind.upper()
key = 'drop'
class Filter(Expression):
2039class Filter(Expression):
2040    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'filter'
class Check(Expression):
2043class Check(Expression):
2044    pass
key = 'check'
class Changes(Expression):
2047class Changes(Expression):
2048    arg_types = {"information": True, "at_before": False, "end": False}
arg_types = {'information': True, 'at_before': False, 'end': False}
key = 'changes'
class Connect(Expression):
2052class Connect(Expression):
2053    arg_types = {"start": False, "connect": True, "nocycle": False}
arg_types = {'start': False, 'connect': True, 'nocycle': False}
key = 'connect'
class CopyParameter(Expression):
2056class CopyParameter(Expression):
2057    arg_types = {"this": True, "expression": False, "expressions": False}
arg_types = {'this': True, 'expression': False, 'expressions': False}
key = 'copyparameter'
class Copy(DML):
2060class Copy(DML):
2061    arg_types = {
2062        "this": True,
2063        "kind": True,
2064        "files": True,
2065        "credentials": False,
2066        "format": False,
2067        "params": False,
2068    }
arg_types = {'this': True, 'kind': True, 'files': True, 'credentials': False, 'format': False, 'params': False}
key = 'copy'
class Credentials(Expression):
2071class Credentials(Expression):
2072    arg_types = {
2073        "credentials": False,
2074        "encryption": False,
2075        "storage": False,
2076        "iam_role": False,
2077        "region": False,
2078    }
arg_types = {'credentials': False, 'encryption': False, 'storage': False, 'iam_role': False, 'region': False}
key = 'credentials'
class Prior(Expression):
2081class Prior(Expression):
2082    pass
key = 'prior'
class Directory(Expression):
2085class Directory(Expression):
2086    # https://spark.apache.org/docs/3.0.0-preview/sql-ref-syntax-dml-insert-overwrite-directory-hive.html
2087    arg_types = {"this": True, "local": False, "row_format": False}
arg_types = {'this': True, 'local': False, 'row_format': False}
key = 'directory'
class ForeignKey(Expression):
2090class ForeignKey(Expression):
2091    arg_types = {
2092        "expressions": True,
2093        "reference": False,
2094        "delete": False,
2095        "update": False,
2096    }
arg_types = {'expressions': True, 'reference': False, 'delete': False, 'update': False}
key = 'foreignkey'
class ColumnPrefix(Expression):
2099class ColumnPrefix(Expression):
2100    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'columnprefix'
class PrimaryKey(Expression):
2103class PrimaryKey(Expression):
2104    arg_types = {"expressions": True, "options": False}
arg_types = {'expressions': True, 'options': False}
key = 'primarykey'
class Into(Expression):
2109class Into(Expression):
2110    arg_types = {"this": True, "temporary": False, "unlogged": False}
arg_types = {'this': True, 'temporary': False, 'unlogged': False}
key = 'into'
class From(Expression):
2113class From(Expression):
2114    @property
2115    def name(self) -> str:
2116        return self.this.name
2117
2118    @property
2119    def alias_or_name(self) -> str:
2120        return self.this.alias_or_name
name: str
2114    @property
2115    def name(self) -> str:
2116        return self.this.name
alias_or_name: str
2118    @property
2119    def alias_or_name(self) -> str:
2120        return self.this.alias_or_name
key = 'from'
class Having(Expression):
2123class Having(Expression):
2124    pass
key = 'having'
class Hint(Expression):
2127class Hint(Expression):
2128    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'hint'
class JoinHint(Expression):
2131class JoinHint(Expression):
2132    arg_types = {"this": True, "expressions": True}
arg_types = {'this': True, 'expressions': True}
key = 'joinhint'
class Identifier(Expression):
2135class Identifier(Expression):
2136    arg_types = {"this": True, "quoted": False, "global": False, "temporary": False}
2137
2138    @property
2139    def quoted(self) -> bool:
2140        return bool(self.args.get("quoted"))
2141
2142    @property
2143    def hashable_args(self) -> t.Any:
2144        return (self.this, self.quoted)
2145
2146    @property
2147    def output_name(self) -> str:
2148        return self.name
arg_types = {'this': True, 'quoted': False, 'global': False, 'temporary': False}
quoted: bool
2138    @property
2139    def quoted(self) -> bool:
2140        return bool(self.args.get("quoted"))
hashable_args: Any
2142    @property
2143    def hashable_args(self) -> t.Any:
2144        return (self.this, self.quoted)
output_name: str
2146    @property
2147    def output_name(self) -> str:
2148        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'identifier'
class Opclass(Expression):
2152class Opclass(Expression):
2153    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'opclass'
class Index(Expression):
2156class Index(Expression):
2157    arg_types = {
2158        "this": False,
2159        "table": False,
2160        "unique": False,
2161        "primary": False,
2162        "amp": False,  # teradata
2163        "params": False,
2164    }
arg_types = {'this': False, 'table': False, 'unique': False, 'primary': False, 'amp': False, 'params': False}
key = 'index'
class IndexParameters(Expression):
2167class IndexParameters(Expression):
2168    arg_types = {
2169        "using": False,
2170        "include": False,
2171        "columns": False,
2172        "with_storage": False,
2173        "partition_by": False,
2174        "tablespace": False,
2175        "where": False,
2176        "on": False,
2177    }
arg_types = {'using': False, 'include': False, 'columns': False, 'with_storage': False, 'partition_by': False, 'tablespace': False, 'where': False, 'on': False}
key = 'indexparameters'
class Insert(DDL, DML):
2180class Insert(DDL, DML):
2181    arg_types = {
2182        "hint": False,
2183        "with": False,
2184        "is_function": False,
2185        "this": False,
2186        "expression": False,
2187        "conflict": False,
2188        "returning": False,
2189        "overwrite": False,
2190        "exists": False,
2191        "alternative": False,
2192        "where": False,
2193        "ignore": False,
2194        "by_name": False,
2195        "stored": False,
2196        "partition": False,
2197        "settings": False,
2198        "source": False,
2199    }
2200
2201    def with_(
2202        self,
2203        alias: ExpOrStr,
2204        as_: ExpOrStr,
2205        recursive: t.Optional[bool] = None,
2206        materialized: t.Optional[bool] = None,
2207        append: bool = True,
2208        dialect: DialectType = None,
2209        copy: bool = True,
2210        **opts,
2211    ) -> Insert:
2212        """
2213        Append to or set the common table expressions.
2214
2215        Example:
2216            >>> insert("SELECT x FROM cte", "t").with_("cte", as_="SELECT * FROM tbl").sql()
2217            'WITH cte AS (SELECT * FROM tbl) INSERT INTO t SELECT x FROM cte'
2218
2219        Args:
2220            alias: the SQL code string to parse as the table name.
2221                If an `Expression` instance is passed, this is used as-is.
2222            as_: the SQL code string to parse as the table expression.
2223                If an `Expression` instance is passed, it will be used as-is.
2224            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
2225            materialized: set the MATERIALIZED part of the expression.
2226            append: if `True`, add to any existing expressions.
2227                Otherwise, this resets the expressions.
2228            dialect: the dialect used to parse the input expression.
2229            copy: if `False`, modify this expression instance in-place.
2230            opts: other options to use to parse the input expressions.
2231
2232        Returns:
2233            The modified expression.
2234        """
2235        return _apply_cte_builder(
2236            self,
2237            alias,
2238            as_,
2239            recursive=recursive,
2240            materialized=materialized,
2241            append=append,
2242            dialect=dialect,
2243            copy=copy,
2244            **opts,
2245        )
arg_types = {'hint': False, 'with': False, 'is_function': False, 'this': False, 'expression': False, 'conflict': False, 'returning': False, 'overwrite': False, 'exists': False, 'alternative': False, 'where': False, 'ignore': False, 'by_name': False, 'stored': False, 'partition': False, 'settings': False, 'source': False}
def with_( self, alias: Union[str, Expression], as_: Union[str, Expression], recursive: Optional[bool] = None, materialized: Optional[bool] = None, append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Insert:
2201    def with_(
2202        self,
2203        alias: ExpOrStr,
2204        as_: ExpOrStr,
2205        recursive: t.Optional[bool] = None,
2206        materialized: t.Optional[bool] = None,
2207        append: bool = True,
2208        dialect: DialectType = None,
2209        copy: bool = True,
2210        **opts,
2211    ) -> Insert:
2212        """
2213        Append to or set the common table expressions.
2214
2215        Example:
2216            >>> insert("SELECT x FROM cte", "t").with_("cte", as_="SELECT * FROM tbl").sql()
2217            'WITH cte AS (SELECT * FROM tbl) INSERT INTO t SELECT x FROM cte'
2218
2219        Args:
2220            alias: the SQL code string to parse as the table name.
2221                If an `Expression` instance is passed, this is used as-is.
2222            as_: the SQL code string to parse as the table expression.
2223                If an `Expression` instance is passed, it will be used as-is.
2224            recursive: set the RECURSIVE part of the expression. Defaults to `False`.
2225            materialized: set the MATERIALIZED part of the expression.
2226            append: if `True`, add to any existing expressions.
2227                Otherwise, this resets the expressions.
2228            dialect: the dialect used to parse the input expression.
2229            copy: if `False`, modify this expression instance in-place.
2230            opts: other options to use to parse the input expressions.
2231
2232        Returns:
2233            The modified expression.
2234        """
2235        return _apply_cte_builder(
2236            self,
2237            alias,
2238            as_,
2239            recursive=recursive,
2240            materialized=materialized,
2241            append=append,
2242            dialect=dialect,
2243            copy=copy,
2244            **opts,
2245        )

Append to or set the common table expressions.

Example:
>>> insert("SELECT x FROM cte", "t").with_("cte", as_="SELECT * FROM tbl").sql()
'WITH cte AS (SELECT * FROM tbl) INSERT INTO t SELECT x FROM cte'
Arguments:
  • alias: the SQL code string to parse as the table name. If an Expression instance is passed, this is used as-is.
  • as_: the SQL code string to parse as the table expression. If an Expression instance is passed, it will be used as-is.
  • recursive: set the RECURSIVE part of the expression. Defaults to False.
  • materialized: set the MATERIALIZED part of the expression.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified expression.

key = 'insert'
class ConditionalInsert(Expression):
2248class ConditionalInsert(Expression):
2249    arg_types = {"this": True, "expression": False, "else_": False}
arg_types = {'this': True, 'expression': False, 'else_': False}
key = 'conditionalinsert'
class MultitableInserts(Expression):
2252class MultitableInserts(Expression):
2253    arg_types = {"expressions": True, "kind": True, "source": True}
arg_types = {'expressions': True, 'kind': True, 'source': True}
key = 'multitableinserts'
class OnConflict(Expression):
2256class OnConflict(Expression):
2257    arg_types = {
2258        "duplicate": False,
2259        "expressions": False,
2260        "action": False,
2261        "conflict_keys": False,
2262        "constraint": False,
2263    }
arg_types = {'duplicate': False, 'expressions': False, 'action': False, 'conflict_keys': False, 'constraint': False}
key = 'onconflict'
class OnCondition(Expression):
2266class OnCondition(Expression):
2267    arg_types = {"error": False, "empty": False, "null": False}
arg_types = {'error': False, 'empty': False, 'null': False}
key = 'oncondition'
class Returning(Expression):
2270class Returning(Expression):
2271    arg_types = {"expressions": True, "into": False}
arg_types = {'expressions': True, 'into': False}
key = 'returning'
class Introducer(Expression):
2275class Introducer(Expression):
2276    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'introducer'
class National(Expression):
2280class National(Expression):
2281    pass
key = 'national'
class LoadData(Expression):
2284class LoadData(Expression):
2285    arg_types = {
2286        "this": True,
2287        "local": False,
2288        "overwrite": False,
2289        "inpath": True,
2290        "partition": False,
2291        "input_format": False,
2292        "serde": False,
2293    }
arg_types = {'this': True, 'local': False, 'overwrite': False, 'inpath': True, 'partition': False, 'input_format': False, 'serde': False}
key = 'loaddata'
class Partition(Expression):
2296class Partition(Expression):
2297    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'partition'
class PartitionRange(Expression):
2300class PartitionRange(Expression):
2301    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'partitionrange'
class PartitionId(Expression):
2305class PartitionId(Expression):
2306    pass
key = 'partitionid'
class Fetch(Expression):
2309class Fetch(Expression):
2310    arg_types = {
2311        "direction": False,
2312        "count": False,
2313        "percent": False,
2314        "with_ties": False,
2315    }
arg_types = {'direction': False, 'count': False, 'percent': False, 'with_ties': False}
key = 'fetch'
class Group(Expression):
2318class Group(Expression):
2319    arg_types = {
2320        "expressions": False,
2321        "grouping_sets": False,
2322        "cube": False,
2323        "rollup": False,
2324        "totals": False,
2325        "all": False,
2326    }
arg_types = {'expressions': False, 'grouping_sets': False, 'cube': False, 'rollup': False, 'totals': False, 'all': False}
key = 'group'
class Cube(Expression):
2329class Cube(Expression):
2330    arg_types = {"expressions": False}
arg_types = {'expressions': False}
key = 'cube'
class Rollup(Expression):
2333class Rollup(Expression):
2334    arg_types = {"expressions": False}
arg_types = {'expressions': False}
key = 'rollup'
class GroupingSets(Expression):
2337class GroupingSets(Expression):
2338    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'groupingsets'
class Lambda(Expression):
2341class Lambda(Expression):
2342    arg_types = {"this": True, "expressions": True}
arg_types = {'this': True, 'expressions': True}
key = 'lambda'
class Limit(Expression):
2345class Limit(Expression):
2346    arg_types = {"this": False, "expression": True, "offset": False, "expressions": False}
arg_types = {'this': False, 'expression': True, 'offset': False, 'expressions': False}
key = 'limit'
class Literal(Condition):
2349class Literal(Condition):
2350    arg_types = {"this": True, "is_string": True}
2351
2352    @property
2353    def hashable_args(self) -> t.Any:
2354        return (self.this, self.args.get("is_string"))
2355
2356    @classmethod
2357    def number(cls, number) -> Literal:
2358        return cls(this=str(number), is_string=False)
2359
2360    @classmethod
2361    def string(cls, string) -> Literal:
2362        return cls(this=str(string), is_string=True)
2363
2364    @property
2365    def output_name(self) -> str:
2366        return self.name
2367
2368    def to_py(self) -> int | str | Decimal:
2369        if self.is_number:
2370            try:
2371                return int(self.this)
2372            except ValueError:
2373                return Decimal(self.this)
2374        return self.this
arg_types = {'this': True, 'is_string': True}
hashable_args: Any
2352    @property
2353    def hashable_args(self) -> t.Any:
2354        return (self.this, self.args.get("is_string"))
@classmethod
def number(cls, number) -> Literal:
2356    @classmethod
2357    def number(cls, number) -> Literal:
2358        return cls(this=str(number), is_string=False)
@classmethod
def string(cls, string) -> Literal:
2360    @classmethod
2361    def string(cls, string) -> Literal:
2362        return cls(this=str(string), is_string=True)
output_name: str
2364    @property
2365    def output_name(self) -> str:
2366        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
def to_py(self) -> int | str | decimal.Decimal:
2368    def to_py(self) -> int | str | Decimal:
2369        if self.is_number:
2370            try:
2371                return int(self.this)
2372            except ValueError:
2373                return Decimal(self.this)
2374        return self.this

Returns a Python object equivalent of the SQL node.

key = 'literal'
class Join(Expression):
2377class Join(Expression):
2378    arg_types = {
2379        "this": True,
2380        "on": False,
2381        "side": False,
2382        "kind": False,
2383        "using": False,
2384        "method": False,
2385        "global": False,
2386        "hint": False,
2387        "match_condition": False,  # Snowflake
2388    }
2389
2390    @property
2391    def method(self) -> str:
2392        return self.text("method").upper()
2393
2394    @property
2395    def kind(self) -> str:
2396        return self.text("kind").upper()
2397
2398    @property
2399    def side(self) -> str:
2400        return self.text("side").upper()
2401
2402    @property
2403    def hint(self) -> str:
2404        return self.text("hint").upper()
2405
2406    @property
2407    def alias_or_name(self) -> str:
2408        return self.this.alias_or_name
2409
2410    def on(
2411        self,
2412        *expressions: t.Optional[ExpOrStr],
2413        append: bool = True,
2414        dialect: DialectType = None,
2415        copy: bool = True,
2416        **opts,
2417    ) -> Join:
2418        """
2419        Append to or set the ON expressions.
2420
2421        Example:
2422            >>> import sqlglot
2423            >>> sqlglot.parse_one("JOIN x", into=Join).on("y = 1").sql()
2424            'JOIN x ON y = 1'
2425
2426        Args:
2427            *expressions: the SQL code strings to parse.
2428                If an `Expression` instance is passed, it will be used as-is.
2429                Multiple expressions are combined with an AND operator.
2430            append: if `True`, AND the new expressions to any existing expression.
2431                Otherwise, this resets the expression.
2432            dialect: the dialect used to parse the input expressions.
2433            copy: if `False`, modify this expression instance in-place.
2434            opts: other options to use to parse the input expressions.
2435
2436        Returns:
2437            The modified Join expression.
2438        """
2439        join = _apply_conjunction_builder(
2440            *expressions,
2441            instance=self,
2442            arg="on",
2443            append=append,
2444            dialect=dialect,
2445            copy=copy,
2446            **opts,
2447        )
2448
2449        if join.kind == "CROSS":
2450            join.set("kind", None)
2451
2452        return join
2453
2454    def using(
2455        self,
2456        *expressions: t.Optional[ExpOrStr],
2457        append: bool = True,
2458        dialect: DialectType = None,
2459        copy: bool = True,
2460        **opts,
2461    ) -> Join:
2462        """
2463        Append to or set the USING expressions.
2464
2465        Example:
2466            >>> import sqlglot
2467            >>> sqlglot.parse_one("JOIN x", into=Join).using("foo", "bla").sql()
2468            'JOIN x USING (foo, bla)'
2469
2470        Args:
2471            *expressions: the SQL code strings to parse.
2472                If an `Expression` instance is passed, it will be used as-is.
2473            append: if `True`, concatenate the new expressions to the existing "using" list.
2474                Otherwise, this resets the expression.
2475            dialect: the dialect used to parse the input expressions.
2476            copy: if `False`, modify this expression instance in-place.
2477            opts: other options to use to parse the input expressions.
2478
2479        Returns:
2480            The modified Join expression.
2481        """
2482        join = _apply_list_builder(
2483            *expressions,
2484            instance=self,
2485            arg="using",
2486            append=append,
2487            dialect=dialect,
2488            copy=copy,
2489            **opts,
2490        )
2491
2492        if join.kind == "CROSS":
2493            join.set("kind", None)
2494
2495        return join
arg_types = {'this': True, 'on': False, 'side': False, 'kind': False, 'using': False, 'method': False, 'global': False, 'hint': False, 'match_condition': False}
method: str
2390    @property
2391    def method(self) -> str:
2392        return self.text("method").upper()
kind: str
2394    @property
2395    def kind(self) -> str:
2396        return self.text("kind").upper()
side: str
2398    @property
2399    def side(self) -> str:
2400        return self.text("side").upper()
hint: str
2402    @property
2403    def hint(self) -> str:
2404        return self.text("hint").upper()
alias_or_name: str
2406    @property
2407    def alias_or_name(self) -> str:
2408        return self.this.alias_or_name
def on( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Join:
2410    def on(
2411        self,
2412        *expressions: t.Optional[ExpOrStr],
2413        append: bool = True,
2414        dialect: DialectType = None,
2415        copy: bool = True,
2416        **opts,
2417    ) -> Join:
2418        """
2419        Append to or set the ON expressions.
2420
2421        Example:
2422            >>> import sqlglot
2423            >>> sqlglot.parse_one("JOIN x", into=Join).on("y = 1").sql()
2424            'JOIN x ON y = 1'
2425
2426        Args:
2427            *expressions: the SQL code strings to parse.
2428                If an `Expression` instance is passed, it will be used as-is.
2429                Multiple expressions are combined with an AND operator.
2430            append: if `True`, AND the new expressions to any existing expression.
2431                Otherwise, this resets the expression.
2432            dialect: the dialect used to parse the input expressions.
2433            copy: if `False`, modify this expression instance in-place.
2434            opts: other options to use to parse the input expressions.
2435
2436        Returns:
2437            The modified Join expression.
2438        """
2439        join = _apply_conjunction_builder(
2440            *expressions,
2441            instance=self,
2442            arg="on",
2443            append=append,
2444            dialect=dialect,
2445            copy=copy,
2446            **opts,
2447        )
2448
2449        if join.kind == "CROSS":
2450            join.set("kind", None)
2451
2452        return join

Append to or set the ON expressions.

Example:
>>> import sqlglot
>>> sqlglot.parse_one("JOIN x", into=Join).on("y = 1").sql()
'JOIN x ON y = 1'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is. Multiple expressions are combined with an AND operator.
  • append: if True, AND the new expressions to any existing expression. Otherwise, this resets the expression.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Join expression.

def using( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Join:
2454    def using(
2455        self,
2456        *expressions: t.Optional[ExpOrStr],
2457        append: bool = True,
2458        dialect: DialectType = None,
2459        copy: bool = True,
2460        **opts,
2461    ) -> Join:
2462        """
2463        Append to or set the USING expressions.
2464
2465        Example:
2466            >>> import sqlglot
2467            >>> sqlglot.parse_one("JOIN x", into=Join).using("foo", "bla").sql()
2468            'JOIN x USING (foo, bla)'
2469
2470        Args:
2471            *expressions: the SQL code strings to parse.
2472                If an `Expression` instance is passed, it will be used as-is.
2473            append: if `True`, concatenate the new expressions to the existing "using" list.
2474                Otherwise, this resets the expression.
2475            dialect: the dialect used to parse the input expressions.
2476            copy: if `False`, modify this expression instance in-place.
2477            opts: other options to use to parse the input expressions.
2478
2479        Returns:
2480            The modified Join expression.
2481        """
2482        join = _apply_list_builder(
2483            *expressions,
2484            instance=self,
2485            arg="using",
2486            append=append,
2487            dialect=dialect,
2488            copy=copy,
2489            **opts,
2490        )
2491
2492        if join.kind == "CROSS":
2493            join.set("kind", None)
2494
2495        return join

Append to or set the USING expressions.

Example:
>>> import sqlglot
>>> sqlglot.parse_one("JOIN x", into=Join).using("foo", "bla").sql()
'JOIN x USING (foo, bla)'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, concatenate the new expressions to the existing "using" list. Otherwise, this resets the expression.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Join expression.

key = 'join'
class Lateral(UDTF):
2498class Lateral(UDTF):
2499    arg_types = {
2500        "this": True,
2501        "view": False,
2502        "outer": False,
2503        "alias": False,
2504        "cross_apply": False,  # True -> CROSS APPLY, False -> OUTER APPLY
2505    }
arg_types = {'this': True, 'view': False, 'outer': False, 'alias': False, 'cross_apply': False}
key = 'lateral'
class MatchRecognizeMeasure(Expression):
2508class MatchRecognizeMeasure(Expression):
2509    arg_types = {
2510        "this": True,
2511        "window_frame": False,
2512    }
arg_types = {'this': True, 'window_frame': False}
key = 'matchrecognizemeasure'
class MatchRecognize(Expression):
2515class MatchRecognize(Expression):
2516    arg_types = {
2517        "partition_by": False,
2518        "order": False,
2519        "measures": False,
2520        "rows": False,
2521        "after": False,
2522        "pattern": False,
2523        "define": False,
2524        "alias": False,
2525    }
arg_types = {'partition_by': False, 'order': False, 'measures': False, 'rows': False, 'after': False, 'pattern': False, 'define': False, 'alias': False}
key = 'matchrecognize'
class Final(Expression):
2530class Final(Expression):
2531    pass
key = 'final'
class Offset(Expression):
2534class Offset(Expression):
2535    arg_types = {"this": False, "expression": True, "expressions": False}
arg_types = {'this': False, 'expression': True, 'expressions': False}
key = 'offset'
class Order(Expression):
2538class Order(Expression):
2539    arg_types = {"this": False, "expressions": True, "siblings": False}
arg_types = {'this': False, 'expressions': True, 'siblings': False}
key = 'order'
class WithFill(Expression):
2543class WithFill(Expression):
2544    arg_types = {
2545        "from": False,
2546        "to": False,
2547        "step": False,
2548        "interpolate": False,
2549    }
arg_types = {'from': False, 'to': False, 'step': False, 'interpolate': False}
key = 'withfill'
class Cluster(Order):
2554class Cluster(Order):
2555    pass
key = 'cluster'
class Distribute(Order):
2558class Distribute(Order):
2559    pass
key = 'distribute'
class Sort(Order):
2562class Sort(Order):
2563    pass
key = 'sort'
class Ordered(Expression):
2566class Ordered(Expression):
2567    arg_types = {"this": True, "desc": False, "nulls_first": True, "with_fill": False}
arg_types = {'this': True, 'desc': False, 'nulls_first': True, 'with_fill': False}
key = 'ordered'
class Property(Expression):
2570class Property(Expression):
2571    arg_types = {"this": True, "value": True}
arg_types = {'this': True, 'value': True}
key = 'property'
class AllowedValuesProperty(Expression):
2574class AllowedValuesProperty(Expression):
2575    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'allowedvaluesproperty'
class AlgorithmProperty(Property):
2578class AlgorithmProperty(Property):
2579    arg_types = {"this": True}
arg_types = {'this': True}
key = 'algorithmproperty'
class AutoIncrementProperty(Property):
2582class AutoIncrementProperty(Property):
2583    arg_types = {"this": True}
arg_types = {'this': True}
key = 'autoincrementproperty'
class AutoRefreshProperty(Property):
2587class AutoRefreshProperty(Property):
2588    arg_types = {"this": True}
arg_types = {'this': True}
key = 'autorefreshproperty'
class BackupProperty(Property):
2591class BackupProperty(Property):
2592    arg_types = {"this": True}
arg_types = {'this': True}
key = 'backupproperty'
class BlockCompressionProperty(Property):
2595class BlockCompressionProperty(Property):
2596    arg_types = {
2597        "autotemp": False,
2598        "always": False,
2599        "default": False,
2600        "manual": False,
2601        "never": False,
2602    }
arg_types = {'autotemp': False, 'always': False, 'default': False, 'manual': False, 'never': False}
key = 'blockcompressionproperty'
class CharacterSetProperty(Property):
2605class CharacterSetProperty(Property):
2606    arg_types = {"this": True, "default": True}
arg_types = {'this': True, 'default': True}
key = 'charactersetproperty'
class ChecksumProperty(Property):
2609class ChecksumProperty(Property):
2610    arg_types = {"on": False, "default": False}
arg_types = {'on': False, 'default': False}
key = 'checksumproperty'
class CollateProperty(Property):
2613class CollateProperty(Property):
2614    arg_types = {"this": True, "default": False}
arg_types = {'this': True, 'default': False}
key = 'collateproperty'
class CopyGrantsProperty(Property):
2617class CopyGrantsProperty(Property):
2618    arg_types = {}
arg_types = {}
key = 'copygrantsproperty'
class DataBlocksizeProperty(Property):
2621class DataBlocksizeProperty(Property):
2622    arg_types = {
2623        "size": False,
2624        "units": False,
2625        "minimum": False,
2626        "maximum": False,
2627        "default": False,
2628    }
arg_types = {'size': False, 'units': False, 'minimum': False, 'maximum': False, 'default': False}
key = 'datablocksizeproperty'
class DataDeletionProperty(Property):
2631class DataDeletionProperty(Property):
2632    arg_types = {"on": True, "filter_col": False, "retention_period": False}
arg_types = {'on': True, 'filter_col': False, 'retention_period': False}
key = 'datadeletionproperty'
class DefinerProperty(Property):
2635class DefinerProperty(Property):
2636    arg_types = {"this": True}
arg_types = {'this': True}
key = 'definerproperty'
class DistKeyProperty(Property):
2639class DistKeyProperty(Property):
2640    arg_types = {"this": True}
arg_types = {'this': True}
key = 'distkeyproperty'
class DistributedByProperty(Property):
2645class DistributedByProperty(Property):
2646    arg_types = {"expressions": False, "kind": True, "buckets": False, "order": False}
arg_types = {'expressions': False, 'kind': True, 'buckets': False, 'order': False}
key = 'distributedbyproperty'
class DistStyleProperty(Property):
2649class DistStyleProperty(Property):
2650    arg_types = {"this": True}
arg_types = {'this': True}
key = 'diststyleproperty'
class DuplicateKeyProperty(Property):
2653class DuplicateKeyProperty(Property):
2654    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'duplicatekeyproperty'
class EngineProperty(Property):
2657class EngineProperty(Property):
2658    arg_types = {"this": True}
arg_types = {'this': True}
key = 'engineproperty'
class HeapProperty(Property):
2661class HeapProperty(Property):
2662    arg_types = {}
arg_types = {}
key = 'heapproperty'
class ToTableProperty(Property):
2665class ToTableProperty(Property):
2666    arg_types = {"this": True}
arg_types = {'this': True}
key = 'totableproperty'
class ExecuteAsProperty(Property):
2669class ExecuteAsProperty(Property):
2670    arg_types = {"this": True}
arg_types = {'this': True}
key = 'executeasproperty'
class ExternalProperty(Property):
2673class ExternalProperty(Property):
2674    arg_types = {"this": False}
arg_types = {'this': False}
key = 'externalproperty'
class FallbackProperty(Property):
2677class FallbackProperty(Property):
2678    arg_types = {"no": True, "protection": False}
arg_types = {'no': True, 'protection': False}
key = 'fallbackproperty'
class FileFormatProperty(Property):
2681class FileFormatProperty(Property):
2682    arg_types = {"this": True}
arg_types = {'this': True}
key = 'fileformatproperty'
class FreespaceProperty(Property):
2685class FreespaceProperty(Property):
2686    arg_types = {"this": True, "percent": False}
arg_types = {'this': True, 'percent': False}
key = 'freespaceproperty'
class GlobalProperty(Property):
2689class GlobalProperty(Property):
2690    arg_types = {}
arg_types = {}
key = 'globalproperty'
class IcebergProperty(Property):
2693class IcebergProperty(Property):
2694    arg_types = {}
arg_types = {}
key = 'icebergproperty'
class InheritsProperty(Property):
2697class InheritsProperty(Property):
2698    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'inheritsproperty'
class InputModelProperty(Property):
2701class InputModelProperty(Property):
2702    arg_types = {"this": True}
arg_types = {'this': True}
key = 'inputmodelproperty'
class OutputModelProperty(Property):
2705class OutputModelProperty(Property):
2706    arg_types = {"this": True}
arg_types = {'this': True}
key = 'outputmodelproperty'
class IsolatedLoadingProperty(Property):
2709class IsolatedLoadingProperty(Property):
2710    arg_types = {"no": False, "concurrent": False, "target": False}
arg_types = {'no': False, 'concurrent': False, 'target': False}
key = 'isolatedloadingproperty'
class JournalProperty(Property):
2713class JournalProperty(Property):
2714    arg_types = {
2715        "no": False,
2716        "dual": False,
2717        "before": False,
2718        "local": False,
2719        "after": False,
2720    }
arg_types = {'no': False, 'dual': False, 'before': False, 'local': False, 'after': False}
key = 'journalproperty'
class LanguageProperty(Property):
2723class LanguageProperty(Property):
2724    arg_types = {"this": True}
arg_types = {'this': True}
key = 'languageproperty'
class ClusteredByProperty(Property):
2728class ClusteredByProperty(Property):
2729    arg_types = {"expressions": True, "sorted_by": False, "buckets": True}
arg_types = {'expressions': True, 'sorted_by': False, 'buckets': True}
key = 'clusteredbyproperty'
class DictProperty(Property):
2732class DictProperty(Property):
2733    arg_types = {"this": True, "kind": True, "settings": False}
arg_types = {'this': True, 'kind': True, 'settings': False}
key = 'dictproperty'
class DictSubProperty(Property):
2736class DictSubProperty(Property):
2737    pass
key = 'dictsubproperty'
class DictRange(Property):
2740class DictRange(Property):
2741    arg_types = {"this": True, "min": True, "max": True}
arg_types = {'this': True, 'min': True, 'max': True}
key = 'dictrange'
class DynamicProperty(Property):
2744class DynamicProperty(Property):
2745    arg_types = {}
arg_types = {}
key = 'dynamicproperty'
class OnCluster(Property):
2750class OnCluster(Property):
2751    arg_types = {"this": True}
arg_types = {'this': True}
key = 'oncluster'
class EmptyProperty(Property):
2755class EmptyProperty(Property):
2756    arg_types = {}
arg_types = {}
key = 'emptyproperty'
class LikeProperty(Property):
2759class LikeProperty(Property):
2760    arg_types = {"this": True, "expressions": False}
arg_types = {'this': True, 'expressions': False}
key = 'likeproperty'
class LocationProperty(Property):
2763class LocationProperty(Property):
2764    arg_types = {"this": True}
arg_types = {'this': True}
key = 'locationproperty'
class LockProperty(Property):
2767class LockProperty(Property):
2768    arg_types = {"this": True}
arg_types = {'this': True}
key = 'lockproperty'
class LockingProperty(Property):
2771class LockingProperty(Property):
2772    arg_types = {
2773        "this": False,
2774        "kind": True,
2775        "for_or_in": False,
2776        "lock_type": True,
2777        "override": False,
2778    }
arg_types = {'this': False, 'kind': True, 'for_or_in': False, 'lock_type': True, 'override': False}
key = 'lockingproperty'
class LogProperty(Property):
2781class LogProperty(Property):
2782    arg_types = {"no": True}
arg_types = {'no': True}
key = 'logproperty'
class MaterializedProperty(Property):
2785class MaterializedProperty(Property):
2786    arg_types = {"this": False}
arg_types = {'this': False}
key = 'materializedproperty'
class MergeBlockRatioProperty(Property):
2789class MergeBlockRatioProperty(Property):
2790    arg_types = {"this": False, "no": False, "default": False, "percent": False}
arg_types = {'this': False, 'no': False, 'default': False, 'percent': False}
key = 'mergeblockratioproperty'
class NoPrimaryIndexProperty(Property):
2793class NoPrimaryIndexProperty(Property):
2794    arg_types = {}
arg_types = {}
key = 'noprimaryindexproperty'
class OnProperty(Property):
2797class OnProperty(Property):
2798    arg_types = {"this": True}
arg_types = {'this': True}
key = 'onproperty'
class OnCommitProperty(Property):
2801class OnCommitProperty(Property):
2802    arg_types = {"delete": False}
arg_types = {'delete': False}
key = 'oncommitproperty'
class PartitionedByProperty(Property):
2805class PartitionedByProperty(Property):
2806    arg_types = {"this": True}
arg_types = {'this': True}
key = 'partitionedbyproperty'
class PartitionBoundSpec(Expression):
2810class PartitionBoundSpec(Expression):
2811    # this -> IN / MODULUS, expression -> REMAINDER, from_expressions -> FROM (...), to_expressions -> TO (...)
2812    arg_types = {
2813        "this": False,
2814        "expression": False,
2815        "from_expressions": False,
2816        "to_expressions": False,
2817    }
arg_types = {'this': False, 'expression': False, 'from_expressions': False, 'to_expressions': False}
key = 'partitionboundspec'
class PartitionedOfProperty(Property):
2820class PartitionedOfProperty(Property):
2821    # this -> parent_table (schema), expression -> FOR VALUES ... / DEFAULT
2822    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'partitionedofproperty'
class StreamingTableProperty(Property):
2825class StreamingTableProperty(Property):
2826    arg_types = {}
arg_types = {}
key = 'streamingtableproperty'
class RemoteWithConnectionModelProperty(Property):
2829class RemoteWithConnectionModelProperty(Property):
2830    arg_types = {"this": True}
arg_types = {'this': True}
key = 'remotewithconnectionmodelproperty'
class ReturnsProperty(Property):
2833class ReturnsProperty(Property):
2834    arg_types = {"this": False, "is_table": False, "table": False, "null": False}
arg_types = {'this': False, 'is_table': False, 'table': False, 'null': False}
key = 'returnsproperty'
class StrictProperty(Property):
2837class StrictProperty(Property):
2838    arg_types = {}
arg_types = {}
key = 'strictproperty'
class RowFormatProperty(Property):
2841class RowFormatProperty(Property):
2842    arg_types = {"this": True}
arg_types = {'this': True}
key = 'rowformatproperty'
class RowFormatDelimitedProperty(Property):
2845class RowFormatDelimitedProperty(Property):
2846    # https://cwiki.apache.org/confluence/display/hive/languagemanual+dml
2847    arg_types = {
2848        "fields": False,
2849        "escaped": False,
2850        "collection_items": False,
2851        "map_keys": False,
2852        "lines": False,
2853        "null": False,
2854        "serde": False,
2855    }
arg_types = {'fields': False, 'escaped': False, 'collection_items': False, 'map_keys': False, 'lines': False, 'null': False, 'serde': False}
key = 'rowformatdelimitedproperty'
class RowFormatSerdeProperty(Property):
2858class RowFormatSerdeProperty(Property):
2859    arg_types = {"this": True, "serde_properties": False}
arg_types = {'this': True, 'serde_properties': False}
key = 'rowformatserdeproperty'
class QueryTransform(Expression):
2863class QueryTransform(Expression):
2864    arg_types = {
2865        "expressions": True,
2866        "command_script": True,
2867        "schema": False,
2868        "row_format_before": False,
2869        "record_writer": False,
2870        "row_format_after": False,
2871        "record_reader": False,
2872    }
arg_types = {'expressions': True, 'command_script': True, 'schema': False, 'row_format_before': False, 'record_writer': False, 'row_format_after': False, 'record_reader': False}
key = 'querytransform'
class SampleProperty(Property):
2875class SampleProperty(Property):
2876    arg_types = {"this": True}
arg_types = {'this': True}
key = 'sampleproperty'
class SecurityProperty(Property):
2880class SecurityProperty(Property):
2881    arg_types = {"this": True}
arg_types = {'this': True}
key = 'securityproperty'
class SchemaCommentProperty(Property):
2884class SchemaCommentProperty(Property):
2885    arg_types = {"this": True}
arg_types = {'this': True}
key = 'schemacommentproperty'
class SerdeProperties(Property):
2888class SerdeProperties(Property):
2889    arg_types = {"expressions": True, "with": False}
arg_types = {'expressions': True, 'with': False}
key = 'serdeproperties'
class SetProperty(Property):
2892class SetProperty(Property):
2893    arg_types = {"multi": True}
arg_types = {'multi': True}
key = 'setproperty'
class SharingProperty(Property):
2896class SharingProperty(Property):
2897    arg_types = {"this": False}
arg_types = {'this': False}
key = 'sharingproperty'
class SetConfigProperty(Property):
2900class SetConfigProperty(Property):
2901    arg_types = {"this": True}
arg_types = {'this': True}
key = 'setconfigproperty'
class SettingsProperty(Property):
2904class SettingsProperty(Property):
2905    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'settingsproperty'
class SortKeyProperty(Property):
2908class SortKeyProperty(Property):
2909    arg_types = {"this": True, "compound": False}
arg_types = {'this': True, 'compound': False}
key = 'sortkeyproperty'
class SqlReadWriteProperty(Property):
2912class SqlReadWriteProperty(Property):
2913    arg_types = {"this": True}
arg_types = {'this': True}
key = 'sqlreadwriteproperty'
class SqlSecurityProperty(Property):
2916class SqlSecurityProperty(Property):
2917    arg_types = {"definer": True}
arg_types = {'definer': True}
key = 'sqlsecurityproperty'
class StabilityProperty(Property):
2920class StabilityProperty(Property):
2921    arg_types = {"this": True}
arg_types = {'this': True}
key = 'stabilityproperty'
class TemporaryProperty(Property):
2924class TemporaryProperty(Property):
2925    arg_types = {"this": False}
arg_types = {'this': False}
key = 'temporaryproperty'
class SecureProperty(Property):
2928class SecureProperty(Property):
2929    arg_types = {}
arg_types = {}
key = 'secureproperty'
class TransformModelProperty(Property):
2932class TransformModelProperty(Property):
2933    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'transformmodelproperty'
class TransientProperty(Property):
2936class TransientProperty(Property):
2937    arg_types = {"this": False}
arg_types = {'this': False}
key = 'transientproperty'
class UnloggedProperty(Property):
2940class UnloggedProperty(Property):
2941    arg_types = {}
arg_types = {}
key = 'unloggedproperty'
class ViewAttributeProperty(Property):
2945class ViewAttributeProperty(Property):
2946    arg_types = {"this": True}
arg_types = {'this': True}
key = 'viewattributeproperty'
class VolatileProperty(Property):
2949class VolatileProperty(Property):
2950    arg_types = {"this": False}
arg_types = {'this': False}
key = 'volatileproperty'
class WithDataProperty(Property):
2953class WithDataProperty(Property):
2954    arg_types = {"no": True, "statistics": False}
arg_types = {'no': True, 'statistics': False}
key = 'withdataproperty'
class WithJournalTableProperty(Property):
2957class WithJournalTableProperty(Property):
2958    arg_types = {"this": True}
arg_types = {'this': True}
key = 'withjournaltableproperty'
class WithSchemaBindingProperty(Property):
2961class WithSchemaBindingProperty(Property):
2962    arg_types = {"this": True}
arg_types = {'this': True}
key = 'withschemabindingproperty'
class WithSystemVersioningProperty(Property):
2965class WithSystemVersioningProperty(Property):
2966    arg_types = {
2967        "on": False,
2968        "this": False,
2969        "data_consistency": False,
2970        "retention_period": False,
2971        "with": True,
2972    }
arg_types = {'on': False, 'this': False, 'data_consistency': False, 'retention_period': False, 'with': True}
key = 'withsystemversioningproperty'
class Properties(Expression):
2975class Properties(Expression):
2976    arg_types = {"expressions": True}
2977
2978    NAME_TO_PROPERTY = {
2979        "ALGORITHM": AlgorithmProperty,
2980        "AUTO_INCREMENT": AutoIncrementProperty,
2981        "CHARACTER SET": CharacterSetProperty,
2982        "CLUSTERED_BY": ClusteredByProperty,
2983        "COLLATE": CollateProperty,
2984        "COMMENT": SchemaCommentProperty,
2985        "DEFINER": DefinerProperty,
2986        "DISTKEY": DistKeyProperty,
2987        "DISTRIBUTED_BY": DistributedByProperty,
2988        "DISTSTYLE": DistStyleProperty,
2989        "ENGINE": EngineProperty,
2990        "EXECUTE AS": ExecuteAsProperty,
2991        "FORMAT": FileFormatProperty,
2992        "LANGUAGE": LanguageProperty,
2993        "LOCATION": LocationProperty,
2994        "LOCK": LockProperty,
2995        "PARTITIONED_BY": PartitionedByProperty,
2996        "RETURNS": ReturnsProperty,
2997        "ROW_FORMAT": RowFormatProperty,
2998        "SORTKEY": SortKeyProperty,
2999    }
3000
3001    PROPERTY_TO_NAME = {v: k for k, v in NAME_TO_PROPERTY.items()}
3002
3003    # CREATE property locations
3004    # Form: schema specified
3005    #   create [POST_CREATE]
3006    #     table a [POST_NAME]
3007    #     (b int) [POST_SCHEMA]
3008    #     with ([POST_WITH])
3009    #     index (b) [POST_INDEX]
3010    #
3011    # Form: alias selection
3012    #   create [POST_CREATE]
3013    #     table a [POST_NAME]
3014    #     as [POST_ALIAS] (select * from b) [POST_EXPRESSION]
3015    #     index (c) [POST_INDEX]
3016    class Location(AutoName):
3017        POST_CREATE = auto()
3018        POST_NAME = auto()
3019        POST_SCHEMA = auto()
3020        POST_WITH = auto()
3021        POST_ALIAS = auto()
3022        POST_EXPRESSION = auto()
3023        POST_INDEX = auto()
3024        UNSUPPORTED = auto()
3025
3026    @classmethod
3027    def from_dict(cls, properties_dict: t.Dict) -> Properties:
3028        expressions = []
3029        for key, value in properties_dict.items():
3030            property_cls = cls.NAME_TO_PROPERTY.get(key.upper())
3031            if property_cls:
3032                expressions.append(property_cls(this=convert(value)))
3033            else:
3034                expressions.append(Property(this=Literal.string(key), value=convert(value)))
3035
3036        return cls(expressions=expressions)
arg_types = {'expressions': True}
NAME_TO_PROPERTY = {'ALGORITHM': <class 'AlgorithmProperty'>, 'AUTO_INCREMENT': <class 'AutoIncrementProperty'>, 'CHARACTER SET': <class 'CharacterSetProperty'>, 'CLUSTERED_BY': <class 'ClusteredByProperty'>, 'COLLATE': <class 'CollateProperty'>, 'COMMENT': <class 'SchemaCommentProperty'>, 'DEFINER': <class 'DefinerProperty'>, 'DISTKEY': <class 'DistKeyProperty'>, 'DISTRIBUTED_BY': <class 'DistributedByProperty'>, 'DISTSTYLE': <class 'DistStyleProperty'>, 'ENGINE': <class 'EngineProperty'>, 'EXECUTE AS': <class 'ExecuteAsProperty'>, 'FORMAT': <class 'FileFormatProperty'>, 'LANGUAGE': <class 'LanguageProperty'>, 'LOCATION': <class 'LocationProperty'>, 'LOCK': <class 'LockProperty'>, 'PARTITIONED_BY': <class 'PartitionedByProperty'>, 'RETURNS': <class 'ReturnsProperty'>, 'ROW_FORMAT': <class 'RowFormatProperty'>, 'SORTKEY': <class 'SortKeyProperty'>}
PROPERTY_TO_NAME = {<class 'AlgorithmProperty'>: 'ALGORITHM', <class 'AutoIncrementProperty'>: 'AUTO_INCREMENT', <class 'CharacterSetProperty'>: 'CHARACTER SET', <class 'ClusteredByProperty'>: 'CLUSTERED_BY', <class 'CollateProperty'>: 'COLLATE', <class 'SchemaCommentProperty'>: 'COMMENT', <class 'DefinerProperty'>: 'DEFINER', <class 'DistKeyProperty'>: 'DISTKEY', <class 'DistributedByProperty'>: 'DISTRIBUTED_BY', <class 'DistStyleProperty'>: 'DISTSTYLE', <class 'EngineProperty'>: 'ENGINE', <class 'ExecuteAsProperty'>: 'EXECUTE AS', <class 'FileFormatProperty'>: 'FORMAT', <class 'LanguageProperty'>: 'LANGUAGE', <class 'LocationProperty'>: 'LOCATION', <class 'LockProperty'>: 'LOCK', <class 'PartitionedByProperty'>: 'PARTITIONED_BY', <class 'ReturnsProperty'>: 'RETURNS', <class 'RowFormatProperty'>: 'ROW_FORMAT', <class 'SortKeyProperty'>: 'SORTKEY'}
@classmethod
def from_dict(cls, properties_dict: Dict) -> Properties:
3026    @classmethod
3027    def from_dict(cls, properties_dict: t.Dict) -> Properties:
3028        expressions = []
3029        for key, value in properties_dict.items():
3030            property_cls = cls.NAME_TO_PROPERTY.get(key.upper())
3031            if property_cls:
3032                expressions.append(property_cls(this=convert(value)))
3033            else:
3034                expressions.append(Property(this=Literal.string(key), value=convert(value)))
3035
3036        return cls(expressions=expressions)
key = 'properties'
class Properties.Location(sqlglot.helper.AutoName):
3016    class Location(AutoName):
3017        POST_CREATE = auto()
3018        POST_NAME = auto()
3019        POST_SCHEMA = auto()
3020        POST_WITH = auto()
3021        POST_ALIAS = auto()
3022        POST_EXPRESSION = auto()
3023        POST_INDEX = auto()
3024        UNSUPPORTED = auto()

An enumeration.

POST_CREATE = <Location.POST_CREATE: 'POST_CREATE'>
POST_NAME = <Location.POST_NAME: 'POST_NAME'>
POST_SCHEMA = <Location.POST_SCHEMA: 'POST_SCHEMA'>
POST_WITH = <Location.POST_WITH: 'POST_WITH'>
POST_ALIAS = <Location.POST_ALIAS: 'POST_ALIAS'>
POST_EXPRESSION = <Location.POST_EXPRESSION: 'POST_EXPRESSION'>
POST_INDEX = <Location.POST_INDEX: 'POST_INDEX'>
UNSUPPORTED = <Location.UNSUPPORTED: 'UNSUPPORTED'>
Inherited Members
enum.Enum
name
value
class Qualify(Expression):
3039class Qualify(Expression):
3040    pass
key = 'qualify'
class InputOutputFormat(Expression):
3043class InputOutputFormat(Expression):
3044    arg_types = {"input_format": False, "output_format": False}
arg_types = {'input_format': False, 'output_format': False}
key = 'inputoutputformat'
class Return(Expression):
3048class Return(Expression):
3049    pass
key = 'return'
class Reference(Expression):
3052class Reference(Expression):
3053    arg_types = {"this": True, "expressions": False, "options": False}
arg_types = {'this': True, 'expressions': False, 'options': False}
key = 'reference'
class Tuple(Expression):
3056class Tuple(Expression):
3057    arg_types = {"expressions": False}
3058
3059    def isin(
3060        self,
3061        *expressions: t.Any,
3062        query: t.Optional[ExpOrStr] = None,
3063        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
3064        copy: bool = True,
3065        **opts,
3066    ) -> In:
3067        return In(
3068            this=maybe_copy(self, copy),
3069            expressions=[convert(e, copy=copy) for e in expressions],
3070            query=maybe_parse(query, copy=copy, **opts) if query else None,
3071            unnest=(
3072                Unnest(
3073                    expressions=[
3074                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
3075                        for e in ensure_list(unnest)
3076                    ]
3077                )
3078                if unnest
3079                else None
3080            ),
3081        )
arg_types = {'expressions': False}
def isin( self, *expressions: Any, query: Union[str, Expression, NoneType] = None, unnest: Union[str, Expression, NoneType, Collection[Union[str, Expression]]] = None, copy: bool = True, **opts) -> In:
3059    def isin(
3060        self,
3061        *expressions: t.Any,
3062        query: t.Optional[ExpOrStr] = None,
3063        unnest: t.Optional[ExpOrStr] | t.Collection[ExpOrStr] = None,
3064        copy: bool = True,
3065        **opts,
3066    ) -> In:
3067        return In(
3068            this=maybe_copy(self, copy),
3069            expressions=[convert(e, copy=copy) for e in expressions],
3070            query=maybe_parse(query, copy=copy, **opts) if query else None,
3071            unnest=(
3072                Unnest(
3073                    expressions=[
3074                        maybe_parse(t.cast(ExpOrStr, e), copy=copy, **opts)
3075                        for e in ensure_list(unnest)
3076                    ]
3077                )
3078                if unnest
3079                else None
3080            ),
3081        )
key = 'tuple'
QUERY_MODIFIERS = {'match': False, 'laterals': False, 'joins': False, 'connect': False, 'pivots': False, 'prewhere': False, 'where': False, 'group': False, 'having': False, 'qualify': False, 'windows': False, 'distribute': False, 'sort': False, 'cluster': False, 'order': False, 'limit': False, 'offset': False, 'locks': False, 'sample': False, 'settings': False, 'format': False, 'options': False}
class QueryOption(Expression):
3112class QueryOption(Expression):
3113    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'queryoption'
class WithTableHint(Expression):
3117class WithTableHint(Expression):
3118    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'withtablehint'
class IndexTableHint(Expression):
3122class IndexTableHint(Expression):
3123    arg_types = {"this": True, "expressions": False, "target": False}
arg_types = {'this': True, 'expressions': False, 'target': False}
key = 'indextablehint'
class HistoricalData(Expression):
3127class HistoricalData(Expression):
3128    arg_types = {"this": True, "kind": True, "expression": True}
arg_types = {'this': True, 'kind': True, 'expression': True}
key = 'historicaldata'
class Table(Expression):
3131class Table(Expression):
3132    arg_types = {
3133        "this": False,
3134        "alias": False,
3135        "db": False,
3136        "catalog": False,
3137        "laterals": False,
3138        "joins": False,
3139        "pivots": False,
3140        "hints": False,
3141        "system_time": False,
3142        "version": False,
3143        "format": False,
3144        "pattern": False,
3145        "ordinality": False,
3146        "when": False,
3147        "only": False,
3148        "partition": False,
3149        "changes": False,
3150        "rows_from": False,
3151        "sample": False,
3152    }
3153
3154    @property
3155    def name(self) -> str:
3156        if isinstance(self.this, Func):
3157            return ""
3158        return self.this.name
3159
3160    @property
3161    def db(self) -> str:
3162        return self.text("db")
3163
3164    @property
3165    def catalog(self) -> str:
3166        return self.text("catalog")
3167
3168    @property
3169    def selects(self) -> t.List[Expression]:
3170        return []
3171
3172    @property
3173    def named_selects(self) -> t.List[str]:
3174        return []
3175
3176    @property
3177    def parts(self) -> t.List[Expression]:
3178        """Return the parts of a table in order catalog, db, table."""
3179        parts: t.List[Expression] = []
3180
3181        for arg in ("catalog", "db", "this"):
3182            part = self.args.get(arg)
3183
3184            if isinstance(part, Dot):
3185                parts.extend(part.flatten())
3186            elif isinstance(part, Expression):
3187                parts.append(part)
3188
3189        return parts
3190
3191    def to_column(self, copy: bool = True) -> Alias | Column | Dot:
3192        parts = self.parts
3193        col = column(*reversed(parts[0:4]), fields=parts[4:], copy=copy)  # type: ignore
3194        alias = self.args.get("alias")
3195        if alias:
3196            col = alias_(col, alias.this, copy=copy)
3197        return col
arg_types = {'this': False, 'alias': False, 'db': False, 'catalog': False, 'laterals': False, 'joins': False, 'pivots': False, 'hints': False, 'system_time': False, 'version': False, 'format': False, 'pattern': False, 'ordinality': False, 'when': False, 'only': False, 'partition': False, 'changes': False, 'rows_from': False, 'sample': False}
name: str
3154    @property
3155    def name(self) -> str:
3156        if isinstance(self.this, Func):
3157            return ""
3158        return self.this.name
db: str
3160    @property
3161    def db(self) -> str:
3162        return self.text("db")
catalog: str
3164    @property
3165    def catalog(self) -> str:
3166        return self.text("catalog")
selects: List[Expression]
3168    @property
3169    def selects(self) -> t.List[Expression]:
3170        return []
named_selects: List[str]
3172    @property
3173    def named_selects(self) -> t.List[str]:
3174        return []
parts: List[Expression]
3176    @property
3177    def parts(self) -> t.List[Expression]:
3178        """Return the parts of a table in order catalog, db, table."""
3179        parts: t.List[Expression] = []
3180
3181        for arg in ("catalog", "db", "this"):
3182            part = self.args.get(arg)
3183
3184            if isinstance(part, Dot):
3185                parts.extend(part.flatten())
3186            elif isinstance(part, Expression):
3187                parts.append(part)
3188
3189        return parts

Return the parts of a table in order catalog, db, table.

def to_column( self, copy: bool = True) -> Alias | Column | Dot:
3191    def to_column(self, copy: bool = True) -> Alias | Column | Dot:
3192        parts = self.parts
3193        col = column(*reversed(parts[0:4]), fields=parts[4:], copy=copy)  # type: ignore
3194        alias = self.args.get("alias")
3195        if alias:
3196            col = alias_(col, alias.this, copy=copy)
3197        return col
key = 'table'
class SetOperation(Query):
3200class SetOperation(Query):
3201    arg_types = {
3202        "with": False,
3203        "this": True,
3204        "expression": True,
3205        "distinct": False,
3206        "by_name": False,
3207        **QUERY_MODIFIERS,
3208    }
3209
3210    def select(
3211        self: S,
3212        *expressions: t.Optional[ExpOrStr],
3213        append: bool = True,
3214        dialect: DialectType = None,
3215        copy: bool = True,
3216        **opts,
3217    ) -> S:
3218        this = maybe_copy(self, copy)
3219        this.this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3220        this.expression.unnest().select(
3221            *expressions, append=append, dialect=dialect, copy=False, **opts
3222        )
3223        return this
3224
3225    @property
3226    def named_selects(self) -> t.List[str]:
3227        return self.this.unnest().named_selects
3228
3229    @property
3230    def is_star(self) -> bool:
3231        return self.this.is_star or self.expression.is_star
3232
3233    @property
3234    def selects(self) -> t.List[Expression]:
3235        return self.this.unnest().selects
3236
3237    @property
3238    def left(self) -> Query:
3239        return self.this
3240
3241    @property
3242    def right(self) -> Query:
3243        return self.expression
arg_types = {'with': False, 'this': True, 'expression': True, 'distinct': False, 'by_name': False, 'match': False, 'laterals': False, 'joins': False, 'connect': False, 'pivots': False, 'prewhere': False, 'where': False, 'group': False, 'having': False, 'qualify': False, 'windows': False, 'distribute': False, 'sort': False, 'cluster': False, 'order': False, 'limit': False, 'offset': False, 'locks': False, 'sample': False, 'settings': False, 'format': False, 'options': False}
def select( self: ~S, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> ~S:
3210    def select(
3211        self: S,
3212        *expressions: t.Optional[ExpOrStr],
3213        append: bool = True,
3214        dialect: DialectType = None,
3215        copy: bool = True,
3216        **opts,
3217    ) -> S:
3218        this = maybe_copy(self, copy)
3219        this.this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3220        this.expression.unnest().select(
3221            *expressions, append=append, dialect=dialect, copy=False, **opts
3222        )
3223        return this

Append to or set the SELECT expressions.

Example:
>>> Select().select("x", "y").sql()
'SELECT x, y'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Query expression.

named_selects: List[str]
3225    @property
3226    def named_selects(self) -> t.List[str]:
3227        return self.this.unnest().named_selects

Returns the output names of the query's projections.

is_star: bool
3229    @property
3230    def is_star(self) -> bool:
3231        return self.this.is_star or self.expression.is_star

Checks whether an expression is a star.

selects: List[Expression]
3233    @property
3234    def selects(self) -> t.List[Expression]:
3235        return self.this.unnest().selects

Returns the query's projections.

left: Query
3237    @property
3238    def left(self) -> Query:
3239        return self.this
right: Query
3241    @property
3242    def right(self) -> Query:
3243        return self.expression
key = 'setoperation'
class Union(SetOperation):
3246class Union(SetOperation):
3247    pass
key = 'union'
class Except(SetOperation):
3250class Except(SetOperation):
3251    pass
key = 'except'
class Intersect(SetOperation):
3254class Intersect(SetOperation):
3255    pass
key = 'intersect'
class Update(Expression):
3258class Update(Expression):
3259    arg_types = {
3260        "with": False,
3261        "this": False,
3262        "expressions": True,
3263        "from": False,
3264        "where": False,
3265        "returning": False,
3266        "order": False,
3267        "limit": False,
3268    }
arg_types = {'with': False, 'this': False, 'expressions': True, 'from': False, 'where': False, 'returning': False, 'order': False, 'limit': False}
key = 'update'
class Values(UDTF):
3271class Values(UDTF):
3272    arg_types = {"expressions": True, "alias": False}
arg_types = {'expressions': True, 'alias': False}
key = 'values'
class Var(Expression):
3275class Var(Expression):
3276    pass
key = 'var'
class Version(Expression):
3279class Version(Expression):
3280    """
3281    Time travel, iceberg, bigquery etc
3282    https://trino.io/docs/current/connector/iceberg.html?highlight=snapshot#using-snapshots
3283    https://www.databricks.com/blog/2019/02/04/introducing-delta-time-travel-for-large-scale-data-lakes.html
3284    https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#for_system_time_as_of
3285    https://learn.microsoft.com/en-us/sql/relational-databases/tables/querying-data-in-a-system-versioned-temporal-table?view=sql-server-ver16
3286    this is either TIMESTAMP or VERSION
3287    kind is ("AS OF", "BETWEEN")
3288    """
3289
3290    arg_types = {"this": True, "kind": True, "expression": False}
arg_types = {'this': True, 'kind': True, 'expression': False}
key = 'version'
class Schema(Expression):
3293class Schema(Expression):
3294    arg_types = {"this": False, "expressions": False}
arg_types = {'this': False, 'expressions': False}
key = 'schema'
class Lock(Expression):
3299class Lock(Expression):
3300    arg_types = {"update": True, "expressions": False, "wait": False}
arg_types = {'update': True, 'expressions': False, 'wait': False}
key = 'lock'
class Select(Query):
3303class Select(Query):
3304    arg_types = {
3305        "with": False,
3306        "kind": False,
3307        "expressions": False,
3308        "hint": False,
3309        "distinct": False,
3310        "into": False,
3311        "from": False,
3312        **QUERY_MODIFIERS,
3313    }
3314
3315    def from_(
3316        self, expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
3317    ) -> Select:
3318        """
3319        Set the FROM expression.
3320
3321        Example:
3322            >>> Select().from_("tbl").select("x").sql()
3323            'SELECT x FROM tbl'
3324
3325        Args:
3326            expression : the SQL code strings to parse.
3327                If a `From` instance is passed, this is used as-is.
3328                If another `Expression` instance is passed, it will be wrapped in a `From`.
3329            dialect: the dialect used to parse the input expression.
3330            copy: if `False`, modify this expression instance in-place.
3331            opts: other options to use to parse the input expressions.
3332
3333        Returns:
3334            The modified Select expression.
3335        """
3336        return _apply_builder(
3337            expression=expression,
3338            instance=self,
3339            arg="from",
3340            into=From,
3341            prefix="FROM",
3342            dialect=dialect,
3343            copy=copy,
3344            **opts,
3345        )
3346
3347    def group_by(
3348        self,
3349        *expressions: t.Optional[ExpOrStr],
3350        append: bool = True,
3351        dialect: DialectType = None,
3352        copy: bool = True,
3353        **opts,
3354    ) -> Select:
3355        """
3356        Set the GROUP BY expression.
3357
3358        Example:
3359            >>> Select().from_("tbl").select("x", "COUNT(1)").group_by("x").sql()
3360            'SELECT x, COUNT(1) FROM tbl GROUP BY x'
3361
3362        Args:
3363            *expressions: the SQL code strings to parse.
3364                If a `Group` instance is passed, this is used as-is.
3365                If another `Expression` instance is passed, it will be wrapped in a `Group`.
3366                If nothing is passed in then a group by is not applied to the expression
3367            append: if `True`, add to any existing expressions.
3368                Otherwise, this flattens all the `Group` expression into a single expression.
3369            dialect: the dialect used to parse the input expression.
3370            copy: if `False`, modify this expression instance in-place.
3371            opts: other options to use to parse the input expressions.
3372
3373        Returns:
3374            The modified Select expression.
3375        """
3376        if not expressions:
3377            return self if not copy else self.copy()
3378
3379        return _apply_child_list_builder(
3380            *expressions,
3381            instance=self,
3382            arg="group",
3383            append=append,
3384            copy=copy,
3385            prefix="GROUP BY",
3386            into=Group,
3387            dialect=dialect,
3388            **opts,
3389        )
3390
3391    def sort_by(
3392        self,
3393        *expressions: t.Optional[ExpOrStr],
3394        append: bool = True,
3395        dialect: DialectType = None,
3396        copy: bool = True,
3397        **opts,
3398    ) -> Select:
3399        """
3400        Set the SORT BY expression.
3401
3402        Example:
3403            >>> Select().from_("tbl").select("x").sort_by("x DESC").sql(dialect="hive")
3404            'SELECT x FROM tbl SORT BY x DESC'
3405
3406        Args:
3407            *expressions: the SQL code strings to parse.
3408                If a `Group` instance is passed, this is used as-is.
3409                If another `Expression` instance is passed, it will be wrapped in a `SORT`.
3410            append: if `True`, add to any existing expressions.
3411                Otherwise, this flattens all the `Order` expression into a single expression.
3412            dialect: the dialect used to parse the input expression.
3413            copy: if `False`, modify this expression instance in-place.
3414            opts: other options to use to parse the input expressions.
3415
3416        Returns:
3417            The modified Select expression.
3418        """
3419        return _apply_child_list_builder(
3420            *expressions,
3421            instance=self,
3422            arg="sort",
3423            append=append,
3424            copy=copy,
3425            prefix="SORT BY",
3426            into=Sort,
3427            dialect=dialect,
3428            **opts,
3429        )
3430
3431    def cluster_by(
3432        self,
3433        *expressions: t.Optional[ExpOrStr],
3434        append: bool = True,
3435        dialect: DialectType = None,
3436        copy: bool = True,
3437        **opts,
3438    ) -> Select:
3439        """
3440        Set the CLUSTER BY expression.
3441
3442        Example:
3443            >>> Select().from_("tbl").select("x").cluster_by("x DESC").sql(dialect="hive")
3444            'SELECT x FROM tbl CLUSTER BY x DESC'
3445
3446        Args:
3447            *expressions: the SQL code strings to parse.
3448                If a `Group` instance is passed, this is used as-is.
3449                If another `Expression` instance is passed, it will be wrapped in a `Cluster`.
3450            append: if `True`, add to any existing expressions.
3451                Otherwise, this flattens all the `Order` expression into a single expression.
3452            dialect: the dialect used to parse the input expression.
3453            copy: if `False`, modify this expression instance in-place.
3454            opts: other options to use to parse the input expressions.
3455
3456        Returns:
3457            The modified Select expression.
3458        """
3459        return _apply_child_list_builder(
3460            *expressions,
3461            instance=self,
3462            arg="cluster",
3463            append=append,
3464            copy=copy,
3465            prefix="CLUSTER BY",
3466            into=Cluster,
3467            dialect=dialect,
3468            **opts,
3469        )
3470
3471    def select(
3472        self,
3473        *expressions: t.Optional[ExpOrStr],
3474        append: bool = True,
3475        dialect: DialectType = None,
3476        copy: bool = True,
3477        **opts,
3478    ) -> Select:
3479        return _apply_list_builder(
3480            *expressions,
3481            instance=self,
3482            arg="expressions",
3483            append=append,
3484            dialect=dialect,
3485            into=Expression,
3486            copy=copy,
3487            **opts,
3488        )
3489
3490    def lateral(
3491        self,
3492        *expressions: t.Optional[ExpOrStr],
3493        append: bool = True,
3494        dialect: DialectType = None,
3495        copy: bool = True,
3496        **opts,
3497    ) -> Select:
3498        """
3499        Append to or set the LATERAL expressions.
3500
3501        Example:
3502            >>> Select().select("x").lateral("OUTER explode(y) tbl2 AS z").from_("tbl").sql()
3503            'SELECT x FROM tbl LATERAL VIEW OUTER EXPLODE(y) tbl2 AS z'
3504
3505        Args:
3506            *expressions: the SQL code strings to parse.
3507                If an `Expression` instance is passed, it will be used as-is.
3508            append: if `True`, add to any existing expressions.
3509                Otherwise, this resets the expressions.
3510            dialect: the dialect used to parse the input expressions.
3511            copy: if `False`, modify this expression instance in-place.
3512            opts: other options to use to parse the input expressions.
3513
3514        Returns:
3515            The modified Select expression.
3516        """
3517        return _apply_list_builder(
3518            *expressions,
3519            instance=self,
3520            arg="laterals",
3521            append=append,
3522            into=Lateral,
3523            prefix="LATERAL VIEW",
3524            dialect=dialect,
3525            copy=copy,
3526            **opts,
3527        )
3528
3529    def join(
3530        self,
3531        expression: ExpOrStr,
3532        on: t.Optional[ExpOrStr] = None,
3533        using: t.Optional[ExpOrStr | t.Collection[ExpOrStr]] = None,
3534        append: bool = True,
3535        join_type: t.Optional[str] = None,
3536        join_alias: t.Optional[Identifier | str] = None,
3537        dialect: DialectType = None,
3538        copy: bool = True,
3539        **opts,
3540    ) -> Select:
3541        """
3542        Append to or set the JOIN expressions.
3543
3544        Example:
3545            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y").sql()
3546            'SELECT * FROM tbl JOIN tbl2 ON tbl1.y = tbl2.y'
3547
3548            >>> Select().select("1").from_("a").join("b", using=["x", "y", "z"]).sql()
3549            'SELECT 1 FROM a JOIN b USING (x, y, z)'
3550
3551            Use `join_type` to change the type of join:
3552
3553            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y", join_type="left outer").sql()
3554            'SELECT * FROM tbl LEFT OUTER JOIN tbl2 ON tbl1.y = tbl2.y'
3555
3556        Args:
3557            expression: the SQL code string to parse.
3558                If an `Expression` instance is passed, it will be used as-is.
3559            on: optionally specify the join "on" criteria as a SQL string.
3560                If an `Expression` instance is passed, it will be used as-is.
3561            using: optionally specify the join "using" criteria as a SQL string.
3562                If an `Expression` instance is passed, it will be used as-is.
3563            append: if `True`, add to any existing expressions.
3564                Otherwise, this resets the expressions.
3565            join_type: if set, alter the parsed join type.
3566            join_alias: an optional alias for the joined source.
3567            dialect: the dialect used to parse the input expressions.
3568            copy: if `False`, modify this expression instance in-place.
3569            opts: other options to use to parse the input expressions.
3570
3571        Returns:
3572            Select: the modified expression.
3573        """
3574        parse_args: t.Dict[str, t.Any] = {"dialect": dialect, **opts}
3575
3576        try:
3577            expression = maybe_parse(expression, into=Join, prefix="JOIN", **parse_args)
3578        except ParseError:
3579            expression = maybe_parse(expression, into=(Join, Expression), **parse_args)
3580
3581        join = expression if isinstance(expression, Join) else Join(this=expression)
3582
3583        if isinstance(join.this, Select):
3584            join.this.replace(join.this.subquery())
3585
3586        if join_type:
3587            method: t.Optional[Token]
3588            side: t.Optional[Token]
3589            kind: t.Optional[Token]
3590
3591            method, side, kind = maybe_parse(join_type, into="JOIN_TYPE", **parse_args)  # type: ignore
3592
3593            if method:
3594                join.set("method", method.text)
3595            if side:
3596                join.set("side", side.text)
3597            if kind:
3598                join.set("kind", kind.text)
3599
3600        if on:
3601            on = and_(*ensure_list(on), dialect=dialect, copy=copy, **opts)
3602            join.set("on", on)
3603
3604        if using:
3605            join = _apply_list_builder(
3606                *ensure_list(using),
3607                instance=join,
3608                arg="using",
3609                append=append,
3610                copy=copy,
3611                into=Identifier,
3612                **opts,
3613            )
3614
3615        if join_alias:
3616            join.set("this", alias_(join.this, join_alias, table=True))
3617
3618        return _apply_list_builder(
3619            join,
3620            instance=self,
3621            arg="joins",
3622            append=append,
3623            copy=copy,
3624            **opts,
3625        )
3626
3627    def where(
3628        self,
3629        *expressions: t.Optional[ExpOrStr],
3630        append: bool = True,
3631        dialect: DialectType = None,
3632        copy: bool = True,
3633        **opts,
3634    ) -> Select:
3635        """
3636        Append to or set the WHERE expressions.
3637
3638        Example:
3639            >>> Select().select("x").from_("tbl").where("x = 'a' OR x < 'b'").sql()
3640            "SELECT x FROM tbl WHERE x = 'a' OR x < 'b'"
3641
3642        Args:
3643            *expressions: the SQL code strings to parse.
3644                If an `Expression` instance is passed, it will be used as-is.
3645                Multiple expressions are combined with an AND operator.
3646            append: if `True`, AND the new expressions to any existing expression.
3647                Otherwise, this resets the expression.
3648            dialect: the dialect used to parse the input expressions.
3649            copy: if `False`, modify this expression instance in-place.
3650            opts: other options to use to parse the input expressions.
3651
3652        Returns:
3653            Select: the modified expression.
3654        """
3655        return _apply_conjunction_builder(
3656            *expressions,
3657            instance=self,
3658            arg="where",
3659            append=append,
3660            into=Where,
3661            dialect=dialect,
3662            copy=copy,
3663            **opts,
3664        )
3665
3666    def having(
3667        self,
3668        *expressions: t.Optional[ExpOrStr],
3669        append: bool = True,
3670        dialect: DialectType = None,
3671        copy: bool = True,
3672        **opts,
3673    ) -> Select:
3674        """
3675        Append to or set the HAVING expressions.
3676
3677        Example:
3678            >>> Select().select("x", "COUNT(y)").from_("tbl").group_by("x").having("COUNT(y) > 3").sql()
3679            'SELECT x, COUNT(y) FROM tbl GROUP BY x HAVING COUNT(y) > 3'
3680
3681        Args:
3682            *expressions: the SQL code strings to parse.
3683                If an `Expression` instance is passed, it will be used as-is.
3684                Multiple expressions are combined with an AND operator.
3685            append: if `True`, AND the new expressions to any existing expression.
3686                Otherwise, this resets the expression.
3687            dialect: the dialect used to parse the input expressions.
3688            copy: if `False`, modify this expression instance in-place.
3689            opts: other options to use to parse the input expressions.
3690
3691        Returns:
3692            The modified Select expression.
3693        """
3694        return _apply_conjunction_builder(
3695            *expressions,
3696            instance=self,
3697            arg="having",
3698            append=append,
3699            into=Having,
3700            dialect=dialect,
3701            copy=copy,
3702            **opts,
3703        )
3704
3705    def window(
3706        self,
3707        *expressions: t.Optional[ExpOrStr],
3708        append: bool = True,
3709        dialect: DialectType = None,
3710        copy: bool = True,
3711        **opts,
3712    ) -> Select:
3713        return _apply_list_builder(
3714            *expressions,
3715            instance=self,
3716            arg="windows",
3717            append=append,
3718            into=Window,
3719            dialect=dialect,
3720            copy=copy,
3721            **opts,
3722        )
3723
3724    def qualify(
3725        self,
3726        *expressions: t.Optional[ExpOrStr],
3727        append: bool = True,
3728        dialect: DialectType = None,
3729        copy: bool = True,
3730        **opts,
3731    ) -> Select:
3732        return _apply_conjunction_builder(
3733            *expressions,
3734            instance=self,
3735            arg="qualify",
3736            append=append,
3737            into=Qualify,
3738            dialect=dialect,
3739            copy=copy,
3740            **opts,
3741        )
3742
3743    def distinct(
3744        self, *ons: t.Optional[ExpOrStr], distinct: bool = True, copy: bool = True
3745    ) -> Select:
3746        """
3747        Set the OFFSET expression.
3748
3749        Example:
3750            >>> Select().from_("tbl").select("x").distinct().sql()
3751            'SELECT DISTINCT x FROM tbl'
3752
3753        Args:
3754            ons: the expressions to distinct on
3755            distinct: whether the Select should be distinct
3756            copy: if `False`, modify this expression instance in-place.
3757
3758        Returns:
3759            Select: the modified expression.
3760        """
3761        instance = maybe_copy(self, copy)
3762        on = Tuple(expressions=[maybe_parse(on, copy=copy) for on in ons if on]) if ons else None
3763        instance.set("distinct", Distinct(on=on) if distinct else None)
3764        return instance
3765
3766    def ctas(
3767        self,
3768        table: ExpOrStr,
3769        properties: t.Optional[t.Dict] = None,
3770        dialect: DialectType = None,
3771        copy: bool = True,
3772        **opts,
3773    ) -> Create:
3774        """
3775        Convert this expression to a CREATE TABLE AS statement.
3776
3777        Example:
3778            >>> Select().select("*").from_("tbl").ctas("x").sql()
3779            'CREATE TABLE x AS SELECT * FROM tbl'
3780
3781        Args:
3782            table: the SQL code string to parse as the table name.
3783                If another `Expression` instance is passed, it will be used as-is.
3784            properties: an optional mapping of table properties
3785            dialect: the dialect used to parse the input table.
3786            copy: if `False`, modify this expression instance in-place.
3787            opts: other options to use to parse the input table.
3788
3789        Returns:
3790            The new Create expression.
3791        """
3792        instance = maybe_copy(self, copy)
3793        table_expression = maybe_parse(table, into=Table, dialect=dialect, **opts)
3794
3795        properties_expression = None
3796        if properties:
3797            properties_expression = Properties.from_dict(properties)
3798
3799        return Create(
3800            this=table_expression,
3801            kind="TABLE",
3802            expression=instance,
3803            properties=properties_expression,
3804        )
3805
3806    def lock(self, update: bool = True, copy: bool = True) -> Select:
3807        """
3808        Set the locking read mode for this expression.
3809
3810        Examples:
3811            >>> Select().select("x").from_("tbl").where("x = 'a'").lock().sql("mysql")
3812            "SELECT x FROM tbl WHERE x = 'a' FOR UPDATE"
3813
3814            >>> Select().select("x").from_("tbl").where("x = 'a'").lock(update=False).sql("mysql")
3815            "SELECT x FROM tbl WHERE x = 'a' FOR SHARE"
3816
3817        Args:
3818            update: if `True`, the locking type will be `FOR UPDATE`, else it will be `FOR SHARE`.
3819            copy: if `False`, modify this expression instance in-place.
3820
3821        Returns:
3822            The modified expression.
3823        """
3824        inst = maybe_copy(self, copy)
3825        inst.set("locks", [Lock(update=update)])
3826
3827        return inst
3828
3829    def hint(self, *hints: ExpOrStr, dialect: DialectType = None, copy: bool = True) -> Select:
3830        """
3831        Set hints for this expression.
3832
3833        Examples:
3834            >>> Select().select("x").from_("tbl").hint("BROADCAST(y)").sql(dialect="spark")
3835            'SELECT /*+ BROADCAST(y) */ x FROM tbl'
3836
3837        Args:
3838            hints: The SQL code strings to parse as the hints.
3839                If an `Expression` instance is passed, it will be used as-is.
3840            dialect: The dialect used to parse the hints.
3841            copy: If `False`, modify this expression instance in-place.
3842
3843        Returns:
3844            The modified expression.
3845        """
3846        inst = maybe_copy(self, copy)
3847        inst.set(
3848            "hint", Hint(expressions=[maybe_parse(h, copy=copy, dialect=dialect) for h in hints])
3849        )
3850
3851        return inst
3852
3853    @property
3854    def named_selects(self) -> t.List[str]:
3855        return [e.output_name for e in self.expressions if e.alias_or_name]
3856
3857    @property
3858    def is_star(self) -> bool:
3859        return any(expression.is_star for expression in self.expressions)
3860
3861    @property
3862    def selects(self) -> t.List[Expression]:
3863        return self.expressions
arg_types = {'with': False, 'kind': False, 'expressions': False, 'hint': False, 'distinct': False, 'into': False, 'from': False, 'match': False, 'laterals': False, 'joins': False, 'connect': False, 'pivots': False, 'prewhere': False, 'where': False, 'group': False, 'having': False, 'qualify': False, 'windows': False, 'distribute': False, 'sort': False, 'cluster': False, 'order': False, 'limit': False, 'offset': False, 'locks': False, 'sample': False, 'settings': False, 'format': False, 'options': False}
def from_( self, expression: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3315    def from_(
3316        self, expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
3317    ) -> Select:
3318        """
3319        Set the FROM expression.
3320
3321        Example:
3322            >>> Select().from_("tbl").select("x").sql()
3323            'SELECT x FROM tbl'
3324
3325        Args:
3326            expression : the SQL code strings to parse.
3327                If a `From` instance is passed, this is used as-is.
3328                If another `Expression` instance is passed, it will be wrapped in a `From`.
3329            dialect: the dialect used to parse the input expression.
3330            copy: if `False`, modify this expression instance in-place.
3331            opts: other options to use to parse the input expressions.
3332
3333        Returns:
3334            The modified Select expression.
3335        """
3336        return _apply_builder(
3337            expression=expression,
3338            instance=self,
3339            arg="from",
3340            into=From,
3341            prefix="FROM",
3342            dialect=dialect,
3343            copy=copy,
3344            **opts,
3345        )

Set the FROM expression.

Example:
>>> Select().from_("tbl").select("x").sql()
'SELECT x FROM tbl'
Arguments:
  • expression : the SQL code strings to parse. If a From instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a From.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def group_by( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3347    def group_by(
3348        self,
3349        *expressions: t.Optional[ExpOrStr],
3350        append: bool = True,
3351        dialect: DialectType = None,
3352        copy: bool = True,
3353        **opts,
3354    ) -> Select:
3355        """
3356        Set the GROUP BY expression.
3357
3358        Example:
3359            >>> Select().from_("tbl").select("x", "COUNT(1)").group_by("x").sql()
3360            'SELECT x, COUNT(1) FROM tbl GROUP BY x'
3361
3362        Args:
3363            *expressions: the SQL code strings to parse.
3364                If a `Group` instance is passed, this is used as-is.
3365                If another `Expression` instance is passed, it will be wrapped in a `Group`.
3366                If nothing is passed in then a group by is not applied to the expression
3367            append: if `True`, add to any existing expressions.
3368                Otherwise, this flattens all the `Group` expression into a single expression.
3369            dialect: the dialect used to parse the input expression.
3370            copy: if `False`, modify this expression instance in-place.
3371            opts: other options to use to parse the input expressions.
3372
3373        Returns:
3374            The modified Select expression.
3375        """
3376        if not expressions:
3377            return self if not copy else self.copy()
3378
3379        return _apply_child_list_builder(
3380            *expressions,
3381            instance=self,
3382            arg="group",
3383            append=append,
3384            copy=copy,
3385            prefix="GROUP BY",
3386            into=Group,
3387            dialect=dialect,
3388            **opts,
3389        )

Set the GROUP BY expression.

Example:
>>> Select().from_("tbl").select("x", "COUNT(1)").group_by("x").sql()
'SELECT x, COUNT(1) FROM tbl GROUP BY x'
Arguments:
  • *expressions: the SQL code strings to parse. If a Group instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a Group. If nothing is passed in then a group by is not applied to the expression
  • append: if True, add to any existing expressions. Otherwise, this flattens all the Group expression into a single expression.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def sort_by( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3391    def sort_by(
3392        self,
3393        *expressions: t.Optional[ExpOrStr],
3394        append: bool = True,
3395        dialect: DialectType = None,
3396        copy: bool = True,
3397        **opts,
3398    ) -> Select:
3399        """
3400        Set the SORT BY expression.
3401
3402        Example:
3403            >>> Select().from_("tbl").select("x").sort_by("x DESC").sql(dialect="hive")
3404            'SELECT x FROM tbl SORT BY x DESC'
3405
3406        Args:
3407            *expressions: the SQL code strings to parse.
3408                If a `Group` instance is passed, this is used as-is.
3409                If another `Expression` instance is passed, it will be wrapped in a `SORT`.
3410            append: if `True`, add to any existing expressions.
3411                Otherwise, this flattens all the `Order` expression into a single expression.
3412            dialect: the dialect used to parse the input expression.
3413            copy: if `False`, modify this expression instance in-place.
3414            opts: other options to use to parse the input expressions.
3415
3416        Returns:
3417            The modified Select expression.
3418        """
3419        return _apply_child_list_builder(
3420            *expressions,
3421            instance=self,
3422            arg="sort",
3423            append=append,
3424            copy=copy,
3425            prefix="SORT BY",
3426            into=Sort,
3427            dialect=dialect,
3428            **opts,
3429        )

Set the SORT BY expression.

Example:
>>> Select().from_("tbl").select("x").sort_by("x DESC").sql(dialect="hive")
'SELECT x FROM tbl SORT BY x DESC'
Arguments:
  • *expressions: the SQL code strings to parse. If a Group instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a SORT.
  • append: if True, add to any existing expressions. Otherwise, this flattens all the Order expression into a single expression.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def cluster_by( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3431    def cluster_by(
3432        self,
3433        *expressions: t.Optional[ExpOrStr],
3434        append: bool = True,
3435        dialect: DialectType = None,
3436        copy: bool = True,
3437        **opts,
3438    ) -> Select:
3439        """
3440        Set the CLUSTER BY expression.
3441
3442        Example:
3443            >>> Select().from_("tbl").select("x").cluster_by("x DESC").sql(dialect="hive")
3444            'SELECT x FROM tbl CLUSTER BY x DESC'
3445
3446        Args:
3447            *expressions: the SQL code strings to parse.
3448                If a `Group` instance is passed, this is used as-is.
3449                If another `Expression` instance is passed, it will be wrapped in a `Cluster`.
3450            append: if `True`, add to any existing expressions.
3451                Otherwise, this flattens all the `Order` expression into a single expression.
3452            dialect: the dialect used to parse the input expression.
3453            copy: if `False`, modify this expression instance in-place.
3454            opts: other options to use to parse the input expressions.
3455
3456        Returns:
3457            The modified Select expression.
3458        """
3459        return _apply_child_list_builder(
3460            *expressions,
3461            instance=self,
3462            arg="cluster",
3463            append=append,
3464            copy=copy,
3465            prefix="CLUSTER BY",
3466            into=Cluster,
3467            dialect=dialect,
3468            **opts,
3469        )

Set the CLUSTER BY expression.

Example:
>>> Select().from_("tbl").select("x").cluster_by("x DESC").sql(dialect="hive")
'SELECT x FROM tbl CLUSTER BY x DESC'
Arguments:
  • *expressions: the SQL code strings to parse. If a Group instance is passed, this is used as-is. If another Expression instance is passed, it will be wrapped in a Cluster.
  • append: if True, add to any existing expressions. Otherwise, this flattens all the Order expression into a single expression.
  • dialect: the dialect used to parse the input expression.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def select( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3471    def select(
3472        self,
3473        *expressions: t.Optional[ExpOrStr],
3474        append: bool = True,
3475        dialect: DialectType = None,
3476        copy: bool = True,
3477        **opts,
3478    ) -> Select:
3479        return _apply_list_builder(
3480            *expressions,
3481            instance=self,
3482            arg="expressions",
3483            append=append,
3484            dialect=dialect,
3485            into=Expression,
3486            copy=copy,
3487            **opts,
3488        )

Append to or set the SELECT expressions.

Example:
>>> Select().select("x", "y").sql()
'SELECT x, y'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Query expression.

def lateral( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3490    def lateral(
3491        self,
3492        *expressions: t.Optional[ExpOrStr],
3493        append: bool = True,
3494        dialect: DialectType = None,
3495        copy: bool = True,
3496        **opts,
3497    ) -> Select:
3498        """
3499        Append to or set the LATERAL expressions.
3500
3501        Example:
3502            >>> Select().select("x").lateral("OUTER explode(y) tbl2 AS z").from_("tbl").sql()
3503            'SELECT x FROM tbl LATERAL VIEW OUTER EXPLODE(y) tbl2 AS z'
3504
3505        Args:
3506            *expressions: the SQL code strings to parse.
3507                If an `Expression` instance is passed, it will be used as-is.
3508            append: if `True`, add to any existing expressions.
3509                Otherwise, this resets the expressions.
3510            dialect: the dialect used to parse the input expressions.
3511            copy: if `False`, modify this expression instance in-place.
3512            opts: other options to use to parse the input expressions.
3513
3514        Returns:
3515            The modified Select expression.
3516        """
3517        return _apply_list_builder(
3518            *expressions,
3519            instance=self,
3520            arg="laterals",
3521            append=append,
3522            into=Lateral,
3523            prefix="LATERAL VIEW",
3524            dialect=dialect,
3525            copy=copy,
3526            **opts,
3527        )

Append to or set the LATERAL expressions.

Example:
>>> Select().select("x").lateral("OUTER explode(y) tbl2 AS z").from_("tbl").sql()
'SELECT x FROM tbl LATERAL VIEW OUTER EXPLODE(y) tbl2 AS z'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def join( self, expression: Union[str, Expression], on: Union[str, Expression, NoneType] = None, using: Union[str, Expression, Collection[Union[str, Expression]], NoneType] = None, append: bool = True, join_type: Optional[str] = None, join_alias: Union[Identifier, str, NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3529    def join(
3530        self,
3531        expression: ExpOrStr,
3532        on: t.Optional[ExpOrStr] = None,
3533        using: t.Optional[ExpOrStr | t.Collection[ExpOrStr]] = None,
3534        append: bool = True,
3535        join_type: t.Optional[str] = None,
3536        join_alias: t.Optional[Identifier | str] = None,
3537        dialect: DialectType = None,
3538        copy: bool = True,
3539        **opts,
3540    ) -> Select:
3541        """
3542        Append to or set the JOIN expressions.
3543
3544        Example:
3545            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y").sql()
3546            'SELECT * FROM tbl JOIN tbl2 ON tbl1.y = tbl2.y'
3547
3548            >>> Select().select("1").from_("a").join("b", using=["x", "y", "z"]).sql()
3549            'SELECT 1 FROM a JOIN b USING (x, y, z)'
3550
3551            Use `join_type` to change the type of join:
3552
3553            >>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y", join_type="left outer").sql()
3554            'SELECT * FROM tbl LEFT OUTER JOIN tbl2 ON tbl1.y = tbl2.y'
3555
3556        Args:
3557            expression: the SQL code string to parse.
3558                If an `Expression` instance is passed, it will be used as-is.
3559            on: optionally specify the join "on" criteria as a SQL string.
3560                If an `Expression` instance is passed, it will be used as-is.
3561            using: optionally specify the join "using" criteria as a SQL string.
3562                If an `Expression` instance is passed, it will be used as-is.
3563            append: if `True`, add to any existing expressions.
3564                Otherwise, this resets the expressions.
3565            join_type: if set, alter the parsed join type.
3566            join_alias: an optional alias for the joined source.
3567            dialect: the dialect used to parse the input expressions.
3568            copy: if `False`, modify this expression instance in-place.
3569            opts: other options to use to parse the input expressions.
3570
3571        Returns:
3572            Select: the modified expression.
3573        """
3574        parse_args: t.Dict[str, t.Any] = {"dialect": dialect, **opts}
3575
3576        try:
3577            expression = maybe_parse(expression, into=Join, prefix="JOIN", **parse_args)
3578        except ParseError:
3579            expression = maybe_parse(expression, into=(Join, Expression), **parse_args)
3580
3581        join = expression if isinstance(expression, Join) else Join(this=expression)
3582
3583        if isinstance(join.this, Select):
3584            join.this.replace(join.this.subquery())
3585
3586        if join_type:
3587            method: t.Optional[Token]
3588            side: t.Optional[Token]
3589            kind: t.Optional[Token]
3590
3591            method, side, kind = maybe_parse(join_type, into="JOIN_TYPE", **parse_args)  # type: ignore
3592
3593            if method:
3594                join.set("method", method.text)
3595            if side:
3596                join.set("side", side.text)
3597            if kind:
3598                join.set("kind", kind.text)
3599
3600        if on:
3601            on = and_(*ensure_list(on), dialect=dialect, copy=copy, **opts)
3602            join.set("on", on)
3603
3604        if using:
3605            join = _apply_list_builder(
3606                *ensure_list(using),
3607                instance=join,
3608                arg="using",
3609                append=append,
3610                copy=copy,
3611                into=Identifier,
3612                **opts,
3613            )
3614
3615        if join_alias:
3616            join.set("this", alias_(join.this, join_alias, table=True))
3617
3618        return _apply_list_builder(
3619            join,
3620            instance=self,
3621            arg="joins",
3622            append=append,
3623            copy=copy,
3624            **opts,
3625        )

Append to or set the JOIN expressions.

Example:
>>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y").sql()
'SELECT * FROM tbl JOIN tbl2 ON tbl1.y = tbl2.y'
>>> Select().select("1").from_("a").join("b", using=["x", "y", "z"]).sql()
'SELECT 1 FROM a JOIN b USING (x, y, z)'

Use join_type to change the type of join:

>>> Select().select("*").from_("tbl").join("tbl2", on="tbl1.y = tbl2.y", join_type="left outer").sql()
'SELECT * FROM tbl LEFT OUTER JOIN tbl2 ON tbl1.y = tbl2.y'
Arguments:
  • expression: the SQL code string to parse. If an Expression instance is passed, it will be used as-is.
  • on: optionally specify the join "on" criteria as a SQL string. If an Expression instance is passed, it will be used as-is.
  • using: optionally specify the join "using" criteria as a SQL string. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • join_type: if set, alter the parsed join type.
  • join_alias: an optional alias for the joined source.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

Select: the modified expression.

def where( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3627    def where(
3628        self,
3629        *expressions: t.Optional[ExpOrStr],
3630        append: bool = True,
3631        dialect: DialectType = None,
3632        copy: bool = True,
3633        **opts,
3634    ) -> Select:
3635        """
3636        Append to or set the WHERE expressions.
3637
3638        Example:
3639            >>> Select().select("x").from_("tbl").where("x = 'a' OR x < 'b'").sql()
3640            "SELECT x FROM tbl WHERE x = 'a' OR x < 'b'"
3641
3642        Args:
3643            *expressions: the SQL code strings to parse.
3644                If an `Expression` instance is passed, it will be used as-is.
3645                Multiple expressions are combined with an AND operator.
3646            append: if `True`, AND the new expressions to any existing expression.
3647                Otherwise, this resets the expression.
3648            dialect: the dialect used to parse the input expressions.
3649            copy: if `False`, modify this expression instance in-place.
3650            opts: other options to use to parse the input expressions.
3651
3652        Returns:
3653            Select: the modified expression.
3654        """
3655        return _apply_conjunction_builder(
3656            *expressions,
3657            instance=self,
3658            arg="where",
3659            append=append,
3660            into=Where,
3661            dialect=dialect,
3662            copy=copy,
3663            **opts,
3664        )

Append to or set the WHERE expressions.

Example:
>>> Select().select("x").from_("tbl").where("x = 'a' OR x < 'b'").sql()
"SELECT x FROM tbl WHERE x = 'a' OR x < 'b'"
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is. Multiple expressions are combined with an AND operator.
  • append: if True, AND the new expressions to any existing expression. Otherwise, this resets the expression.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

Select: the modified expression.

def having( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3666    def having(
3667        self,
3668        *expressions: t.Optional[ExpOrStr],
3669        append: bool = True,
3670        dialect: DialectType = None,
3671        copy: bool = True,
3672        **opts,
3673    ) -> Select:
3674        """
3675        Append to or set the HAVING expressions.
3676
3677        Example:
3678            >>> Select().select("x", "COUNT(y)").from_("tbl").group_by("x").having("COUNT(y) > 3").sql()
3679            'SELECT x, COUNT(y) FROM tbl GROUP BY x HAVING COUNT(y) > 3'
3680
3681        Args:
3682            *expressions: the SQL code strings to parse.
3683                If an `Expression` instance is passed, it will be used as-is.
3684                Multiple expressions are combined with an AND operator.
3685            append: if `True`, AND the new expressions to any existing expression.
3686                Otherwise, this resets the expression.
3687            dialect: the dialect used to parse the input expressions.
3688            copy: if `False`, modify this expression instance in-place.
3689            opts: other options to use to parse the input expressions.
3690
3691        Returns:
3692            The modified Select expression.
3693        """
3694        return _apply_conjunction_builder(
3695            *expressions,
3696            instance=self,
3697            arg="having",
3698            append=append,
3699            into=Having,
3700            dialect=dialect,
3701            copy=copy,
3702            **opts,
3703        )

Append to or set the HAVING expressions.

Example:
>>> Select().select("x", "COUNT(y)").from_("tbl").group_by("x").having("COUNT(y) > 3").sql()
'SELECT x, COUNT(y) FROM tbl GROUP BY x HAVING COUNT(y) > 3'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is. Multiple expressions are combined with an AND operator.
  • append: if True, AND the new expressions to any existing expression. Otherwise, this resets the expression.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Select expression.

def window( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3705    def window(
3706        self,
3707        *expressions: t.Optional[ExpOrStr],
3708        append: bool = True,
3709        dialect: DialectType = None,
3710        copy: bool = True,
3711        **opts,
3712    ) -> Select:
3713        return _apply_list_builder(
3714            *expressions,
3715            instance=self,
3716            arg="windows",
3717            append=append,
3718            into=Window,
3719            dialect=dialect,
3720            copy=copy,
3721            **opts,
3722        )
def qualify( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Select:
3724    def qualify(
3725        self,
3726        *expressions: t.Optional[ExpOrStr],
3727        append: bool = True,
3728        dialect: DialectType = None,
3729        copy: bool = True,
3730        **opts,
3731    ) -> Select:
3732        return _apply_conjunction_builder(
3733            *expressions,
3734            instance=self,
3735            arg="qualify",
3736            append=append,
3737            into=Qualify,
3738            dialect=dialect,
3739            copy=copy,
3740            **opts,
3741        )
def distinct( self, *ons: Union[str, Expression, NoneType], distinct: bool = True, copy: bool = True) -> Select:
3743    def distinct(
3744        self, *ons: t.Optional[ExpOrStr], distinct: bool = True, copy: bool = True
3745    ) -> Select:
3746        """
3747        Set the OFFSET expression.
3748
3749        Example:
3750            >>> Select().from_("tbl").select("x").distinct().sql()
3751            'SELECT DISTINCT x FROM tbl'
3752
3753        Args:
3754            ons: the expressions to distinct on
3755            distinct: whether the Select should be distinct
3756            copy: if `False`, modify this expression instance in-place.
3757
3758        Returns:
3759            Select: the modified expression.
3760        """
3761        instance = maybe_copy(self, copy)
3762        on = Tuple(expressions=[maybe_parse(on, copy=copy) for on in ons if on]) if ons else None
3763        instance.set("distinct", Distinct(on=on) if distinct else None)
3764        return instance

Set the OFFSET expression.

Example:
>>> Select().from_("tbl").select("x").distinct().sql()
'SELECT DISTINCT x FROM tbl'
Arguments:
  • ons: the expressions to distinct on
  • distinct: whether the Select should be distinct
  • copy: if False, modify this expression instance in-place.
Returns:

Select: the modified expression.

def ctas( self, table: Union[str, Expression], properties: Optional[Dict] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Create:
3766    def ctas(
3767        self,
3768        table: ExpOrStr,
3769        properties: t.Optional[t.Dict] = None,
3770        dialect: DialectType = None,
3771        copy: bool = True,
3772        **opts,
3773    ) -> Create:
3774        """
3775        Convert this expression to a CREATE TABLE AS statement.
3776
3777        Example:
3778            >>> Select().select("*").from_("tbl").ctas("x").sql()
3779            'CREATE TABLE x AS SELECT * FROM tbl'
3780
3781        Args:
3782            table: the SQL code string to parse as the table name.
3783                If another `Expression` instance is passed, it will be used as-is.
3784            properties: an optional mapping of table properties
3785            dialect: the dialect used to parse the input table.
3786            copy: if `False`, modify this expression instance in-place.
3787            opts: other options to use to parse the input table.
3788
3789        Returns:
3790            The new Create expression.
3791        """
3792        instance = maybe_copy(self, copy)
3793        table_expression = maybe_parse(table, into=Table, dialect=dialect, **opts)
3794
3795        properties_expression = None
3796        if properties:
3797            properties_expression = Properties.from_dict(properties)
3798
3799        return Create(
3800            this=table_expression,
3801            kind="TABLE",
3802            expression=instance,
3803            properties=properties_expression,
3804        )

Convert this expression to a CREATE TABLE AS statement.

Example:
>>> Select().select("*").from_("tbl").ctas("x").sql()
'CREATE TABLE x AS SELECT * FROM tbl'
Arguments:
  • table: the SQL code string to parse as the table name. If another Expression instance is passed, it will be used as-is.
  • properties: an optional mapping of table properties
  • dialect: the dialect used to parse the input table.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input table.
Returns:

The new Create expression.

def lock( self, update: bool = True, copy: bool = True) -> Select:
3806    def lock(self, update: bool = True, copy: bool = True) -> Select:
3807        """
3808        Set the locking read mode for this expression.
3809
3810        Examples:
3811            >>> Select().select("x").from_("tbl").where("x = 'a'").lock().sql("mysql")
3812            "SELECT x FROM tbl WHERE x = 'a' FOR UPDATE"
3813
3814            >>> Select().select("x").from_("tbl").where("x = 'a'").lock(update=False).sql("mysql")
3815            "SELECT x FROM tbl WHERE x = 'a' FOR SHARE"
3816
3817        Args:
3818            update: if `True`, the locking type will be `FOR UPDATE`, else it will be `FOR SHARE`.
3819            copy: if `False`, modify this expression instance in-place.
3820
3821        Returns:
3822            The modified expression.
3823        """
3824        inst = maybe_copy(self, copy)
3825        inst.set("locks", [Lock(update=update)])
3826
3827        return inst

Set the locking read mode for this expression.

Examples:
>>> Select().select("x").from_("tbl").where("x = 'a'").lock().sql("mysql")
"SELECT x FROM tbl WHERE x = 'a' FOR UPDATE"
>>> Select().select("x").from_("tbl").where("x = 'a'").lock(update=False).sql("mysql")
"SELECT x FROM tbl WHERE x = 'a' FOR SHARE"
Arguments:
  • update: if True, the locking type will be FOR UPDATE, else it will be FOR SHARE.
  • copy: if False, modify this expression instance in-place.
Returns:

The modified expression.

def hint( self, *hints: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True) -> Select:
3829    def hint(self, *hints: ExpOrStr, dialect: DialectType = None, copy: bool = True) -> Select:
3830        """
3831        Set hints for this expression.
3832
3833        Examples:
3834            >>> Select().select("x").from_("tbl").hint("BROADCAST(y)").sql(dialect="spark")
3835            'SELECT /*+ BROADCAST(y) */ x FROM tbl'
3836
3837        Args:
3838            hints: The SQL code strings to parse as the hints.
3839                If an `Expression` instance is passed, it will be used as-is.
3840            dialect: The dialect used to parse the hints.
3841            copy: If `False`, modify this expression instance in-place.
3842
3843        Returns:
3844            The modified expression.
3845        """
3846        inst = maybe_copy(self, copy)
3847        inst.set(
3848            "hint", Hint(expressions=[maybe_parse(h, copy=copy, dialect=dialect) for h in hints])
3849        )
3850
3851        return inst

Set hints for this expression.

Examples:
>>> Select().select("x").from_("tbl").hint("BROADCAST(y)").sql(dialect="spark")
'SELECT /*+ BROADCAST(y) */ x FROM tbl'
Arguments:
  • hints: The SQL code strings to parse as the hints. If an Expression instance is passed, it will be used as-is.
  • dialect: The dialect used to parse the hints.
  • copy: If False, modify this expression instance in-place.
Returns:

The modified expression.

named_selects: List[str]
3853    @property
3854    def named_selects(self) -> t.List[str]:
3855        return [e.output_name for e in self.expressions if e.alias_or_name]

Returns the output names of the query's projections.

is_star: bool
3857    @property
3858    def is_star(self) -> bool:
3859        return any(expression.is_star for expression in self.expressions)

Checks whether an expression is a star.

selects: List[Expression]
3861    @property
3862    def selects(self) -> t.List[Expression]:
3863        return self.expressions

Returns the query's projections.

key = 'select'
UNWRAPPED_QUERIES = (<class 'Select'>, <class 'SetOperation'>)
class Subquery(DerivedTable, Query):
3869class Subquery(DerivedTable, Query):
3870    arg_types = {
3871        "this": True,
3872        "alias": False,
3873        "with": False,
3874        **QUERY_MODIFIERS,
3875    }
3876
3877    def unnest(self):
3878        """Returns the first non subquery."""
3879        expression = self
3880        while isinstance(expression, Subquery):
3881            expression = expression.this
3882        return expression
3883
3884    def unwrap(self) -> Subquery:
3885        expression = self
3886        while expression.same_parent and expression.is_wrapper:
3887            expression = t.cast(Subquery, expression.parent)
3888        return expression
3889
3890    def select(
3891        self,
3892        *expressions: t.Optional[ExpOrStr],
3893        append: bool = True,
3894        dialect: DialectType = None,
3895        copy: bool = True,
3896        **opts,
3897    ) -> Subquery:
3898        this = maybe_copy(self, copy)
3899        this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3900        return this
3901
3902    @property
3903    def is_wrapper(self) -> bool:
3904        """
3905        Whether this Subquery acts as a simple wrapper around another expression.
3906
3907        SELECT * FROM (((SELECT * FROM t)))
3908                      ^
3909                      This corresponds to a "wrapper" Subquery node
3910        """
3911        return all(v is None for k, v in self.args.items() if k != "this")
3912
3913    @property
3914    def is_star(self) -> bool:
3915        return self.this.is_star
3916
3917    @property
3918    def output_name(self) -> str:
3919        return self.alias
arg_types = {'this': True, 'alias': False, 'with': False, 'match': False, 'laterals': False, 'joins': False, 'connect': False, 'pivots': False, 'prewhere': False, 'where': False, 'group': False, 'having': False, 'qualify': False, 'windows': False, 'distribute': False, 'sort': False, 'cluster': False, 'order': False, 'limit': False, 'offset': False, 'locks': False, 'sample': False, 'settings': False, 'format': False, 'options': False}
def unnest(self):
3877    def unnest(self):
3878        """Returns the first non subquery."""
3879        expression = self
3880        while isinstance(expression, Subquery):
3881            expression = expression.this
3882        return expression

Returns the first non subquery.

def unwrap(self) -> Subquery:
3884    def unwrap(self) -> Subquery:
3885        expression = self
3886        while expression.same_parent and expression.is_wrapper:
3887            expression = t.cast(Subquery, expression.parent)
3888        return expression
def select( self, *expressions: Union[str, Expression, NoneType], append: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Subquery:
3890    def select(
3891        self,
3892        *expressions: t.Optional[ExpOrStr],
3893        append: bool = True,
3894        dialect: DialectType = None,
3895        copy: bool = True,
3896        **opts,
3897    ) -> Subquery:
3898        this = maybe_copy(self, copy)
3899        this.unnest().select(*expressions, append=append, dialect=dialect, copy=False, **opts)
3900        return this

Append to or set the SELECT expressions.

Example:
>>> Select().select("x", "y").sql()
'SELECT x, y'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, it will be used as-is.
  • append: if True, add to any existing expressions. Otherwise, this resets the expressions.
  • dialect: the dialect used to parse the input expressions.
  • copy: if False, modify this expression instance in-place.
  • opts: other options to use to parse the input expressions.
Returns:

The modified Query expression.

is_wrapper: bool
3902    @property
3903    def is_wrapper(self) -> bool:
3904        """
3905        Whether this Subquery acts as a simple wrapper around another expression.
3906
3907        SELECT * FROM (((SELECT * FROM t)))
3908                      ^
3909                      This corresponds to a "wrapper" Subquery node
3910        """
3911        return all(v is None for k, v in self.args.items() if k != "this")

Whether this Subquery acts as a simple wrapper around another expression.

SELECT * FROM (((SELECT * FROM t))) ^ This corresponds to a "wrapper" Subquery node

is_star: bool
3913    @property
3914    def is_star(self) -> bool:
3915        return self.this.is_star

Checks whether an expression is a star.

output_name: str
3917    @property
3918    def output_name(self) -> str:
3919        return self.alias

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'subquery'
class TableSample(Expression):
3922class TableSample(Expression):
3923    arg_types = {
3924        "expressions": False,
3925        "method": False,
3926        "bucket_numerator": False,
3927        "bucket_denominator": False,
3928        "bucket_field": False,
3929        "percent": False,
3930        "rows": False,
3931        "size": False,
3932        "seed": False,
3933    }
arg_types = {'expressions': False, 'method': False, 'bucket_numerator': False, 'bucket_denominator': False, 'bucket_field': False, 'percent': False, 'rows': False, 'size': False, 'seed': False}
key = 'tablesample'
class Tag(Expression):
3936class Tag(Expression):
3937    """Tags are used for generating arbitrary sql like SELECT <span>x</span>."""
3938
3939    arg_types = {
3940        "this": False,
3941        "prefix": False,
3942        "postfix": False,
3943    }

Tags are used for generating arbitrary sql like SELECT x.

arg_types = {'this': False, 'prefix': False, 'postfix': False}
key = 'tag'
class Pivot(Expression):
3948class Pivot(Expression):
3949    arg_types = {
3950        "this": False,
3951        "alias": False,
3952        "expressions": False,
3953        "field": False,
3954        "unpivot": False,
3955        "using": False,
3956        "group": False,
3957        "columns": False,
3958        "include_nulls": False,
3959        "default_on_null": False,
3960    }
3961
3962    @property
3963    def unpivot(self) -> bool:
3964        return bool(self.args.get("unpivot"))
arg_types = {'this': False, 'alias': False, 'expressions': False, 'field': False, 'unpivot': False, 'using': False, 'group': False, 'columns': False, 'include_nulls': False, 'default_on_null': False}
unpivot: bool
3962    @property
3963    def unpivot(self) -> bool:
3964        return bool(self.args.get("unpivot"))
key = 'pivot'
class Window(Condition):
3967class Window(Condition):
3968    arg_types = {
3969        "this": True,
3970        "partition_by": False,
3971        "order": False,
3972        "spec": False,
3973        "alias": False,
3974        "over": False,
3975        "first": False,
3976    }
arg_types = {'this': True, 'partition_by': False, 'order': False, 'spec': False, 'alias': False, 'over': False, 'first': False}
key = 'window'
class WindowSpec(Expression):
3979class WindowSpec(Expression):
3980    arg_types = {
3981        "kind": False,
3982        "start": False,
3983        "start_side": False,
3984        "end": False,
3985        "end_side": False,
3986    }
arg_types = {'kind': False, 'start': False, 'start_side': False, 'end': False, 'end_side': False}
key = 'windowspec'
class PreWhere(Expression):
3989class PreWhere(Expression):
3990    pass
key = 'prewhere'
class Where(Expression):
3993class Where(Expression):
3994    pass
key = 'where'
class Star(Expression):
3997class Star(Expression):
3998    arg_types = {"except": False, "replace": False, "rename": False}
3999
4000    @property
4001    def name(self) -> str:
4002        return "*"
4003
4004    @property
4005    def output_name(self) -> str:
4006        return self.name
arg_types = {'except': False, 'replace': False, 'rename': False}
name: str
4000    @property
4001    def name(self) -> str:
4002        return "*"
output_name: str
4004    @property
4005    def output_name(self) -> str:
4006        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'star'
class Parameter(Condition):
4009class Parameter(Condition):
4010    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'parameter'
class SessionParameter(Condition):
4013class SessionParameter(Condition):
4014    arg_types = {"this": True, "kind": False}
arg_types = {'this': True, 'kind': False}
key = 'sessionparameter'
class Placeholder(Condition):
4017class Placeholder(Condition):
4018    arg_types = {"this": False, "kind": False}
4019
4020    @property
4021    def name(self) -> str:
4022        return self.this or "?"
arg_types = {'this': False, 'kind': False}
name: str
4020    @property
4021    def name(self) -> str:
4022        return self.this or "?"
key = 'placeholder'
class Null(Condition):
4025class Null(Condition):
4026    arg_types: t.Dict[str, t.Any] = {}
4027
4028    @property
4029    def name(self) -> str:
4030        return "NULL"
4031
4032    def to_py(self) -> Lit[None]:
4033        return None
arg_types: Dict[str, Any] = {}
name: str
4028    @property
4029    def name(self) -> str:
4030        return "NULL"
def to_py(self) -> Literal[None]:
4032    def to_py(self) -> Lit[None]:
4033        return None

Returns a Python object equivalent of the SQL node.

key = 'null'
class Boolean(Condition):
4036class Boolean(Condition):
4037    def to_py(self) -> bool:
4038        return self.this
def to_py(self) -> bool:
4037    def to_py(self) -> bool:
4038        return self.this

Returns a Python object equivalent of the SQL node.

key = 'boolean'
class DataTypeParam(Expression):
4041class DataTypeParam(Expression):
4042    arg_types = {"this": True, "expression": False}
4043
4044    @property
4045    def name(self) -> str:
4046        return self.this.name
arg_types = {'this': True, 'expression': False}
name: str
4044    @property
4045    def name(self) -> str:
4046        return self.this.name
key = 'datatypeparam'
class DataType(Expression):
4051class DataType(Expression):
4052    arg_types = {
4053        "this": True,
4054        "expressions": False,
4055        "nested": False,
4056        "values": False,
4057        "prefix": False,
4058        "kind": False,
4059        "nullable": False,
4060    }
4061
4062    class Type(AutoName):
4063        ARRAY = auto()
4064        AGGREGATEFUNCTION = auto()
4065        SIMPLEAGGREGATEFUNCTION = auto()
4066        BIGDECIMAL = auto()
4067        BIGINT = auto()
4068        BIGSERIAL = auto()
4069        BINARY = auto()
4070        BIT = auto()
4071        BOOLEAN = auto()
4072        BPCHAR = auto()
4073        CHAR = auto()
4074        DATE = auto()
4075        DATE32 = auto()
4076        DATEMULTIRANGE = auto()
4077        DATERANGE = auto()
4078        DATETIME = auto()
4079        DATETIME64 = auto()
4080        DECIMAL = auto()
4081        DECIMAL32 = auto()
4082        DECIMAL64 = auto()
4083        DECIMAL128 = auto()
4084        DOUBLE = auto()
4085        ENUM = auto()
4086        ENUM8 = auto()
4087        ENUM16 = auto()
4088        FIXEDSTRING = auto()
4089        FLOAT = auto()
4090        GEOGRAPHY = auto()
4091        GEOMETRY = auto()
4092        HLLSKETCH = auto()
4093        HSTORE = auto()
4094        IMAGE = auto()
4095        INET = auto()
4096        INT = auto()
4097        INT128 = auto()
4098        INT256 = auto()
4099        INT4MULTIRANGE = auto()
4100        INT4RANGE = auto()
4101        INT8MULTIRANGE = auto()
4102        INT8RANGE = auto()
4103        INTERVAL = auto()
4104        IPADDRESS = auto()
4105        IPPREFIX = auto()
4106        IPV4 = auto()
4107        IPV6 = auto()
4108        JSON = auto()
4109        JSONB = auto()
4110        LIST = auto()
4111        LONGBLOB = auto()
4112        LONGTEXT = auto()
4113        LOWCARDINALITY = auto()
4114        MAP = auto()
4115        MEDIUMBLOB = auto()
4116        MEDIUMINT = auto()
4117        MEDIUMTEXT = auto()
4118        MONEY = auto()
4119        NAME = auto()
4120        NCHAR = auto()
4121        NESTED = auto()
4122        NULL = auto()
4123        NUMMULTIRANGE = auto()
4124        NUMRANGE = auto()
4125        NVARCHAR = auto()
4126        OBJECT = auto()
4127        ROWVERSION = auto()
4128        SERIAL = auto()
4129        SET = auto()
4130        SMALLINT = auto()
4131        SMALLMONEY = auto()
4132        SMALLSERIAL = auto()
4133        STRUCT = auto()
4134        SUPER = auto()
4135        TEXT = auto()
4136        TINYBLOB = auto()
4137        TINYTEXT = auto()
4138        TIME = auto()
4139        TIMETZ = auto()
4140        TIMESTAMP = auto()
4141        TIMESTAMPNTZ = auto()
4142        TIMESTAMPLTZ = auto()
4143        TIMESTAMPTZ = auto()
4144        TIMESTAMP_S = auto()
4145        TIMESTAMP_MS = auto()
4146        TIMESTAMP_NS = auto()
4147        TINYINT = auto()
4148        TSMULTIRANGE = auto()
4149        TSRANGE = auto()
4150        TSTZMULTIRANGE = auto()
4151        TSTZRANGE = auto()
4152        UBIGINT = auto()
4153        UINT = auto()
4154        UINT128 = auto()
4155        UINT256 = auto()
4156        UMEDIUMINT = auto()
4157        UDECIMAL = auto()
4158        UNIQUEIDENTIFIER = auto()
4159        UNKNOWN = auto()  # Sentinel value, useful for type annotation
4160        USERDEFINED = "USER-DEFINED"
4161        USMALLINT = auto()
4162        UTINYINT = auto()
4163        UUID = auto()
4164        VARBINARY = auto()
4165        VARCHAR = auto()
4166        VARIANT = auto()
4167        VECTOR = auto()
4168        XML = auto()
4169        YEAR = auto()
4170        TDIGEST = auto()
4171
4172    STRUCT_TYPES = {
4173        Type.NESTED,
4174        Type.OBJECT,
4175        Type.STRUCT,
4176    }
4177
4178    ARRAY_TYPES = {
4179        Type.ARRAY,
4180        Type.LIST,
4181    }
4182
4183    NESTED_TYPES = {
4184        *STRUCT_TYPES,
4185        *ARRAY_TYPES,
4186        Type.MAP,
4187    }
4188
4189    TEXT_TYPES = {
4190        Type.CHAR,
4191        Type.NCHAR,
4192        Type.NVARCHAR,
4193        Type.TEXT,
4194        Type.VARCHAR,
4195        Type.NAME,
4196    }
4197
4198    SIGNED_INTEGER_TYPES = {
4199        Type.BIGINT,
4200        Type.INT,
4201        Type.INT128,
4202        Type.INT256,
4203        Type.MEDIUMINT,
4204        Type.SMALLINT,
4205        Type.TINYINT,
4206    }
4207
4208    UNSIGNED_INTEGER_TYPES = {
4209        Type.UBIGINT,
4210        Type.UINT,
4211        Type.UINT128,
4212        Type.UINT256,
4213        Type.UMEDIUMINT,
4214        Type.USMALLINT,
4215        Type.UTINYINT,
4216    }
4217
4218    INTEGER_TYPES = {
4219        *SIGNED_INTEGER_TYPES,
4220        *UNSIGNED_INTEGER_TYPES,
4221        Type.BIT,
4222    }
4223
4224    FLOAT_TYPES = {
4225        Type.DOUBLE,
4226        Type.FLOAT,
4227    }
4228
4229    REAL_TYPES = {
4230        *FLOAT_TYPES,
4231        Type.BIGDECIMAL,
4232        Type.DECIMAL,
4233        Type.DECIMAL32,
4234        Type.DECIMAL64,
4235        Type.DECIMAL128,
4236        Type.MONEY,
4237        Type.SMALLMONEY,
4238        Type.UDECIMAL,
4239    }
4240
4241    NUMERIC_TYPES = {
4242        *INTEGER_TYPES,
4243        *REAL_TYPES,
4244    }
4245
4246    TEMPORAL_TYPES = {
4247        Type.DATE,
4248        Type.DATE32,
4249        Type.DATETIME,
4250        Type.DATETIME64,
4251        Type.TIME,
4252        Type.TIMESTAMP,
4253        Type.TIMESTAMPNTZ,
4254        Type.TIMESTAMPLTZ,
4255        Type.TIMESTAMPTZ,
4256        Type.TIMESTAMP_MS,
4257        Type.TIMESTAMP_NS,
4258        Type.TIMESTAMP_S,
4259        Type.TIMETZ,
4260    }
4261
4262    @classmethod
4263    def build(
4264        cls,
4265        dtype: DATA_TYPE,
4266        dialect: DialectType = None,
4267        udt: bool = False,
4268        copy: bool = True,
4269        **kwargs,
4270    ) -> DataType:
4271        """
4272        Constructs a DataType object.
4273
4274        Args:
4275            dtype: the data type of interest.
4276            dialect: the dialect to use for parsing `dtype`, in case it's a string.
4277            udt: when set to True, `dtype` will be used as-is if it can't be parsed into a
4278                DataType, thus creating a user-defined type.
4279            copy: whether to copy the data type.
4280            kwargs: additional arguments to pass in the constructor of DataType.
4281
4282        Returns:
4283            The constructed DataType object.
4284        """
4285        from sqlglot import parse_one
4286
4287        if isinstance(dtype, str):
4288            if dtype.upper() == "UNKNOWN":
4289                return DataType(this=DataType.Type.UNKNOWN, **kwargs)
4290
4291            try:
4292                data_type_exp = parse_one(
4293                    dtype, read=dialect, into=DataType, error_level=ErrorLevel.IGNORE
4294                )
4295            except ParseError:
4296                if udt:
4297                    return DataType(this=DataType.Type.USERDEFINED, kind=dtype, **kwargs)
4298                raise
4299        elif isinstance(dtype, DataType.Type):
4300            data_type_exp = DataType(this=dtype)
4301        elif isinstance(dtype, DataType):
4302            return maybe_copy(dtype, copy)
4303        else:
4304            raise ValueError(f"Invalid data type: {type(dtype)}. Expected str or DataType.Type")
4305
4306        return DataType(**{**data_type_exp.args, **kwargs})
4307
4308    def is_type(self, *dtypes: DATA_TYPE, check_nullable: bool = False) -> bool:
4309        """
4310        Checks whether this DataType matches one of the provided data types. Nested types or precision
4311        will be compared using "structural equivalence" semantics, so e.g. array<int> != array<float>.
4312
4313        Args:
4314            dtypes: the data types to compare this DataType to.
4315            check_nullable: whether to take the NULLABLE type constructor into account for the comparison.
4316                If false, it means that NULLABLE<INT> is equivalent to INT.
4317
4318        Returns:
4319            True, if and only if there is a type in `dtypes` which is equal to this DataType.
4320        """
4321        self_is_nullable = self.args.get("nullable")
4322        for dtype in dtypes:
4323            other_type = DataType.build(dtype, copy=False, udt=True)
4324            other_is_nullable = other_type.args.get("nullable")
4325            if (
4326                other_type.expressions
4327                or (check_nullable and (self_is_nullable or other_is_nullable))
4328                or self.this == DataType.Type.USERDEFINED
4329                or other_type.this == DataType.Type.USERDEFINED
4330            ):
4331                matches = self == other_type
4332            else:
4333                matches = self.this == other_type.this
4334
4335            if matches:
4336                return True
4337        return False
arg_types = {'this': True, 'expressions': False, 'nested': False, 'values': False, 'prefix': False, 'kind': False, 'nullable': False}
STRUCT_TYPES = {<Type.STRUCT: 'STRUCT'>, <Type.NESTED: 'NESTED'>, <Type.OBJECT: 'OBJECT'>}
ARRAY_TYPES = {<Type.ARRAY: 'ARRAY'>, <Type.LIST: 'LIST'>}
NESTED_TYPES = {<Type.MAP: 'MAP'>, <Type.NESTED: 'NESTED'>, <Type.ARRAY: 'ARRAY'>, <Type.OBJECT: 'OBJECT'>, <Type.LIST: 'LIST'>, <Type.STRUCT: 'STRUCT'>}
TEXT_TYPES = {<Type.NVARCHAR: 'NVARCHAR'>, <Type.TEXT: 'TEXT'>, <Type.CHAR: 'CHAR'>, <Type.VARCHAR: 'VARCHAR'>, <Type.NAME: 'NAME'>, <Type.NCHAR: 'NCHAR'>}
SIGNED_INTEGER_TYPES = {<Type.SMALLINT: 'SMALLINT'>, <Type.TINYINT: 'TINYINT'>, <Type.INT128: 'INT128'>, <Type.BIGINT: 'BIGINT'>, <Type.MEDIUMINT: 'MEDIUMINT'>, <Type.INT256: 'INT256'>, <Type.INT: 'INT'>}
UNSIGNED_INTEGER_TYPES = {<Type.USMALLINT: 'USMALLINT'>, <Type.UTINYINT: 'UTINYINT'>, <Type.UBIGINT: 'UBIGINT'>, <Type.UINT256: 'UINT256'>, <Type.UINT128: 'UINT128'>, <Type.UMEDIUMINT: 'UMEDIUMINT'>, <Type.UINT: 'UINT'>}
INTEGER_TYPES = {<Type.USMALLINT: 'USMALLINT'>, <Type.SMALLINT: 'SMALLINT'>, <Type.TINYINT: 'TINYINT'>, <Type.INT128: 'INT128'>, <Type.UTINYINT: 'UTINYINT'>, <Type.BIGINT: 'BIGINT'>, <Type.UBIGINT: 'UBIGINT'>, <Type.UINT128: 'UINT128'>, <Type.MEDIUMINT: 'MEDIUMINT'>, <Type.BIT: 'BIT'>, <Type.UMEDIUMINT: 'UMEDIUMINT'>, <Type.UINT256: 'UINT256'>, <Type.INT256: 'INT256'>, <Type.INT: 'INT'>, <Type.UINT: 'UINT'>}
FLOAT_TYPES = {<Type.FLOAT: 'FLOAT'>, <Type.DOUBLE: 'DOUBLE'>}
REAL_TYPES = {<Type.MONEY: 'MONEY'>, <Type.DECIMAL32: 'DECIMAL32'>, <Type.DECIMAL64: 'DECIMAL64'>, <Type.DOUBLE: 'DOUBLE'>, <Type.DECIMAL128: 'DECIMAL128'>, <Type.SMALLMONEY: 'SMALLMONEY'>, <Type.BIGDECIMAL: 'BIGDECIMAL'>, <Type.FLOAT: 'FLOAT'>, <Type.DECIMAL: 'DECIMAL'>, <Type.UDECIMAL: 'UDECIMAL'>}
NUMERIC_TYPES = {<Type.TINYINT: 'TINYINT'>, <Type.UBIGINT: 'UBIGINT'>, <Type.INT256: 'INT256'>, <Type.MEDIUMINT: 'MEDIUMINT'>, <Type.BIT: 'BIT'>, <Type.DOUBLE: 'DOUBLE'>, <Type.FLOAT: 'FLOAT'>, <Type.UMEDIUMINT: 'UMEDIUMINT'>, <Type.INT: 'INT'>, <Type.UINT: 'UINT'>, <Type.DECIMAL: 'DECIMAL'>, <Type.UDECIMAL: 'UDECIMAL'>, <Type.USMALLINT: 'USMALLINT'>, <Type.SMALLINT: 'SMALLINT'>, <Type.UTINYINT: 'UTINYINT'>, <Type.INT128: 'INT128'>, <Type.MONEY: 'MONEY'>, <Type.DECIMAL32: 'DECIMAL32'>, <Type.BIGINT: 'BIGINT'>, <Type.DECIMAL64: 'DECIMAL64'>, <Type.BIGDECIMAL: 'BIGDECIMAL'>, <Type.DECIMAL128: 'DECIMAL128'>, <Type.SMALLMONEY: 'SMALLMONEY'>, <Type.UINT256: 'UINT256'>, <Type.UINT128: 'UINT128'>}
TEMPORAL_TYPES = {<Type.DATE: 'DATE'>, <Type.TIME: 'TIME'>, <Type.TIMESTAMP: 'TIMESTAMP'>, <Type.TIMESTAMP_MS: 'TIMESTAMP_MS'>, <Type.TIMESTAMPTZ: 'TIMESTAMPTZ'>, <Type.TIMESTAMP_NS: 'TIMESTAMP_NS'>, <Type.DATETIME: 'DATETIME'>, <Type.TIMETZ: 'TIMETZ'>, <Type.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>, <Type.TIMESTAMP_S: 'TIMESTAMP_S'>, <Type.DATE32: 'DATE32'>, <Type.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>, <Type.DATETIME64: 'DATETIME64'>}
@classmethod
def build( cls, dtype: Union[str, DataType, DataType.Type], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, udt: bool = False, copy: bool = True, **kwargs) -> DataType:
4262    @classmethod
4263    def build(
4264        cls,
4265        dtype: DATA_TYPE,
4266        dialect: DialectType = None,
4267        udt: bool = False,
4268        copy: bool = True,
4269        **kwargs,
4270    ) -> DataType:
4271        """
4272        Constructs a DataType object.
4273
4274        Args:
4275            dtype: the data type of interest.
4276            dialect: the dialect to use for parsing `dtype`, in case it's a string.
4277            udt: when set to True, `dtype` will be used as-is if it can't be parsed into a
4278                DataType, thus creating a user-defined type.
4279            copy: whether to copy the data type.
4280            kwargs: additional arguments to pass in the constructor of DataType.
4281
4282        Returns:
4283            The constructed DataType object.
4284        """
4285        from sqlglot import parse_one
4286
4287        if isinstance(dtype, str):
4288            if dtype.upper() == "UNKNOWN":
4289                return DataType(this=DataType.Type.UNKNOWN, **kwargs)
4290
4291            try:
4292                data_type_exp = parse_one(
4293                    dtype, read=dialect, into=DataType, error_level=ErrorLevel.IGNORE
4294                )
4295            except ParseError:
4296                if udt:
4297                    return DataType(this=DataType.Type.USERDEFINED, kind=dtype, **kwargs)
4298                raise
4299        elif isinstance(dtype, DataType.Type):
4300            data_type_exp = DataType(this=dtype)
4301        elif isinstance(dtype, DataType):
4302            return maybe_copy(dtype, copy)
4303        else:
4304            raise ValueError(f"Invalid data type: {type(dtype)}. Expected str or DataType.Type")
4305
4306        return DataType(**{**data_type_exp.args, **kwargs})

Constructs a DataType object.

Arguments:
  • dtype: the data type of interest.
  • dialect: the dialect to use for parsing dtype, in case it's a string.
  • udt: when set to True, dtype will be used as-is if it can't be parsed into a DataType, thus creating a user-defined type.
  • copy: whether to copy the data type.
  • kwargs: additional arguments to pass in the constructor of DataType.
Returns:

The constructed DataType object.

def is_type( self, *dtypes: Union[str, DataType, DataType.Type], check_nullable: bool = False) -> bool:
4308    def is_type(self, *dtypes: DATA_TYPE, check_nullable: bool = False) -> bool:
4309        """
4310        Checks whether this DataType matches one of the provided data types. Nested types or precision
4311        will be compared using "structural equivalence" semantics, so e.g. array<int> != array<float>.
4312
4313        Args:
4314            dtypes: the data types to compare this DataType to.
4315            check_nullable: whether to take the NULLABLE type constructor into account for the comparison.
4316                If false, it means that NULLABLE<INT> is equivalent to INT.
4317
4318        Returns:
4319            True, if and only if there is a type in `dtypes` which is equal to this DataType.
4320        """
4321        self_is_nullable = self.args.get("nullable")
4322        for dtype in dtypes:
4323            other_type = DataType.build(dtype, copy=False, udt=True)
4324            other_is_nullable = other_type.args.get("nullable")
4325            if (
4326                other_type.expressions
4327                or (check_nullable and (self_is_nullable or other_is_nullable))
4328                or self.this == DataType.Type.USERDEFINED
4329                or other_type.this == DataType.Type.USERDEFINED
4330            ):
4331                matches = self == other_type
4332            else:
4333                matches = self.this == other_type.this
4334
4335            if matches:
4336                return True
4337        return False

Checks whether this DataType matches one of the provided data types. Nested types or precision will be compared using "structural equivalence" semantics, so e.g. array != array.

Arguments:
  • dtypes: the data types to compare this DataType to.
  • check_nullable: whether to take the NULLABLE type constructor into account for the comparison. If false, it means that NULLABLE is equivalent to INT.
Returns:

True, if and only if there is a type in dtypes which is equal to this DataType.

key = 'datatype'
class DataType.Type(sqlglot.helper.AutoName):
4062    class Type(AutoName):
4063        ARRAY = auto()
4064        AGGREGATEFUNCTION = auto()
4065        SIMPLEAGGREGATEFUNCTION = auto()
4066        BIGDECIMAL = auto()
4067        BIGINT = auto()
4068        BIGSERIAL = auto()
4069        BINARY = auto()
4070        BIT = auto()
4071        BOOLEAN = auto()
4072        BPCHAR = auto()
4073        CHAR = auto()
4074        DATE = auto()
4075        DATE32 = auto()
4076        DATEMULTIRANGE = auto()
4077        DATERANGE = auto()
4078        DATETIME = auto()
4079        DATETIME64 = auto()
4080        DECIMAL = auto()
4081        DECIMAL32 = auto()
4082        DECIMAL64 = auto()
4083        DECIMAL128 = auto()
4084        DOUBLE = auto()
4085        ENUM = auto()
4086        ENUM8 = auto()
4087        ENUM16 = auto()
4088        FIXEDSTRING = auto()
4089        FLOAT = auto()
4090        GEOGRAPHY = auto()
4091        GEOMETRY = auto()
4092        HLLSKETCH = auto()
4093        HSTORE = auto()
4094        IMAGE = auto()
4095        INET = auto()
4096        INT = auto()
4097        INT128 = auto()
4098        INT256 = auto()
4099        INT4MULTIRANGE = auto()
4100        INT4RANGE = auto()
4101        INT8MULTIRANGE = auto()
4102        INT8RANGE = auto()
4103        INTERVAL = auto()
4104        IPADDRESS = auto()
4105        IPPREFIX = auto()
4106        IPV4 = auto()
4107        IPV6 = auto()
4108        JSON = auto()
4109        JSONB = auto()
4110        LIST = auto()
4111        LONGBLOB = auto()
4112        LONGTEXT = auto()
4113        LOWCARDINALITY = auto()
4114        MAP = auto()
4115        MEDIUMBLOB = auto()
4116        MEDIUMINT = auto()
4117        MEDIUMTEXT = auto()
4118        MONEY = auto()
4119        NAME = auto()
4120        NCHAR = auto()
4121        NESTED = auto()
4122        NULL = auto()
4123        NUMMULTIRANGE = auto()
4124        NUMRANGE = auto()
4125        NVARCHAR = auto()
4126        OBJECT = auto()
4127        ROWVERSION = auto()
4128        SERIAL = auto()
4129        SET = auto()
4130        SMALLINT = auto()
4131        SMALLMONEY = auto()
4132        SMALLSERIAL = auto()
4133        STRUCT = auto()
4134        SUPER = auto()
4135        TEXT = auto()
4136        TINYBLOB = auto()
4137        TINYTEXT = auto()
4138        TIME = auto()
4139        TIMETZ = auto()
4140        TIMESTAMP = auto()
4141        TIMESTAMPNTZ = auto()
4142        TIMESTAMPLTZ = auto()
4143        TIMESTAMPTZ = auto()
4144        TIMESTAMP_S = auto()
4145        TIMESTAMP_MS = auto()
4146        TIMESTAMP_NS = auto()
4147        TINYINT = auto()
4148        TSMULTIRANGE = auto()
4149        TSRANGE = auto()
4150        TSTZMULTIRANGE = auto()
4151        TSTZRANGE = auto()
4152        UBIGINT = auto()
4153        UINT = auto()
4154        UINT128 = auto()
4155        UINT256 = auto()
4156        UMEDIUMINT = auto()
4157        UDECIMAL = auto()
4158        UNIQUEIDENTIFIER = auto()
4159        UNKNOWN = auto()  # Sentinel value, useful for type annotation
4160        USERDEFINED = "USER-DEFINED"
4161        USMALLINT = auto()
4162        UTINYINT = auto()
4163        UUID = auto()
4164        VARBINARY = auto()
4165        VARCHAR = auto()
4166        VARIANT = auto()
4167        VECTOR = auto()
4168        XML = auto()
4169        YEAR = auto()
4170        TDIGEST = auto()

An enumeration.

ARRAY = <Type.ARRAY: 'ARRAY'>
AGGREGATEFUNCTION = <Type.AGGREGATEFUNCTION: 'AGGREGATEFUNCTION'>
SIMPLEAGGREGATEFUNCTION = <Type.SIMPLEAGGREGATEFUNCTION: 'SIMPLEAGGREGATEFUNCTION'>
BIGDECIMAL = <Type.BIGDECIMAL: 'BIGDECIMAL'>
BIGINT = <Type.BIGINT: 'BIGINT'>
BIGSERIAL = <Type.BIGSERIAL: 'BIGSERIAL'>
BINARY = <Type.BINARY: 'BINARY'>
BIT = <Type.BIT: 'BIT'>
BOOLEAN = <Type.BOOLEAN: 'BOOLEAN'>
BPCHAR = <Type.BPCHAR: 'BPCHAR'>
CHAR = <Type.CHAR: 'CHAR'>
DATE = <Type.DATE: 'DATE'>
DATE32 = <Type.DATE32: 'DATE32'>
DATEMULTIRANGE = <Type.DATEMULTIRANGE: 'DATEMULTIRANGE'>
DATERANGE = <Type.DATERANGE: 'DATERANGE'>
DATETIME = <Type.DATETIME: 'DATETIME'>
DATETIME64 = <Type.DATETIME64: 'DATETIME64'>
DECIMAL = <Type.DECIMAL: 'DECIMAL'>
DECIMAL32 = <Type.DECIMAL32: 'DECIMAL32'>
DECIMAL64 = <Type.DECIMAL64: 'DECIMAL64'>
DECIMAL128 = <Type.DECIMAL128: 'DECIMAL128'>
DOUBLE = <Type.DOUBLE: 'DOUBLE'>
ENUM = <Type.ENUM: 'ENUM'>
ENUM8 = <Type.ENUM8: 'ENUM8'>
ENUM16 = <Type.ENUM16: 'ENUM16'>
FIXEDSTRING = <Type.FIXEDSTRING: 'FIXEDSTRING'>
FLOAT = <Type.FLOAT: 'FLOAT'>
GEOGRAPHY = <Type.GEOGRAPHY: 'GEOGRAPHY'>
GEOMETRY = <Type.GEOMETRY: 'GEOMETRY'>
HLLSKETCH = <Type.HLLSKETCH: 'HLLSKETCH'>
HSTORE = <Type.HSTORE: 'HSTORE'>
IMAGE = <Type.IMAGE: 'IMAGE'>
INET = <Type.INET: 'INET'>
INT = <Type.INT: 'INT'>
INT128 = <Type.INT128: 'INT128'>
INT256 = <Type.INT256: 'INT256'>
INT4MULTIRANGE = <Type.INT4MULTIRANGE: 'INT4MULTIRANGE'>
INT4RANGE = <Type.INT4RANGE: 'INT4RANGE'>
INT8MULTIRANGE = <Type.INT8MULTIRANGE: 'INT8MULTIRANGE'>
INT8RANGE = <Type.INT8RANGE: 'INT8RANGE'>
INTERVAL = <Type.INTERVAL: 'INTERVAL'>
IPADDRESS = <Type.IPADDRESS: 'IPADDRESS'>
IPPREFIX = <Type.IPPREFIX: 'IPPREFIX'>
IPV4 = <Type.IPV4: 'IPV4'>
IPV6 = <Type.IPV6: 'IPV6'>
JSON = <Type.JSON: 'JSON'>
JSONB = <Type.JSONB: 'JSONB'>
LIST = <Type.LIST: 'LIST'>
LONGBLOB = <Type.LONGBLOB: 'LONGBLOB'>
LONGTEXT = <Type.LONGTEXT: 'LONGTEXT'>
LOWCARDINALITY = <Type.LOWCARDINALITY: 'LOWCARDINALITY'>
MAP = <Type.MAP: 'MAP'>
MEDIUMBLOB = <Type.MEDIUMBLOB: 'MEDIUMBLOB'>
MEDIUMINT = <Type.MEDIUMINT: 'MEDIUMINT'>
MEDIUMTEXT = <Type.MEDIUMTEXT: 'MEDIUMTEXT'>
MONEY = <Type.MONEY: 'MONEY'>
NAME = <Type.NAME: 'NAME'>
NCHAR = <Type.NCHAR: 'NCHAR'>
NESTED = <Type.NESTED: 'NESTED'>
NULL = <Type.NULL: 'NULL'>
NUMMULTIRANGE = <Type.NUMMULTIRANGE: 'NUMMULTIRANGE'>
NUMRANGE = <Type.NUMRANGE: 'NUMRANGE'>
NVARCHAR = <Type.NVARCHAR: 'NVARCHAR'>
OBJECT = <Type.OBJECT: 'OBJECT'>
ROWVERSION = <Type.ROWVERSION: 'ROWVERSION'>
SERIAL = <Type.SERIAL: 'SERIAL'>
SET = <Type.SET: 'SET'>
SMALLINT = <Type.SMALLINT: 'SMALLINT'>
SMALLMONEY = <Type.SMALLMONEY: 'SMALLMONEY'>
SMALLSERIAL = <Type.SMALLSERIAL: 'SMALLSERIAL'>
STRUCT = <Type.STRUCT: 'STRUCT'>
SUPER = <Type.SUPER: 'SUPER'>
TEXT = <Type.TEXT: 'TEXT'>
TINYBLOB = <Type.TINYBLOB: 'TINYBLOB'>
TINYTEXT = <Type.TINYTEXT: 'TINYTEXT'>
TIME = <Type.TIME: 'TIME'>
TIMETZ = <Type.TIMETZ: 'TIMETZ'>
TIMESTAMP = <Type.TIMESTAMP: 'TIMESTAMP'>
TIMESTAMPNTZ = <Type.TIMESTAMPNTZ: 'TIMESTAMPNTZ'>
TIMESTAMPLTZ = <Type.TIMESTAMPLTZ: 'TIMESTAMPLTZ'>
TIMESTAMPTZ = <Type.TIMESTAMPTZ: 'TIMESTAMPTZ'>
TIMESTAMP_S = <Type.TIMESTAMP_S: 'TIMESTAMP_S'>
TIMESTAMP_MS = <Type.TIMESTAMP_MS: 'TIMESTAMP_MS'>
TIMESTAMP_NS = <Type.TIMESTAMP_NS: 'TIMESTAMP_NS'>
TINYINT = <Type.TINYINT: 'TINYINT'>
TSMULTIRANGE = <Type.TSMULTIRANGE: 'TSMULTIRANGE'>
TSRANGE = <Type.TSRANGE: 'TSRANGE'>
TSTZMULTIRANGE = <Type.TSTZMULTIRANGE: 'TSTZMULTIRANGE'>
TSTZRANGE = <Type.TSTZRANGE: 'TSTZRANGE'>
UBIGINT = <Type.UBIGINT: 'UBIGINT'>
UINT = <Type.UINT: 'UINT'>
UINT128 = <Type.UINT128: 'UINT128'>
UINT256 = <Type.UINT256: 'UINT256'>
UMEDIUMINT = <Type.UMEDIUMINT: 'UMEDIUMINT'>
UDECIMAL = <Type.UDECIMAL: 'UDECIMAL'>
UNIQUEIDENTIFIER = <Type.UNIQUEIDENTIFIER: 'UNIQUEIDENTIFIER'>
UNKNOWN = <Type.UNKNOWN: 'UNKNOWN'>
USERDEFINED = <Type.USERDEFINED: 'USER-DEFINED'>
USMALLINT = <Type.USMALLINT: 'USMALLINT'>
UTINYINT = <Type.UTINYINT: 'UTINYINT'>
UUID = <Type.UUID: 'UUID'>
VARBINARY = <Type.VARBINARY: 'VARBINARY'>
VARCHAR = <Type.VARCHAR: 'VARCHAR'>
VARIANT = <Type.VARIANT: 'VARIANT'>
VECTOR = <Type.VECTOR: 'VECTOR'>
XML = <Type.XML: 'XML'>
YEAR = <Type.YEAR: 'YEAR'>
TDIGEST = <Type.TDIGEST: 'TDIGEST'>
Inherited Members
enum.Enum
name
value
DATA_TYPE = typing.Union[str, DataType, DataType.Type]
class PseudoType(DataType):
4344class PseudoType(DataType):
4345    arg_types = {"this": True}
arg_types = {'this': True}
key = 'pseudotype'
class ObjectIdentifier(DataType):
4349class ObjectIdentifier(DataType):
4350    arg_types = {"this": True}
arg_types = {'this': True}
key = 'objectidentifier'
class SubqueryPredicate(Predicate):
4354class SubqueryPredicate(Predicate):
4355    pass
key = 'subquerypredicate'
class All(SubqueryPredicate):
4358class All(SubqueryPredicate):
4359    pass
key = 'all'
class Any(SubqueryPredicate):
4362class Any(SubqueryPredicate):
4363    pass
key = 'any'
class Exists(SubqueryPredicate):
4366class Exists(SubqueryPredicate):
4367    pass
key = 'exists'
class Command(Expression):
4372class Command(Expression):
4373    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'command'
class Transaction(Expression):
4376class Transaction(Expression):
4377    arg_types = {"this": False, "modes": False, "mark": False}
arg_types = {'this': False, 'modes': False, 'mark': False}
key = 'transaction'
class Commit(Expression):
4380class Commit(Expression):
4381    arg_types = {"chain": False, "this": False, "durability": False}
arg_types = {'chain': False, 'this': False, 'durability': False}
key = 'commit'
class Rollback(Expression):
4384class Rollback(Expression):
4385    arg_types = {"savepoint": False, "this": False}
arg_types = {'savepoint': False, 'this': False}
key = 'rollback'
class Alter(Expression):
4388class Alter(Expression):
4389    arg_types = {
4390        "this": True,
4391        "kind": True,
4392        "actions": True,
4393        "exists": False,
4394        "only": False,
4395        "options": False,
4396        "cluster": False,
4397        "not_valid": False,
4398    }
arg_types = {'this': True, 'kind': True, 'actions': True, 'exists': False, 'only': False, 'options': False, 'cluster': False, 'not_valid': False}
key = 'alter'
class AddConstraint(Expression):
4401class AddConstraint(Expression):
4402    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'addconstraint'
class DropPartition(Expression):
4405class DropPartition(Expression):
4406    arg_types = {"expressions": True, "exists": False}
arg_types = {'expressions': True, 'exists': False}
key = 'droppartition'
class ReplacePartition(Expression):
4410class ReplacePartition(Expression):
4411    arg_types = {"expression": True, "source": True}
arg_types = {'expression': True, 'source': True}
key = 'replacepartition'
class Binary(Condition):
4415class Binary(Condition):
4416    arg_types = {"this": True, "expression": True}
4417
4418    @property
4419    def left(self) -> Expression:
4420        return self.this
4421
4422    @property
4423    def right(self) -> Expression:
4424        return self.expression
arg_types = {'this': True, 'expression': True}
left: Expression
4418    @property
4419    def left(self) -> Expression:
4420        return self.this
right: Expression
4422    @property
4423    def right(self) -> Expression:
4424        return self.expression
key = 'binary'
class Add(Binary):
4427class Add(Binary):
4428    pass
key = 'add'
class Connector(Binary):
4431class Connector(Binary):
4432    pass
key = 'connector'
class And(Connector):
4435class And(Connector):
4436    pass
key = 'and'
class Or(Connector):
4439class Or(Connector):
4440    pass
key = 'or'
class BitwiseAnd(Binary):
4443class BitwiseAnd(Binary):
4444    pass
key = 'bitwiseand'
class BitwiseLeftShift(Binary):
4447class BitwiseLeftShift(Binary):
4448    pass
key = 'bitwiseleftshift'
class BitwiseOr(Binary):
4451class BitwiseOr(Binary):
4452    pass
key = 'bitwiseor'
class BitwiseRightShift(Binary):
4455class BitwiseRightShift(Binary):
4456    pass
key = 'bitwiserightshift'
class BitwiseXor(Binary):
4459class BitwiseXor(Binary):
4460    pass
key = 'bitwisexor'
class Div(Binary):
4463class Div(Binary):
4464    arg_types = {"this": True, "expression": True, "typed": False, "safe": False}
arg_types = {'this': True, 'expression': True, 'typed': False, 'safe': False}
key = 'div'
class Overlaps(Binary):
4467class Overlaps(Binary):
4468    pass
key = 'overlaps'
class Dot(Binary):
4471class Dot(Binary):
4472    @property
4473    def is_star(self) -> bool:
4474        return self.expression.is_star
4475
4476    @property
4477    def name(self) -> str:
4478        return self.expression.name
4479
4480    @property
4481    def output_name(self) -> str:
4482        return self.name
4483
4484    @classmethod
4485    def build(self, expressions: t.Sequence[Expression]) -> Dot:
4486        """Build a Dot object with a sequence of expressions."""
4487        if len(expressions) < 2:
4488            raise ValueError("Dot requires >= 2 expressions.")
4489
4490        return t.cast(Dot, reduce(lambda x, y: Dot(this=x, expression=y), expressions))
4491
4492    @property
4493    def parts(self) -> t.List[Expression]:
4494        """Return the parts of a table / column in order catalog, db, table."""
4495        this, *parts = self.flatten()
4496
4497        parts.reverse()
4498
4499        for arg in COLUMN_PARTS:
4500            part = this.args.get(arg)
4501
4502            if isinstance(part, Expression):
4503                parts.append(part)
4504
4505        parts.reverse()
4506        return parts
is_star: bool
4472    @property
4473    def is_star(self) -> bool:
4474        return self.expression.is_star

Checks whether an expression is a star.

name: str
4476    @property
4477    def name(self) -> str:
4478        return self.expression.name
output_name: str
4480    @property
4481    def output_name(self) -> str:
4482        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
@classmethod
def build( self, expressions: Sequence[Expression]) -> Dot:
4484    @classmethod
4485    def build(self, expressions: t.Sequence[Expression]) -> Dot:
4486        """Build a Dot object with a sequence of expressions."""
4487        if len(expressions) < 2:
4488            raise ValueError("Dot requires >= 2 expressions.")
4489
4490        return t.cast(Dot, reduce(lambda x, y: Dot(this=x, expression=y), expressions))

Build a Dot object with a sequence of expressions.

parts: List[Expression]
4492    @property
4493    def parts(self) -> t.List[Expression]:
4494        """Return the parts of a table / column in order catalog, db, table."""
4495        this, *parts = self.flatten()
4496
4497        parts.reverse()
4498
4499        for arg in COLUMN_PARTS:
4500            part = this.args.get(arg)
4501
4502            if isinstance(part, Expression):
4503                parts.append(part)
4504
4505        parts.reverse()
4506        return parts

Return the parts of a table / column in order catalog, db, table.

key = 'dot'
class DPipe(Binary):
4509class DPipe(Binary):
4510    arg_types = {"this": True, "expression": True, "safe": False}
arg_types = {'this': True, 'expression': True, 'safe': False}
key = 'dpipe'
class EQ(Binary, Predicate):
4513class EQ(Binary, Predicate):
4514    pass
key = 'eq'
class NullSafeEQ(Binary, Predicate):
4517class NullSafeEQ(Binary, Predicate):
4518    pass
key = 'nullsafeeq'
class NullSafeNEQ(Binary, Predicate):
4521class NullSafeNEQ(Binary, Predicate):
4522    pass
key = 'nullsafeneq'
class PropertyEQ(Binary):
4526class PropertyEQ(Binary):
4527    pass
key = 'propertyeq'
class Distance(Binary):
4530class Distance(Binary):
4531    pass
key = 'distance'
class Escape(Binary):
4534class Escape(Binary):
4535    pass
key = 'escape'
class Glob(Binary, Predicate):
4538class Glob(Binary, Predicate):
4539    pass
key = 'glob'
class GT(Binary, Predicate):
4542class GT(Binary, Predicate):
4543    pass
key = 'gt'
class GTE(Binary, Predicate):
4546class GTE(Binary, Predicate):
4547    pass
key = 'gte'
class ILike(Binary, Predicate):
4550class ILike(Binary, Predicate):
4551    pass
key = 'ilike'
class ILikeAny(Binary, Predicate):
4554class ILikeAny(Binary, Predicate):
4555    pass
key = 'ilikeany'
class IntDiv(Binary):
4558class IntDiv(Binary):
4559    pass
key = 'intdiv'
class Is(Binary, Predicate):
4562class Is(Binary, Predicate):
4563    pass
key = 'is'
class Kwarg(Binary):
4566class Kwarg(Binary):
4567    """Kwarg in special functions like func(kwarg => y)."""

Kwarg in special functions like func(kwarg => y).

key = 'kwarg'
class Like(Binary, Predicate):
4570class Like(Binary, Predicate):
4571    pass
key = 'like'
class LikeAny(Binary, Predicate):
4574class LikeAny(Binary, Predicate):
4575    pass
key = 'likeany'
class LT(Binary, Predicate):
4578class LT(Binary, Predicate):
4579    pass
key = 'lt'
class LTE(Binary, Predicate):
4582class LTE(Binary, Predicate):
4583    pass
key = 'lte'
class Mod(Binary):
4586class Mod(Binary):
4587    pass
key = 'mod'
class Mul(Binary):
4590class Mul(Binary):
4591    pass
key = 'mul'
class NEQ(Binary, Predicate):
4594class NEQ(Binary, Predicate):
4595    pass
key = 'neq'
class Operator(Binary):
4599class Operator(Binary):
4600    arg_types = {"this": True, "operator": True, "expression": True}
arg_types = {'this': True, 'operator': True, 'expression': True}
key = 'operator'
class SimilarTo(Binary, Predicate):
4603class SimilarTo(Binary, Predicate):
4604    pass
key = 'similarto'
class Slice(Binary):
4607class Slice(Binary):
4608    arg_types = {"this": False, "expression": False}
arg_types = {'this': False, 'expression': False}
key = 'slice'
class Sub(Binary):
4611class Sub(Binary):
4612    pass
key = 'sub'
class Unary(Condition):
4617class Unary(Condition):
4618    pass
key = 'unary'
class BitwiseNot(Unary):
4621class BitwiseNot(Unary):
4622    pass
key = 'bitwisenot'
class Not(Unary):
4625class Not(Unary):
4626    pass
key = 'not'
class Paren(Unary):
4629class Paren(Unary):
4630    @property
4631    def output_name(self) -> str:
4632        return self.this.name
output_name: str
4630    @property
4631    def output_name(self) -> str:
4632        return self.this.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'paren'
class Neg(Unary):
4635class Neg(Unary):
4636    def to_py(self) -> int | Decimal:
4637        if self.is_number:
4638            return self.this.to_py() * -1
4639        return super().to_py()
def to_py(self) -> int | decimal.Decimal:
4636    def to_py(self) -> int | Decimal:
4637        if self.is_number:
4638            return self.this.to_py() * -1
4639        return super().to_py()

Returns a Python object equivalent of the SQL node.

key = 'neg'
class Alias(Expression):
4642class Alias(Expression):
4643    arg_types = {"this": True, "alias": False}
4644
4645    @property
4646    def output_name(self) -> str:
4647        return self.alias
arg_types = {'this': True, 'alias': False}
output_name: str
4645    @property
4646    def output_name(self) -> str:
4647        return self.alias

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'alias'
class PivotAlias(Alias):
4652class PivotAlias(Alias):
4653    pass
key = 'pivotalias'
class PivotAny(Expression):
4658class PivotAny(Expression):
4659    arg_types = {"this": False}
arg_types = {'this': False}
key = 'pivotany'
class Aliases(Expression):
4662class Aliases(Expression):
4663    arg_types = {"this": True, "expressions": True}
4664
4665    @property
4666    def aliases(self):
4667        return self.expressions
arg_types = {'this': True, 'expressions': True}
aliases
4665    @property
4666    def aliases(self):
4667        return self.expressions
key = 'aliases'
class AtIndex(Expression):
4671class AtIndex(Expression):
4672    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'atindex'
class AtTimeZone(Expression):
4675class AtTimeZone(Expression):
4676    arg_types = {"this": True, "zone": True}
arg_types = {'this': True, 'zone': True}
key = 'attimezone'
class FromTimeZone(Expression):
4679class FromTimeZone(Expression):
4680    arg_types = {"this": True, "zone": True}
arg_types = {'this': True, 'zone': True}
key = 'fromtimezone'
class Between(Predicate):
4683class Between(Predicate):
4684    arg_types = {"this": True, "low": True, "high": True}
arg_types = {'this': True, 'low': True, 'high': True}
key = 'between'
class Bracket(Condition):
4687class Bracket(Condition):
4688    # https://cloud.google.com/bigquery/docs/reference/standard-sql/operators#array_subscript_operator
4689    arg_types = {
4690        "this": True,
4691        "expressions": True,
4692        "offset": False,
4693        "safe": False,
4694        "returns_list_for_maps": False,
4695    }
4696
4697    @property
4698    def output_name(self) -> str:
4699        if len(self.expressions) == 1:
4700            return self.expressions[0].output_name
4701
4702        return super().output_name
arg_types = {'this': True, 'expressions': True, 'offset': False, 'safe': False, 'returns_list_for_maps': False}
output_name: str
4697    @property
4698    def output_name(self) -> str:
4699        if len(self.expressions) == 1:
4700            return self.expressions[0].output_name
4701
4702        return super().output_name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'bracket'
class Distinct(Expression):
4705class Distinct(Expression):
4706    arg_types = {"expressions": False, "on": False}
arg_types = {'expressions': False, 'on': False}
key = 'distinct'
class In(Predicate):
4709class In(Predicate):
4710    arg_types = {
4711        "this": True,
4712        "expressions": False,
4713        "query": False,
4714        "unnest": False,
4715        "field": False,
4716        "is_global": False,
4717    }
arg_types = {'this': True, 'expressions': False, 'query': False, 'unnest': False, 'field': False, 'is_global': False}
key = 'in'
class ForIn(Expression):
4721class ForIn(Expression):
4722    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'forin'
class TimeUnit(Expression):
4725class TimeUnit(Expression):
4726    """Automatically converts unit arg into a var."""
4727
4728    arg_types = {"unit": False}
4729
4730    UNABBREVIATED_UNIT_NAME = {
4731        "D": "DAY",
4732        "H": "HOUR",
4733        "M": "MINUTE",
4734        "MS": "MILLISECOND",
4735        "NS": "NANOSECOND",
4736        "Q": "QUARTER",
4737        "S": "SECOND",
4738        "US": "MICROSECOND",
4739        "W": "WEEK",
4740        "Y": "YEAR",
4741    }
4742
4743    VAR_LIKE = (Column, Literal, Var)
4744
4745    def __init__(self, **args):
4746        unit = args.get("unit")
4747        if isinstance(unit, self.VAR_LIKE):
4748            args["unit"] = Var(
4749                this=(self.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
4750            )
4751        elif isinstance(unit, Week):
4752            unit.set("this", Var(this=unit.this.name.upper()))
4753
4754        super().__init__(**args)
4755
4756    @property
4757    def unit(self) -> t.Optional[Var | IntervalSpan]:
4758        return self.args.get("unit")

Automatically converts unit arg into a var.

TimeUnit(**args)
4745    def __init__(self, **args):
4746        unit = args.get("unit")
4747        if isinstance(unit, self.VAR_LIKE):
4748            args["unit"] = Var(
4749                this=(self.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
4750            )
4751        elif isinstance(unit, Week):
4752            unit.set("this", Var(this=unit.this.name.upper()))
4753
4754        super().__init__(**args)
arg_types = {'unit': False}
UNABBREVIATED_UNIT_NAME = {'D': 'DAY', 'H': 'HOUR', 'M': 'MINUTE', 'MS': 'MILLISECOND', 'NS': 'NANOSECOND', 'Q': 'QUARTER', 'S': 'SECOND', 'US': 'MICROSECOND', 'W': 'WEEK', 'Y': 'YEAR'}
VAR_LIKE = (<class 'Column'>, <class 'Literal'>, <class 'Var'>)
unit: Union[Var, IntervalSpan, NoneType]
4756    @property
4757    def unit(self) -> t.Optional[Var | IntervalSpan]:
4758        return self.args.get("unit")
key = 'timeunit'
class IntervalOp(TimeUnit):
4761class IntervalOp(TimeUnit):
4762    arg_types = {"unit": False, "expression": True}
4763
4764    def interval(self):
4765        return Interval(
4766            this=self.expression.copy(),
4767            unit=self.unit.copy() if self.unit else None,
4768        )
arg_types = {'unit': False, 'expression': True}
def interval(self):
4764    def interval(self):
4765        return Interval(
4766            this=self.expression.copy(),
4767            unit=self.unit.copy() if self.unit else None,
4768        )
key = 'intervalop'
class IntervalSpan(DataType):
4774class IntervalSpan(DataType):
4775    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'intervalspan'
class Interval(TimeUnit):
4778class Interval(TimeUnit):
4779    arg_types = {"this": False, "unit": False}
arg_types = {'this': False, 'unit': False}
key = 'interval'
class IgnoreNulls(Expression):
4782class IgnoreNulls(Expression):
4783    pass
key = 'ignorenulls'
class RespectNulls(Expression):
4786class RespectNulls(Expression):
4787    pass
key = 'respectnulls'
class HavingMax(Expression):
4791class HavingMax(Expression):
4792    arg_types = {"this": True, "expression": True, "max": True}
arg_types = {'this': True, 'expression': True, 'max': True}
key = 'havingmax'
class Func(Condition):
4796class Func(Condition):
4797    """
4798    The base class for all function expressions.
4799
4800    Attributes:
4801        is_var_len_args (bool): if set to True the last argument defined in arg_types will be
4802            treated as a variable length argument and the argument's value will be stored as a list.
4803        _sql_names (list): the SQL name (1st item in the list) and aliases (subsequent items) for this
4804            function expression. These values are used to map this node to a name during parsing as
4805            well as to provide the function's name during SQL string generation. By default the SQL
4806            name is set to the expression's class name transformed to snake case.
4807    """
4808
4809    is_var_len_args = False
4810
4811    @classmethod
4812    def from_arg_list(cls, args):
4813        if cls.is_var_len_args:
4814            all_arg_keys = list(cls.arg_types)
4815            # If this function supports variable length argument treat the last argument as such.
4816            non_var_len_arg_keys = all_arg_keys[:-1] if cls.is_var_len_args else all_arg_keys
4817            num_non_var = len(non_var_len_arg_keys)
4818
4819            args_dict = {arg_key: arg for arg, arg_key in zip(args, non_var_len_arg_keys)}
4820            args_dict[all_arg_keys[-1]] = args[num_non_var:]
4821        else:
4822            args_dict = {arg_key: arg for arg, arg_key in zip(args, cls.arg_types)}
4823
4824        return cls(**args_dict)
4825
4826    @classmethod
4827    def sql_names(cls):
4828        if cls is Func:
4829            raise NotImplementedError(
4830                "SQL name is only supported by concrete function implementations"
4831            )
4832        if "_sql_names" not in cls.__dict__:
4833            cls._sql_names = [camel_to_snake_case(cls.__name__)]
4834        return cls._sql_names
4835
4836    @classmethod
4837    def sql_name(cls):
4838        return cls.sql_names()[0]
4839
4840    @classmethod
4841    def default_parser_mappings(cls):
4842        return {name: cls.from_arg_list for name in cls.sql_names()}

The base class for all function expressions.

Attributes:
  • is_var_len_args (bool): if set to True the last argument defined in arg_types will be treated as a variable length argument and the argument's value will be stored as a list.
  • _sql_names (list): the SQL name (1st item in the list) and aliases (subsequent items) for this function expression. These values are used to map this node to a name during parsing as well as to provide the function's name during SQL string generation. By default the SQL name is set to the expression's class name transformed to snake case.
is_var_len_args = False
@classmethod
def from_arg_list(cls, args):
4811    @classmethod
4812    def from_arg_list(cls, args):
4813        if cls.is_var_len_args:
4814            all_arg_keys = list(cls.arg_types)
4815            # If this function supports variable length argument treat the last argument as such.
4816            non_var_len_arg_keys = all_arg_keys[:-1] if cls.is_var_len_args else all_arg_keys
4817            num_non_var = len(non_var_len_arg_keys)
4818
4819            args_dict = {arg_key: arg for arg, arg_key in zip(args, non_var_len_arg_keys)}
4820            args_dict[all_arg_keys[-1]] = args[num_non_var:]
4821        else:
4822            args_dict = {arg_key: arg for arg, arg_key in zip(args, cls.arg_types)}
4823
4824        return cls(**args_dict)
@classmethod
def sql_names(cls):
4826    @classmethod
4827    def sql_names(cls):
4828        if cls is Func:
4829            raise NotImplementedError(
4830                "SQL name is only supported by concrete function implementations"
4831            )
4832        if "_sql_names" not in cls.__dict__:
4833            cls._sql_names = [camel_to_snake_case(cls.__name__)]
4834        return cls._sql_names
@classmethod
def sql_name(cls):
4836    @classmethod
4837    def sql_name(cls):
4838        return cls.sql_names()[0]
@classmethod
def default_parser_mappings(cls):
4840    @classmethod
4841    def default_parser_mappings(cls):
4842        return {name: cls.from_arg_list for name in cls.sql_names()}
key = 'func'
class AggFunc(Func):
4845class AggFunc(Func):
4846    pass
key = 'aggfunc'
class ParameterizedAgg(AggFunc):
4849class ParameterizedAgg(AggFunc):
4850    arg_types = {"this": True, "expressions": True, "params": True}
arg_types = {'this': True, 'expressions': True, 'params': True}
key = 'parameterizedagg'
class Abs(Func):
4853class Abs(Func):
4854    pass
key = 'abs'
class ArgMax(AggFunc):
4857class ArgMax(AggFunc):
4858    arg_types = {"this": True, "expression": True, "count": False}
4859    _sql_names = ["ARG_MAX", "ARGMAX", "MAX_BY"]
arg_types = {'this': True, 'expression': True, 'count': False}
key = 'argmax'
class ArgMin(AggFunc):
4862class ArgMin(AggFunc):
4863    arg_types = {"this": True, "expression": True, "count": False}
4864    _sql_names = ["ARG_MIN", "ARGMIN", "MIN_BY"]
arg_types = {'this': True, 'expression': True, 'count': False}
key = 'argmin'
class ApproxTopK(AggFunc):
4867class ApproxTopK(AggFunc):
4868    arg_types = {"this": True, "expression": False, "counters": False}
arg_types = {'this': True, 'expression': False, 'counters': False}
key = 'approxtopk'
class Flatten(Func):
4871class Flatten(Func):
4872    pass
key = 'flatten'
class Transform(Func):
4876class Transform(Func):
4877    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'transform'
class Anonymous(Func):
4880class Anonymous(Func):
4881    arg_types = {"this": True, "expressions": False}
4882    is_var_len_args = True
4883
4884    @property
4885    def name(self) -> str:
4886        return self.this if isinstance(self.this, str) else self.this.name
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
name: str
4884    @property
4885    def name(self) -> str:
4886        return self.this if isinstance(self.this, str) else self.this.name
key = 'anonymous'
class AnonymousAggFunc(AggFunc):
4889class AnonymousAggFunc(AggFunc):
4890    arg_types = {"this": True, "expressions": False}
4891    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'anonymousaggfunc'
class CombinedAggFunc(AnonymousAggFunc):
4895class CombinedAggFunc(AnonymousAggFunc):
4896    arg_types = {"this": True, "expressions": False, "parts": True}
arg_types = {'this': True, 'expressions': False, 'parts': True}
key = 'combinedaggfunc'
class CombinedParameterizedAgg(ParameterizedAgg):
4899class CombinedParameterizedAgg(ParameterizedAgg):
4900    arg_types = {"this": True, "expressions": True, "params": True, "parts": True}
arg_types = {'this': True, 'expressions': True, 'params': True, 'parts': True}
key = 'combinedparameterizedagg'
class Hll(AggFunc):
4905class Hll(AggFunc):
4906    arg_types = {"this": True, "expressions": False}
4907    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'hll'
class ApproxDistinct(AggFunc):
4910class ApproxDistinct(AggFunc):
4911    arg_types = {"this": True, "accuracy": False}
4912    _sql_names = ["APPROX_DISTINCT", "APPROX_COUNT_DISTINCT"]
arg_types = {'this': True, 'accuracy': False}
key = 'approxdistinct'
class Array(Func):
4915class Array(Func):
4916    arg_types = {"expressions": False, "bracket_notation": False}
4917    is_var_len_args = True
arg_types = {'expressions': False, 'bracket_notation': False}
is_var_len_args = True
key = 'array'
class ToArray(Func):
4921class ToArray(Func):
4922    pass
key = 'toarray'
class List(Func):
4926class List(Func):
4927    arg_types = {"expressions": False}
4928    is_var_len_args = True
arg_types = {'expressions': False}
is_var_len_args = True
key = 'list'
class Pad(Func):
4932class Pad(Func):
4933    arg_types = {"this": True, "expression": True, "fill_pattern": False, "is_left": True}
arg_types = {'this': True, 'expression': True, 'fill_pattern': False, 'is_left': True}
key = 'pad'
class ToChar(Func):
4938class ToChar(Func):
4939    arg_types = {"this": True, "format": False, "nlsparam": False}
arg_types = {'this': True, 'format': False, 'nlsparam': False}
key = 'tochar'
class ToNumber(Func):
4944class ToNumber(Func):
4945    arg_types = {
4946        "this": True,
4947        "format": False,
4948        "nlsparam": False,
4949        "precision": False,
4950        "scale": False,
4951    }
arg_types = {'this': True, 'format': False, 'nlsparam': False, 'precision': False, 'scale': False}
key = 'tonumber'
class Convert(Func):
4955class Convert(Func):
4956    arg_types = {"this": True, "expression": True, "style": False}
arg_types = {'this': True, 'expression': True, 'style': False}
key = 'convert'
class ConvertTimezone(Func):
4959class ConvertTimezone(Func):
4960    arg_types = {"source_tz": False, "target_tz": True, "timestamp": True}
arg_types = {'source_tz': False, 'target_tz': True, 'timestamp': True}
key = 'converttimezone'
class GenerateSeries(Func):
4963class GenerateSeries(Func):
4964    arg_types = {"start": True, "end": True, "step": False, "is_end_exclusive": False}
arg_types = {'start': True, 'end': True, 'step': False, 'is_end_exclusive': False}
key = 'generateseries'
class ExplodingGenerateSeries(GenerateSeries):
4970class ExplodingGenerateSeries(GenerateSeries):
4971    pass
key = 'explodinggenerateseries'
class ArrayAgg(AggFunc):
4974class ArrayAgg(AggFunc):
4975    arg_types = {"this": True, "nulls_excluded": False}
arg_types = {'this': True, 'nulls_excluded': False}
key = 'arrayagg'
class ArrayUniqueAgg(AggFunc):
4978class ArrayUniqueAgg(AggFunc):
4979    pass
key = 'arrayuniqueagg'
class ArrayAll(Func):
4982class ArrayAll(Func):
4983    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'arrayall'
class ArrayAny(Func):
4987class ArrayAny(Func):
4988    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'arrayany'
class ArrayConcat(Func):
4991class ArrayConcat(Func):
4992    _sql_names = ["ARRAY_CONCAT", "ARRAY_CAT"]
4993    arg_types = {"this": True, "expressions": False}
4994    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'arrayconcat'
class ArrayConstructCompact(Func):
4997class ArrayConstructCompact(Func):
4998    arg_types = {"expressions": True}
4999    is_var_len_args = True
arg_types = {'expressions': True}
is_var_len_args = True
key = 'arrayconstructcompact'
class ArrayContains(Binary, Func):
5002class ArrayContains(Binary, Func):
5003    _sql_names = ["ARRAY_CONTAINS", "ARRAY_HAS"]
key = 'arraycontains'
class ArrayContainsAll(Binary, Func):
5006class ArrayContainsAll(Binary, Func):
5007    _sql_names = ["ARRAY_CONTAINS_ALL", "ARRAY_HAS_ALL"]
key = 'arraycontainsall'
class ArrayFilter(Func):
5010class ArrayFilter(Func):
5011    arg_types = {"this": True, "expression": True}
5012    _sql_names = ["FILTER", "ARRAY_FILTER"]
arg_types = {'this': True, 'expression': True}
key = 'arrayfilter'
class ArrayToString(Func):
5015class ArrayToString(Func):
5016    arg_types = {"this": True, "expression": True, "null": False}
5017    _sql_names = ["ARRAY_TO_STRING", "ARRAY_JOIN"]
arg_types = {'this': True, 'expression': True, 'null': False}
key = 'arraytostring'
class StringToArray(Func):
5020class StringToArray(Func):
5021    arg_types = {"this": True, "expression": True, "null": False}
5022    _sql_names = ["STRING_TO_ARRAY", "SPLIT_BY_STRING"]
arg_types = {'this': True, 'expression': True, 'null': False}
key = 'stringtoarray'
class ArrayOverlaps(Binary, Func):
5025class ArrayOverlaps(Binary, Func):
5026    pass
key = 'arrayoverlaps'
class ArraySize(Func):
5029class ArraySize(Func):
5030    arg_types = {"this": True, "expression": False}
5031    _sql_names = ["ARRAY_SIZE", "ARRAY_LENGTH"]
arg_types = {'this': True, 'expression': False}
key = 'arraysize'
class ArraySort(Func):
5034class ArraySort(Func):
5035    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'arraysort'
class ArraySum(Func):
5038class ArraySum(Func):
5039    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'arraysum'
class ArrayUnionAgg(AggFunc):
5042class ArrayUnionAgg(AggFunc):
5043    pass
key = 'arrayunionagg'
class Avg(AggFunc):
5046class Avg(AggFunc):
5047    pass
key = 'avg'
class AnyValue(AggFunc):
5050class AnyValue(AggFunc):
5051    pass
key = 'anyvalue'
class Lag(AggFunc):
5054class Lag(AggFunc):
5055    arg_types = {"this": True, "offset": False, "default": False}
arg_types = {'this': True, 'offset': False, 'default': False}
key = 'lag'
class Lead(AggFunc):
5058class Lead(AggFunc):
5059    arg_types = {"this": True, "offset": False, "default": False}
arg_types = {'this': True, 'offset': False, 'default': False}
key = 'lead'
class First(AggFunc):
5064class First(AggFunc):
5065    pass
key = 'first'
class Last(AggFunc):
5068class Last(AggFunc):
5069    pass
key = 'last'
class FirstValue(AggFunc):
5072class FirstValue(AggFunc):
5073    pass
key = 'firstvalue'
class LastValue(AggFunc):
5076class LastValue(AggFunc):
5077    pass
key = 'lastvalue'
class NthValue(AggFunc):
5080class NthValue(AggFunc):
5081    arg_types = {"this": True, "offset": True}
arg_types = {'this': True, 'offset': True}
key = 'nthvalue'
class Case(Func):
5084class Case(Func):
5085    arg_types = {"this": False, "ifs": True, "default": False}
5086
5087    def when(self, condition: ExpOrStr, then: ExpOrStr, copy: bool = True, **opts) -> Case:
5088        instance = maybe_copy(self, copy)
5089        instance.append(
5090            "ifs",
5091            If(
5092                this=maybe_parse(condition, copy=copy, **opts),
5093                true=maybe_parse(then, copy=copy, **opts),
5094            ),
5095        )
5096        return instance
5097
5098    def else_(self, condition: ExpOrStr, copy: bool = True, **opts) -> Case:
5099        instance = maybe_copy(self, copy)
5100        instance.set("default", maybe_parse(condition, copy=copy, **opts))
5101        return instance
arg_types = {'this': False, 'ifs': True, 'default': False}
def when( self, condition: Union[str, Expression], then: Union[str, Expression], copy: bool = True, **opts) -> Case:
5087    def when(self, condition: ExpOrStr, then: ExpOrStr, copy: bool = True, **opts) -> Case:
5088        instance = maybe_copy(self, copy)
5089        instance.append(
5090            "ifs",
5091            If(
5092                this=maybe_parse(condition, copy=copy, **opts),
5093                true=maybe_parse(then, copy=copy, **opts),
5094            ),
5095        )
5096        return instance
def else_( self, condition: Union[str, Expression], copy: bool = True, **opts) -> Case:
5098    def else_(self, condition: ExpOrStr, copy: bool = True, **opts) -> Case:
5099        instance = maybe_copy(self, copy)
5100        instance.set("default", maybe_parse(condition, copy=copy, **opts))
5101        return instance
key = 'case'
class Cast(Func):
5104class Cast(Func):
5105    arg_types = {
5106        "this": True,
5107        "to": True,
5108        "format": False,
5109        "safe": False,
5110        "action": False,
5111    }
5112
5113    @property
5114    def name(self) -> str:
5115        return self.this.name
5116
5117    @property
5118    def to(self) -> DataType:
5119        return self.args["to"]
5120
5121    @property
5122    def output_name(self) -> str:
5123        return self.name
5124
5125    def is_type(self, *dtypes: DATA_TYPE) -> bool:
5126        """
5127        Checks whether this Cast's DataType matches one of the provided data types. Nested types
5128        like arrays or structs will be compared using "structural equivalence" semantics, so e.g.
5129        array<int> != array<float>.
5130
5131        Args:
5132            dtypes: the data types to compare this Cast's DataType to.
5133
5134        Returns:
5135            True, if and only if there is a type in `dtypes` which is equal to this Cast's DataType.
5136        """
5137        return self.to.is_type(*dtypes)
arg_types = {'this': True, 'to': True, 'format': False, 'safe': False, 'action': False}
name: str
5113    @property
5114    def name(self) -> str:
5115        return self.this.name
to: DataType
5117    @property
5118    def to(self) -> DataType:
5119        return self.args["to"]
output_name: str
5121    @property
5122    def output_name(self) -> str:
5123        return self.name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
def is_type( self, *dtypes: Union[str, DataType, DataType.Type]) -> bool:
5125    def is_type(self, *dtypes: DATA_TYPE) -> bool:
5126        """
5127        Checks whether this Cast's DataType matches one of the provided data types. Nested types
5128        like arrays or structs will be compared using "structural equivalence" semantics, so e.g.
5129        array<int> != array<float>.
5130
5131        Args:
5132            dtypes: the data types to compare this Cast's DataType to.
5133
5134        Returns:
5135            True, if and only if there is a type in `dtypes` which is equal to this Cast's DataType.
5136        """
5137        return self.to.is_type(*dtypes)

Checks whether this Cast's DataType matches one of the provided data types. Nested types like arrays or structs will be compared using "structural equivalence" semantics, so e.g. array != array.

Arguments:
  • dtypes: the data types to compare this Cast's DataType to.
Returns:

True, if and only if there is a type in dtypes which is equal to this Cast's DataType.

key = 'cast'
class TryCast(Cast):
5140class TryCast(Cast):
5141    pass
key = 'trycast'
class Try(Func):
5144class Try(Func):
5145    pass
key = 'try'
class CastToStrType(Func):
5148class CastToStrType(Func):
5149    arg_types = {"this": True, "to": True}
arg_types = {'this': True, 'to': True}
key = 'casttostrtype'
class Collate(Binary, Func):
5152class Collate(Binary, Func):
5153    pass
key = 'collate'
class Ceil(Func):
5156class Ceil(Func):
5157    arg_types = {"this": True, "decimals": False}
5158    _sql_names = ["CEIL", "CEILING"]
arg_types = {'this': True, 'decimals': False}
key = 'ceil'
class Coalesce(Func):
5161class Coalesce(Func):
5162    arg_types = {"this": True, "expressions": False, "is_nvl": False}
5163    is_var_len_args = True
5164    _sql_names = ["COALESCE", "IFNULL", "NVL"]
arg_types = {'this': True, 'expressions': False, 'is_nvl': False}
is_var_len_args = True
key = 'coalesce'
class Chr(Func):
5167class Chr(Func):
5168    arg_types = {"expressions": True, "charset": False}
5169    is_var_len_args = True
5170    _sql_names = ["CHR", "CHAR"]
arg_types = {'expressions': True, 'charset': False}
is_var_len_args = True
key = 'chr'
class Concat(Func):
5173class Concat(Func):
5174    arg_types = {"expressions": True, "safe": False, "coalesce": False}
5175    is_var_len_args = True
arg_types = {'expressions': True, 'safe': False, 'coalesce': False}
is_var_len_args = True
key = 'concat'
class ConcatWs(Concat):
5178class ConcatWs(Concat):
5179    _sql_names = ["CONCAT_WS"]
key = 'concatws'
class ConnectByRoot(Func):
5183class ConnectByRoot(Func):
5184    pass
key = 'connectbyroot'
class Count(AggFunc):
5187class Count(AggFunc):
5188    arg_types = {"this": False, "expressions": False, "big_int": False}
5189    is_var_len_args = True
arg_types = {'this': False, 'expressions': False, 'big_int': False}
is_var_len_args = True
key = 'count'
class CountIf(AggFunc):
5192class CountIf(AggFunc):
5193    _sql_names = ["COUNT_IF", "COUNTIF"]
key = 'countif'
class Cbrt(Func):
5197class Cbrt(Func):
5198    pass
key = 'cbrt'
class CurrentDate(Func):
5201class CurrentDate(Func):
5202    arg_types = {"this": False}
arg_types = {'this': False}
key = 'currentdate'
class CurrentDatetime(Func):
5205class CurrentDatetime(Func):
5206    arg_types = {"this": False}
arg_types = {'this': False}
key = 'currentdatetime'
class CurrentTime(Func):
5209class CurrentTime(Func):
5210    arg_types = {"this": False}
arg_types = {'this': False}
key = 'currenttime'
class CurrentTimestamp(Func):
5213class CurrentTimestamp(Func):
5214    arg_types = {"this": False, "sysdate": False}
arg_types = {'this': False, 'sysdate': False}
key = 'currenttimestamp'
class CurrentUser(Func):
5217class CurrentUser(Func):
5218    arg_types = {"this": False}
arg_types = {'this': False}
key = 'currentuser'
class DateAdd(Func, IntervalOp):
5221class DateAdd(Func, IntervalOp):
5222    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'dateadd'
class DateSub(Func, IntervalOp):
5225class DateSub(Func, IntervalOp):
5226    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'datesub'
class DateDiff(Func, TimeUnit):
5229class DateDiff(Func, TimeUnit):
5230    _sql_names = ["DATEDIFF", "DATE_DIFF"]
5231    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'datediff'
class DateTrunc(Func):
5234class DateTrunc(Func):
5235    arg_types = {"unit": True, "this": True, "zone": False}
5236
5237    def __init__(self, **args):
5238        unit = args.get("unit")
5239        if isinstance(unit, TimeUnit.VAR_LIKE):
5240            args["unit"] = Literal.string(
5241                (TimeUnit.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
5242            )
5243        elif isinstance(unit, Week):
5244            unit.set("this", Literal.string(unit.this.name.upper()))
5245
5246        super().__init__(**args)
5247
5248    @property
5249    def unit(self) -> Expression:
5250        return self.args["unit"]
DateTrunc(**args)
5237    def __init__(self, **args):
5238        unit = args.get("unit")
5239        if isinstance(unit, TimeUnit.VAR_LIKE):
5240            args["unit"] = Literal.string(
5241                (TimeUnit.UNABBREVIATED_UNIT_NAME.get(unit.name) or unit.name).upper()
5242            )
5243        elif isinstance(unit, Week):
5244            unit.set("this", Literal.string(unit.this.name.upper()))
5245
5246        super().__init__(**args)
arg_types = {'unit': True, 'this': True, 'zone': False}
unit: Expression
5248    @property
5249    def unit(self) -> Expression:
5250        return self.args["unit"]
key = 'datetrunc'
class Datetime(Func):
5255class Datetime(Func):
5256    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'datetime'
class DatetimeAdd(Func, IntervalOp):
5259class DatetimeAdd(Func, IntervalOp):
5260    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'datetimeadd'
class DatetimeSub(Func, IntervalOp):
5263class DatetimeSub(Func, IntervalOp):
5264    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'datetimesub'
class DatetimeDiff(Func, TimeUnit):
5267class DatetimeDiff(Func, TimeUnit):
5268    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'datetimediff'
class DatetimeTrunc(Func, TimeUnit):
5271class DatetimeTrunc(Func, TimeUnit):
5272    arg_types = {"this": True, "unit": True, "zone": False}
arg_types = {'this': True, 'unit': True, 'zone': False}
key = 'datetimetrunc'
class DayOfWeek(Func):
5275class DayOfWeek(Func):
5276    _sql_names = ["DAY_OF_WEEK", "DAYOFWEEK"]
key = 'dayofweek'
class DayOfWeekIso(Func):
5281class DayOfWeekIso(Func):
5282    _sql_names = ["DAYOFWEEK_ISO", "ISODOW"]
key = 'dayofweekiso'
class DayOfMonth(Func):
5285class DayOfMonth(Func):
5286    _sql_names = ["DAY_OF_MONTH", "DAYOFMONTH"]
key = 'dayofmonth'
class DayOfYear(Func):
5289class DayOfYear(Func):
5290    _sql_names = ["DAY_OF_YEAR", "DAYOFYEAR"]
key = 'dayofyear'
class ToDays(Func):
5293class ToDays(Func):
5294    pass
key = 'todays'
class WeekOfYear(Func):
5297class WeekOfYear(Func):
5298    _sql_names = ["WEEK_OF_YEAR", "WEEKOFYEAR"]
key = 'weekofyear'
class MonthsBetween(Func):
5301class MonthsBetween(Func):
5302    arg_types = {"this": True, "expression": True, "roundoff": False}
arg_types = {'this': True, 'expression': True, 'roundoff': False}
key = 'monthsbetween'
class LastDay(Func, TimeUnit):
5305class LastDay(Func, TimeUnit):
5306    _sql_names = ["LAST_DAY", "LAST_DAY_OF_MONTH"]
5307    arg_types = {"this": True, "unit": False}
arg_types = {'this': True, 'unit': False}
key = 'lastday'
class Extract(Func):
5310class Extract(Func):
5311    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'extract'
class Timestamp(Func):
5314class Timestamp(Func):
5315    arg_types = {"this": False, "zone": False, "with_tz": False}
arg_types = {'this': False, 'zone': False, 'with_tz': False}
key = 'timestamp'
class TimestampAdd(Func, TimeUnit):
5318class TimestampAdd(Func, TimeUnit):
5319    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timestampadd'
class TimestampSub(Func, TimeUnit):
5322class TimestampSub(Func, TimeUnit):
5323    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timestampsub'
class TimestampDiff(Func, TimeUnit):
5326class TimestampDiff(Func, TimeUnit):
5327    _sql_names = ["TIMESTAMPDIFF", "TIMESTAMP_DIFF"]
5328    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timestampdiff'
class TimestampTrunc(Func, TimeUnit):
5331class TimestampTrunc(Func, TimeUnit):
5332    arg_types = {"this": True, "unit": True, "zone": False}
arg_types = {'this': True, 'unit': True, 'zone': False}
key = 'timestamptrunc'
class TimeAdd(Func, TimeUnit):
5335class TimeAdd(Func, TimeUnit):
5336    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timeadd'
class TimeSub(Func, TimeUnit):
5339class TimeSub(Func, TimeUnit):
5340    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timesub'
class TimeDiff(Func, TimeUnit):
5343class TimeDiff(Func, TimeUnit):
5344    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'timediff'
class TimeTrunc(Func, TimeUnit):
5347class TimeTrunc(Func, TimeUnit):
5348    arg_types = {"this": True, "unit": True, "zone": False}
arg_types = {'this': True, 'unit': True, 'zone': False}
key = 'timetrunc'
class DateFromParts(Func):
5351class DateFromParts(Func):
5352    _sql_names = ["DATE_FROM_PARTS", "DATEFROMPARTS"]
5353    arg_types = {"year": True, "month": True, "day": True}
arg_types = {'year': True, 'month': True, 'day': True}
key = 'datefromparts'
class TimeFromParts(Func):
5356class TimeFromParts(Func):
5357    _sql_names = ["TIME_FROM_PARTS", "TIMEFROMPARTS"]
5358    arg_types = {
5359        "hour": True,
5360        "min": True,
5361        "sec": True,
5362        "nano": False,
5363        "fractions": False,
5364        "precision": False,
5365    }
arg_types = {'hour': True, 'min': True, 'sec': True, 'nano': False, 'fractions': False, 'precision': False}
key = 'timefromparts'
class DateStrToDate(Func):
5368class DateStrToDate(Func):
5369    pass
key = 'datestrtodate'
class DateToDateStr(Func):
5372class DateToDateStr(Func):
5373    pass
key = 'datetodatestr'
class DateToDi(Func):
5376class DateToDi(Func):
5377    pass
key = 'datetodi'
class Date(Func):
5381class Date(Func):
5382    arg_types = {"this": False, "zone": False, "expressions": False}
5383    is_var_len_args = True
arg_types = {'this': False, 'zone': False, 'expressions': False}
is_var_len_args = True
key = 'date'
class Day(Func):
5386class Day(Func):
5387    pass
key = 'day'
class Decode(Func):
5390class Decode(Func):
5391    arg_types = {"this": True, "charset": True, "replace": False}
arg_types = {'this': True, 'charset': True, 'replace': False}
key = 'decode'
class DiToDate(Func):
5394class DiToDate(Func):
5395    pass
key = 'ditodate'
class Encode(Func):
5398class Encode(Func):
5399    arg_types = {"this": True, "charset": True}
arg_types = {'this': True, 'charset': True}
key = 'encode'
class Exp(Func):
5402class Exp(Func):
5403    pass
key = 'exp'
class Explode(Func):
5407class Explode(Func):
5408    arg_types = {"this": True, "expressions": False}
5409    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'explode'
class Inline(Func):
5413class Inline(Func):
5414    pass
key = 'inline'
class ExplodeOuter(Explode):
5417class ExplodeOuter(Explode):
5418    pass
key = 'explodeouter'
class Posexplode(Explode):
5421class Posexplode(Explode):
5422    pass
key = 'posexplode'
class PosexplodeOuter(Posexplode, ExplodeOuter):
5425class PosexplodeOuter(Posexplode, ExplodeOuter):
5426    pass
key = 'posexplodeouter'
class Unnest(Func, UDTF):
5429class Unnest(Func, UDTF):
5430    arg_types = {
5431        "expressions": True,
5432        "alias": False,
5433        "offset": False,
5434        "explode_array": False,
5435    }
5436
5437    @property
5438    def selects(self) -> t.List[Expression]:
5439        columns = super().selects
5440        offset = self.args.get("offset")
5441        if offset:
5442            columns = columns + [to_identifier("offset") if offset is True else offset]
5443        return columns
arg_types = {'expressions': True, 'alias': False, 'offset': False, 'explode_array': False}
selects: List[Expression]
5437    @property
5438    def selects(self) -> t.List[Expression]:
5439        columns = super().selects
5440        offset = self.args.get("offset")
5441        if offset:
5442            columns = columns + [to_identifier("offset") if offset is True else offset]
5443        return columns
key = 'unnest'
class Floor(Func):
5446class Floor(Func):
5447    arg_types = {"this": True, "decimals": False}
arg_types = {'this': True, 'decimals': False}
key = 'floor'
class FromBase64(Func):
5450class FromBase64(Func):
5451    pass
key = 'frombase64'
class ToBase64(Func):
5454class ToBase64(Func):
5455    pass
key = 'tobase64'
class FromISO8601Timestamp(Func):
5459class FromISO8601Timestamp(Func):
5460    _sql_names = ["FROM_ISO8601_TIMESTAMP"]
key = 'fromiso8601timestamp'
class GapFill(Func):
5463class GapFill(Func):
5464    arg_types = {
5465        "this": True,
5466        "ts_column": True,
5467        "bucket_width": True,
5468        "partitioning_columns": False,
5469        "value_columns": False,
5470        "origin": False,
5471        "ignore_nulls": False,
5472    }
arg_types = {'this': True, 'ts_column': True, 'bucket_width': True, 'partitioning_columns': False, 'value_columns': False, 'origin': False, 'ignore_nulls': False}
key = 'gapfill'
class GenerateDateArray(Func):
5476class GenerateDateArray(Func):
5477    arg_types = {"start": True, "end": True, "step": False}
arg_types = {'start': True, 'end': True, 'step': False}
key = 'generatedatearray'
class GenerateTimestampArray(Func):
5481class GenerateTimestampArray(Func):
5482    arg_types = {"start": True, "end": True, "step": True}
arg_types = {'start': True, 'end': True, 'step': True}
key = 'generatetimestamparray'
class Greatest(Func):
5485class Greatest(Func):
5486    arg_types = {"this": True, "expressions": False}
5487    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'greatest'
class GroupConcat(AggFunc):
5490class GroupConcat(AggFunc):
5491    arg_types = {"this": True, "separator": False}
arg_types = {'this': True, 'separator': False}
key = 'groupconcat'
class Hex(Func):
5494class Hex(Func):
5495    pass
key = 'hex'
class LowerHex(Hex):
5498class LowerHex(Hex):
5499    pass
key = 'lowerhex'
class Xor(Connector, Func):
5502class Xor(Connector, Func):
5503    arg_types = {"this": False, "expression": False, "expressions": False}
arg_types = {'this': False, 'expression': False, 'expressions': False}
key = 'xor'
class If(Func):
5506class If(Func):
5507    arg_types = {"this": True, "true": True, "false": False}
5508    _sql_names = ["IF", "IIF"]
arg_types = {'this': True, 'true': True, 'false': False}
key = 'if'
class Nullif(Func):
5511class Nullif(Func):
5512    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'nullif'
class Initcap(Func):
5515class Initcap(Func):
5516    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'initcap'
class IsNan(Func):
5519class IsNan(Func):
5520    _sql_names = ["IS_NAN", "ISNAN"]
key = 'isnan'
class IsInf(Func):
5523class IsInf(Func):
5524    _sql_names = ["IS_INF", "ISINF"]
key = 'isinf'
class JSON(Expression):
5528class JSON(Expression):
5529    arg_types = {"this": False, "with": False, "unique": False}
arg_types = {'this': False, 'with': False, 'unique': False}
key = 'json'
class JSONPath(Expression):
5532class JSONPath(Expression):
5533    arg_types = {"expressions": True, "escape": False}
5534
5535    @property
5536    def output_name(self) -> str:
5537        last_segment = self.expressions[-1].this
5538        return last_segment if isinstance(last_segment, str) else ""
arg_types = {'expressions': True, 'escape': False}
output_name: str
5535    @property
5536    def output_name(self) -> str:
5537        last_segment = self.expressions[-1].this
5538        return last_segment if isinstance(last_segment, str) else ""

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'jsonpath'
class JSONPathPart(Expression):
5541class JSONPathPart(Expression):
5542    arg_types = {}
arg_types = {}
key = 'jsonpathpart'
class JSONPathFilter(JSONPathPart):
5545class JSONPathFilter(JSONPathPart):
5546    arg_types = {"this": True}
arg_types = {'this': True}
key = 'jsonpathfilter'
class JSONPathKey(JSONPathPart):
5549class JSONPathKey(JSONPathPart):
5550    arg_types = {"this": True}
arg_types = {'this': True}
key = 'jsonpathkey'
class JSONPathRecursive(JSONPathPart):
5553class JSONPathRecursive(JSONPathPart):
5554    arg_types = {"this": False}
arg_types = {'this': False}
key = 'jsonpathrecursive'
class JSONPathRoot(JSONPathPart):
5557class JSONPathRoot(JSONPathPart):
5558    pass
key = 'jsonpathroot'
class JSONPathScript(JSONPathPart):
5561class JSONPathScript(JSONPathPart):
5562    arg_types = {"this": True}
arg_types = {'this': True}
key = 'jsonpathscript'
class JSONPathSlice(JSONPathPart):
5565class JSONPathSlice(JSONPathPart):
5566    arg_types = {"start": False, "end": False, "step": False}
arg_types = {'start': False, 'end': False, 'step': False}
key = 'jsonpathslice'
class JSONPathSelector(JSONPathPart):
5569class JSONPathSelector(JSONPathPart):
5570    arg_types = {"this": True}
arg_types = {'this': True}
key = 'jsonpathselector'
class JSONPathSubscript(JSONPathPart):
5573class JSONPathSubscript(JSONPathPart):
5574    arg_types = {"this": True}
arg_types = {'this': True}
key = 'jsonpathsubscript'
class JSONPathUnion(JSONPathPart):
5577class JSONPathUnion(JSONPathPart):
5578    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'jsonpathunion'
class JSONPathWildcard(JSONPathPart):
5581class JSONPathWildcard(JSONPathPart):
5582    pass
key = 'jsonpathwildcard'
class FormatJson(Expression):
5585class FormatJson(Expression):
5586    pass
key = 'formatjson'
class JSONKeyValue(Expression):
5589class JSONKeyValue(Expression):
5590    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'jsonkeyvalue'
class JSONObject(Func):
5593class JSONObject(Func):
5594    arg_types = {
5595        "expressions": False,
5596        "null_handling": False,
5597        "unique_keys": False,
5598        "return_type": False,
5599        "encoding": False,
5600    }
arg_types = {'expressions': False, 'null_handling': False, 'unique_keys': False, 'return_type': False, 'encoding': False}
key = 'jsonobject'
class JSONObjectAgg(AggFunc):
5603class JSONObjectAgg(AggFunc):
5604    arg_types = {
5605        "expressions": False,
5606        "null_handling": False,
5607        "unique_keys": False,
5608        "return_type": False,
5609        "encoding": False,
5610    }
arg_types = {'expressions': False, 'null_handling': False, 'unique_keys': False, 'return_type': False, 'encoding': False}
key = 'jsonobjectagg'
class JSONArray(Func):
5614class JSONArray(Func):
5615    arg_types = {
5616        "expressions": True,
5617        "null_handling": False,
5618        "return_type": False,
5619        "strict": False,
5620    }
arg_types = {'expressions': True, 'null_handling': False, 'return_type': False, 'strict': False}
key = 'jsonarray'
class JSONArrayAgg(Func):
5624class JSONArrayAgg(Func):
5625    arg_types = {
5626        "this": True,
5627        "order": False,
5628        "null_handling": False,
5629        "return_type": False,
5630        "strict": False,
5631    }
arg_types = {'this': True, 'order': False, 'null_handling': False, 'return_type': False, 'strict': False}
key = 'jsonarrayagg'
class JSONExists(Func):
5634class JSONExists(Func):
5635    arg_types = {"this": True, "path": True, "passing": False, "on_condition": False}
arg_types = {'this': True, 'path': True, 'passing': False, 'on_condition': False}
key = 'jsonexists'
class JSONColumnDef(Expression):
5640class JSONColumnDef(Expression):
5641    arg_types = {"this": False, "kind": False, "path": False, "nested_schema": False}
arg_types = {'this': False, 'kind': False, 'path': False, 'nested_schema': False}
key = 'jsoncolumndef'
class JSONSchema(Expression):
5644class JSONSchema(Expression):
5645    arg_types = {"expressions": True}
arg_types = {'expressions': True}
key = 'jsonschema'
class JSONValue(Expression):
5649class JSONValue(Expression):
5650    arg_types = {
5651        "this": True,
5652        "path": True,
5653        "returning": False,
5654        "on_condition": False,
5655    }
arg_types = {'this': True, 'path': True, 'returning': False, 'on_condition': False}
key = 'jsonvalue'
class JSONTable(Func):
5659class JSONTable(Func):
5660    arg_types = {
5661        "this": True,
5662        "schema": True,
5663        "path": False,
5664        "error_handling": False,
5665        "empty_handling": False,
5666    }
arg_types = {'this': True, 'schema': True, 'path': False, 'error_handling': False, 'empty_handling': False}
key = 'jsontable'
class ObjectInsert(Func):
5670class ObjectInsert(Func):
5671    arg_types = {
5672        "this": True,
5673        "key": True,
5674        "value": True,
5675        "update_flag": False,
5676    }
arg_types = {'this': True, 'key': True, 'value': True, 'update_flag': False}
key = 'objectinsert'
class OpenJSONColumnDef(Expression):
5679class OpenJSONColumnDef(Expression):
5680    arg_types = {"this": True, "kind": True, "path": False, "as_json": False}
arg_types = {'this': True, 'kind': True, 'path': False, 'as_json': False}
key = 'openjsoncolumndef'
class OpenJSON(Func):
5683class OpenJSON(Func):
5684    arg_types = {"this": True, "path": False, "expressions": False}
arg_types = {'this': True, 'path': False, 'expressions': False}
key = 'openjson'
class JSONBContains(Binary, Func):
5687class JSONBContains(Binary, Func):
5688    _sql_names = ["JSONB_CONTAINS"]
key = 'jsonbcontains'
class JSONExtract(Binary, Func):
5691class JSONExtract(Binary, Func):
5692    arg_types = {
5693        "this": True,
5694        "expression": True,
5695        "only_json_types": False,
5696        "expressions": False,
5697        "variant_extract": False,
5698    }
5699    _sql_names = ["JSON_EXTRACT"]
5700    is_var_len_args = True
5701
5702    @property
5703    def output_name(self) -> str:
5704        return self.expression.output_name if not self.expressions else ""
arg_types = {'this': True, 'expression': True, 'only_json_types': False, 'expressions': False, 'variant_extract': False}
is_var_len_args = True
output_name: str
5702    @property
5703    def output_name(self) -> str:
5704        return self.expression.output_name if not self.expressions else ""

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'jsonextract'
class JSONExtractScalar(Binary, Func):
5707class JSONExtractScalar(Binary, Func):
5708    arg_types = {"this": True, "expression": True, "only_json_types": False, "expressions": False}
5709    _sql_names = ["JSON_EXTRACT_SCALAR"]
5710    is_var_len_args = True
5711
5712    @property
5713    def output_name(self) -> str:
5714        return self.expression.output_name
arg_types = {'this': True, 'expression': True, 'only_json_types': False, 'expressions': False}
is_var_len_args = True
output_name: str
5712    @property
5713    def output_name(self) -> str:
5714        return self.expression.output_name

Name of the output column if this expression is a selection.

If the Expression has no output name, an empty string is returned.

Example:
>>> from sqlglot import parse_one
>>> parse_one("SELECT a")sqlglot.expressions[0].output_name
'a'
>>> parse_one("SELECT b AS c")sqlglot.expressions[0].output_name
'c'
>>> parse_one("SELECT 1 + 2")sqlglot.expressions[0].output_name
''
key = 'jsonextractscalar'
class JSONBExtract(Binary, Func):
5717class JSONBExtract(Binary, Func):
5718    _sql_names = ["JSONB_EXTRACT"]
key = 'jsonbextract'
class JSONBExtractScalar(Binary, Func):
5721class JSONBExtractScalar(Binary, Func):
5722    _sql_names = ["JSONB_EXTRACT_SCALAR"]
key = 'jsonbextractscalar'
class JSONFormat(Func):
5725class JSONFormat(Func):
5726    arg_types = {"this": False, "options": False}
5727    _sql_names = ["JSON_FORMAT"]
arg_types = {'this': False, 'options': False}
key = 'jsonformat'
class JSONArrayContains(Binary, Predicate, Func):
5731class JSONArrayContains(Binary, Predicate, Func):
5732    _sql_names = ["JSON_ARRAY_CONTAINS"]
key = 'jsonarraycontains'
class ParseJSON(Func):
5735class ParseJSON(Func):
5736    # BigQuery, Snowflake have PARSE_JSON, Presto has JSON_PARSE
5737    # Snowflake also has TRY_PARSE_JSON, which is represented using `safe`
5738    _sql_names = ["PARSE_JSON", "JSON_PARSE"]
5739    arg_types = {"this": True, "expression": False, "safe": False}
arg_types = {'this': True, 'expression': False, 'safe': False}
key = 'parsejson'
class Least(Func):
5742class Least(Func):
5743    arg_types = {"this": True, "expressions": False}
5744    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'least'
class Left(Func):
5747class Left(Func):
5748    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'left'
class Length(Func):
5755class Length(Func):
5756    arg_types = {"this": True, "binary": False}
5757    _sql_names = ["LENGTH", "LEN"]
arg_types = {'this': True, 'binary': False}
key = 'length'
class Levenshtein(Func):
5760class Levenshtein(Func):
5761    arg_types = {
5762        "this": True,
5763        "expression": False,
5764        "ins_cost": False,
5765        "del_cost": False,
5766        "sub_cost": False,
5767    }
arg_types = {'this': True, 'expression': False, 'ins_cost': False, 'del_cost': False, 'sub_cost': False}
key = 'levenshtein'
class Ln(Func):
5770class Ln(Func):
5771    pass
key = 'ln'
class Log(Func):
5774class Log(Func):
5775    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'log'
class LogicalOr(AggFunc):
5778class LogicalOr(AggFunc):
5779    _sql_names = ["LOGICAL_OR", "BOOL_OR", "BOOLOR_AGG"]
key = 'logicalor'
class LogicalAnd(AggFunc):
5782class LogicalAnd(AggFunc):
5783    _sql_names = ["LOGICAL_AND", "BOOL_AND", "BOOLAND_AGG"]
key = 'logicaland'
class Lower(Func):
5786class Lower(Func):
5787    _sql_names = ["LOWER", "LCASE"]
key = 'lower'
class Map(Func):
5790class Map(Func):
5791    arg_types = {"keys": False, "values": False}
5792
5793    @property
5794    def keys(self) -> t.List[Expression]:
5795        keys = self.args.get("keys")
5796        return keys.expressions if keys else []
5797
5798    @property
5799    def values(self) -> t.List[Expression]:
5800        values = self.args.get("values")
5801        return values.expressions if values else []
arg_types = {'keys': False, 'values': False}
keys: List[Expression]
5793    @property
5794    def keys(self) -> t.List[Expression]:
5795        keys = self.args.get("keys")
5796        return keys.expressions if keys else []
values: List[Expression]
5798    @property
5799    def values(self) -> t.List[Expression]:
5800        values = self.args.get("values")
5801        return values.expressions if values else []
key = 'map'
class ToMap(Func):
5805class ToMap(Func):
5806    pass
key = 'tomap'
class MapFromEntries(Func):
5809class MapFromEntries(Func):
5810    pass
key = 'mapfromentries'
class ScopeResolution(Expression):
5814class ScopeResolution(Expression):
5815    arg_types = {"this": False, "expression": True}
arg_types = {'this': False, 'expression': True}
key = 'scoperesolution'
class Stream(Expression):
5818class Stream(Expression):
5819    pass
key = 'stream'
class StarMap(Func):
5822class StarMap(Func):
5823    pass
key = 'starmap'
class VarMap(Func):
5826class VarMap(Func):
5827    arg_types = {"keys": True, "values": True}
5828    is_var_len_args = True
5829
5830    @property
5831    def keys(self) -> t.List[Expression]:
5832        return self.args["keys"].expressions
5833
5834    @property
5835    def values(self) -> t.List[Expression]:
5836        return self.args["values"].expressions
arg_types = {'keys': True, 'values': True}
is_var_len_args = True
keys: List[Expression]
5830    @property
5831    def keys(self) -> t.List[Expression]:
5832        return self.args["keys"].expressions
values: List[Expression]
5834    @property
5835    def values(self) -> t.List[Expression]:
5836        return self.args["values"].expressions
key = 'varmap'
class MatchAgainst(Func):
5840class MatchAgainst(Func):
5841    arg_types = {"this": True, "expressions": True, "modifier": False}
arg_types = {'this': True, 'expressions': True, 'modifier': False}
key = 'matchagainst'
class Max(AggFunc):
5844class Max(AggFunc):
5845    arg_types = {"this": True, "expressions": False}
5846    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'max'
class MD5(Func):
5849class MD5(Func):
5850    _sql_names = ["MD5"]
key = 'md5'
class MD5Digest(Func):
5854class MD5Digest(Func):
5855    _sql_names = ["MD5_DIGEST"]
key = 'md5digest'
class Min(AggFunc):
5858class Min(AggFunc):
5859    arg_types = {"this": True, "expressions": False}
5860    is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
is_var_len_args = True
key = 'min'
class Month(Func):
5863class Month(Func):
5864    pass
key = 'month'
class AddMonths(Func):
5867class AddMonths(Func):
5868    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'addmonths'
class Nvl2(Func):
5871class Nvl2(Func):
5872    arg_types = {"this": True, "true": True, "false": False}
arg_types = {'this': True, 'true': True, 'false': False}
key = 'nvl2'
class Normalize(Func):
5875class Normalize(Func):
5876    arg_types = {"this": True, "form": False}
arg_types = {'this': True, 'form': False}
key = 'normalize'
class Predict(Func):
5880class Predict(Func):
5881    arg_types = {"this": True, "expression": True, "params_struct": False}
arg_types = {'this': True, 'expression': True, 'params_struct': False}
key = 'predict'
class Pow(Binary, Func):
5884class Pow(Binary, Func):
5885    _sql_names = ["POWER", "POW"]
key = 'pow'
class PercentileCont(AggFunc):
5888class PercentileCont(AggFunc):
5889    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'percentilecont'
class PercentileDisc(AggFunc):
5892class PercentileDisc(AggFunc):
5893    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'percentiledisc'
class Quantile(AggFunc):
5896class Quantile(AggFunc):
5897    arg_types = {"this": True, "quantile": True}
arg_types = {'this': True, 'quantile': True}
key = 'quantile'
class ApproxQuantile(Quantile):
5900class ApproxQuantile(Quantile):
5901    arg_types = {"this": True, "quantile": True, "accuracy": False, "weight": False}
arg_types = {'this': True, 'quantile': True, 'accuracy': False, 'weight': False}
key = 'approxquantile'
class Quarter(Func):
5904class Quarter(Func):
5905    pass
key = 'quarter'
class Rand(Func):
5910class Rand(Func):
5911    _sql_names = ["RAND", "RANDOM"]
5912    arg_types = {"this": False, "lower": False, "upper": False}
arg_types = {'this': False, 'lower': False, 'upper': False}
key = 'rand'
class Randn(Func):
5915class Randn(Func):
5916    arg_types = {"this": False}
arg_types = {'this': False}
key = 'randn'
class RangeN(Func):
5919class RangeN(Func):
5920    arg_types = {"this": True, "expressions": True, "each": False}
arg_types = {'this': True, 'expressions': True, 'each': False}
key = 'rangen'
class ReadCSV(Func):
5923class ReadCSV(Func):
5924    _sql_names = ["READ_CSV"]
5925    is_var_len_args = True
5926    arg_types = {"this": True, "expressions": False}
is_var_len_args = True
arg_types = {'this': True, 'expressions': False}
key = 'readcsv'
class Reduce(Func):
5929class Reduce(Func):
5930    arg_types = {"this": True, "initial": True, "merge": True, "finish": False}
arg_types = {'this': True, 'initial': True, 'merge': True, 'finish': False}
key = 'reduce'
class RegexpExtract(Func):
5933class RegexpExtract(Func):
5934    arg_types = {
5935        "this": True,
5936        "expression": True,
5937        "position": False,
5938        "occurrence": False,
5939        "parameters": False,
5940        "group": False,
5941    }
arg_types = {'this': True, 'expression': True, 'position': False, 'occurrence': False, 'parameters': False, 'group': False}
key = 'regexpextract'
class RegexpReplace(Func):
5944class RegexpReplace(Func):
5945    arg_types = {
5946        "this": True,
5947        "expression": True,
5948        "replacement": False,
5949        "position": False,
5950        "occurrence": False,
5951        "modifiers": False,
5952    }
arg_types = {'this': True, 'expression': True, 'replacement': False, 'position': False, 'occurrence': False, 'modifiers': False}
key = 'regexpreplace'
class RegexpLike(Binary, Func):
5955class RegexpLike(Binary, Func):
5956    arg_types = {"this": True, "expression": True, "flag": False}
arg_types = {'this': True, 'expression': True, 'flag': False}
key = 'regexplike'
class RegexpILike(Binary, Func):
5959class RegexpILike(Binary, Func):
5960    arg_types = {"this": True, "expression": True, "flag": False}
arg_types = {'this': True, 'expression': True, 'flag': False}
key = 'regexpilike'
class RegexpSplit(Func):
5965class RegexpSplit(Func):
5966    arg_types = {"this": True, "expression": True, "limit": False}
arg_types = {'this': True, 'expression': True, 'limit': False}
key = 'regexpsplit'
class Repeat(Func):
5969class Repeat(Func):
5970    arg_types = {"this": True, "times": True}
arg_types = {'this': True, 'times': True}
key = 'repeat'
class Round(Func):
5975class Round(Func):
5976    arg_types = {"this": True, "decimals": False, "truncate": False}
arg_types = {'this': True, 'decimals': False, 'truncate': False}
key = 'round'
class RowNumber(Func):
5979class RowNumber(Func):
5980    arg_types: t.Dict[str, t.Any] = {}
arg_types: Dict[str, Any] = {}
key = 'rownumber'
class SafeDivide(Func):
5983class SafeDivide(Func):
5984    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'safedivide'
class SHA(Func):
5987class SHA(Func):
5988    _sql_names = ["SHA", "SHA1"]
key = 'sha'
class SHA2(Func):
5991class SHA2(Func):
5992    _sql_names = ["SHA2"]
5993    arg_types = {"this": True, "length": False}
arg_types = {'this': True, 'length': False}
key = 'sha2'
class Sign(Func):
5996class Sign(Func):
5997    _sql_names = ["SIGN", "SIGNUM"]
key = 'sign'
class SortArray(Func):
6000class SortArray(Func):
6001    arg_types = {"this": True, "asc": False}
arg_types = {'this': True, 'asc': False}
key = 'sortarray'
class Split(Func):
6004class Split(Func):
6005    arg_types = {"this": True, "expression": True, "limit": False}
arg_types = {'this': True, 'expression': True, 'limit': False}
key = 'split'
class Substring(Func):
6010class Substring(Func):
6011    arg_types = {"this": True, "start": False, "length": False}
arg_types = {'this': True, 'start': False, 'length': False}
key = 'substring'
class StandardHash(Func):
6014class StandardHash(Func):
6015    arg_types = {"this": True, "expression": False}
arg_types = {'this': True, 'expression': False}
key = 'standardhash'
class StartsWith(Func):
6018class StartsWith(Func):
6019    _sql_names = ["STARTS_WITH", "STARTSWITH"]
6020    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'startswith'
class StrPosition(Func):
6023class StrPosition(Func):
6024    arg_types = {
6025        "this": True,
6026        "substr": True,
6027        "position": False,
6028        "instance": False,
6029    }
arg_types = {'this': True, 'substr': True, 'position': False, 'instance': False}
key = 'strposition'
class StrToDate(Func):
6032class StrToDate(Func):
6033    arg_types = {"this": True, "format": False, "safe": False}
arg_types = {'this': True, 'format': False, 'safe': False}
key = 'strtodate'
class StrToTime(Func):
6036class StrToTime(Func):
6037    arg_types = {"this": True, "format": True, "zone": False, "safe": False}
arg_types = {'this': True, 'format': True, 'zone': False, 'safe': False}
key = 'strtotime'
class StrToUnix(Func):
6042class StrToUnix(Func):
6043    arg_types = {"this": False, "format": False}
arg_types = {'this': False, 'format': False}
key = 'strtounix'
class StrToMap(Func):
6048class StrToMap(Func):
6049    arg_types = {
6050        "this": True,
6051        "pair_delim": False,
6052        "key_value_delim": False,
6053        "duplicate_resolution_callback": False,
6054    }
arg_types = {'this': True, 'pair_delim': False, 'key_value_delim': False, 'duplicate_resolution_callback': False}
key = 'strtomap'
class NumberToStr(Func):
6057class NumberToStr(Func):
6058    arg_types = {"this": True, "format": True, "culture": False}
arg_types = {'this': True, 'format': True, 'culture': False}
key = 'numbertostr'
class FromBase(Func):
6061class FromBase(Func):
6062    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'frombase'
class Struct(Func):
6065class Struct(Func):
6066    arg_types = {"expressions": False}
6067    is_var_len_args = True
arg_types = {'expressions': False}
is_var_len_args = True
key = 'struct'
class StructExtract(Func):
6070class StructExtract(Func):
6071    arg_types = {"this": True, "expression": True}
arg_types = {'this': True, 'expression': True}
key = 'structextract'
class Stuff(Func):
6076class Stuff(Func):
6077    _sql_names = ["STUFF", "INSERT"]
6078    arg_types = {"this": True, "start": True, "length": True, "expression": True}
arg_types = {'this': True, 'start': True, 'length': True, 'expression': True}
key = 'stuff'
class Sum(AggFunc):
6081class Sum(AggFunc):
6082    pass
key = 'sum'
class Sqrt(Func):
6085class Sqrt(Func):
6086    pass
key = 'sqrt'
class Stddev(AggFunc):
6089class Stddev(AggFunc):
6090    _sql_names = ["STDDEV", "STDEV"]
key = 'stddev'
class StddevPop(AggFunc):
6093class StddevPop(AggFunc):
6094    pass
key = 'stddevpop'
class StddevSamp(AggFunc):
6097class StddevSamp(AggFunc):
6098    pass
key = 'stddevsamp'
class Time(Func):
6102class Time(Func):
6103    arg_types = {"this": False, "zone": False}
arg_types = {'this': False, 'zone': False}
key = 'time'
class TimeToStr(Func):
6106class TimeToStr(Func):
6107    arg_types = {"this": True, "format": True, "culture": False, "zone": False}
arg_types = {'this': True, 'format': True, 'culture': False, 'zone': False}
key = 'timetostr'
class TimeToTimeStr(Func):
6110class TimeToTimeStr(Func):
6111    pass
key = 'timetotimestr'
class TimeToUnix(Func):
6114class TimeToUnix(Func):
6115    pass
key = 'timetounix'
class TimeStrToDate(Func):
6118class TimeStrToDate(Func):
6119    pass
key = 'timestrtodate'
class TimeStrToTime(Func):
6122class TimeStrToTime(Func):
6123    arg_types = {"this": True, "zone": False}
arg_types = {'this': True, 'zone': False}
key = 'timestrtotime'
class TimeStrToUnix(Func):
6126class TimeStrToUnix(Func):
6127    pass
key = 'timestrtounix'
class Trim(Func):
6130class Trim(Func):
6131    arg_types = {
6132        "this": True,
6133        "expression": False,
6134        "position": False,
6135        "collation": False,
6136    }
arg_types = {'this': True, 'expression': False, 'position': False, 'collation': False}
key = 'trim'
class TsOrDsAdd(Func, TimeUnit):
6139class TsOrDsAdd(Func, TimeUnit):
6140    # return_type is used to correctly cast the arguments of this expression when transpiling it
6141    arg_types = {"this": True, "expression": True, "unit": False, "return_type": False}
6142
6143    @property
6144    def return_type(self) -> DataType:
6145        return DataType.build(self.args.get("return_type") or DataType.Type.DATE)
arg_types = {'this': True, 'expression': True, 'unit': False, 'return_type': False}
return_type: DataType
6143    @property
6144    def return_type(self) -> DataType:
6145        return DataType.build(self.args.get("return_type") or DataType.Type.DATE)
key = 'tsordsadd'
class TsOrDsDiff(Func, TimeUnit):
6148class TsOrDsDiff(Func, TimeUnit):
6149    arg_types = {"this": True, "expression": True, "unit": False}
arg_types = {'this': True, 'expression': True, 'unit': False}
key = 'tsordsdiff'
class TsOrDsToDateStr(Func):
6152class TsOrDsToDateStr(Func):
6153    pass
key = 'tsordstodatestr'
class TsOrDsToDate(Func):
6156class TsOrDsToDate(Func):
6157    arg_types = {"this": True, "format": False, "safe": False}
arg_types = {'this': True, 'format': False, 'safe': False}
key = 'tsordstodate'
class TsOrDsToTime(Func):
6160class TsOrDsToTime(Func):
6161    pass
key = 'tsordstotime'
class TsOrDsToTimestamp(Func):
6164class TsOrDsToTimestamp(Func):
6165    pass
key = 'tsordstotimestamp'
class TsOrDiToDi(Func):
6168class TsOrDiToDi(Func):
6169    pass
key = 'tsorditodi'
class Unhex(Func):
6172class Unhex(Func):
6173    pass
key = 'unhex'
class UnixDate(Func):
6177class UnixDate(Func):
6178    pass
key = 'unixdate'
class UnixToStr(Func):
6181class UnixToStr(Func):
6182    arg_types = {"this": True, "format": False}
arg_types = {'this': True, 'format': False}
key = 'unixtostr'
class UnixToTime(Func):
6187class UnixToTime(Func):
6188    arg_types = {
6189        "this": True,
6190        "scale": False,
6191        "zone": False,
6192        "hours": False,
6193        "minutes": False,
6194        "format": False,
6195    }
6196
6197    SECONDS = Literal.number(0)
6198    DECIS = Literal.number(1)
6199    CENTIS = Literal.number(2)
6200    MILLIS = Literal.number(3)
6201    DECIMILLIS = Literal.number(4)
6202    CENTIMILLIS = Literal.number(5)
6203    MICROS = Literal.number(6)
6204    DECIMICROS = Literal.number(7)
6205    CENTIMICROS = Literal.number(8)
6206    NANOS = Literal.number(9)
arg_types = {'this': True, 'scale': False, 'zone': False, 'hours': False, 'minutes': False, 'format': False}
SECONDS = Literal(this=0, is_string=False)
DECIS = Literal(this=1, is_string=False)
CENTIS = Literal(this=2, is_string=False)
MILLIS = Literal(this=3, is_string=False)
DECIMILLIS = Literal(this=4, is_string=False)
CENTIMILLIS = Literal(this=5, is_string=False)
MICROS = Literal(this=6, is_string=False)
DECIMICROS = Literal(this=7, is_string=False)
CENTIMICROS = Literal(this=8, is_string=False)
NANOS = Literal(this=9, is_string=False)
key = 'unixtotime'
class UnixToTimeStr(Func):
6209class UnixToTimeStr(Func):
6210    pass
key = 'unixtotimestr'
class UnpackColumns(Func):
6213class UnpackColumns(Func):
6214    pass
key = 'unpackcolumns'
class Uuid(Func):
6217class Uuid(Func):
6218    _sql_names = ["UUID", "GEN_RANDOM_UUID", "GENERATE_UUID", "UUID_STRING"]
6219
6220    arg_types = {"this": False, "name": False}
arg_types = {'this': False, 'name': False}
key = 'uuid'
class TimestampFromParts(Func):
6223class TimestampFromParts(Func):
6224    _sql_names = ["TIMESTAMP_FROM_PARTS", "TIMESTAMPFROMPARTS"]
6225    arg_types = {
6226        "year": True,
6227        "month": True,
6228        "day": True,
6229        "hour": True,
6230        "min": True,
6231        "sec": True,
6232        "nano": False,
6233        "zone": False,
6234        "milli": False,
6235    }
arg_types = {'year': True, 'month': True, 'day': True, 'hour': True, 'min': True, 'sec': True, 'nano': False, 'zone': False, 'milli': False}
key = 'timestampfromparts'
class Upper(Func):
6238class Upper(Func):
6239    _sql_names = ["UPPER", "UCASE"]
key = 'upper'
class Corr(Binary, AggFunc):
6242class Corr(Binary, AggFunc):
6243    pass
key = 'corr'
class Variance(AggFunc):
6246class Variance(AggFunc):
6247    _sql_names = ["VARIANCE", "VARIANCE_SAMP", "VAR_SAMP"]
key = 'variance'
class VariancePop(AggFunc):
6250class VariancePop(AggFunc):
6251    _sql_names = ["VARIANCE_POP", "VAR_POP"]
key = 'variancepop'
class CovarSamp(Binary, AggFunc):
6254class CovarSamp(Binary, AggFunc):
6255    pass
key = 'covarsamp'
class CovarPop(Binary, AggFunc):
6258class CovarPop(Binary, AggFunc):
6259    pass
key = 'covarpop'
class Week(Func):
6262class Week(Func):
6263    arg_types = {"this": True, "mode": False}
arg_types = {'this': True, 'mode': False}
key = 'week'
class XMLTable(Func):
6266class XMLTable(Func):
6267    arg_types = {"this": True, "passing": False, "columns": False, "by_ref": False}
arg_types = {'this': True, 'passing': False, 'columns': False, 'by_ref': False}
key = 'xmltable'
class Year(Func):
6270class Year(Func):
6271    pass
key = 'year'
class Use(Expression):
6274class Use(Expression):
6275    arg_types = {"this": True, "kind": False}
arg_types = {'this': True, 'kind': False}
key = 'use'
class Merge(Expression):
6278class Merge(Expression):
6279    arg_types = {
6280        "this": True,
6281        "using": True,
6282        "on": True,
6283        "expressions": True,
6284        "with": False,
6285        "returning": False,
6286    }
arg_types = {'this': True, 'using': True, 'on': True, 'expressions': True, 'with': False, 'returning': False}
key = 'merge'
class When(Func):
6289class When(Func):
6290    arg_types = {"matched": True, "source": False, "condition": False, "then": True}
arg_types = {'matched': True, 'source': False, 'condition': False, 'then': True}
key = 'when'
class NextValueFor(Func):
6295class NextValueFor(Func):
6296    arg_types = {"this": True, "order": False}
arg_types = {'this': True, 'order': False}
key = 'nextvaluefor'
class Semicolon(Expression):
6301class Semicolon(Expression):
6302    arg_types = {}
arg_types = {}
key = 'semicolon'
ALL_FUNCTIONS = [<class 'Abs'>, <class 'AddMonths'>, <class 'AnonymousAggFunc'>, <class 'AnyValue'>, <class 'ApproxDistinct'>, <class 'ApproxQuantile'>, <class 'ApproxTopK'>, <class 'ArgMax'>, <class 'ArgMin'>, <class 'Array'>, <class 'ArrayAgg'>, <class 'ArrayAll'>, <class 'ArrayAny'>, <class 'ArrayConcat'>, <class 'ArrayConstructCompact'>, <class 'ArrayContains'>, <class 'ArrayContainsAll'>, <class 'ArrayFilter'>, <class 'ArrayOverlaps'>, <class 'ArraySize'>, <class 'ArraySort'>, <class 'ArraySum'>, <class 'ArrayToString'>, <class 'ArrayUnionAgg'>, <class 'ArrayUniqueAgg'>, <class 'Avg'>, <class 'Case'>, <class 'Cast'>, <class 'CastToStrType'>, <class 'Cbrt'>, <class 'Ceil'>, <class 'Chr'>, <class 'Coalesce'>, <class 'Collate'>, <class 'CombinedAggFunc'>, <class 'CombinedParameterizedAgg'>, <class 'Concat'>, <class 'ConcatWs'>, <class 'ConnectByRoot'>, <class 'Convert'>, <class 'ConvertTimezone'>, <class 'Corr'>, <class 'Count'>, <class 'CountIf'>, <class 'CovarPop'>, <class 'CovarSamp'>, <class 'CurrentDate'>, <class 'CurrentDatetime'>, <class 'CurrentTime'>, <class 'CurrentTimestamp'>, <class 'CurrentUser'>, <class 'Date'>, <class 'DateAdd'>, <class 'DateDiff'>, <class 'DateFromParts'>, <class 'DateStrToDate'>, <class 'DateSub'>, <class 'DateToDateStr'>, <class 'DateToDi'>, <class 'DateTrunc'>, <class 'Datetime'>, <class 'DatetimeAdd'>, <class 'DatetimeDiff'>, <class 'DatetimeSub'>, <class 'DatetimeTrunc'>, <class 'Day'>, <class 'DayOfMonth'>, <class 'DayOfWeek'>, <class 'DayOfWeekIso'>, <class 'DayOfYear'>, <class 'Decode'>, <class 'DiToDate'>, <class 'Encode'>, <class 'Exp'>, <class 'Explode'>, <class 'ExplodeOuter'>, <class 'ExplodingGenerateSeries'>, <class 'Extract'>, <class 'First'>, <class 'FirstValue'>, <class 'Flatten'>, <class 'Floor'>, <class 'FromBase'>, <class 'FromBase64'>, <class 'FromISO8601Timestamp'>, <class 'GapFill'>, <class 'GenerateDateArray'>, <class 'GenerateSeries'>, <class 'GenerateTimestampArray'>, <class 'Greatest'>, <class 'GroupConcat'>, <class 'Hex'>, <class 'Hll'>, <class 'If'>, <class 'Initcap'>, <class 'Inline'>, <class 'IsInf'>, <class 'IsNan'>, <class 'JSONArray'>, <class 'JSONArrayAgg'>, <class 'JSONArrayContains'>, <class 'JSONBContains'>, <class 'JSONBExtract'>, <class 'JSONBExtractScalar'>, <class 'JSONExists'>, <class 'JSONExtract'>, <class 'JSONExtractScalar'>, <class 'JSONFormat'>, <class 'JSONObject'>, <class 'JSONObjectAgg'>, <class 'JSONTable'>, <class 'Lag'>, <class 'Last'>, <class 'LastDay'>, <class 'LastValue'>, <class 'Lead'>, <class 'Least'>, <class 'Left'>, <class 'Length'>, <class 'Levenshtein'>, <class 'List'>, <class 'Ln'>, <class 'Log'>, <class 'LogicalAnd'>, <class 'LogicalOr'>, <class 'Lower'>, <class 'LowerHex'>, <class 'MD5'>, <class 'MD5Digest'>, <class 'Map'>, <class 'MapFromEntries'>, <class 'MatchAgainst'>, <class 'Max'>, <class 'Min'>, <class 'Month'>, <class 'MonthsBetween'>, <class 'NextValueFor'>, <class 'Normalize'>, <class 'NthValue'>, <class 'Nullif'>, <class 'NumberToStr'>, <class 'Nvl2'>, <class 'ObjectInsert'>, <class 'OpenJSON'>, <class 'Pad'>, <class 'ParameterizedAgg'>, <class 'ParseJSON'>, <class 'PercentileCont'>, <class 'PercentileDisc'>, <class 'Posexplode'>, <class 'PosexplodeOuter'>, <class 'Pow'>, <class 'Predict'>, <class 'Quantile'>, <class 'Quarter'>, <class 'Rand'>, <class 'Randn'>, <class 'RangeN'>, <class 'ReadCSV'>, <class 'Reduce'>, <class 'RegexpExtract'>, <class 'RegexpILike'>, <class 'RegexpLike'>, <class 'RegexpReplace'>, <class 'RegexpSplit'>, <class 'Repeat'>, <class 'Right'>, <class 'Round'>, <class 'RowNumber'>, <class 'SHA'>, <class 'SHA2'>, <class 'SafeDivide'>, <class 'Sign'>, <class 'SortArray'>, <class 'Split'>, <class 'Sqrt'>, <class 'StandardHash'>, <class 'StarMap'>, <class 'StartsWith'>, <class 'Stddev'>, <class 'StddevPop'>, <class 'StddevSamp'>, <class 'StrPosition'>, <class 'StrToDate'>, <class 'StrToMap'>, <class 'StrToTime'>, <class 'StrToUnix'>, <class 'StringToArray'>, <class 'Struct'>, <class 'StructExtract'>, <class 'Stuff'>, <class 'Substring'>, <class 'Sum'>, <class 'Time'>, <class 'TimeAdd'>, <class 'TimeDiff'>, <class 'TimeFromParts'>, <class 'TimeStrToDate'>, <class 'TimeStrToTime'>, <class 'TimeStrToUnix'>, <class 'TimeSub'>, <class 'TimeToStr'>, <class 'TimeToTimeStr'>, <class 'TimeToUnix'>, <class 'TimeTrunc'>, <class 'Timestamp'>, <class 'TimestampAdd'>, <class 'TimestampDiff'>, <class 'TimestampFromParts'>, <class 'TimestampSub'>, <class 'TimestampTrunc'>, <class 'ToArray'>, <class 'ToBase64'>, <class 'ToChar'>, <class 'ToDays'>, <class 'ToMap'>, <class 'ToNumber'>, <class 'Transform'>, <class 'Trim'>, <class 'Try'>, <class 'TryCast'>, <class 'TsOrDiToDi'>, <class 'TsOrDsAdd'>, <class 'TsOrDsDiff'>, <class 'TsOrDsToDate'>, <class 'TsOrDsToDateStr'>, <class 'TsOrDsToTime'>, <class 'TsOrDsToTimestamp'>, <class 'Unhex'>, <class 'UnixDate'>, <class 'UnixToStr'>, <class 'UnixToTime'>, <class 'UnixToTimeStr'>, <class 'Unnest'>, <class 'UnpackColumns'>, <class 'Upper'>, <class 'Uuid'>, <class 'VarMap'>, <class 'Variance'>, <class 'VariancePop'>, <class 'Week'>, <class 'WeekOfYear'>, <class 'When'>, <class 'XMLTable'>, <class 'Xor'>, <class 'Year'>]
FUNCTION_BY_NAME = {'ABS': <class 'Abs'>, 'ADD_MONTHS': <class 'AddMonths'>, 'ANONYMOUS_AGG_FUNC': <class 'AnonymousAggFunc'>, 'ANY_VALUE': <class 'AnyValue'>, 'APPROX_DISTINCT': <class 'ApproxDistinct'>, 'APPROX_COUNT_DISTINCT': <class 'ApproxDistinct'>, 'APPROX_QUANTILE': <class 'ApproxQuantile'>, 'APPROX_TOP_K': <class 'ApproxTopK'>, 'ARG_MAX': <class 'ArgMax'>, 'ARGMAX': <class 'ArgMax'>, 'MAX_BY': <class 'ArgMax'>, 'ARG_MIN': <class 'ArgMin'>, 'ARGMIN': <class 'ArgMin'>, 'MIN_BY': <class 'ArgMin'>, 'ARRAY': <class 'Array'>, 'ARRAY_AGG': <class 'ArrayAgg'>, 'ARRAY_ALL': <class 'ArrayAll'>, 'ARRAY_ANY': <class 'ArrayAny'>, 'ARRAY_CONCAT': <class 'ArrayConcat'>, 'ARRAY_CAT': <class 'ArrayConcat'>, 'ARRAY_CONSTRUCT_COMPACT': <class 'ArrayConstructCompact'>, 'ARRAY_CONTAINS': <class 'ArrayContains'>, 'ARRAY_HAS': <class 'ArrayContains'>, 'ARRAY_CONTAINS_ALL': <class 'ArrayContainsAll'>, 'ARRAY_HAS_ALL': <class 'ArrayContainsAll'>, 'FILTER': <class 'ArrayFilter'>, 'ARRAY_FILTER': <class 'ArrayFilter'>, 'ARRAY_OVERLAPS': <class 'ArrayOverlaps'>, 'ARRAY_SIZE': <class 'ArraySize'>, 'ARRAY_LENGTH': <class 'ArraySize'>, 'ARRAY_SORT': <class 'ArraySort'>, 'ARRAY_SUM': <class 'ArraySum'>, 'ARRAY_TO_STRING': <class 'ArrayToString'>, 'ARRAY_JOIN': <class 'ArrayToString'>, 'ARRAY_UNION_AGG': <class 'ArrayUnionAgg'>, 'ARRAY_UNIQUE_AGG': <class 'ArrayUniqueAgg'>, 'AVG': <class 'Avg'>, 'CASE': <class 'Case'>, 'CAST': <class 'Cast'>, 'CAST_TO_STR_TYPE': <class 'CastToStrType'>, 'CBRT': <class 'Cbrt'>, 'CEIL': <class 'Ceil'>, 'CEILING': <class 'Ceil'>, 'CHR': <class 'Chr'>, 'CHAR': <class 'Chr'>, 'COALESCE': <class 'Coalesce'>, 'IFNULL': <class 'Coalesce'>, 'NVL': <class 'Coalesce'>, 'COLLATE': <class 'Collate'>, 'COMBINED_AGG_FUNC': <class 'CombinedAggFunc'>, 'COMBINED_PARAMETERIZED_AGG': <class 'CombinedParameterizedAgg'>, 'CONCAT': <class 'Concat'>, 'CONCAT_WS': <class 'ConcatWs'>, 'CONNECT_BY_ROOT': <class 'ConnectByRoot'>, 'CONVERT': <class 'Convert'>, 'CONVERT_TIMEZONE': <class 'ConvertTimezone'>, 'CORR': <class 'Corr'>, 'COUNT': <class 'Count'>, 'COUNT_IF': <class 'CountIf'>, 'COUNTIF': <class 'CountIf'>, 'COVAR_POP': <class 'CovarPop'>, 'COVAR_SAMP': <class 'CovarSamp'>, 'CURRENT_DATE': <class 'CurrentDate'>, 'CURRENT_DATETIME': <class 'CurrentDatetime'>, 'CURRENT_TIME': <class 'CurrentTime'>, 'CURRENT_TIMESTAMP': <class 'CurrentTimestamp'>, 'CURRENT_USER': <class 'CurrentUser'>, 'DATE': <class 'Date'>, 'DATE_ADD': <class 'DateAdd'>, 'DATEDIFF': <class 'DateDiff'>, 'DATE_DIFF': <class 'DateDiff'>, 'DATE_FROM_PARTS': <class 'DateFromParts'>, 'DATEFROMPARTS': <class 'DateFromParts'>, 'DATE_STR_TO_DATE': <class 'DateStrToDate'>, 'DATE_SUB': <class 'DateSub'>, 'DATE_TO_DATE_STR': <class 'DateToDateStr'>, 'DATE_TO_DI': <class 'DateToDi'>, 'DATE_TRUNC': <class 'DateTrunc'>, 'DATETIME': <class 'Datetime'>, 'DATETIME_ADD': <class 'DatetimeAdd'>, 'DATETIME_DIFF': <class 'DatetimeDiff'>, 'DATETIME_SUB': <class 'DatetimeSub'>, 'DATETIME_TRUNC': <class 'DatetimeTrunc'>, 'DAY': <class 'Day'>, 'DAY_OF_MONTH': <class 'DayOfMonth'>, 'DAYOFMONTH': <class 'DayOfMonth'>, 'DAY_OF_WEEK': <class 'DayOfWeek'>, 'DAYOFWEEK': <class 'DayOfWeek'>, 'DAYOFWEEK_ISO': <class 'DayOfWeekIso'>, 'ISODOW': <class 'DayOfWeekIso'>, 'DAY_OF_YEAR': <class 'DayOfYear'>, 'DAYOFYEAR': <class 'DayOfYear'>, 'DECODE': <class 'Decode'>, 'DI_TO_DATE': <class 'DiToDate'>, 'ENCODE': <class 'Encode'>, 'EXP': <class 'Exp'>, 'EXPLODE': <class 'Explode'>, 'EXPLODE_OUTER': <class 'ExplodeOuter'>, 'EXPLODING_GENERATE_SERIES': <class 'ExplodingGenerateSeries'>, 'EXTRACT': <class 'Extract'>, 'FIRST': <class 'First'>, 'FIRST_VALUE': <class 'FirstValue'>, 'FLATTEN': <class 'Flatten'>, 'FLOOR': <class 'Floor'>, 'FROM_BASE': <class 'FromBase'>, 'FROM_BASE64': <class 'FromBase64'>, 'FROM_ISO8601_TIMESTAMP': <class 'FromISO8601Timestamp'>, 'GAP_FILL': <class 'GapFill'>, 'GENERATE_DATE_ARRAY': <class 'GenerateDateArray'>, 'GENERATE_SERIES': <class 'GenerateSeries'>, 'GENERATE_TIMESTAMP_ARRAY': <class 'GenerateTimestampArray'>, 'GREATEST': <class 'Greatest'>, 'GROUP_CONCAT': <class 'GroupConcat'>, 'HEX': <class 'Hex'>, 'HLL': <class 'Hll'>, 'IF': <class 'If'>, 'IIF': <class 'If'>, 'INITCAP': <class 'Initcap'>, 'INLINE': <class 'Inline'>, 'IS_INF': <class 'IsInf'>, 'ISINF': <class 'IsInf'>, 'IS_NAN': <class 'IsNan'>, 'ISNAN': <class 'IsNan'>, 'J_S_O_N_ARRAY': <class 'JSONArray'>, 'J_S_O_N_ARRAY_AGG': <class 'JSONArrayAgg'>, 'JSON_ARRAY_CONTAINS': <class 'JSONArrayContains'>, 'JSONB_CONTAINS': <class 'JSONBContains'>, 'JSONB_EXTRACT': <class 'JSONBExtract'>, 'JSONB_EXTRACT_SCALAR': <class 'JSONBExtractScalar'>, 'J_S_O_N_EXISTS': <class 'JSONExists'>, 'JSON_EXTRACT': <class 'JSONExtract'>, 'JSON_EXTRACT_SCALAR': <class 'JSONExtractScalar'>, 'JSON_FORMAT': <class 'JSONFormat'>, 'J_S_O_N_OBJECT': <class 'JSONObject'>, 'J_S_O_N_OBJECT_AGG': <class 'JSONObjectAgg'>, 'J_S_O_N_TABLE': <class 'JSONTable'>, 'LAG': <class 'Lag'>, 'LAST': <class 'Last'>, 'LAST_DAY': <class 'LastDay'>, 'LAST_DAY_OF_MONTH': <class 'LastDay'>, 'LAST_VALUE': <class 'LastValue'>, 'LEAD': <class 'Lead'>, 'LEAST': <class 'Least'>, 'LEFT': <class 'Left'>, 'LENGTH': <class 'Length'>, 'LEN': <class 'Length'>, 'LEVENSHTEIN': <class 'Levenshtein'>, 'LIST': <class 'List'>, 'LN': <class 'Ln'>, 'LOG': <class 'Log'>, 'LOGICAL_AND': <class 'LogicalAnd'>, 'BOOL_AND': <class 'LogicalAnd'>, 'BOOLAND_AGG': <class 'LogicalAnd'>, 'LOGICAL_OR': <class 'LogicalOr'>, 'BOOL_OR': <class 'LogicalOr'>, 'BOOLOR_AGG': <class 'LogicalOr'>, 'LOWER': <class 'Lower'>, 'LCASE': <class 'Lower'>, 'LOWER_HEX': <class 'LowerHex'>, 'MD5': <class 'MD5'>, 'MD5_DIGEST': <class 'MD5Digest'>, 'MAP': <class 'Map'>, 'MAP_FROM_ENTRIES': <class 'MapFromEntries'>, 'MATCH_AGAINST': <class 'MatchAgainst'>, 'MAX': <class 'Max'>, 'MIN': <class 'Min'>, 'MONTH': <class 'Month'>, 'MONTHS_BETWEEN': <class 'MonthsBetween'>, 'NEXT_VALUE_FOR': <class 'NextValueFor'>, 'NORMALIZE': <class 'Normalize'>, 'NTH_VALUE': <class 'NthValue'>, 'NULLIF': <class 'Nullif'>, 'NUMBER_TO_STR': <class 'NumberToStr'>, 'NVL2': <class 'Nvl2'>, 'OBJECT_INSERT': <class 'ObjectInsert'>, 'OPEN_J_S_O_N': <class 'OpenJSON'>, 'PAD': <class 'Pad'>, 'PARAMETERIZED_AGG': <class 'ParameterizedAgg'>, 'PARSE_JSON': <class 'ParseJSON'>, 'JSON_PARSE': <class 'ParseJSON'>, 'PERCENTILE_CONT': <class 'PercentileCont'>, 'PERCENTILE_DISC': <class 'PercentileDisc'>, 'POSEXPLODE': <class 'Posexplode'>, 'POSEXPLODE_OUTER': <class 'PosexplodeOuter'>, 'POWER': <class 'Pow'>, 'POW': <class 'Pow'>, 'PREDICT': <class 'Predict'>, 'QUANTILE': <class 'Quantile'>, 'QUARTER': <class 'Quarter'>, 'RAND': <class 'Rand'>, 'RANDOM': <class 'Rand'>, 'RANDN': <class 'Randn'>, 'RANGE_N': <class 'RangeN'>, 'READ_CSV': <class 'ReadCSV'>, 'REDUCE': <class 'Reduce'>, 'REGEXP_EXTRACT': <class 'RegexpExtract'>, 'REGEXP_I_LIKE': <class 'RegexpILike'>, 'REGEXP_LIKE': <class 'RegexpLike'>, 'REGEXP_REPLACE': <class 'RegexpReplace'>, 'REGEXP_SPLIT': <class 'RegexpSplit'>, 'REPEAT': <class 'Repeat'>, 'RIGHT': <class 'Right'>, 'ROUND': <class 'Round'>, 'ROW_NUMBER': <class 'RowNumber'>, 'SHA': <class 'SHA'>, 'SHA1': <class 'SHA'>, 'SHA2': <class 'SHA2'>, 'SAFE_DIVIDE': <class 'SafeDivide'>, 'SIGN': <class 'Sign'>, 'SIGNUM': <class 'Sign'>, 'SORT_ARRAY': <class 'SortArray'>, 'SPLIT': <class 'Split'>, 'SQRT': <class 'Sqrt'>, 'STANDARD_HASH': <class 'StandardHash'>, 'STAR_MAP': <class 'StarMap'>, 'STARTS_WITH': <class 'StartsWith'>, 'STARTSWITH': <class 'StartsWith'>, 'STDDEV': <class 'Stddev'>, 'STDEV': <class 'Stddev'>, 'STDDEV_POP': <class 'StddevPop'>, 'STDDEV_SAMP': <class 'StddevSamp'>, 'STR_POSITION': <class 'StrPosition'>, 'STR_TO_DATE': <class 'StrToDate'>, 'STR_TO_MAP': <class 'StrToMap'>, 'STR_TO_TIME': <class 'StrToTime'>, 'STR_TO_UNIX': <class 'StrToUnix'>, 'STRING_TO_ARRAY': <class 'StringToArray'>, 'SPLIT_BY_STRING': <class 'StringToArray'>, 'STRUCT': <class 'Struct'>, 'STRUCT_EXTRACT': <class 'StructExtract'>, 'STUFF': <class 'Stuff'>, 'INSERT': <class 'Stuff'>, 'SUBSTRING': <class 'Substring'>, 'SUM': <class 'Sum'>, 'TIME': <class 'Time'>, 'TIME_ADD': <class 'TimeAdd'>, 'TIME_DIFF': <class 'TimeDiff'>, 'TIME_FROM_PARTS': <class 'TimeFromParts'>, 'TIMEFROMPARTS': <class 'TimeFromParts'>, 'TIME_STR_TO_DATE': <class 'TimeStrToDate'>, 'TIME_STR_TO_TIME': <class 'TimeStrToTime'>, 'TIME_STR_TO_UNIX': <class 'TimeStrToUnix'>, 'TIME_SUB': <class 'TimeSub'>, 'TIME_TO_STR': <class 'TimeToStr'>, 'TIME_TO_TIME_STR': <class 'TimeToTimeStr'>, 'TIME_TO_UNIX': <class 'TimeToUnix'>, 'TIME_TRUNC': <class 'TimeTrunc'>, 'TIMESTAMP': <class 'Timestamp'>, 'TIMESTAMP_ADD': <class 'TimestampAdd'>, 'TIMESTAMPDIFF': <class 'TimestampDiff'>, 'TIMESTAMP_DIFF': <class 'TimestampDiff'>, 'TIMESTAMP_FROM_PARTS': <class 'TimestampFromParts'>, 'TIMESTAMPFROMPARTS': <class 'TimestampFromParts'>, 'TIMESTAMP_SUB': <class 'TimestampSub'>, 'TIMESTAMP_TRUNC': <class 'TimestampTrunc'>, 'TO_ARRAY': <class 'ToArray'>, 'TO_BASE64': <class 'ToBase64'>, 'TO_CHAR': <class 'ToChar'>, 'TO_DAYS': <class 'ToDays'>, 'TO_MAP': <class 'ToMap'>, 'TO_NUMBER': <class 'ToNumber'>, 'TRANSFORM': <class 'Transform'>, 'TRIM': <class 'Trim'>, 'TRY': <class 'Try'>, 'TRY_CAST': <class 'TryCast'>, 'TS_OR_DI_TO_DI': <class 'TsOrDiToDi'>, 'TS_OR_DS_ADD': <class 'TsOrDsAdd'>, 'TS_OR_DS_DIFF': <class 'TsOrDsDiff'>, 'TS_OR_DS_TO_DATE': <class 'TsOrDsToDate'>, 'TS_OR_DS_TO_DATE_STR': <class 'TsOrDsToDateStr'>, 'TS_OR_DS_TO_TIME': <class 'TsOrDsToTime'>, 'TS_OR_DS_TO_TIMESTAMP': <class 'TsOrDsToTimestamp'>, 'UNHEX': <class 'Unhex'>, 'UNIX_DATE': <class 'UnixDate'>, 'UNIX_TO_STR': <class 'UnixToStr'>, 'UNIX_TO_TIME': <class 'UnixToTime'>, 'UNIX_TO_TIME_STR': <class 'UnixToTimeStr'>, 'UNNEST': <class 'Unnest'>, 'UNPACK_COLUMNS': <class 'UnpackColumns'>, 'UPPER': <class 'Upper'>, 'UCASE': <class 'Upper'>, 'UUID': <class 'Uuid'>, 'GEN_RANDOM_UUID': <class 'Uuid'>, 'GENERATE_UUID': <class 'Uuid'>, 'UUID_STRING': <class 'Uuid'>, 'VAR_MAP': <class 'VarMap'>, 'VARIANCE': <class 'Variance'>, 'VARIANCE_SAMP': <class 'Variance'>, 'VAR_SAMP': <class 'Variance'>, 'VARIANCE_POP': <class 'VariancePop'>, 'VAR_POP': <class 'VariancePop'>, 'WEEK': <class 'Week'>, 'WEEK_OF_YEAR': <class 'WeekOfYear'>, 'WEEKOFYEAR': <class 'WeekOfYear'>, 'WHEN': <class 'When'>, 'X_M_L_TABLE': <class 'XMLTable'>, 'XOR': <class 'Xor'>, 'YEAR': <class 'Year'>}
JSON_PATH_PARTS = [<class 'JSONPathFilter'>, <class 'JSONPathKey'>, <class 'JSONPathRecursive'>, <class 'JSONPathRoot'>, <class 'JSONPathScript'>, <class 'JSONPathSelector'>, <class 'JSONPathSlice'>, <class 'JSONPathSubscript'>, <class 'JSONPathUnion'>, <class 'JSONPathWildcard'>]
PERCENTILES = (<class 'PercentileCont'>, <class 'PercentileDisc'>)
def maybe_parse( sql_or_expression: Union[str, Expression], *, into: Union[str, Type[Expression], Collection[Union[str, Type[Expression]]], NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, prefix: Optional[str] = None, copy: bool = False, **opts) -> Expression:
6342def maybe_parse(
6343    sql_or_expression: ExpOrStr,
6344    *,
6345    into: t.Optional[IntoType] = None,
6346    dialect: DialectType = None,
6347    prefix: t.Optional[str] = None,
6348    copy: bool = False,
6349    **opts,
6350) -> Expression:
6351    """Gracefully handle a possible string or expression.
6352
6353    Example:
6354        >>> maybe_parse("1")
6355        Literal(this=1, is_string=False)
6356        >>> maybe_parse(to_identifier("x"))
6357        Identifier(this=x, quoted=False)
6358
6359    Args:
6360        sql_or_expression: the SQL code string or an expression
6361        into: the SQLGlot Expression to parse into
6362        dialect: the dialect used to parse the input expressions (in the case that an
6363            input expression is a SQL string).
6364        prefix: a string to prefix the sql with before it gets parsed
6365            (automatically includes a space)
6366        copy: whether to copy the expression.
6367        **opts: other options to use to parse the input expressions (again, in the case
6368            that an input expression is a SQL string).
6369
6370    Returns:
6371        Expression: the parsed or given expression.
6372    """
6373    if isinstance(sql_or_expression, Expression):
6374        if copy:
6375            return sql_or_expression.copy()
6376        return sql_or_expression
6377
6378    if sql_or_expression is None:
6379        raise ParseError("SQL cannot be None")
6380
6381    import sqlglot
6382
6383    sql = str(sql_or_expression)
6384    if prefix:
6385        sql = f"{prefix} {sql}"
6386
6387    return sqlglot.parse_one(sql, read=dialect, into=into, **opts)

Gracefully handle a possible string or expression.

Example:
>>> maybe_parse("1")
Literal(this=1, is_string=False)
>>> maybe_parse(to_identifier("x"))
Identifier(this=x, quoted=False)
Arguments:
  • sql_or_expression: the SQL code string or an expression
  • into: the SQLGlot Expression to parse into
  • dialect: the dialect used to parse the input expressions (in the case that an input expression is a SQL string).
  • prefix: a string to prefix the sql with before it gets parsed (automatically includes a space)
  • copy: whether to copy the expression.
  • **opts: other options to use to parse the input expressions (again, in the case that an input expression is a SQL string).
Returns:

Expression: the parsed or given expression.

def maybe_copy(instance, copy=True):
6398def maybe_copy(instance, copy=True):
6399    return instance.copy() if copy and instance else instance
def union( left: Union[str, Expression], right: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Union:
6620def union(
6621    left: ExpOrStr,
6622    right: ExpOrStr,
6623    distinct: bool = True,
6624    dialect: DialectType = None,
6625    copy: bool = True,
6626    **opts,
6627) -> Union:
6628    """
6629    Initializes a syntax tree from one UNION expression.
6630
6631    Example:
6632        >>> union("SELECT * FROM foo", "SELECT * FROM bla").sql()
6633        'SELECT * FROM foo UNION SELECT * FROM bla'
6634
6635    Args:
6636        left: the SQL code string corresponding to the left-hand side.
6637            If an `Expression` instance is passed, it will be used as-is.
6638        right: the SQL code string corresponding to the right-hand side.
6639            If an `Expression` instance is passed, it will be used as-is.
6640        distinct: set the DISTINCT flag if and only if this is true.
6641        dialect: the dialect used to parse the input expression.
6642        copy: whether to copy the expression.
6643        opts: other options to use to parse the input expressions.
6644
6645    Returns:
6646        The new Union instance.
6647    """
6648    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6649    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6650
6651    return Union(this=left, expression=right, distinct=distinct)

Initializes a syntax tree from one UNION expression.

Example:
>>> union("SELECT * FROM foo", "SELECT * FROM bla").sql()
'SELECT * FROM foo UNION SELECT * FROM bla'
Arguments:
  • left: the SQL code string corresponding to the left-hand side. If an Expression instance is passed, it will be used as-is.
  • right: the SQL code string corresponding to the right-hand side. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Union instance.

def intersect( left: Union[str, Expression], right: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Intersect:
6654def intersect(
6655    left: ExpOrStr,
6656    right: ExpOrStr,
6657    distinct: bool = True,
6658    dialect: DialectType = None,
6659    copy: bool = True,
6660    **opts,
6661) -> Intersect:
6662    """
6663    Initializes a syntax tree from one INTERSECT expression.
6664
6665    Example:
6666        >>> intersect("SELECT * FROM foo", "SELECT * FROM bla").sql()
6667        'SELECT * FROM foo INTERSECT SELECT * FROM bla'
6668
6669    Args:
6670        left: the SQL code string corresponding to the left-hand side.
6671            If an `Expression` instance is passed, it will be used as-is.
6672        right: the SQL code string corresponding to the right-hand side.
6673            If an `Expression` instance is passed, it will be used as-is.
6674        distinct: set the DISTINCT flag if and only if this is true.
6675        dialect: the dialect used to parse the input expression.
6676        copy: whether to copy the expression.
6677        opts: other options to use to parse the input expressions.
6678
6679    Returns:
6680        The new Intersect instance.
6681    """
6682    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6683    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6684
6685    return Intersect(this=left, expression=right, distinct=distinct)

Initializes a syntax tree from one INTERSECT expression.

Example:
>>> intersect("SELECT * FROM foo", "SELECT * FROM bla").sql()
'SELECT * FROM foo INTERSECT SELECT * FROM bla'
Arguments:
  • left: the SQL code string corresponding to the left-hand side. If an Expression instance is passed, it will be used as-is.
  • right: the SQL code string corresponding to the right-hand side. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Intersect instance.

def except_( left: Union[str, Expression], right: Union[str, Expression], distinct: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Except:
6688def except_(
6689    left: ExpOrStr,
6690    right: ExpOrStr,
6691    distinct: bool = True,
6692    dialect: DialectType = None,
6693    copy: bool = True,
6694    **opts,
6695) -> Except:
6696    """
6697    Initializes a syntax tree from one EXCEPT expression.
6698
6699    Example:
6700        >>> except_("SELECT * FROM foo", "SELECT * FROM bla").sql()
6701        'SELECT * FROM foo EXCEPT SELECT * FROM bla'
6702
6703    Args:
6704        left: the SQL code string corresponding to the left-hand side.
6705            If an `Expression` instance is passed, it will be used as-is.
6706        right: the SQL code string corresponding to the right-hand side.
6707            If an `Expression` instance is passed, it will be used as-is.
6708        distinct: set the DISTINCT flag if and only if this is true.
6709        dialect: the dialect used to parse the input expression.
6710        copy: whether to copy the expression.
6711        opts: other options to use to parse the input expressions.
6712
6713    Returns:
6714        The new Except instance.
6715    """
6716    left = maybe_parse(sql_or_expression=left, dialect=dialect, copy=copy, **opts)
6717    right = maybe_parse(sql_or_expression=right, dialect=dialect, copy=copy, **opts)
6718
6719    return Except(this=left, expression=right, distinct=distinct)

Initializes a syntax tree from one EXCEPT expression.

Example:
>>> except_("SELECT * FROM foo", "SELECT * FROM bla").sql()
'SELECT * FROM foo EXCEPT SELECT * FROM bla'
Arguments:
  • left: the SQL code string corresponding to the left-hand side. If an Expression instance is passed, it will be used as-is.
  • right: the SQL code string corresponding to the right-hand side. If an Expression instance is passed, it will be used as-is.
  • distinct: set the DISTINCT flag if and only if this is true.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the expression.
  • opts: other options to use to parse the input expressions.
Returns:

The new Except instance.

def select( *expressions: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Select:
6722def select(*expressions: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6723    """
6724    Initializes a syntax tree from one or multiple SELECT expressions.
6725
6726    Example:
6727        >>> select("col1", "col2").from_("tbl").sql()
6728        'SELECT col1, col2 FROM tbl'
6729
6730    Args:
6731        *expressions: the SQL code string to parse as the expressions of a
6732            SELECT statement. If an Expression instance is passed, this is used as-is.
6733        dialect: the dialect used to parse the input expressions (in the case that an
6734            input expression is a SQL string).
6735        **opts: other options to use to parse the input expressions (again, in the case
6736            that an input expression is a SQL string).
6737
6738    Returns:
6739        Select: the syntax tree for the SELECT statement.
6740    """
6741    return Select().select(*expressions, dialect=dialect, **opts)

Initializes a syntax tree from one or multiple SELECT expressions.

Example:
>>> select("col1", "col2").from_("tbl").sql()
'SELECT col1, col2 FROM tbl'
Arguments:
  • *expressions: the SQL code string to parse as the expressions of a SELECT statement. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expressions (in the case that an input expression is a SQL string).
  • **opts: other options to use to parse the input expressions (again, in the case that an input expression is a SQL string).
Returns:

Select: the syntax tree for the SELECT statement.

def from_( expression: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Select:
6744def from_(expression: ExpOrStr, dialect: DialectType = None, **opts) -> Select:
6745    """
6746    Initializes a syntax tree from a FROM expression.
6747
6748    Example:
6749        >>> from_("tbl").select("col1", "col2").sql()
6750        'SELECT col1, col2 FROM tbl'
6751
6752    Args:
6753        *expression: the SQL code string to parse as the FROM expressions of a
6754            SELECT statement. If an Expression instance is passed, this is used as-is.
6755        dialect: the dialect used to parse the input expression (in the case that the
6756            input expression is a SQL string).
6757        **opts: other options to use to parse the input expressions (again, in the case
6758            that the input expression is a SQL string).
6759
6760    Returns:
6761        Select: the syntax tree for the SELECT statement.
6762    """
6763    return Select().from_(expression, dialect=dialect, **opts)

Initializes a syntax tree from a FROM expression.

Example:
>>> from_("tbl").select("col1", "col2").sql()
'SELECT col1, col2 FROM tbl'
Arguments:
  • *expression: the SQL code string to parse as the FROM expressions of a SELECT statement. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression (in the case that the input expression is a SQL string).
  • **opts: other options to use to parse the input expressions (again, in the case that the input expression is a SQL string).
Returns:

Select: the syntax tree for the SELECT statement.

def update( table: str | Table, properties: dict, where: Union[str, Expression, NoneType] = None, from_: Union[str, Expression, NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Update:
6766def update(
6767    table: str | Table,
6768    properties: dict,
6769    where: t.Optional[ExpOrStr] = None,
6770    from_: t.Optional[ExpOrStr] = None,
6771    dialect: DialectType = None,
6772    **opts,
6773) -> Update:
6774    """
6775    Creates an update statement.
6776
6777    Example:
6778        >>> update("my_table", {"x": 1, "y": "2", "z": None}, from_="baz", where="id > 1").sql()
6779        "UPDATE my_table SET x = 1, y = '2', z = NULL FROM baz WHERE id > 1"
6780
6781    Args:
6782        *properties: dictionary of properties to set which are
6783            auto converted to sql objects eg None -> NULL
6784        where: sql conditional parsed into a WHERE statement
6785        from_: sql statement parsed into a FROM statement
6786        dialect: the dialect used to parse the input expressions.
6787        **opts: other options to use to parse the input expressions.
6788
6789    Returns:
6790        Update: the syntax tree for the UPDATE statement.
6791    """
6792    update_expr = Update(this=maybe_parse(table, into=Table, dialect=dialect))
6793    update_expr.set(
6794        "expressions",
6795        [
6796            EQ(this=maybe_parse(k, dialect=dialect, **opts), expression=convert(v))
6797            for k, v in properties.items()
6798        ],
6799    )
6800    if from_:
6801        update_expr.set(
6802            "from",
6803            maybe_parse(from_, into=From, dialect=dialect, prefix="FROM", **opts),
6804        )
6805    if isinstance(where, Condition):
6806        where = Where(this=where)
6807    if where:
6808        update_expr.set(
6809            "where",
6810            maybe_parse(where, into=Where, dialect=dialect, prefix="WHERE", **opts),
6811        )
6812    return update_expr

Creates an update statement.

Example:
>>> update("my_table", {"x": 1, "y": "2", "z": None}, from_="baz", where="id > 1").sql()
"UPDATE my_table SET x = 1, y = '2', z = NULL FROM baz WHERE id > 1"
Arguments:
  • *properties: dictionary of properties to set which are auto converted to sql objects eg None -> NULL
  • where: sql conditional parsed into a WHERE statement
  • from_: sql statement parsed into a FROM statement
  • dialect: the dialect used to parse the input expressions.
  • **opts: other options to use to parse the input expressions.
Returns:

Update: the syntax tree for the UPDATE statement.

def delete( table: Union[str, Expression], where: Union[str, Expression, NoneType] = None, returning: Union[str, Expression, NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Delete:
6815def delete(
6816    table: ExpOrStr,
6817    where: t.Optional[ExpOrStr] = None,
6818    returning: t.Optional[ExpOrStr] = None,
6819    dialect: DialectType = None,
6820    **opts,
6821) -> Delete:
6822    """
6823    Builds a delete statement.
6824
6825    Example:
6826        >>> delete("my_table", where="id > 1").sql()
6827        'DELETE FROM my_table WHERE id > 1'
6828
6829    Args:
6830        where: sql conditional parsed into a WHERE statement
6831        returning: sql conditional parsed into a RETURNING statement
6832        dialect: the dialect used to parse the input expressions.
6833        **opts: other options to use to parse the input expressions.
6834
6835    Returns:
6836        Delete: the syntax tree for the DELETE statement.
6837    """
6838    delete_expr = Delete().delete(table, dialect=dialect, copy=False, **opts)
6839    if where:
6840        delete_expr = delete_expr.where(where, dialect=dialect, copy=False, **opts)
6841    if returning:
6842        delete_expr = t.cast(
6843            Delete, delete_expr.returning(returning, dialect=dialect, copy=False, **opts)
6844        )
6845    return delete_expr

Builds a delete statement.

Example:
>>> delete("my_table", where="id > 1").sql()
'DELETE FROM my_table WHERE id > 1'
Arguments:
  • where: sql conditional parsed into a WHERE statement
  • returning: sql conditional parsed into a RETURNING statement
  • dialect: the dialect used to parse the input expressions.
  • **opts: other options to use to parse the input expressions.
Returns:

Delete: the syntax tree for the DELETE statement.

def insert( expression: Union[str, Expression], into: Union[str, Expression], columns: Optional[Sequence[str | Identifier]] = None, overwrite: Optional[bool] = None, returning: Union[str, Expression, NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Insert:
6848def insert(
6849    expression: ExpOrStr,
6850    into: ExpOrStr,
6851    columns: t.Optional[t.Sequence[str | Identifier]] = None,
6852    overwrite: t.Optional[bool] = None,
6853    returning: t.Optional[ExpOrStr] = None,
6854    dialect: DialectType = None,
6855    copy: bool = True,
6856    **opts,
6857) -> Insert:
6858    """
6859    Builds an INSERT statement.
6860
6861    Example:
6862        >>> insert("VALUES (1, 2, 3)", "tbl").sql()
6863        'INSERT INTO tbl VALUES (1, 2, 3)'
6864
6865    Args:
6866        expression: the sql string or expression of the INSERT statement
6867        into: the tbl to insert data to.
6868        columns: optionally the table's column names.
6869        overwrite: whether to INSERT OVERWRITE or not.
6870        returning: sql conditional parsed into a RETURNING statement
6871        dialect: the dialect used to parse the input expressions.
6872        copy: whether to copy the expression.
6873        **opts: other options to use to parse the input expressions.
6874
6875    Returns:
6876        Insert: the syntax tree for the INSERT statement.
6877    """
6878    expr = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
6879    this: Table | Schema = maybe_parse(into, into=Table, dialect=dialect, copy=copy, **opts)
6880
6881    if columns:
6882        this = Schema(this=this, expressions=[to_identifier(c, copy=copy) for c in columns])
6883
6884    insert = Insert(this=this, expression=expr, overwrite=overwrite)
6885
6886    if returning:
6887        insert = t.cast(Insert, insert.returning(returning, dialect=dialect, copy=False, **opts))
6888
6889    return insert

Builds an INSERT statement.

Example:
>>> insert("VALUES (1, 2, 3)", "tbl").sql()
'INSERT INTO tbl VALUES (1, 2, 3)'
Arguments:
  • expression: the sql string or expression of the INSERT statement
  • into: the tbl to insert data to.
  • columns: optionally the table's column names.
  • overwrite: whether to INSERT OVERWRITE or not.
  • returning: sql conditional parsed into a RETURNING statement
  • dialect: the dialect used to parse the input expressions.
  • copy: whether to copy the expression.
  • **opts: other options to use to parse the input expressions.
Returns:

Insert: the syntax tree for the INSERT statement.

def merge( *when_exprs: Union[str, Expression], into: Union[str, Expression], using: Union[str, Expression], on: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Merge:
6892def merge(
6893    *when_exprs: ExpOrStr,
6894    into: ExpOrStr,
6895    using: ExpOrStr,
6896    on: ExpOrStr,
6897    dialect: DialectType = None,
6898    copy: bool = True,
6899    **opts,
6900) -> Merge:
6901    """
6902    Builds a MERGE statement.
6903
6904    Example:
6905        >>> merge("WHEN MATCHED THEN UPDATE SET col1 = source_table.col1",
6906        ...       "WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)",
6907        ...       into="my_table",
6908        ...       using="source_table",
6909        ...       on="my_table.id = source_table.id").sql()
6910        'MERGE INTO my_table USING source_table ON my_table.id = source_table.id WHEN MATCHED THEN UPDATE SET col1 = source_table.col1 WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)'
6911
6912    Args:
6913        *when_exprs: The WHEN clauses specifying actions for matched and unmatched rows.
6914        into: The target table to merge data into.
6915        using: The source table to merge data from.
6916        on: The join condition for the merge.
6917        dialect: The dialect used to parse the input expressions.
6918        copy: Whether to copy the expression.
6919        **opts: Other options to use to parse the input expressions.
6920
6921    Returns:
6922        Merge: The syntax tree for the MERGE statement.
6923    """
6924    return Merge(
6925        this=maybe_parse(into, dialect=dialect, copy=copy, **opts),
6926        using=maybe_parse(using, dialect=dialect, copy=copy, **opts),
6927        on=maybe_parse(on, dialect=dialect, copy=copy, **opts),
6928        expressions=[
6929            maybe_parse(when_expr, dialect=dialect, copy=copy, into=When, **opts)
6930            for when_expr in when_exprs
6931        ],
6932    )

Builds a MERGE statement.

Example:
>>> merge("WHEN MATCHED THEN UPDATE SET col1 = source_table.col1",
...       "WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)",
...       into="my_table",
...       using="source_table",
...       on="my_table.id = source_table.id").sql()
'MERGE INTO my_table USING source_table ON my_table.id = source_table.id WHEN MATCHED THEN UPDATE SET col1 = source_table.col1 WHEN NOT MATCHED THEN INSERT (col1) VALUES (source_table.col1)'
Arguments:
  • *when_exprs: The WHEN clauses specifying actions for matched and unmatched rows.
  • into: The target table to merge data into.
  • using: The source table to merge data from.
  • on: The join condition for the merge.
  • dialect: The dialect used to parse the input expressions.
  • copy: Whether to copy the expression.
  • **opts: Other options to use to parse the input expressions.
Returns:

Merge: The syntax tree for the MERGE statement.

def condition( expression: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
6935def condition(
6936    expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts
6937) -> Condition:
6938    """
6939    Initialize a logical condition expression.
6940
6941    Example:
6942        >>> condition("x=1").sql()
6943        'x = 1'
6944
6945        This is helpful for composing larger logical syntax trees:
6946        >>> where = condition("x=1")
6947        >>> where = where.and_("y=1")
6948        >>> Select().from_("tbl").select("*").where(where).sql()
6949        'SELECT * FROM tbl WHERE x = 1 AND y = 1'
6950
6951    Args:
6952        *expression: the SQL code string to parse.
6953            If an Expression instance is passed, this is used as-is.
6954        dialect: the dialect used to parse the input expression (in the case that the
6955            input expression is a SQL string).
6956        copy: Whether to copy `expression` (only applies to expressions).
6957        **opts: other options to use to parse the input expressions (again, in the case
6958            that the input expression is a SQL string).
6959
6960    Returns:
6961        The new Condition instance
6962    """
6963    return maybe_parse(
6964        expression,
6965        into=Condition,
6966        dialect=dialect,
6967        copy=copy,
6968        **opts,
6969    )

Initialize a logical condition expression.

Example:
>>> condition("x=1").sql()
'x = 1'

This is helpful for composing larger logical syntax trees:

>>> where = condition("x=1")
>>> where = where.and_("y=1")
>>> Select().from_("tbl").select("*").where(where).sql()
'SELECT * FROM tbl WHERE x = 1 AND y = 1'
Arguments:
  • *expression: the SQL code string to parse. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression (in the case that the input expression is a SQL string).
  • copy: Whether to copy expression (only applies to expressions).
  • **opts: other options to use to parse the input expressions (again, in the case that the input expression is a SQL string).
Returns:

The new Condition instance

def and_( *expressions: Union[str, Expression, NoneType], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
6972def and_(
6973    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6974) -> Condition:
6975    """
6976    Combine multiple conditions with an AND logical operator.
6977
6978    Example:
6979        >>> and_("x=1", and_("y=1", "z=1")).sql()
6980        'x = 1 AND (y = 1 AND z = 1)'
6981
6982    Args:
6983        *expressions: the SQL code strings to parse.
6984            If an Expression instance is passed, this is used as-is.
6985        dialect: the dialect used to parse the input expression.
6986        copy: whether to copy `expressions` (only applies to Expressions).
6987        **opts: other options to use to parse the input expressions.
6988
6989    Returns:
6990        The new condition
6991    """
6992    return t.cast(Condition, _combine(expressions, And, dialect, copy=copy, **opts))

Combine multiple conditions with an AND logical operator.

Example:
>>> and_("x=1", and_("y=1", "z=1")).sql()
'x = 1 AND (y = 1 AND z = 1)'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy expressions (only applies to Expressions).
  • **opts: other options to use to parse the input expressions.
Returns:

The new condition

def or_( *expressions: Union[str, Expression, NoneType], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
6995def or_(
6996    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
6997) -> Condition:
6998    """
6999    Combine multiple conditions with an OR logical operator.
7000
7001    Example:
7002        >>> or_("x=1", or_("y=1", "z=1")).sql()
7003        'x = 1 OR (y = 1 OR z = 1)'
7004
7005    Args:
7006        *expressions: the SQL code strings to parse.
7007            If an Expression instance is passed, this is used as-is.
7008        dialect: the dialect used to parse the input expression.
7009        copy: whether to copy `expressions` (only applies to Expressions).
7010        **opts: other options to use to parse the input expressions.
7011
7012    Returns:
7013        The new condition
7014    """
7015    return t.cast(Condition, _combine(expressions, Or, dialect, copy=copy, **opts))

Combine multiple conditions with an OR logical operator.

Example:
>>> or_("x=1", or_("y=1", "z=1")).sql()
'x = 1 OR (y = 1 OR z = 1)'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy expressions (only applies to Expressions).
  • **opts: other options to use to parse the input expressions.
Returns:

The new condition

def xor( *expressions: Union[str, Expression, NoneType], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Condition:
7018def xor(
7019    *expressions: t.Optional[ExpOrStr], dialect: DialectType = None, copy: bool = True, **opts
7020) -> Condition:
7021    """
7022    Combine multiple conditions with an XOR logical operator.
7023
7024    Example:
7025        >>> xor("x=1", xor("y=1", "z=1")).sql()
7026        'x = 1 XOR (y = 1 XOR z = 1)'
7027
7028    Args:
7029        *expressions: the SQL code strings to parse.
7030            If an Expression instance is passed, this is used as-is.
7031        dialect: the dialect used to parse the input expression.
7032        copy: whether to copy `expressions` (only applies to Expressions).
7033        **opts: other options to use to parse the input expressions.
7034
7035    Returns:
7036        The new condition
7037    """
7038    return t.cast(Condition, _combine(expressions, Xor, dialect, copy=copy, **opts))

Combine multiple conditions with an XOR logical operator.

Example:
>>> xor("x=1", xor("y=1", "z=1")).sql()
'x = 1 XOR (y = 1 XOR z = 1)'
Arguments:
  • *expressions: the SQL code strings to parse. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy expressions (only applies to Expressions).
  • **opts: other options to use to parse the input expressions.
Returns:

The new condition

def not_( expression: Union[str, Expression], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts) -> Not:
7041def not_(expression: ExpOrStr, dialect: DialectType = None, copy: bool = True, **opts) -> Not:
7042    """
7043    Wrap a condition with a NOT operator.
7044
7045    Example:
7046        >>> not_("this_suit='black'").sql()
7047        "NOT this_suit = 'black'"
7048
7049    Args:
7050        expression: the SQL code string to parse.
7051            If an Expression instance is passed, this is used as-is.
7052        dialect: the dialect used to parse the input expression.
7053        copy: whether to copy the expression or not.
7054        **opts: other options to use to parse the input expressions.
7055
7056    Returns:
7057        The new condition.
7058    """
7059    this = condition(
7060        expression,
7061        dialect=dialect,
7062        copy=copy,
7063        **opts,
7064    )
7065    return Not(this=_wrap(this, Connector))

Wrap a condition with a NOT operator.

Example:
>>> not_("this_suit='black'").sql()
"NOT this_suit = 'black'"
Arguments:
  • expression: the SQL code string to parse. If an Expression instance is passed, this is used as-is.
  • dialect: the dialect used to parse the input expression.
  • copy: whether to copy the expression or not.
  • **opts: other options to use to parse the input expressions.
Returns:

The new condition.

def paren( expression: Union[str, Expression], copy: bool = True) -> Paren:
7068def paren(expression: ExpOrStr, copy: bool = True) -> Paren:
7069    """
7070    Wrap an expression in parentheses.
7071
7072    Example:
7073        >>> paren("5 + 3").sql()
7074        '(5 + 3)'
7075
7076    Args:
7077        expression: the SQL code string to parse.
7078            If an Expression instance is passed, this is used as-is.
7079        copy: whether to copy the expression or not.
7080
7081    Returns:
7082        The wrapped expression.
7083    """
7084    return Paren(this=maybe_parse(expression, copy=copy))

Wrap an expression in parentheses.

Example:
>>> paren("5 + 3").sql()
'(5 + 3)'
Arguments:
  • expression: the SQL code string to parse. If an Expression instance is passed, this is used as-is.
  • copy: whether to copy the expression or not.
Returns:

The wrapped expression.

SAFE_IDENTIFIER_RE: Pattern[str] = re.compile('^[_a-zA-Z][\\w]*$')
def to_identifier(name, quoted=None, copy=True):
7100def to_identifier(name, quoted=None, copy=True):
7101    """Builds an identifier.
7102
7103    Args:
7104        name: The name to turn into an identifier.
7105        quoted: Whether to force quote the identifier.
7106        copy: Whether to copy name if it's an Identifier.
7107
7108    Returns:
7109        The identifier ast node.
7110    """
7111
7112    if name is None:
7113        return None
7114
7115    if isinstance(name, Identifier):
7116        identifier = maybe_copy(name, copy)
7117    elif isinstance(name, str):
7118        identifier = Identifier(
7119            this=name,
7120            quoted=not SAFE_IDENTIFIER_RE.match(name) if quoted is None else quoted,
7121        )
7122    else:
7123        raise ValueError(f"Name needs to be a string or an Identifier, got: {name.__class__}")
7124    return identifier

Builds an identifier.

Arguments:
  • name: The name to turn into an identifier.
  • quoted: Whether to force quote the identifier.
  • copy: Whether to copy name if it's an Identifier.
Returns:

The identifier ast node.

def parse_identifier( name: str | Identifier, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None) -> Identifier:
7127def parse_identifier(name: str | Identifier, dialect: DialectType = None) -> Identifier:
7128    """
7129    Parses a given string into an identifier.
7130
7131    Args:
7132        name: The name to parse into an identifier.
7133        dialect: The dialect to parse against.
7134
7135    Returns:
7136        The identifier ast node.
7137    """
7138    try:
7139        expression = maybe_parse(name, dialect=dialect, into=Identifier)
7140    except (ParseError, TokenError):
7141        expression = to_identifier(name)
7142
7143    return expression

Parses a given string into an identifier.

Arguments:
  • name: The name to parse into an identifier.
  • dialect: The dialect to parse against.
Returns:

The identifier ast node.

INTERVAL_STRING_RE = re.compile('\\s*([0-9]+)\\s*([a-zA-Z]+)\\s*')
def to_interval( interval: str | Literal) -> Interval:
7149def to_interval(interval: str | Literal) -> Interval:
7150    """Builds an interval expression from a string like '1 day' or '5 months'."""
7151    if isinstance(interval, Literal):
7152        if not interval.is_string:
7153            raise ValueError("Invalid interval string.")
7154
7155        interval = interval.this
7156
7157    interval_parts = INTERVAL_STRING_RE.match(interval)  # type: ignore
7158
7159    if not interval_parts:
7160        raise ValueError("Invalid interval string.")
7161
7162    return Interval(
7163        this=Literal.string(interval_parts.group(1)),
7164        unit=Var(this=interval_parts.group(2).upper()),
7165    )

Builds an interval expression from a string like '1 day' or '5 months'.

def to_table( sql_path: str | Table, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **kwargs) -> Table:
7168def to_table(
7169    sql_path: str | Table, dialect: DialectType = None, copy: bool = True, **kwargs
7170) -> Table:
7171    """
7172    Create a table expression from a `[catalog].[schema].[table]` sql path. Catalog and schema are optional.
7173    If a table is passed in then that table is returned.
7174
7175    Args:
7176        sql_path: a `[catalog].[schema].[table]` string.
7177        dialect: the source dialect according to which the table name will be parsed.
7178        copy: Whether to copy a table if it is passed in.
7179        kwargs: the kwargs to instantiate the resulting `Table` expression with.
7180
7181    Returns:
7182        A table expression.
7183    """
7184    if isinstance(sql_path, Table):
7185        return maybe_copy(sql_path, copy=copy)
7186
7187    table = maybe_parse(sql_path, into=Table, dialect=dialect)
7188
7189    for k, v in kwargs.items():
7190        table.set(k, v)
7191
7192    return table

Create a table expression from a [catalog].[schema].[table] sql path. Catalog and schema are optional. If a table is passed in then that table is returned.

Arguments:
  • sql_path: a [catalog].[schema].[table] string.
  • dialect: the source dialect according to which the table name will be parsed.
  • copy: Whether to copy a table if it is passed in.
  • kwargs: the kwargs to instantiate the resulting Table expression with.
Returns:

A table expression.

def to_column( sql_path: str | Column, quoted: Optional[bool] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **kwargs) -> Column:
7195def to_column(
7196    sql_path: str | Column,
7197    quoted: t.Optional[bool] = None,
7198    dialect: DialectType = None,
7199    copy: bool = True,
7200    **kwargs,
7201) -> Column:
7202    """
7203    Create a column from a `[table].[column]` sql path. Table is optional.
7204    If a column is passed in then that column is returned.
7205
7206    Args:
7207        sql_path: a `[table].[column]` string.
7208        quoted: Whether or not to force quote identifiers.
7209        dialect: the source dialect according to which the column name will be parsed.
7210        copy: Whether to copy a column if it is passed in.
7211        kwargs: the kwargs to instantiate the resulting `Column` expression with.
7212
7213    Returns:
7214        A column expression.
7215    """
7216    if isinstance(sql_path, Column):
7217        return maybe_copy(sql_path, copy=copy)
7218
7219    try:
7220        col = maybe_parse(sql_path, into=Column, dialect=dialect)
7221    except ParseError:
7222        return column(*reversed(sql_path.split(".")), quoted=quoted, **kwargs)
7223
7224    for k, v in kwargs.items():
7225        col.set(k, v)
7226
7227    if quoted:
7228        for i in col.find_all(Identifier):
7229            i.set("quoted", True)
7230
7231    return col

Create a column from a [table].[column] sql path. Table is optional. If a column is passed in then that column is returned.

Arguments:
  • sql_path: a [table].[column] string.
  • quoted: Whether or not to force quote identifiers.
  • dialect: the source dialect according to which the column name will be parsed.
  • copy: Whether to copy a column if it is passed in.
  • kwargs: the kwargs to instantiate the resulting Column expression with.
Returns:

A column expression.

def alias_( expression: Union[str, Expression], alias: Union[Identifier, str, NoneType], table: Union[bool, Sequence[str | Identifier]] = False, quoted: Optional[bool] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True, **opts):
7234def alias_(
7235    expression: ExpOrStr,
7236    alias: t.Optional[str | Identifier],
7237    table: bool | t.Sequence[str | Identifier] = False,
7238    quoted: t.Optional[bool] = None,
7239    dialect: DialectType = None,
7240    copy: bool = True,
7241    **opts,
7242):
7243    """Create an Alias expression.
7244
7245    Example:
7246        >>> alias_('foo', 'bar').sql()
7247        'foo AS bar'
7248
7249        >>> alias_('(select 1, 2)', 'bar', table=['a', 'b']).sql()
7250        '(SELECT 1, 2) AS bar(a, b)'
7251
7252    Args:
7253        expression: the SQL code strings to parse.
7254            If an Expression instance is passed, this is used as-is.
7255        alias: the alias name to use. If the name has
7256            special characters it is quoted.
7257        table: Whether to create a table alias, can also be a list of columns.
7258        quoted: whether to quote the alias
7259        dialect: the dialect used to parse the input expression.
7260        copy: Whether to copy the expression.
7261        **opts: other options to use to parse the input expressions.
7262
7263    Returns:
7264        Alias: the aliased expression
7265    """
7266    exp = maybe_parse(expression, dialect=dialect, copy=copy, **opts)
7267    alias = to_identifier(alias, quoted=quoted)
7268
7269    if table:
7270        table_alias = TableAlias(this=alias)
7271        exp.set("alias", table_alias)
7272
7273        if not isinstance(table, bool):
7274            for column in table:
7275                table_alias.append("columns", to_identifier(column, quoted=quoted))
7276
7277        return exp
7278
7279    # We don't set the "alias" arg for Window expressions, because that would add an IDENTIFIER node in
7280    # the AST, representing a "named_window" [1] construct (eg. bigquery). What we want is an ALIAS node
7281    # for the complete Window expression.
7282    #
7283    # [1]: https://cloud.google.com/bigquery/docs/reference/standard-sql/window-function-calls
7284
7285    if "alias" in exp.arg_types and not isinstance(exp, Window):
7286        exp.set("alias", alias)
7287        return exp
7288    return Alias(this=exp, alias=alias)

Create an Alias expression.

Example:
>>> alias_('foo', 'bar').sql()
'foo AS bar'
>>> alias_('(select 1, 2)', 'bar', table=['a', 'b']).sql()
'(SELECT 1, 2) AS bar(a, b)'
Arguments:
  • expression: the SQL code strings to parse. If an Expression instance is passed, this is used as-is.
  • alias: the alias name to use. If the name has special characters it is quoted.
  • table: Whether to create a table alias, can also be a list of columns.
  • quoted: whether to quote the alias
  • dialect: the dialect used to parse the input expression.
  • copy: Whether to copy the expression.
  • **opts: other options to use to parse the input expressions.
Returns:

Alias: the aliased expression

def subquery( expression: Union[str, Expression], alias: Union[Identifier, str, NoneType] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Select:
7291def subquery(
7292    expression: ExpOrStr,
7293    alias: t.Optional[Identifier | str] = None,
7294    dialect: DialectType = None,
7295    **opts,
7296) -> Select:
7297    """
7298    Build a subquery expression that's selected from.
7299
7300    Example:
7301        >>> subquery('select x from tbl', 'bar').select('x').sql()
7302        'SELECT x FROM (SELECT x FROM tbl) AS bar'
7303
7304    Args:
7305        expression: the SQL code strings to parse.
7306            If an Expression instance is passed, this is used as-is.
7307        alias: the alias name to use.
7308        dialect: the dialect used to parse the input expression.
7309        **opts: other options to use to parse the input expressions.
7310
7311    Returns:
7312        A new Select instance with the subquery expression included.
7313    """
7314
7315    expression = maybe_parse(expression, dialect=dialect, **opts).subquery(alias, **opts)
7316    return Select().from_(expression, dialect=dialect, **opts)

Build a subquery expression that's selected from.

Example:
>>> subquery('select x from tbl', 'bar').select('x').sql()
'SELECT x FROM (SELECT x FROM tbl) AS bar'
Arguments:
  • expression: the SQL code strings to parse. If an Expression instance is passed, this is used as-is.
  • alias: the alias name to use.
  • dialect: the dialect used to parse the input expression.
  • **opts: other options to use to parse the input expressions.
Returns:

A new Select instance with the subquery expression included.

def column( col, table=None, db=None, catalog=None, *, fields=None, quoted=None, copy=True):
7347def column(
7348    col,
7349    table=None,
7350    db=None,
7351    catalog=None,
7352    *,
7353    fields=None,
7354    quoted=None,
7355    copy=True,
7356):
7357    """
7358    Build a Column.
7359
7360    Args:
7361        col: Column name.
7362        table: Table name.
7363        db: Database name.
7364        catalog: Catalog name.
7365        fields: Additional fields using dots.
7366        quoted: Whether to force quotes on the column's identifiers.
7367        copy: Whether to copy identifiers if passed in.
7368
7369    Returns:
7370        The new Column instance.
7371    """
7372    this = Column(
7373        this=to_identifier(col, quoted=quoted, copy=copy),
7374        table=to_identifier(table, quoted=quoted, copy=copy),
7375        db=to_identifier(db, quoted=quoted, copy=copy),
7376        catalog=to_identifier(catalog, quoted=quoted, copy=copy),
7377    )
7378
7379    if fields:
7380        this = Dot.build(
7381            (this, *(to_identifier(field, quoted=quoted, copy=copy) for field in fields))
7382        )
7383    return this

Build a Column.

Arguments:
  • col: Column name.
  • table: Table name.
  • db: Database name.
  • catalog: Catalog name.
  • fields: Additional fields using dots.
  • quoted: Whether to force quotes on the column's identifiers.
  • copy: Whether to copy identifiers if passed in.
Returns:

The new Column instance.

def cast( expression: Union[str, Expression], to: Union[str, DataType, DataType.Type], copy: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **opts) -> Cast:
7386def cast(
7387    expression: ExpOrStr, to: DATA_TYPE, copy: bool = True, dialect: DialectType = None, **opts
7388) -> Cast:
7389    """Cast an expression to a data type.
7390
7391    Example:
7392        >>> cast('x + 1', 'int').sql()
7393        'CAST(x + 1 AS INT)'
7394
7395    Args:
7396        expression: The expression to cast.
7397        to: The datatype to cast to.
7398        copy: Whether to copy the supplied expressions.
7399        dialect: The target dialect. This is used to prevent a re-cast in the following scenario:
7400            - The expression to be cast is already a exp.Cast expression
7401            - The existing cast is to a type that is logically equivalent to new type
7402
7403            For example, if :expression='CAST(x as DATETIME)' and :to=Type.TIMESTAMP,
7404            but in the target dialect DATETIME is mapped to TIMESTAMP, then we will NOT return `CAST(x (as DATETIME) as TIMESTAMP)`
7405            and instead just return the original expression `CAST(x as DATETIME)`.
7406
7407            This is to prevent it being output as a double cast `CAST(x (as TIMESTAMP) as TIMESTAMP)` once the DATETIME -> TIMESTAMP
7408            mapping is applied in the target dialect generator.
7409
7410    Returns:
7411        The new Cast instance.
7412    """
7413    expr = maybe_parse(expression, copy=copy, dialect=dialect, **opts)
7414    data_type = DataType.build(to, copy=copy, dialect=dialect, **opts)
7415
7416    # dont re-cast if the expression is already a cast to the correct type
7417    if isinstance(expr, Cast):
7418        from sqlglot.dialects.dialect import Dialect
7419
7420        target_dialect = Dialect.get_or_raise(dialect)
7421        type_mapping = target_dialect.generator_class.TYPE_MAPPING
7422
7423        existing_cast_type: DataType.Type = expr.to.this
7424        new_cast_type: DataType.Type = data_type.this
7425        types_are_equivalent = type_mapping.get(
7426            existing_cast_type, existing_cast_type
7427        ) == type_mapping.get(new_cast_type, new_cast_type)
7428        if expr.is_type(data_type) or types_are_equivalent:
7429            return expr
7430
7431    expr = Cast(this=expr, to=data_type)
7432    expr.type = data_type
7433
7434    return expr

Cast an expression to a data type.

Example:
>>> cast('x + 1', 'int').sql()
'CAST(x + 1 AS INT)'
Arguments:
  • expression: The expression to cast.
  • to: The datatype to cast to.
  • copy: Whether to copy the supplied expressions.
  • dialect: The target dialect. This is used to prevent a re-cast in the following scenario:

    • The expression to be cast is already a exp.Cast expression
    • The existing cast is to a type that is logically equivalent to new type

    For example, if :expression='CAST(x as DATETIME)' and :to=Type.TIMESTAMP, but in the target dialect DATETIME is mapped to TIMESTAMP, then we will NOT return CAST(x (as DATETIME) as TIMESTAMP) and instead just return the original expression CAST(x as DATETIME).

    This is to prevent it being output as a double cast CAST(x (as TIMESTAMP) as TIMESTAMP) once the DATETIME -> TIMESTAMP mapping is applied in the target dialect generator.

Returns:

The new Cast instance.

def table_( table: Identifier | str, db: Union[Identifier, str, NoneType] = None, catalog: Union[Identifier, str, NoneType] = None, quoted: Optional[bool] = None, alias: Union[Identifier, str, NoneType] = None) -> Table:
7437def table_(
7438    table: Identifier | str,
7439    db: t.Optional[Identifier | str] = None,
7440    catalog: t.Optional[Identifier | str] = None,
7441    quoted: t.Optional[bool] = None,
7442    alias: t.Optional[Identifier | str] = None,
7443) -> Table:
7444    """Build a Table.
7445
7446    Args:
7447        table: Table name.
7448        db: Database name.
7449        catalog: Catalog name.
7450        quote: Whether to force quotes on the table's identifiers.
7451        alias: Table's alias.
7452
7453    Returns:
7454        The new Table instance.
7455    """
7456    return Table(
7457        this=to_identifier(table, quoted=quoted) if table else None,
7458        db=to_identifier(db, quoted=quoted) if db else None,
7459        catalog=to_identifier(catalog, quoted=quoted) if catalog else None,
7460        alias=TableAlias(this=to_identifier(alias)) if alias else None,
7461    )

Build a Table.

Arguments:
  • table: Table name.
  • db: Database name.
  • catalog: Catalog name.
  • quote: Whether to force quotes on the table's identifiers.
  • alias: Table's alias.
Returns:

The new Table instance.

def values( values: Iterable[Tuple[Any, ...]], alias: Optional[str] = None, columns: Union[Iterable[str], Dict[str, DataType], NoneType] = None) -> Values:
7464def values(
7465    values: t.Iterable[t.Tuple[t.Any, ...]],
7466    alias: t.Optional[str] = None,
7467    columns: t.Optional[t.Iterable[str] | t.Dict[str, DataType]] = None,
7468) -> Values:
7469    """Build VALUES statement.
7470
7471    Example:
7472        >>> values([(1, '2')]).sql()
7473        "VALUES (1, '2')"
7474
7475    Args:
7476        values: values statements that will be converted to SQL
7477        alias: optional alias
7478        columns: Optional list of ordered column names or ordered dictionary of column names to types.
7479         If either are provided then an alias is also required.
7480
7481    Returns:
7482        Values: the Values expression object
7483    """
7484    if columns and not alias:
7485        raise ValueError("Alias is required when providing columns")
7486
7487    return Values(
7488        expressions=[convert(tup) for tup in values],
7489        alias=(
7490            TableAlias(this=to_identifier(alias), columns=[to_identifier(x) for x in columns])
7491            if columns
7492            else (TableAlias(this=to_identifier(alias)) if alias else None)
7493        ),
7494    )

Build VALUES statement.

Example:
>>> values([(1, '2')]).sql()
"VALUES (1, '2')"
Arguments:
  • values: values statements that will be converted to SQL
  • alias: optional alias
  • columns: Optional list of ordered column names or ordered dictionary of column names to types. If either are provided then an alias is also required.
Returns:

Values: the Values expression object

def var( name: Union[str, Expression, NoneType]) -> Var:
7497def var(name: t.Optional[ExpOrStr]) -> Var:
7498    """Build a SQL variable.
7499
7500    Example:
7501        >>> repr(var('x'))
7502        'Var(this=x)'
7503
7504        >>> repr(var(column('x', table='y')))
7505        'Var(this=x)'
7506
7507    Args:
7508        name: The name of the var or an expression who's name will become the var.
7509
7510    Returns:
7511        The new variable node.
7512    """
7513    if not name:
7514        raise ValueError("Cannot convert empty name into var.")
7515
7516    if isinstance(name, Expression):
7517        name = name.name
7518    return Var(this=name)

Build a SQL variable.

Example:
>>> repr(var('x'))
'Var(this=x)'
>>> repr(var(column('x', table='y')))
'Var(this=x)'
Arguments:
  • name: The name of the var or an expression who's name will become the var.
Returns:

The new variable node.

def rename_table( old_name: str | Table, new_name: str | Table, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None) -> Alter:
7521def rename_table(
7522    old_name: str | Table,
7523    new_name: str | Table,
7524    dialect: DialectType = None,
7525) -> Alter:
7526    """Build ALTER TABLE... RENAME... expression
7527
7528    Args:
7529        old_name: The old name of the table
7530        new_name: The new name of the table
7531        dialect: The dialect to parse the table.
7532
7533    Returns:
7534        Alter table expression
7535    """
7536    old_table = to_table(old_name, dialect=dialect)
7537    new_table = to_table(new_name, dialect=dialect)
7538    return Alter(
7539        this=old_table,
7540        kind="TABLE",
7541        actions=[
7542            RenameTable(this=new_table),
7543        ],
7544    )

Build ALTER TABLE... RENAME... expression

Arguments:
  • old_name: The old name of the table
  • new_name: The new name of the table
  • dialect: The dialect to parse the table.
Returns:

Alter table expression

def rename_column( table_name: str | Table, old_column_name: str | Column, new_column_name: str | Column, exists: Optional[bool] = None, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None) -> Alter:
7547def rename_column(
7548    table_name: str | Table,
7549    old_column_name: str | Column,
7550    new_column_name: str | Column,
7551    exists: t.Optional[bool] = None,
7552    dialect: DialectType = None,
7553) -> Alter:
7554    """Build ALTER TABLE... RENAME COLUMN... expression
7555
7556    Args:
7557        table_name: Name of the table
7558        old_column: The old name of the column
7559        new_column: The new name of the column
7560        exists: Whether to add the `IF EXISTS` clause
7561        dialect: The dialect to parse the table/column.
7562
7563    Returns:
7564        Alter table expression
7565    """
7566    table = to_table(table_name, dialect=dialect)
7567    old_column = to_column(old_column_name, dialect=dialect)
7568    new_column = to_column(new_column_name, dialect=dialect)
7569    return Alter(
7570        this=table,
7571        kind="TABLE",
7572        actions=[
7573            RenameColumn(this=old_column, to=new_column, exists=exists),
7574        ],
7575    )

Build ALTER TABLE... RENAME COLUMN... expression

Arguments:
  • table_name: Name of the table
  • old_column: The old name of the column
  • new_column: The new name of the column
  • exists: Whether to add the IF EXISTS clause
  • dialect: The dialect to parse the table/column.
Returns:

Alter table expression

def convert(value: Any, copy: bool = False) -> Expression:
7578def convert(value: t.Any, copy: bool = False) -> Expression:
7579    """Convert a python value into an expression object.
7580
7581    Raises an error if a conversion is not possible.
7582
7583    Args:
7584        value: A python object.
7585        copy: Whether to copy `value` (only applies to Expressions and collections).
7586
7587    Returns:
7588        The equivalent expression object.
7589    """
7590    if isinstance(value, Expression):
7591        return maybe_copy(value, copy)
7592    if isinstance(value, str):
7593        return Literal.string(value)
7594    if isinstance(value, bool):
7595        return Boolean(this=value)
7596    if value is None or (isinstance(value, float) and math.isnan(value)):
7597        return null()
7598    if isinstance(value, numbers.Number):
7599        return Literal.number(value)
7600    if isinstance(value, bytes):
7601        return HexString(this=value.hex())
7602    if isinstance(value, datetime.datetime):
7603        datetime_literal = Literal.string(value.isoformat(sep=" "))
7604
7605        tz = None
7606        if value.tzinfo:
7607            # this works for zoneinfo.ZoneInfo, pytz.timezone and datetime.datetime.utc to return IANA timezone names like "America/Los_Angeles"
7608            # instead of abbreviations like "PDT". This is for consistency with other timezone handling functions in SQLGlot
7609            tz = Literal.string(str(value.tzinfo))
7610
7611        return TimeStrToTime(this=datetime_literal, zone=tz)
7612    if isinstance(value, datetime.date):
7613        date_literal = Literal.string(value.strftime("%Y-%m-%d"))
7614        return DateStrToDate(this=date_literal)
7615    if isinstance(value, tuple):
7616        if hasattr(value, "_fields"):
7617            return Struct(
7618                expressions=[
7619                    PropertyEQ(
7620                        this=to_identifier(k), expression=convert(getattr(value, k), copy=copy)
7621                    )
7622                    for k in value._fields
7623                ]
7624            )
7625        return Tuple(expressions=[convert(v, copy=copy) for v in value])
7626    if isinstance(value, list):
7627        return Array(expressions=[convert(v, copy=copy) for v in value])
7628    if isinstance(value, dict):
7629        return Map(
7630            keys=Array(expressions=[convert(k, copy=copy) for k in value]),
7631            values=Array(expressions=[convert(v, copy=copy) for v in value.values()]),
7632        )
7633    if hasattr(value, "__dict__"):
7634        return Struct(
7635            expressions=[
7636                PropertyEQ(this=to_identifier(k), expression=convert(v, copy=copy))
7637                for k, v in value.__dict__.items()
7638            ]
7639        )
7640    raise ValueError(f"Cannot convert {value}")

Convert a python value into an expression object.

Raises an error if a conversion is not possible.

Arguments:
  • value: A python object.
  • copy: Whether to copy value (only applies to Expressions and collections).
Returns:

The equivalent expression object.

def replace_children( expression: Expression, fun: Callable, *args, **kwargs) -> None:
7643def replace_children(expression: Expression, fun: t.Callable, *args, **kwargs) -> None:
7644    """
7645    Replace children of an expression with the result of a lambda fun(child) -> exp.
7646    """
7647    for k, v in tuple(expression.args.items()):
7648        is_list_arg = type(v) is list
7649
7650        child_nodes = v if is_list_arg else [v]
7651        new_child_nodes = []
7652
7653        for cn in child_nodes:
7654            if isinstance(cn, Expression):
7655                for child_node in ensure_collection(fun(cn, *args, **kwargs)):
7656                    new_child_nodes.append(child_node)
7657            else:
7658                new_child_nodes.append(cn)
7659
7660        expression.set(k, new_child_nodes if is_list_arg else seq_get(new_child_nodes, 0))

Replace children of an expression with the result of a lambda fun(child) -> exp.

def replace_tree( expression: Expression, fun: Callable, prune: Optional[Callable[[Expression], bool]] = None) -> Expression:
7663def replace_tree(
7664    expression: Expression,
7665    fun: t.Callable,
7666    prune: t.Optional[t.Callable[[Expression], bool]] = None,
7667) -> Expression:
7668    """
7669    Replace an entire tree with the result of function calls on each node.
7670
7671    This will be traversed in reverse dfs, so leaves first.
7672    If new nodes are created as a result of function calls, they will also be traversed.
7673    """
7674    stack = list(expression.dfs(prune=prune))
7675
7676    while stack:
7677        node = stack.pop()
7678        new_node = fun(node)
7679
7680        if new_node is not node:
7681            node.replace(new_node)
7682
7683            if isinstance(new_node, Expression):
7684                stack.append(new_node)
7685
7686    return new_node

Replace an entire tree with the result of function calls on each node.

This will be traversed in reverse dfs, so leaves first. If new nodes are created as a result of function calls, they will also be traversed.

def column_table_names( expression: Expression, exclude: str = '') -> Set[str]:
7689def column_table_names(expression: Expression, exclude: str = "") -> t.Set[str]:
7690    """
7691    Return all table names referenced through columns in an expression.
7692
7693    Example:
7694        >>> import sqlglot
7695        >>> sorted(column_table_names(sqlglot.parse_one("a.b AND c.d AND c.e")))
7696        ['a', 'c']
7697
7698    Args:
7699        expression: expression to find table names.
7700        exclude: a table name to exclude
7701
7702    Returns:
7703        A list of unique names.
7704    """
7705    return {
7706        table
7707        for table in (column.table for column in expression.find_all(Column))
7708        if table and table != exclude
7709    }

Return all table names referenced through columns in an expression.

Example:
>>> import sqlglot
>>> sorted(column_table_names(sqlglot.parse_one("a.b AND c.d AND c.e")))
['a', 'c']
Arguments:
  • expression: expression to find table names.
  • exclude: a table name to exclude
Returns:

A list of unique names.

def table_name( table: Table | str, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, identify: bool = False) -> str:
7712def table_name(table: Table | str, dialect: DialectType = None, identify: bool = False) -> str:
7713    """Get the full name of a table as a string.
7714
7715    Args:
7716        table: Table expression node or string.
7717        dialect: The dialect to generate the table name for.
7718        identify: Determines when an identifier should be quoted. Possible values are:
7719            False (default): Never quote, except in cases where it's mandatory by the dialect.
7720            True: Always quote.
7721
7722    Examples:
7723        >>> from sqlglot import exp, parse_one
7724        >>> table_name(parse_one("select * from a.b.c").find(exp.Table))
7725        'a.b.c'
7726
7727    Returns:
7728        The table name.
7729    """
7730
7731    table = maybe_parse(table, into=Table, dialect=dialect)
7732
7733    if not table:
7734        raise ValueError(f"Cannot parse {table}")
7735
7736    return ".".join(
7737        (
7738            part.sql(dialect=dialect, identify=True, copy=False)
7739            if identify or not SAFE_IDENTIFIER_RE.match(part.name)
7740            else part.name
7741        )
7742        for part in table.parts
7743    )

Get the full name of a table as a string.

Arguments:
  • table: Table expression node or string.
  • dialect: The dialect to generate the table name for.
  • identify: Determines when an identifier should be quoted. Possible values are: False (default): Never quote, except in cases where it's mandatory by the dialect. True: Always quote.
Examples:
>>> from sqlglot import exp, parse_one
>>> table_name(parse_one("select * from a.b.c").find(exp.Table))
'a.b.c'
Returns:

The table name.

def normalize_table_name( table: str | Table, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True) -> str:
7746def normalize_table_name(table: str | Table, dialect: DialectType = None, copy: bool = True) -> str:
7747    """Returns a case normalized table name without quotes.
7748
7749    Args:
7750        table: the table to normalize
7751        dialect: the dialect to use for normalization rules
7752        copy: whether to copy the expression.
7753
7754    Examples:
7755        >>> normalize_table_name("`A-B`.c", dialect="bigquery")
7756        'A-B.c'
7757    """
7758    from sqlglot.optimizer.normalize_identifiers import normalize_identifiers
7759
7760    return ".".join(
7761        p.name
7762        for p in normalize_identifiers(
7763            to_table(table, dialect=dialect, copy=copy), dialect=dialect
7764        ).parts
7765    )

Returns a case normalized table name without quotes.

Arguments:
  • table: the table to normalize
  • dialect: the dialect to use for normalization rules
  • copy: whether to copy the expression.
Examples:
>>> normalize_table_name("`A-B`.c", dialect="bigquery")
'A-B.c'
def replace_tables( expression: ~E, mapping: Dict[str, str], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True) -> ~E:
7768def replace_tables(
7769    expression: E, mapping: t.Dict[str, str], dialect: DialectType = None, copy: bool = True
7770) -> E:
7771    """Replace all tables in expression according to the mapping.
7772
7773    Args:
7774        expression: expression node to be transformed and replaced.
7775        mapping: mapping of table names.
7776        dialect: the dialect of the mapping table
7777        copy: whether to copy the expression.
7778
7779    Examples:
7780        >>> from sqlglot import exp, parse_one
7781        >>> replace_tables(parse_one("select * from a.b"), {"a.b": "c"}).sql()
7782        'SELECT * FROM c /* a.b */'
7783
7784    Returns:
7785        The mapped expression.
7786    """
7787
7788    mapping = {normalize_table_name(k, dialect=dialect): v for k, v in mapping.items()}
7789
7790    def _replace_tables(node: Expression) -> Expression:
7791        if isinstance(node, Table):
7792            original = normalize_table_name(node, dialect=dialect)
7793            new_name = mapping.get(original)
7794
7795            if new_name:
7796                table = to_table(
7797                    new_name,
7798                    **{k: v for k, v in node.args.items() if k not in TABLE_PARTS},
7799                    dialect=dialect,
7800                )
7801                table.add_comments([original])
7802                return table
7803        return node
7804
7805    return expression.transform(_replace_tables, copy=copy)  # type: ignore

Replace all tables in expression according to the mapping.

Arguments:
  • expression: expression node to be transformed and replaced.
  • mapping: mapping of table names.
  • dialect: the dialect of the mapping table
  • copy: whether to copy the expression.
Examples:
>>> from sqlglot import exp, parse_one
>>> replace_tables(parse_one("select * from a.b"), {"a.b": "c"}).sql()
'SELECT * FROM c /* a.b */'
Returns:

The mapped expression.

def replace_placeholders( expression: Expression, *args, **kwargs) -> Expression:
7808def replace_placeholders(expression: Expression, *args, **kwargs) -> Expression:
7809    """Replace placeholders in an expression.
7810
7811    Args:
7812        expression: expression node to be transformed and replaced.
7813        args: positional names that will substitute unnamed placeholders in the given order.
7814        kwargs: keyword arguments that will substitute named placeholders.
7815
7816    Examples:
7817        >>> from sqlglot import exp, parse_one
7818        >>> replace_placeholders(
7819        ...     parse_one("select * from :tbl where ? = ?"),
7820        ...     exp.to_identifier("str_col"), "b", tbl=exp.to_identifier("foo")
7821        ... ).sql()
7822        "SELECT * FROM foo WHERE str_col = 'b'"
7823
7824    Returns:
7825        The mapped expression.
7826    """
7827
7828    def _replace_placeholders(node: Expression, args, **kwargs) -> Expression:
7829        if isinstance(node, Placeholder):
7830            if node.this:
7831                new_name = kwargs.get(node.this)
7832                if new_name is not None:
7833                    return convert(new_name)
7834            else:
7835                try:
7836                    return convert(next(args))
7837                except StopIteration:
7838                    pass
7839        return node
7840
7841    return expression.transform(_replace_placeholders, iter(args), **kwargs)

Replace placeholders in an expression.

Arguments:
  • expression: expression node to be transformed and replaced.
  • args: positional names that will substitute unnamed placeholders in the given order.
  • kwargs: keyword arguments that will substitute named placeholders.
Examples:
>>> from sqlglot import exp, parse_one
>>> replace_placeholders(
...     parse_one("select * from :tbl where ? = ?"),
...     exp.to_identifier("str_col"), "b", tbl=exp.to_identifier("foo")
... ).sql()
"SELECT * FROM foo WHERE str_col = 'b'"
Returns:

The mapped expression.

def expand( expression: Expression, sources: Dict[str, Query], dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, copy: bool = True) -> Expression:
7844def expand(
7845    expression: Expression,
7846    sources: t.Dict[str, Query],
7847    dialect: DialectType = None,
7848    copy: bool = True,
7849) -> Expression:
7850    """Transforms an expression by expanding all referenced sources into subqueries.
7851
7852    Examples:
7853        >>> from sqlglot import parse_one
7854        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y")}).sql()
7855        'SELECT * FROM (SELECT * FROM y) AS z /* source: x */'
7856
7857        >>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y"), "y": parse_one("select * from z")}).sql()
7858        'SELECT * FROM (SELECT * FROM (SELECT * FROM z) AS y /* source: y */) AS z /* source: x */'
7859
7860    Args:
7861        expression: The expression to expand.
7862        sources: A dictionary of name to Queries.
7863        dialect: The dialect of the sources dict.
7864        copy: Whether to copy the expression during transformation. Defaults to True.
7865
7866    Returns:
7867        The transformed expression.
7868    """
7869    sources = {normalize_table_name(k, dialect=dialect): v for k, v in sources.items()}
7870
7871    def _expand(node: Expression):
7872        if isinstance(node, Table):
7873            name = normalize_table_name(node, dialect=dialect)
7874            source = sources.get(name)
7875            if source:
7876                subquery = source.subquery(node.alias or name)
7877                subquery.comments = [f"source: {name}"]
7878                return subquery.transform(_expand, copy=False)
7879        return node
7880
7881    return expression.transform(_expand, copy=copy)

Transforms an expression by expanding all referenced sources into subqueries.

Examples:
>>> from sqlglot import parse_one
>>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y")}).sql()
'SELECT * FROM (SELECT * FROM y) AS z /* source: x */'
>>> expand(parse_one("select * from x AS z"), {"x": parse_one("select * from y"), "y": parse_one("select * from z")}).sql()
'SELECT * FROM (SELECT * FROM (SELECT * FROM z) AS y /* source: y */) AS z /* source: x */'
Arguments:
  • expression: The expression to expand.
  • sources: A dictionary of name to Queries.
  • dialect: The dialect of the sources dict.
  • copy: Whether to copy the expression during transformation. Defaults to True.
Returns:

The transformed expression.

def func( name: str, *args, copy: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **kwargs) -> Func:
7884def func(name: str, *args, copy: bool = True, dialect: DialectType = None, **kwargs) -> Func:
7885    """
7886    Returns a Func expression.
7887
7888    Examples:
7889        >>> func("abs", 5).sql()
7890        'ABS(5)'
7891
7892        >>> func("cast", this=5, to=DataType.build("DOUBLE")).sql()
7893        'CAST(5 AS DOUBLE)'
7894
7895    Args:
7896        name: the name of the function to build.
7897        args: the args used to instantiate the function of interest.
7898        copy: whether to copy the argument expressions.
7899        dialect: the source dialect.
7900        kwargs: the kwargs used to instantiate the function of interest.
7901
7902    Note:
7903        The arguments `args` and `kwargs` are mutually exclusive.
7904
7905    Returns:
7906        An instance of the function of interest, or an anonymous function, if `name` doesn't
7907        correspond to an existing `sqlglot.expressions.Func` class.
7908    """
7909    if args and kwargs:
7910        raise ValueError("Can't use both args and kwargs to instantiate a function.")
7911
7912    from sqlglot.dialects.dialect import Dialect
7913
7914    dialect = Dialect.get_or_raise(dialect)
7915
7916    converted: t.List[Expression] = [maybe_parse(arg, dialect=dialect, copy=copy) for arg in args]
7917    kwargs = {key: maybe_parse(value, dialect=dialect, copy=copy) for key, value in kwargs.items()}
7918
7919    constructor = dialect.parser_class.FUNCTIONS.get(name.upper())
7920    if constructor:
7921        if converted:
7922            if "dialect" in constructor.__code__.co_varnames:
7923                function = constructor(converted, dialect=dialect)
7924            else:
7925                function = constructor(converted)
7926        elif constructor.__name__ == "from_arg_list":
7927            function = constructor.__self__(**kwargs)  # type: ignore
7928        else:
7929            constructor = FUNCTION_BY_NAME.get(name.upper())
7930            if constructor:
7931                function = constructor(**kwargs)
7932            else:
7933                raise ValueError(
7934                    f"Unable to convert '{name}' into a Func. Either manually construct "
7935                    "the Func expression of interest or parse the function call."
7936                )
7937    else:
7938        kwargs = kwargs or {"expressions": converted}
7939        function = Anonymous(this=name, **kwargs)
7940
7941    for error_message in function.error_messages(converted):
7942        raise ValueError(error_message)
7943
7944    return function

Returns a Func expression.

Examples:
>>> func("abs", 5).sql()
'ABS(5)'
>>> func("cast", this=5, to=DataType.build("DOUBLE")).sql()
'CAST(5 AS DOUBLE)'
Arguments:
  • name: the name of the function to build.
  • args: the args used to instantiate the function of interest.
  • copy: whether to copy the argument expressions.
  • dialect: the source dialect.
  • kwargs: the kwargs used to instantiate the function of interest.
Note:

The arguments args and kwargs are mutually exclusive.

Returns:

An instance of the function of interest, or an anonymous function, if name doesn't correspond to an existing sqlglot.expressions.Func class.

def case( expression: Union[str, Expression, NoneType] = None, **opts) -> Case:
7947def case(
7948    expression: t.Optional[ExpOrStr] = None,
7949    **opts,
7950) -> Case:
7951    """
7952    Initialize a CASE statement.
7953
7954    Example:
7955        case().when("a = 1", "foo").else_("bar")
7956
7957    Args:
7958        expression: Optionally, the input expression (not all dialects support this)
7959        **opts: Extra keyword arguments for parsing `expression`
7960    """
7961    if expression is not None:
7962        this = maybe_parse(expression, **opts)
7963    else:
7964        this = None
7965    return Case(this=this, ifs=[])

Initialize a CASE statement.

Example:

case().when("a = 1", "foo").else_("bar")

Arguments:
  • expression: Optionally, the input expression (not all dialects support this)
  • **opts: Extra keyword arguments for parsing expression
def array( *expressions: Union[str, Expression], copy: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **kwargs) -> Array:
7968def array(
7969    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7970) -> Array:
7971    """
7972    Returns an array.
7973
7974    Examples:
7975        >>> array(1, 'x').sql()
7976        'ARRAY(1, x)'
7977
7978    Args:
7979        expressions: the expressions to add to the array.
7980        copy: whether to copy the argument expressions.
7981        dialect: the source dialect.
7982        kwargs: the kwargs used to instantiate the function of interest.
7983
7984    Returns:
7985        An array expression.
7986    """
7987    return Array(
7988        expressions=[
7989            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
7990            for expression in expressions
7991        ]
7992    )

Returns an array.

Examples:
>>> array(1, 'x').sql()
'ARRAY(1, x)'
Arguments:
  • expressions: the expressions to add to the array.
  • copy: whether to copy the argument expressions.
  • dialect: the source dialect.
  • kwargs: the kwargs used to instantiate the function of interest.
Returns:

An array expression.

def tuple_( *expressions: Union[str, Expression], copy: bool = True, dialect: Union[str, sqlglot.dialects.dialect.Dialect, Type[sqlglot.dialects.dialect.Dialect], NoneType] = None, **kwargs) -> Tuple:
7995def tuple_(
7996    *expressions: ExpOrStr, copy: bool = True, dialect: DialectType = None, **kwargs
7997) -> Tuple:
7998    """
7999    Returns an tuple.
8000
8001    Examples:
8002        >>> tuple_(1, 'x').sql()
8003        '(1, x)'
8004
8005    Args:
8006        expressions: the expressions to add to the tuple.
8007        copy: whether to copy the argument expressions.
8008        dialect: the source dialect.
8009        kwargs: the kwargs used to instantiate the function of interest.
8010
8011    Returns:
8012        A tuple expression.
8013    """
8014    return Tuple(
8015        expressions=[
8016            maybe_parse(expression, copy=copy, dialect=dialect, **kwargs)
8017            for expression in expressions
8018        ]
8019    )

Returns an tuple.

Examples:
>>> tuple_(1, 'x').sql()
'(1, x)'
Arguments:
  • expressions: the expressions to add to the tuple.
  • copy: whether to copy the argument expressions.
  • dialect: the source dialect.
  • kwargs: the kwargs used to instantiate the function of interest.
Returns:

A tuple expression.

def true() -> Boolean:
8022def true() -> Boolean:
8023    """
8024    Returns a true Boolean expression.
8025    """
8026    return Boolean(this=True)

Returns a true Boolean expression.

def false() -> Boolean:
8029def false() -> Boolean:
8030    """
8031    Returns a false Boolean expression.
8032    """
8033    return Boolean(this=False)

Returns a false Boolean expression.

def null() -> Null:
8036def null() -> Null:
8037    """
8038    Returns a Null expression.
8039    """
8040    return Null()

Returns a Null expression.

NONNULL_CONSTANTS = (<class 'Literal'>, <class 'Boolean'>)
CONSTANTS = (<class 'Literal'>, <class 'Boolean'>, <class 'Null'>)