Enum risinglight::parser::Statement

pub enum Statement {
    Analyze {
        table_name: ObjectName,
        partitions: Option<Vec<Expr, Global>>,
        for_columns: bool,
        columns: Vec<Ident, Global>,
        cache_metadata: bool,
        noscan: bool,
        compute_statistics: bool,
    },
    Truncate {
        table_name: ObjectName,
        partitions: Option<Vec<Expr, Global>>,
    },
    Msck {
        table_name: ObjectName,
        repair: bool,
        partition_action: Option<AddDropSync>,
    },
    Query(Box<Query, Global>),
    Insert {
        or: Option<SqliteOnConflict>,
        into: bool,
        table_name: ObjectName,
        columns: Vec<Ident, Global>,
        overwrite: bool,
        source: Box<Query, Global>,
        partitioned: Option<Vec<Expr, Global>>,
        after_columns: Vec<Ident, Global>,
        table: bool,
        on: Option<OnInsert>,
        returning: Option<Vec<SelectItem, Global>>,
    },
    Directory {
        overwrite: bool,
        local: bool,
        path: String,
        file_format: Option<FileFormat>,
        source: Box<Query, Global>,
    },
    Copy {
        table_name: ObjectName,
        columns: Vec<Ident, Global>,
        to: bool,
        target: CopyTarget,
        options: Vec<CopyOption, Global>,
        legacy_options: Vec<CopyLegacyOption, Global>,
        values: Vec<Option<String>, Global>,
    },
    Close {
        cursor: CloseCursor,
    },
    Update {
        table: TableWithJoins,
        assignments: Vec<Assignment, Global>,
        from: Option<TableWithJoins>,
        selection: Option<Expr>,
        returning: Option<Vec<SelectItem, Global>>,
    },
    Delete {
        table_name: TableFactor,
        using: Option<TableFactor>,
        selection: Option<Expr>,
        returning: Option<Vec<SelectItem, Global>>,
    },
    CreateView {
        or_replace: bool,
        materialized: bool,
        name: ObjectName,
        columns: Vec<Ident, Global>,
        query: Box<Query, Global>,
        with_options: Vec<SqlOption, Global>,
    },
    CreateTable {

        or_replace: bool,
        temporary: bool,
        external: bool,
        global: Option<bool>,
        if_not_exists: bool,
        name: ObjectName,
        columns: Vec<ColumnDef, Global>,
        constraints: Vec<TableConstraint, Global>,
        hive_distribution: HiveDistributionStyle,
        hive_formats: Option<HiveFormat>,
        table_properties: Vec<SqlOption, Global>,
        with_options: Vec<SqlOption, Global>,
        file_format: Option<FileFormat>,
        location: Option<String>,
        query: Option<Box<Query, Global>>,
        without_rowid: bool,
        like: Option<ObjectName>,
        clone: Option<ObjectName>,
        engine: Option<String>,
        default_charset: Option<String>,
        collation: Option<String>,
        on_commit: Option<OnCommit>,
        on_cluster: Option<String>,
    
},
    CreateVirtualTable {
        name: ObjectName,
        if_not_exists: bool,
        module_name: Ident,
        module_args: Vec<Ident, Global>,
    },
    CreateIndex {
        name: ObjectName,
        table_name: ObjectName,
        columns: Vec<OrderByExpr, Global>,
        unique: bool,
        if_not_exists: bool,
    },
    CreateRole {

        names: Vec<ObjectName, Global>,
        if_not_exists: bool,
        login: Option<bool>,
        inherit: Option<bool>,
        bypassrls: Option<bool>,
        password: Option<Password>,
        superuser: Option<bool>,
        create_db: Option<bool>,
        create_role: Option<bool>,
        replication: Option<bool>,
        connection_limit: Option<Expr>,
        valid_until: Option<Expr>,
        in_role: Vec<Ident, Global>,
        in_group: Vec<Ident, Global>,
        role: Vec<Ident, Global>,
        user: Vec<Ident, Global>,
        admin: Vec<Ident, Global>,
        authorization_owner: Option<ObjectName>,
    
},
    AlterTable {
        name: ObjectName,
        operation: AlterTableOperation,
    },
    Drop {
        object_type: ObjectType,
        if_exists: bool,
        names: Vec<ObjectName, Global>,
        cascade: bool,
        restrict: bool,
        purge: bool,
    },
    Declare {
        name: Ident,
        binary: bool,
        sensitive: Option<bool>,
        scroll: Option<bool>,
        hold: Option<bool>,
        query: Box<Query, Global>,
    },
    Fetch {
        name: Ident,
        direction: FetchDirection,
        into: Option<ObjectName>,
    },
    Discard {
        object_type: DiscardObject,
    },
    SetRole {
        context_modifier: ContextModifier,
        role_name: Option<Ident>,
    },
    SetVariable {
        local: bool,
        hivevar: bool,
        variable: ObjectName,
        value: Vec<Expr, Global>,
    },
    SetNames {
        charset_name: String,
        collation_name: Option<String>,
    },
    SetNamesDefault {},
    ShowFunctions {
        filter: Option<ShowStatementFilter>,
    },
    ShowVariable {
        variable: Vec<Ident, Global>,
    },
    ShowVariables {
        filter: Option<ShowStatementFilter>,
    },
    ShowCreate {
        obj_type: ShowCreateObject,
        obj_name: ObjectName,
    },
    ShowColumns {
        extended: bool,
        full: bool,
        table_name: ObjectName,
        filter: Option<ShowStatementFilter>,
    },
    ShowTables {
        extended: bool,
        full: bool,
        db_name: Option<Ident>,
        filter: Option<ShowStatementFilter>,
    },
    ShowCollation {
        filter: Option<ShowStatementFilter>,
    },
    Use {
        db_name: Ident,
    },
    StartTransaction {
        modes: Vec<TransactionMode, Global>,
    },
    SetTransaction {
        modes: Vec<TransactionMode, Global>,
        snapshot: Option<Value>,
        session: bool,
    },
    Comment {
        object_type: CommentObject,
        object_name: ObjectName,
        comment: Option<String>,
    },
    Commit {
        chain: bool,
    },
    Rollback {
        chain: bool,
    },
    CreateSchema {
        schema_name: SchemaName,
        if_not_exists: bool,
    },
    CreateDatabase {
        db_name: ObjectName,
        if_not_exists: bool,
        location: Option<String>,
        managed_location: Option<String>,
    },
    CreateFunction {
        temporary: bool,
        name: ObjectName,
        class_name: String,
        using: Option<CreateFunctionUsing>,
    },
    Assert {
        condition: Expr,
        message: Option<Expr>,
    },
    Grant {
        privileges: Privileges,
        objects: GrantObjects,
        grantees: Vec<Ident, Global>,
        with_grant_option: bool,
        granted_by: Option<Ident>,
    },
    Revoke {
        privileges: Privileges,
        objects: GrantObjects,
        grantees: Vec<Ident, Global>,
        granted_by: Option<Ident>,
        cascade: bool,
    },
    Deallocate {
        name: Ident,
        prepare: bool,
    },
    Execute {
        name: Ident,
        parameters: Vec<Expr, Global>,
    },
    Prepare {
        name: Ident,
        data_types: Vec<DataType, Global>,
        statement: Box<Statement, Global>,
    },
    Kill {
        modifier: Option<KillType>,
        id: u64,
    },
    ExplainTable {
        describe_alias: bool,
        table_name: ObjectName,
    },
    Explain {
        describe_alias: bool,
        analyze: bool,
        verbose: bool,
        statement: Box<Statement, Global>,
        format: Option<AnalyzeFormat>,
    },
    Savepoint {
        name: Ident,
    },
    Merge {
        into: bool,
        table: TableFactor,
        source: TableFactor,
        on: Box<Expr, Global>,
        clauses: Vec<MergeClause, Global>,
    },
    Cache {
        table_flag: Option<ObjectName>,
        table_name: ObjectName,
        has_as: bool,
        options: Vec<SqlOption, Global>,
        query: Option<Query>,
    },
    UNCache {
        table_name: ObjectName,
        if_exists: bool,
    },
    CreateSequence {
        temporary: bool,
        if_not_exists: bool,
        name: ObjectName,
        data_type: Option<DataType>,
        sequence_options: Vec<SequenceOptions, Global>,
        owned_by: Option<ObjectName>,
    },
}

A top-level statement (SELECT, INSERT, CREATE, etc.)

Variants

Analyze

Fields

table_name: ObjectName

partitions: Option<Vec<Expr, Global>>

for_columns: bool

columns: Vec<Ident, Global>

cache_metadata: bool

noscan: bool

compute_statistics: bool

Analyze (Hive)

Truncate

Fields

table_name: ObjectName

partitions: Option<Vec<Expr, Global>>

Truncate (Hive)

Msck

Fields

table_name: ObjectName

repair: bool

partition_action: Option<AddDropSync>

Msck (Hive)

Query(Box<Query, Global>)

SELECT

Insert

Fields

or: Option<SqliteOnConflict>

Only for Sqlite

into: bool

INTO - optional keyword

table_name: ObjectName

TABLE

columns: Vec<Ident, Global>

COLUMNS

overwrite: bool

Overwrite (Hive)

source: Box<Query, Global>

A SQL query that specifies what to insert

partitioned: Option<Vec<Expr, Global>>

partitioned insert (Hive)

after_columns: Vec<Ident, Global>

Columns defined after PARTITION

table: bool

whether the insert has the table keyword (Hive)

on: Option<OnInsert>

returning: Option<Vec<SelectItem, Global>>

RETURNING

INSERT

Directory

Fields

overwrite: bool

local: bool

path: String

file_format: Option<FileFormat>

source: Box<Query, Global>

Copy

Fields

table_name: ObjectName

TABLE

columns: Vec<Ident, Global>

COLUMNS

to: bool

If true, is a ‘COPY TO’ statement. If false is a ‘COPY FROM’

target: CopyTarget

The source of ‘COPY FROM’, or the target of ‘COPY TO’

options: Vec<CopyOption, Global>

WITH options (from PostgreSQL version 9.0)

legacy_options: Vec<CopyLegacyOption, Global>

WITH options (before PostgreSQL version 9.0)

values: Vec<Option<String>, Global>

VALUES a vector of values to be copied

Close

Fields

cursor: CloseCursor

Cursor name

Close - closes the portal underlying an open cursor.

Update

Fields

table: TableWithJoins

TABLE

assignments: Vec<Assignment, Global>

Column assignments

from: Option<TableWithJoins>

Table which provide value to be set

selection: Option<Expr>

WHERE

returning: Option<Vec<SelectItem, Global>>

RETURNING

UPDATE

Delete

Fields

table_name: TableFactor

FROM

using: Option<TableFactor>

USING (Snowflake, Postgres)

selection: Option<Expr>

WHERE

returning: Option<Vec<SelectItem, Global>>

RETURNING

DELETE

CreateView

Fields

or_replace: bool

materialized: bool

name: ObjectName

View name

columns: Vec<Ident, Global>

query: Box<Query, Global>

with_options: Vec<SqlOption, Global>

CREATE VIEW

CreateTable

Fields

or_replace: bool

temporary: bool

external: bool

global: Option<bool>

if_not_exists: bool

name: ObjectName

Table name

columns: Vec<ColumnDef, Global>

Optional schema

constraints: Vec<TableConstraint, Global>

hive_distribution: HiveDistributionStyle

hive_formats: Option<HiveFormat>

table_properties: Vec<SqlOption, Global>

with_options: Vec<SqlOption, Global>

file_format: Option<FileFormat>

location: Option<String>

query: Option<Box<Query, Global>>

without_rowid: bool

like: Option<ObjectName>

clone: Option<ObjectName>

engine: Option<String>

default_charset: Option<String>

collation: Option<String>

on_commit: Option<OnCommit>

on_cluster: Option<String>

Click house “ON CLUSTER” clause: https://clickhouse.com/docs/en/sql-reference/distributed-ddl/

CREATE TABLE

CreateVirtualTable

Fields

name: ObjectName

if_not_exists: bool

module_name: Ident

module_args: Vec<Ident, Global>

SQLite’s CREATE VIRTUAL TABLE .. USING <module_name> (<module_args>)

CreateIndex

Fields

name: ObjectName

index name

table_name: ObjectName

columns: Vec<OrderByExpr, Global>

unique: bool

if_not_exists: bool

CREATE INDEX

CreateRole

Fields

names: Vec<ObjectName, Global>

if_not_exists: bool

login: Option<bool>

inherit: Option<bool>

bypassrls: Option<bool>

password: Option<Password>

superuser: Option<bool>

create_db: Option<bool>

create_role: Option<bool>

replication: Option<bool>

connection_limit: Option<Expr>

valid_until: Option<Expr>

in_role: Vec<Ident, Global>

in_group: Vec<Ident, Global>

role: Vec<Ident, Global>

user: Vec<Ident, Global>

admin: Vec<Ident, Global>

authorization_owner: Option<ObjectName>

CREATE ROLE See postgres

AlterTable

Fields

name: ObjectName

Table name

operation: AlterTableOperation

ALTER TABLE

Drop

Fields

object_type: ObjectType

The type of the object to drop: TABLE, VIEW, etc.

if_exists: bool

An optional IF EXISTS clause. (Non-standard.)

names: Vec<ObjectName, Global>

One or more objects to drop. (ANSI SQL requires exactly one.)

cascade: bool

Whether CASCADE was specified. This will be false when RESTRICT or no drop behavior at all was specified.

restrict: bool

Whether RESTRICT was specified. This will be false when CASCADE or no drop behavior at all was specified.

purge: bool

Hive allows you specify whether the table’s stored data will be deleted along with the dropped table

DROP

Declare

Fields

name: Ident

Cursor name

binary: bool

Causes the cursor to return data in binary rather than in text format.

sensitive: Option<bool>

None = Not specified Some(true) = INSENSITIVE Some(false) = ASENSITIVE

scroll: Option<bool>

None = Not specified Some(true) = SCROLL Some(false) = NO SCROLL

hold: Option<bool>

None = Not specified Some(true) = WITH HOLD, specifies that the cursor can continue to be used after the transaction that created it successfully commits Some(false) = WITHOUT HOLD, specifies that the cursor cannot be used outside of the transaction that created it

query: Box<Query, Global>

DECLARE - Declaring Cursor Variables

Note: this is a PostgreSQL-specific statement, but may also compatible with other SQL.

Fetch

Fields

name: Ident

Cursor name

direction: FetchDirection

into: Option<ObjectName>

Optional, It’s possible to fetch rows form cursor to the table

FETCH - retrieve rows from a query using a cursor

Note: this is a PostgreSQL-specific statement, but may also compatible with other SQL.

Discard

Fields

object_type: DiscardObject

DISCARD [ ALL | PLANS | SEQUENCES | TEMPORARY | TEMP ]

Note: this is a PostgreSQL-specific statement, but may also compatible with other SQL.

SetRole

Fields

context_modifier: ContextModifier

Non-ANSI optional identifier to inform if the role is defined inside the current session (SESSION) or transaction (LOCAL).

role_name: Option<Ident>

Role name. If NONE is specified, then the current role name is removed.

SET [ SESSION | LOCAL ] ROLE role_name. Examples: ANSI, Postgresql, MySQL, and Oracle.

SetVariable

Fields

local: bool

hivevar: bool

variable: ObjectName

value: Vec<Expr, Global>

SET

Note: this is not a standard SQL statement, but it is supported by at least MySQL and PostgreSQL. Not all MySQL-specific syntatic forms are supported yet.

SetNames

Fields

charset_name: String

collation_name: Option<String>

SET NAMES ‘charset_name’ [COLLATE ‘collation_name’]

Note: this is a MySQL-specific statement.

SetNamesDefault

Fields

SET NAMES DEFAULT

Note: this is a MySQL-specific statement.

ShowFunctions

Fields

filter: Option<ShowStatementFilter>

SHOW FUNCTIONS

Note: this is a Presto-specific statement.

ShowVariable

Fields

variable: Vec<Ident, Global>

SHOW

Note: this is a PostgreSQL-specific statement.

ShowVariables

Fields

filter: Option<ShowStatementFilter>

SHOW VARIABLES

Note: this is a MySQL-specific statement.

ShowCreate

Fields

obj_type: ShowCreateObject

obj_name: ObjectName

SHOW CREATE TABLE

Note: this is a MySQL-specific statement.

ShowColumns

Fields

extended: bool

full: bool

table_name: ObjectName

filter: Option<ShowStatementFilter>

SHOW COLUMNS

Note: this is a MySQL-specific statement.

ShowTables

Fields

extended: bool

full: bool

db_name: Option<Ident>

filter: Option<ShowStatementFilter>

SHOW TABLES

Note: this is a MySQL-specific statement.

ShowCollation

Fields

filter: Option<ShowStatementFilter>

SHOW COLLATION

Note: this is a MySQL-specific statement.

Use

Fields

db_name: Ident

USE

Note: This is a MySQL-specific statement.

StartTransaction

Fields

modes: Vec<TransactionMode, Global>

{ BEGIN [ TRANSACTION | WORK ] | START TRANSACTION } ...

SetTransaction

Fields

modes: Vec<TransactionMode, Global>

snapshot: Option<Value>

session: bool

SET TRANSACTION ...

Comment

Fields

object_type: CommentObject

object_name: ObjectName

comment: Option<String>

COMMENT ON ...

Note: this is a PostgreSQL-specific statement.

Commit

Fields

chain: bool

COMMIT [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]

Rollback

Fields

chain: bool

ROLLBACK [ TRANSACTION | WORK ] [ AND [ NO ] CHAIN ]

CreateSchema

Fields

schema_name: SchemaName

<schema name> | AUTHORIZATION <schema authorization identifier> | <schema name> AUTHORIZATION <schema authorization identifier>

if_not_exists: bool

CREATE SCHEMA

CreateDatabase

Fields

db_name: ObjectName

if_not_exists: bool

location: Option<String>

managed_location: Option<String>

CREATE DATABASE

CreateFunction

Fields

temporary: bool

name: ObjectName

class_name: String

using: Option<CreateFunctionUsing>

CREATE FUNCTION

Hive: https://cwiki.apache.org/confluence/display/hive/languagemanual+ddl#LanguageManualDDL-Create/Drop/ReloadFunction

Assert

Fields

condition: Expr

message: Option<Expr>

ASSERT <condition> [AS <message>]

Grant

Fields

privileges: Privileges

objects: GrantObjects

grantees: Vec<Ident, Global>

with_grant_option: bool

granted_by: Option<Ident>

GRANT privileges ON objects TO grantees

Revoke

Fields

privileges: Privileges

objects: GrantObjects

grantees: Vec<Ident, Global>

granted_by: Option<Ident>

cascade: bool

REVOKE privileges ON objects FROM grantees

Deallocate

Fields

name: Ident

prepare: bool

DEALLOCATE [ PREPARE ] { name | ALL }

Note: this is a PostgreSQL-specific statement.

Execute

Fields

name: Ident

parameters: Vec<Expr, Global>

EXECUTE name [ ( parameter [, ...] ) ]

Note: this is a PostgreSQL-specific statement.

Prepare

Fields

name: Ident

data_types: Vec<DataType, Global>

statement: Box<Statement, Global>

PREPARE name [ ( data_type [, ...] ) ] AS statement

Note: this is a PostgreSQL-specific statement.

Kill

Fields

modifier: Option<KillType>

id: u64

KILL [CONNECTION | QUERY | MUTATION]

See https://clickhouse.com/docs/ru/sql-reference/statements/kill/ See https://dev.mysql.com/doc/refman/8.0/en/kill.html

ExplainTable

Fields

describe_alias: bool

table_name: ObjectName

EXPLAIN TABLE Note: this is a MySQL-specific statement. See https://dev.mysql.com/doc/refman/8.0/en/explain.html

Explain

Fields

describe_alias: bool

analyze: bool

Carry out the command and show actual run times and other statistics.

verbose: bool

statement: Box<Statement, Global>

A SQL query that specifies what to explain

format: Option<AnalyzeFormat>

Optional output format of explain

EXPLAIN / DESCRIBE for select_statement

Savepoint

Fields

name: Ident

SAVEPOINT – define a new savepoint within the current transaction

Merge

Fields

into: bool

table: TableFactor

source: TableFactor

on: Box<Expr, Global>

clauses: Vec<MergeClause, Global>

Cache

Fields

table_flag: Option<ObjectName>

table_name: ObjectName

has_as: bool

options: Vec<SqlOption, Global>

query: Option<Query>

CACHE [ FLAG ] TABLE <table_name> [ OPTIONS(‘K1’ = ‘V1’, ‘K2’ = V2) ] [ AS ] [ ] Based on Spark SQL,see https://docs.databricks.com/spark/latest/spark-sql/language-manual/sql-ref-syntax-aux-cache-cache-table.html

UNCache

Fields

table_name: ObjectName

if_exists: bool

UNCACHE TABLE [ IF EXISTS ] <table_name>

CreateSequence

Fields

temporary: bool

if_not_exists: bool

name: ObjectName

data_type: Option<DataType>

sequence_options: Vec<SequenceOptions, Global>

owned_by: Option<ObjectName>

CreateSequence – define a new sequence CREATE [ { TEMPORARY | TEMP } ] SEQUENCE [ IF NOT EXISTS ] <sequence_name>

Trait Implementations

impl Clone for Statement

fn clone(&self) -> Statement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Statement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Statement

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Statement, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Statement

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

Formats the value using the given formatter.

impl Hash for Statement

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

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 PartialEq<Statement> for Statement

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Statement

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

Serialize this value into the given Serde serializer.

impl TryFrom<Statement> for CreateTableBuilder

type Error = ParserError

The type returned in the event of a conversion error.

fn try_from(
    stmt: Statement
) -> Result<CreateTableBuilder, <CreateTableBuilder as TryFrom<Statement>>::Error>

Performs the conversion.

impl Eq for Statement

impl StructuralEq for Statement

impl StructuralPartialEq for Statement