Module datafusion_python::datafusion_sql::sqlparser::ast

SQL Abstract Syntax Tree (AST) types

Modules

• helpers

Structs

• Array
  Represents an Array Expression, either ARRAY[..], or [..]
• Assignment
  SQL assignment foo = expr as used in SQLUpdate
• ColumnDef
  SQL column definition
• ColumnOptionDef
  An optionally-named ColumnOption: [ CONSTRAINT <name> ] <column-option>.
• ConnectBy
  Joins a table to itself to process hierarchical data in the table.
• ConstraintCharacteristics
  <constraint_characteristics> = [ DEFERRABLE | NOT DEFERRABLE ] [ INITIALLY DEFERRED | INITIALLY IMMEDIATE ] [ ENFORCED | NOT ENFORCED ]
• CreateIndex
  CREATE INDEX statement.
• CreateTable
  CREATE TABLE statement.
• Cte
  A single CTE (used after WITH): <alias> [(col1, col2, ...)] AS <materialized> ( <query> ) The names in the column list before AS, when specified, replace the names of the columns returned by the query. The parser does not validate that the number of columns in the query matches the number of columns in the query.
• Declare
  A DECLARE statement. Postgres Snowflake BigQuery
• Delete
  DELETE statement.
• DictionaryField
  A dictionary field within a dictionary.
• DisplaySeparated
• DoUpdate
• DollarQuotedString
• DropFunctionDesc
  Function describe in DROP FUNCTION.
• ExceptSelectItem
  Bigquery EXCEPT information, with at least one column.
• ExprWithAlias
  An expression optionally followed by an alias.
• Fetch
• Function
  A function call
• FunctionArgumentList
  This represents everything inside the parentheses when calling a function.
• HavingBound
  The HAVING clause in a call to ANY_VALUE on BigQuery.
• HiveFormat
• HiveRowDelimiter
• HiveSetLocation
• Ident
  An identifier, decomposed into its value or character data and the quote style.
• IdentWithAlias
  Single aliased identifier
• IlikeSelectItem
  Snowflake ILIKE information.
• Insert
  INSERT statement.
• InsertAliases
• Interpolate
• InterpolateExpr
  ClickHouse INTERPOLATE clause for use in ORDER BY clause when using WITH FILL modifier. Supported by ClickHouse syntax
• Interval
  Represents an INTERVAL expression, roughly in the following format: INTERVAL '<value>' [ <leading_field> [ (<leading_precision>) ] ] [ TO <last_field> [ (<fractional_seconds_precision>) ] ], e.g. INTERVAL '123:45.67' MINUTE(3) TO SECOND(2).
• Join
• JsonPath
  A JSON path.
• JsonTableColumn
  A single column definition in MySQL’s JSON_TABLE table valued function.
• LambdaFunction
  A lambda function.
• LateralView
  A hive LATERAL VIEW with potential column aliases
• LockClause
• LockTable
• MacroArg
  NAME = <EXPR> arguments for DuckDB macros
• Map
  Represents a Map expression.
• MapAccessKey
  Expression used to access a value in a nested structure.
• MapEntry
  A map field within a map.
• Measure
  An item in the MEASURES subclause of a MATCH_RECOGNIZE operation.
• MergeClause
  A when clause within a MERGE Statement
• MergeInsertExpr
  The expression used to insert rows within a MERGE statement.
• NamedWindowDefinition
• ObjectName
  A name of a table, view, custom type, etc., possibly multi-part, i.e. db.schema.obj
• Offset
• OnConflict
• OperateFunctionArg
  Function argument in CREATE OR DROP FUNCTION.
• OrderBy
• OrderByExpr
  An ORDER BY expression
• Partition
  PARTITION statement used in ALTER TABLE et al. such as in Hive SQL
• ProcedureParam
• Query
  The most complete variant of a SELECT query expression, optionally including WITH, UNION / other set operations, and ORDER BY.
• ReplaceSelectElement
  Syntax
• ReplaceSelectItem
  Bigquery REPLACE information.
• RowAccessPolicy
  Snowflake WITH ROW ACCESS POLICY policy_name ON (identifier, ...)
• SecretOption
• Select
  A restricted variant of SELECT (without CTEs/ORDER BY), which may appear either as the only body item of a Query, or as an operand to a set operation like UNION.
• SelectInto
• Setting
• SqlOption
• StructField
  A field definition within a struct
• SymbolDefinition
  A symbol defined in a MATCH_RECOGNIZE operation.
• Table
  A TABLE command
• TableAlias
• TableEngine
  Engine of DB. Some warehouse has parameters of engine, e.g. clickhouse
• TableWithJoins
• Tag
  Snowflake WITH TAG ( tag_name = '<tag_value>', ...)
• Top
• UnionField
  A field definition within a union
• UserDefinedTypeCompositeAttributeDef
  SQL user defined type attribute definition
• Values
• ViewColumnDef
  Column definition specified in a CREATE VIEW statement.
• WildcardAdditionalOptions
  Additional options for wildcards, e.g. Snowflake EXCLUDE/RENAME and Bigquery EXCEPT.
• WindowFrame
  Specifies the data processed by a window function, e.g. RANGE UNBOUNDED PRECEDING or ROWS BETWEEN 5 PRECEDING AND CURRENT ROW.
• WindowSpec
  A window specification (i.e. OVER ([window_name] PARTITION BY .. ORDER BY .. etc.))
• With
• WithFill
  ClickHouse WITH FILL modifier for ORDER BY clause. Supported by ClickHouse syntax

Enums

• Action
  A privilege on a database object (table, sequence, etc.).
• AddDropSync
• AfterMatchSkip
  The after match skip option in a MATCH_RECOGNIZE operation.
• AlterColumnOperation
  An ALTER COLUMN (Statement::AlterTable) operation
• AlterIndexOperation
• AlterRoleOperation
  An ALTER ROLE (Statement::AlterRole) operation
• AlterTableOperation
  An ALTER TABLE (Statement::AlterTable) operation
• AnalyzeFormat
• ArgMode
  The mode of an argument in CREATE FUNCTION.
• ArrayElemTypeDef
  Represents the data type of the elements in an array (if any) as well as the syntax used to declare the array.
• AssignmentTarget
  Left-hand side of an assignment in an UPDATE statement, e.g. foo in foo = 5 (ColumnName assignment) or (a, b) in (a, b) = (1, 2) (Tuple assignment).
• AttachDuckDBDatabaseOption
• BinaryOperator
  Binary operators
• CastFormat
  Options for CAST / TRY_CAST BigQuery: https://cloud.google.com/bigquery/docs/reference/standard-sql/format-elements#formatting_syntax
• CastKind
  The syntax used for in a cast expression.
• CharLengthUnits
  Possible units for characters, initially based on 2016 ANSI standard.
• CharacterLength
  Information about character length, including length and possibly unit.
• CloseCursor
• ColumnOption
  ColumnOptions are modifiers that follow a column definition in a CREATE TABLE statement.
• CommentDef
  Helper to indicate if a comment includes the = in the display form
• CommentObject
• ConflictTarget
• ContextModifier
  Optional context modifier for statements that can be or LOCAL, or SESSION.
• CopyLegacyCsvOption
  A CSV option in COPY statement before PostgreSQL version 9.0.
• CopyLegacyOption
  An option in COPY statement before PostgreSQL version 9.0.
• CopyOption
  An option in COPY statement.
• CopySource
• CopyTarget
• CreateFunctionBody
  Represent the expression body of a CREATE FUNCTION statement as well as where within the statement, the body shows up.
• CreateFunctionUsing
• CreateTableOptions
  Sql options of a CREATE TABLE statement.
• CteAsMaterialized
• DataType
  SQL data types
• DateTimeField
• DeclareAssignment
  Represents an expression assignment within a variable DECLARE statement.
• DeclareType
  Represents the type of a DECLARE statement.
• DeferrableInitial
• DescribeAlias
• DiscardObject
• Distinct
• DropFunctionOption
  Function describe in DROP FUNCTION.
• DuplicateTreatment
• EmptyMatchesMode
• ExactNumberInfo
  Additional information for NUMERIC, DECIMAL, and DEC data types following the 2016 standard.
• ExcludeSelectItem
  Snowflake EXCLUDE information.
• Expr
  An SQL expression of any type.
• FetchDirection
  Specific direction for FETCH statement
• FileFormat
  External table’s available file format
• FlushLocation
• FlushType
• ForClause
  FOR XML or FOR JSON clause, specific to MSSQL (formats the output of a query as XML or JSON)
• ForJson
• ForXml
• FormatClause
  FORMAT identifier or FORMAT NULL clause, specific to ClickHouse.
• FromTable
  A FROM clause within a DELETE statement.
• FunctionArg
• FunctionArgExpr
• FunctionArgOperator
  Operator used to separate function arguments
• FunctionArgumentClause
• FunctionArguments
  The arguments passed to a function call.
• FunctionBehavior
  These attributes inform the query optimizer about the behavior of the function.
• FunctionCalledOnNull
  These attributes describe the behavior of the function when called with a null argument.
• FunctionDeterminismSpecifier
  BigQuery Determinism specifier used in a UDF definition.
• FunctionParallel
  If it is safe for PostgreSQL to call the function from multiple threads at once
• GeneratedAs
  GeneratedAss are modifiers that follow a column option in a generated. ‘ExpStored’ is used for a column generated from an expression and stored.
• GeneratedExpressionMode
  GeneratedExpressionModes are modifiers that follow an expression in a generated. No modifier is typically the same as Virtual.
• GrantObjects
  Objects on which privileges are granted in a GRANT statement.
• GroupByExpr
• GroupByWithModifier
  ClickHouse supports GROUP BY WITH modifiers(includes ROLLUP|CUBE|TOTALS). e.g. GROUP BY year WITH ROLLUP WITH TOTALS
• HavingBoundKind
• HiveDelimiter
• HiveDescribeFormat
• HiveDistributionStyle
• HiveIOFormat
• HiveRowFormat
• IndexOption
  MySQLs index option.
• IndexType
  Indexing method used by that index.
• JoinConstraint
• JoinOperator
• JsonPathElem
  An element of a JSON path.
• JsonTableColumnErrorHandling
  Stores the error handling clause of a JSON_TABLE table valued function: {NULL | DEFAULT json_string | ERROR} ON {ERROR | EMPTY }
• KeyOrIndexDisplay
  Representation whether a definition can can contains the KEY or INDEX keywords with the same meaning.
• KillType
• ListAggOnOverflow
  The ON OVERFLOW clause of a LISTAGG invocation
• LockTableType
• LockType
• MacroDefinition
• MapAccessSyntax
  Represents the syntax/style used in a map access.
• MatchRecognizePattern
  The pattern in a MATCH_RECOGNIZE operation.
• MatchRecognizeSymbol
  A symbol in a MATCH_RECOGNIZE pattern.
• MergeAction
  Underlying statement of a when clause within a MERGE Statement
• MergeClauseKind
  Variant of WHEN clause used within a MERGE Statement.
• MergeInsertKind
  The type of expression used to insert rows within a MERGE statement.
• MinMaxValue
  Can use to describe options in create sequence or table column type identity [ MINVALUE minvalue | NO MINVALUE ] [ MAXVALUE maxvalue | NO MAXVALUE ]
• MySQLColumnPosition
  MySQL ALTER TABLE only [FIRST | AFTER column_name]
• MysqlInsertPriority
  Mysql specific syntax
• NamedWindowExpr
  An expression used in a named window declaration.
• NonBlock
• NullTreatment
  Specifies Ignore / Respect NULL within window functions. For example FIRST_VALUE(column2) IGNORE NULLS OVER (PARTITION BY column1)
• ObjectType
• OffsetRows
  Stores the keyword after OFFSET <number>
• OnCommit
• OnConflictAction
• OnInsert
• OneOrManyWithParens
  Encapsulates the common pattern in SQL where either one unparenthesized item such as an identifier or expression is permitted, or multiple of the same item in a parenthesized list.
• Owner
• Password
• PivotValueSource
  The source of values in a PIVOT operation.
• Privileges
  Privileges granted in a GRANT statement or revoked in a REVOKE statement.
• ReferentialAction
  <referential_action> = { RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT }
• RenameSelectItem
  Snowflake RENAME information.
• RepetitionQuantifier
  Determines the minimum and maximum allowed occurrences of a pattern in a MATCH_RECOGNIZE operation.
• ResetConfig
  RESET config option:
• RoleOption
  An option in ROLE statement.
• RowsPerMatch
  The rows per match option in a MATCH_RECOGNIZE operation.
• SchemaName
  Schema possible naming variants (1).
• SearchModifier
  Fulltext search modifiers (1).
• SelectItem
  One item of the comma-separated list following SELECT
• SequenceOptions
  Can use to describe options in create sequence or table column type identity
• SetConfigValue
  SET config value option:
• SetExpr
  A node in a tree, representing a “query body” expression, roughly: SELECT ... [ {UNION|EXCEPT|INTERSECT} SELECT ...]
• SetOperator
• SetQuantifier
  A quantifier for SetOperator.
• ShowCreateObject
• ShowStatementFilter
• SqliteOnConflict
  Sqlite specific syntax
• Statement
  A top-level statement (SELECT, INSERT, CREATE, etc.)
• Subscript
  The contents inside the [ and ] in a subscript expression.
• TableConstraint
  A table-level constraint, specified in a CREATE TABLE or an ALTER TABLE ADD <constraint> statement.
• TableFactor
  A table name or a parenthesized subquery with an optional alias
• TableVersion
• TimezoneInfo
  Timestamp and Time data types information about TimeZone formatting.
• TopQuantity
• TransactionAccessMode
• TransactionIsolationLevel
• TransactionMode
• TransactionModifier
  SQLite specific syntax
• TrimWhereField
• UnaryOperator
  Unary operators
• UserDefinedTypeRepresentation
  SQL user defined type definition
• Value
  Primitive SQL values such as number and string
• ValueTableMode
  BigQuery supports ValueTables which have 2 modes: SELECT AS STRUCT SELECT AS VALUE https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#value_tables
• WindowFrameBound
  Specifies WindowFrame’s start_bound and end_bound
• WindowFrameUnits
• WindowType
• WrappedCollection
  Helper to indicate if a collection should be wrapped by a symbol in the display form

Traits

• Visit
  A type that can be visited by a Visitor. See Visitor for recursively visiting parsed SQL statements.
• VisitMut
  A type that can be visited by a VisitorMut. See VisitorMut for recursively visiting parsed SQL statements.
• Visitor
  A visitor that can be used to walk an AST tree.
• VisitorMut
  A visitor that can be used to mutate an AST tree.

Functions

• display_comma_separated
• display_separated
• escape_double_quote_string
• escape_quoted_string
• visit_expressions
  Invokes the provided closure on all expressions (e.g. 1 + 2) present in v
• visit_expressions_mut
  Invokes the provided closure iteratively with a mutable reference to all expressions present in v.
• visit_relations
  Invokes the provided closure on all relations (e.g. table names) present in v
• visit_relations_mut
  Invokes the provided closure with a mutable reference to all relations (e.g. table names) present in v.
• visit_statements
  Invokes the provided closure iteratively with a mutable reference to all statements present in v (e.g. SELECT, CREATE TABLE, etc).
• visit_statements_mut
  Invokes the provided closure on all statements (e.g. SELECT, CREATE TABLE, etc) present in v