Enum TableFactor 

pub enum TableFactor {
    Table {
        name: ObjectName,
        alias: Option<TableAlias>,
        args: Option<TableFunctionArgs>,
        with_hints: Vec<Expr>,
        version: Option<TableVersion>,
        with_ordinality: bool,
        partitions: Vec<Ident>,
        json_path: Option<JsonPath>,
        sample: Option<TableSampleKind>,
        index_hints: Vec<TableIndexHints>,
    },
    Derived {
        lateral: bool,
        subquery: Box<Query>,
        alias: Option<TableAlias>,
    },
    TableFunction {
        expr: Expr,
        alias: Option<TableAlias>,
    },
    Function {
        lateral: bool,
        name: ObjectName,
        args: Vec<FunctionArg>,
        alias: Option<TableAlias>,
    },
    UNNEST {
        alias: Option<TableAlias>,
        array_exprs: Vec<Expr>,
        with_offset: bool,
        with_offset_alias: Option<Ident>,
        with_ordinality: bool,
    },
    JsonTable {
        json_expr: Expr,
        json_path: Value,
        columns: Vec<JsonTableColumn>,
        alias: Option<TableAlias>,
    },
    OpenJsonTable {
        json_expr: Expr,
        json_path: Option<Value>,
        columns: Vec<OpenJsonTableColumn>,
        alias: Option<TableAlias>,
    },
    NestedJoin {
        table_with_joins: Box<TableWithJoins>,
        alias: Option<TableAlias>,
    },
    Pivot {
        table: Box<TableFactor>,
        aggregate_functions: Vec<ExprWithAlias>,
        value_column: Vec<Ident>,
        value_source: PivotValueSource,
        default_on_null: Option<Expr>,
        alias: Option<TableAlias>,
    },
    Unpivot {
        table: Box<TableFactor>,
        value: Ident,
        name: Ident,
        columns: Vec<Ident>,
        alias: Option<TableAlias>,
    },
    MatchRecognize {
        table: Box<TableFactor>,
        partition_by: Vec<Expr>,
        order_by: Vec<OrderByExpr>,
        measures: Vec<Measure>,
        rows_per_match: Option<RowsPerMatch>,
        after_match_skip: Option<AfterMatchSkip>,
        pattern: MatchRecognizePattern,
        symbols: Vec<SymbolDefinition>,
        alias: Option<TableAlias>,
    },
}

A table name or a parenthesized subquery with an optional alias

Variants

Table

Fields

name: ObjectName

alias: Option<TableAlias>

args: Option<TableFunctionArgs>

Arguments of a table-valued function, as supported by Postgres and MSSQL. Note that deprecated MSSQL FROM foo (NOLOCK) syntax will also be parsed as args.

This field’s value is Some(v), where v is a (possibly empty) vector of arguments, in the case of a table-valued function call, whereas it’s None in the case of a regular table name.

with_hints: Vec<Expr>

MSSQL-specific WITH (...) hints such as NOLOCK.

version: Option<TableVersion>

Optional version qualifier to facilitate table time-travel, as supported by BigQuery and MSSQL.

with_ordinality: bool

For example, SELECT * FROM generate_series(1, 10) WITH ORDINALITY AS t(a, b); WITH ORDINALITY, supported by Postgres.

partitions: Vec<Ident>

Partition selection, supported by MySQL.

json_path: Option<JsonPath>

Optional PartiQL JsonPath: https://partiql.org/dql/from.html

sample: Option<TableSampleKind>

Optional table sample modifier See: https://jakewheat.github.io/sql-overview/sql-2016-foundation-grammar.html#sample-clause

index_hints: Vec<TableIndexHints>

Optional index hints(mysql) See: https://dev.mysql.com/doc/refman/8.4/en/index-hints.html

Derived

Fields

lateral: bool

subquery: Box<Query>

alias: Option<TableAlias>

TableFunction

TABLE(<expr>)[ AS <alias> ]

Fields

expr: Expr

alias: Option<TableAlias>

Function

e.g. LATERAL FLATTEN(<args>)[ AS <alias> ]

Fields

lateral: bool

name: ObjectName

args: Vec<FunctionArg>

alias: Option<TableAlias>

UNNEST

SELECT * FROM UNNEST ([10,20,30]) as numbers WITH OFFSET;
+---------+--------+
| numbers | offset |
+---------+--------+
| 10      | 0      |
| 20      | 1      |
| 30      | 2      |
+---------+--------+

Fields

alias: Option<TableAlias>

array_exprs: Vec<Expr>

with_offset: bool

with_offset_alias: Option<Ident>

with_ordinality: bool

JsonTable

The JSON_TABLE table-valued function. Part of the SQL standard, but implemented only by MySQL, Oracle, and DB2.

https://modern-sql.com/blog/2017-06/whats-new-in-sql-2016#json_table https://dev.mysql.com/doc/refman/8.0/en/json-table-functions.html#function_json-table

SELECT * FROM JSON_TABLE(
   '[{"a": 1, "b": 2}, {"a": 3, "b": 4}]',
   '$[*]' COLUMNS(
       a INT PATH '$.a' DEFAULT '0' ON EMPTY,
       b INT PATH '$.b' NULL ON ERROR
    )
) AS jt;

Fields

json_expr: Expr

The JSON expression to be evaluated. It must evaluate to a json string

json_path: Value

The path to the array or object to be iterated over. It must evaluate to a json array or object.

columns: Vec<JsonTableColumn>

The columns to be extracted from each element of the array or object. Each column must have a name and a type.

alias: Option<TableAlias>

The alias for the table.

OpenJsonTable

The MSSQL’s OPENJSON table-valued function.

OPENJSON( jsonExpression [ , path ] )  [ <with_clause> ]

<with_clause> ::= WITH ( { colName type [ column_path ] [ AS JSON ] } [ ,...n ] )

Reference: https://learn.microsoft.com/en-us/sql/t-sql/functions/openjson-transact-sql?view=sql-server-ver16#syntax

Fields

json_expr: Expr

The JSON expression to be evaluated. It must evaluate to a json string

json_path: Option<Value>

The path to the array or object to be iterated over. It must evaluate to a json array or object.

columns: Vec<OpenJsonTableColumn>

The columns to be extracted from each element of the array or object. Each column must have a name and a type.

alias: Option<TableAlias>

The alias for the table.

NestedJoin

Represents a parenthesized table factor. The SQL spec only allows a join expression ((foo <JOIN> bar [ <JOIN> baz ... ])) to be nested, possibly several times.

The parser may also accept non-standard nesting of bare tables for some dialects, but the information about such nesting is stripped from AST.

Fields

table_with_joins: Box<TableWithJoins>

alias: Option<TableAlias>

Pivot

Represents PIVOT operation on a table. For example FROM monthly_sales PIVOT(sum(amount) FOR MONTH IN ('JAN', 'FEB'))

BigQuery Snowflake

Fields

table: Box<TableFactor>

aggregate_functions: Vec<ExprWithAlias>

value_column: Vec<Ident>

value_source: PivotValueSource

default_on_null: Option<Expr>

alias: Option<TableAlias>

Unpivot

An UNPIVOT operation on a table.

Syntax:

table UNPIVOT(value FOR name IN (column1, [ column2, ... ])) [ alias ]

See https://docs.snowflake.com/en/sql-reference/constructs/unpivot.

Fields

table: Box<TableFactor>

value: Ident

name: Ident

columns: Vec<Ident>

alias: Option<TableAlias>

MatchRecognize

A MATCH_RECOGNIZE operation on a table.

See https://docs.snowflake.com/en/sql-reference/constructs/match_recognize.

Fields

table: Box<TableFactor>

partition_by: Vec<Expr>

PARTITION BY <expr> [, ... ]

order_by: Vec<OrderByExpr>

ORDER BY <expr> [, ... ]

measures: Vec<Measure>

MEASURES <expr> [AS] <alias> [, ... ]

rows_per_match: Option<RowsPerMatch>

ONE ROW PER MATCH | ALL ROWS PER MATCH [ <option> ]

after_match_skip: Option<AfterMatchSkip>

AFTER MATCH SKIP <option>

pattern: MatchRecognizePattern

PATTERN ( <pattern> )

symbols: Vec<SymbolDefinition>

DEFINE <symbol> AS <expr> [, ... ]

alias: Option<TableAlias>

Trait Implementations

impl Clone for TableFactor

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TableFactor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableFactor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TableFactor

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for TableFactor

impl Hash for TableFactor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TableFactor

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for TableFactor

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for TableFactor

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for TableFactor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for TableFactor

partial span

Missing spans:

• TableFactor::JsonTable

fn span(&self) -> Span

Return the Span (the minimum and maximum Location) for this AST node, by recursively combining the spans of its children.

impl StructuralPartialEq for TableFactor

impl Visit for TableFactor

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

impl VisitMut for TableFactor

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>