Struct datafusion_sql::parser::CopyToStatement

pub struct CopyToStatement {
    pub source: CopyToSource,
    pub target: String,
    pub partitioned_by: Vec<String>,
    pub has_header: bool,
    pub stored_as: Option<String>,
    pub options: Vec<(String, Value)>,
}

DataFusion extension DDL for COPY

Syntax:

COPY <table_name | (<query>)>
TO
<destination_url>
(key_value_list)

Examples

COPY lineitem  TO 'lineitem'
 (format parquet,
  partitions 16,
  row_group_limit_rows 100000,
  row_group_limit_bytes 200000
 )

COPY (SELECT l_orderkey from lineitem) to 'lineitem.parquet';

Fields

source: CopyToSource

From where the data comes from

target: String

The URL to where the data is heading

partitioned_by: Vec<String>

Partition keys

has_header: bool

Indicates whether there is a header row (e.g. CSV)

stored_as: Option<String>

File type (Parquet, NDJSON, CSV etc.)

options: Vec<(String, Value)>

Target specific options

Trait Implementations

impl Clone for CopyToStatement

fn clone(&self) -> CopyToStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CopyToStatement

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

Formats the value using the given formatter.

impl Display for CopyToStatement

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

Formats the value using the given formatter.

impl PartialEq for CopyToStatement

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

impl StructuralPartialEq for CopyToStatement