Module mz_sql_parser::ast
source · Expand description
SQL Abstract Syntax Tree (AST) types
Modules§
- defs 🔒This module houses the definitions of the structs and enums that are formally part of the AST.
- Transformation of an owned AST.
- metadata 🔒
- Traversal of an immutable AST.
- Traversal of a mutable AST.
Structs§
ALTER CLUSTER .. SET ...- An option in an
ALTER CONNECTION...statement. ALTER CONNECTIONALTER DEFAULT PRIVILEGES ...ALTER INDEX ... {RESET, SET}- AN
ALTER NETWORK POLICYstatement. ALTER <OBJECT> ... RENAME TOALTER <OBJECT> SWAP ...ALTER <OBJECT> ... OWNER TOALTER <OBJECT> ... [RE]SET (RETAIN HISTORY [FOR ...])ALTER ROLEALTER SECRET ... ASALTER SET CLUSTER- An option in an
ALTER SOURCE...ADD SUBSOURCEstatement. ALTER SYSTEM RESET ALLALTER SYSTEM RESET ...ALTER SYSTEM SET ...ALTER TABLE ... ADD COLUMN ...- SQL assignment
foo = expras used in SQLUpdate CLOSE ...- An option in a
ALTER CLUSTER... WITHstatement. - An option in a
CREATE CLUSTERstatement. - SQL column definition
- An optionally-named
ColumnOption:[ CONSTRAINT <name> ] <column-option>. COMMENT ON ...COMMIT [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]- An option in a
CREATE CONNECTION. COPYCREATE CLUSTER REPLICA ..CREATE CLUSTER ..- An option in a
CREATE CONNECTION...statement. CREATE CONNECTIONrefactor WIPCREATE CONTINUAL TASKCREATE DATABASECREATE INDEXCREATE MATERIALIZED VIEW- A
CREATE NETWORK POLICYstatement. - A
CREATE ROLEstatement. CREATE SCHEMA- A
CREATE SECRETstatement. CREATE SINK- An option in a
CREATE SOURCE...statement. CREATE SOURCECREATE SUBSOURCECREATE TABLE .. FROM SOURCECREATE TABLECREATE TYPE ..CREATE VIEWBODY [AS ...] [BYTES]CHECK ( ... )CHECK ( WITH ( ... ) )HEADER [AS ...] [BYTES]INCLUDE [HEADER | HEADERS]INCLUDE HEADER <name> [AS <alias>] [BYTES]SECRET ... [AS ...] [BYTES]CREATE SOURCE <name> FROM WEBHOOK- An option in a
{FROM|INTO} CONNECTION ...statement. - A single CTE (used after
WITH):alias [(col1, col2, ...)] AS ( query )The names in the column list beforeAS, 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. - A column definition in a
CteMutRec. DEALLOCATE ...DECLARE ...DELETEDROPDROP OWNED BY ...EXECUTE ...- A selected external reference in a FOR TABLES (..) statement
FETCH ...- A function call
GRANT ...GRANT ...- An identifier.
INSERTINSPECT SHARD <id>- An intermediate value for Intervals, which tracks all data from the user, as well as the computed ParsedDateTime.
- An option in a
CREATE CONNECTION...SSH. - An option in a
{FROM|INTO} CONNECTION ...statement. - A reference to an operator.
- SQL ORDER BY expression
- An option in a
{FROM|INTO} CONNECTION ...statement. PREPARE ...- The most complete variant of a
SELECTquery expression, optionally includingWITH,UNION/ other set operations, andORDER BY. RAISE ...REASSIGN OWNED ...- An option in a
CREATE CLUSTER REPLICAstatement. RESET <variable>REVOKE ...REVOKE ...ROLLBACK [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]- A restricted variant of
SELECT(without CTEs/ORDER BY), which may appear either as the only body item of anSQLQuery, or as an operand to a set operation likeUNION. SELECTSET TRANSACTION ...SET <variable>SHOW COLUMNSSHOW CREATE INDEX <index>SHOW CREATE MATERIALIZED VIEW <name>SHOW CREATE SINK <sink>SHOW CREATE SOURCE <source>SHOW CREATE TABLE <table>SHOW CREATE VIEW <view>SHOW <object>SSHOW <variable>{ BEGIN [ TRANSACTION | WORK ] | START TRANSACTION } ...SUBSCRIBE- A name of a database
- A name of a table, view, custom type, etc. that lives in a schema, possibly multi-part, i.e. db.schema.obj
- A name of a schema
UPDATEVALIDATE CONNECTION- Specifies the data processed by a window function, e.g.
RANGE UNBOUNDED PRECEDINGorROWS BETWEEN 5 PRECEDING AND CURRENT ROW. - A window specification (i.e.
OVER (PARTITION BY .. ORDER BY .. etc.)) Includes potential IGNORE NULLS or RESPECT NULLS from before the OVER clause.
Enums§
ALTER ROLE ... [ WITH | SET ] ...ColumnOptions are modifiers that follow a column definition in aCREATE TABLEstatement.- An option in a
CREATE SINKstatement. - An option in a
CREATE SUBSOURCEstatement. CREATE TYPE .. AS <TYPE>- A block of common table expressions (CTEs).
- Specifies what Statement::ExplainPlan is actually explained.
- What is being explained. The bools mean whether this is an EXPLAIN BROKEN.
- An SQL expression of any type.
- Specifies which set of external references to generate a source export for in a
CREATE SOURCEstatement. - Arguments for a function call.
- An option in a
CREATE CLUSTERstatement. - A key constraint, specified in a
CREATE SOURCE. - An enum of named plans that identifies specific stages in an optimizer trace where these plans can be found.
- SQL data types
- Attributes that can be attached to roles.
- One item of the comma-separated list following
SELECT - A node in a tree, representing a “query body” expression, roughly:
SELECT ... [ {UNION|EXCEPT|INTERSECT} SELECT ...] ALTER ROLE role_name [SET | RESET] ...- A top-level statement (SELECT, INSERT, CREATE, etc.)
- A table-level constraint, specified in a
CREATE TABLEor anALTER TABLE ADD <constraint>statement. - A table name or a parenthesized subquery with an optional alias
CREATE TABLE .. FROM SOURCEcolumns specification can have 3 states: Before purification they can beNotSpecifiedorNamedby the user to specify the column names to use. After purification they can be in any of the 3 states. For some source types we define the columns during purification and for others the columns are defined during planning based on the encoding option of the source.- Primitive SQL values.
Traits§
- This represents the metadata that lives next to an AST, as we take it through various stages in the planning process.
Functions§
- A static str for each statement kind