Struct datafusion_sql::parser::CreateExternalTable

pub struct CreateExternalTable {
    pub name: String,
    pub columns: Vec<ColumnDef>,
    pub file_type: String,
    pub has_header: bool,
    pub delimiter: char,
    pub location: String,
    pub table_partition_cols: Vec<String>,
    pub order_exprs: Vec<Vec<OrderByExpr>>,
    pub if_not_exists: bool,
    pub file_compression_type: CompressionTypeVariant,
    pub unbounded: bool,
    pub options: HashMap<String, String>,
}

DataFusion extension DDL for CREATE EXTERNAL TABLE

Syntax:

CREATE EXTERNAL TABLE
[ IF NOT EXISTS ]
<TABLE_NAME>[ (<column_definition>) ]
STORED AS <file_type>
[ WITH HEADER ROW ]
[ DELIMITER <char> ]
[ COMPRESSION TYPE <GZIP | BZIP2 | XZ | ZSTD> ]
[ PARTITIONED BY (<column list>) ]
[ WITH ORDER (<ordered column list>)
[ OPTIONS (<key_value_list>) ]
LOCATION <literal>

<column_definition> := (<column_name> <data_type>, ...)

<column_list> := (<column_name>, ...)

<ordered_column_list> := (<column_name> <sort_clause>, ...)

<key_value_list> := (<literal> <literal, <literal> <literal>, ...)

Fields

name: String

Table name

columns: Vec<ColumnDef>

Optional schema

file_type: String

File type (Parquet, NDJSON, CSV, etc)

has_header: bool

CSV Header row?

delimiter: char

User defined delimiter for CSVs

location: String

Path to file

table_partition_cols: Vec<String>

Partition Columns

order_exprs: Vec<Vec<OrderByExpr>>

Ordered expressions

if_not_exists: bool

Option to not error if table already exists

file_compression_type: CompressionTypeVariant

File compression type (GZIP, BZIP2, XZ)

unbounded: bool

Infinite streams?

options: HashMap<String, String>

Table(provider) specific options

Trait Implementations

impl Clone for CreateExternalTable

fn clone(&self) -> CreateExternalTable

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateExternalTable

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

Formats the value using the given formatter.

impl Display for CreateExternalTable

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

Formats the value using the given formatter.

impl PartialEq<CreateExternalTable> for CreateExternalTable

fn eq(&self, other: &CreateExternalTable) -> 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 Eq for CreateExternalTable

impl StructuralEq for CreateExternalTable

impl StructuralPartialEq for CreateExternalTable