Skip to main content

CopyOptionValue

Enum CopyOptionValue 

Source
pub enum CopyOptionValue {
    Word {
        word: Ident,
        meta: Meta,
    },
    String {
        value: Literal,
        meta: Meta,
    },
    Number {
        value: Literal,
        meta: Meta,
    },
    Star {
        meta: Meta,
    },
    List {
        values: ThinVec<CopyOptionValue>,
        meta: Meta,
    },
    Force {
        kind: ForceKind,
        columns: ThinVec<Ident>,
        meta: Meta,
    },
    OptionList {
        options: ThinVec<CopyOption>,
        meta: Meta,
    },
}
Expand description

The argument shapes a CopyOption can carry — the extensible axis of the COPY option machinery.

Mirrors PostgreSQL’s copy_generic_opt_arg alternatives (opt_boolean_or_string, NumericOnly, '*', and '(' copy_generic_opt_arg_list ')'), which pg_query accepts under the plain copy gate, plus the legacy Force compound. DuckDB’s and the Snowflake-adjacent parity target’s format/option values are a subset of these same shapes, so no widening feature flag is needed. This enum is the pre-staged extension point for the COPY INTO sibling: a keyed nested option list (Snowflake FILE_FORMAT = (TYPE = CSV …)) becomes an additive variant here (a ThinVec<CopyOption> payload), riding the same CopyOption/CopyStatement machinery rather than reshaping it.

Variants§

§

Word

A bareword argument kept as its source word (FORMAT csv, HEADER true, DuckDB FORMAT PARQUET). PostgreSQL opt_boolean_or_string.

Fields

§word: Ident

Identifier-form value.

§meta: Meta

Source location and node identity.

§

String

A string argument (DELIMITER ',', NULL '', DuckDB COMPRESSION 'zstd').

Fields

§value: Literal

Value supplied by this syntax.

§meta: Meta

Source location and node identity.

§

Number

A numeric argument (HEADER 1, DuckDB ROW_GROUP_SIZE 100000), including a sign-folded negative (-1) or decimal (1.5). PostgreSQL NumericOnly; the sign is folded into the literal’s span so it round-trips whole.

Fields

§value: Literal

Value supplied by this syntax.

§meta: Meta

Source location and node identity.

§

Star

The bare * argument of a generic parenthesized option (FORCE_QUOTE *). PostgreSQL '*'; distinct from the legacy Force all-columns form, which spells * as an empty column list.

Fields

§meta: Meta

Source location and node identity.

§

List

A parenthesized argument list (FORCE_QUOTE (a, b), DuckDB PARTITION_BY (y, m)). PostgreSQL '(' copy_generic_opt_arg_list ')'. The parser only ever emits Word/String/Number list items (PostgreSQL’s list items are opt_boolean_or_string; DuckDB adds numerics); the recursive type keeps one axis rather than a parallel item enum.

Fields

§values: ThinVec<CopyOptionValue>

Values in source order.

§meta: Meta

Source location and node identity.

§

Force

The {QUOTE | NULL | NOT NULL} {<column-list> | *} payload of a legacy FORCE option (PostgreSQL copy_opt_item), whose compound keyword the generic <name> [<value>] shape cannot carry: the name is the leading FORCE word and this value holds the sub-keyword (which kind distinguishes) and its target. An empty columns list is the * (all-columns) form (PostgreSQL A_Star) — unambiguous because PostgreSQL’s columnList is never empty.

Fields

§kind: ForceKind

Whether the force applies to all columns or a named list; see ForceKind.

§columns: ThinVec<Ident>

Columns in source order.

§meta: Meta

Source location and node identity.

§

OptionList

A keyed nested option list — the space-separated <key> = <value> pairs inside a Snowflake FILE_FORMAT = (TYPE = CSV FIELD_DELIMITER = ',') (or a FORMAT_NAME = '...') argument. Each element is a CopyOption, so the nested option vocabulary rides the same machinery as the outer list rather than a parallel node — the additive extension point ADR-0011 pre-staged on this enum. Distinct from List, whose elements are bare comma-separated values (FORCE_QUOTE (a, b)): an OptionList element is a key = value pair and the elements are space-separated. Only CopyIntoStatement emits this (via its = (...) option grammar); PostgreSQL/DuckDB COPY never does.

Fields

§options: ThinVec<CopyOption>

Options supplied in source order.

§meta: Meta

Source location and node identity.

Trait Implementations§

Source§

impl Clone for CopyOptionValue

Source§

fn clone(&self) -> CopyOptionValue

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CopyOptionValue

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for CopyOptionValue

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for CopyOptionValue

Source§

impl Hash for CopyOptionValue

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for CopyOptionValue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Render for CopyOptionValue

Source§

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

Return the render for this value.
Source§

fn operand_binding_power(&self) -> Option<BindingPower>

The binding power this node contributes when it appears as an operand, or None (the default) for a self-delimiting node — an atom, call, or constructor — that never needs parentheses. Read more
Source§

impl Serialize for CopyOptionValue

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Spanned for CopyOptionValue

Source§

fn span(&self) -> Span

Return the span for this value.
Source§

impl StructuralPartialEq for CopyOptionValue

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynAstExt for T
where T: Extension + Render + 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Erase to &dyn Any for downcasting a node back to its concrete type.
Source§

fn dyn_clone(&self) -> Box<dyn DynAstExt>

Clone into a fresh box — the object-safe stand-in for Clone (whose Self-returning signature cannot go through a vtable).
Source§

fn dyn_eq(&self, other: &dyn DynAstExt) -> bool

Structural equality against another erased node — the object-safe stand-in for PartialEq (whose &Self argument cannot go through a vtable). Equal iff other holds the same concrete type and that type deems the values equal; differently-typed nodes are never equal.
Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feed this node’s hash into an erased hasher — the object-safe stand-in for Hash::hash (whose generic H: Hasher cannot go through a vtable).
Source§

impl<T> Extension for T
where T: Clone + Debug + Eq + Hash + Spanned,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> RenderExt for T
where T: Render,

Source§

fn displayed<'a>(&'a self, ctx: &'a RenderCtx<'a>) -> Displayed<'a, T>

Pair this node with an explicit canonical RenderCtx so format!, to_string, and {} render it. This is the canonical path: the ctx’s resolver and source must match the node’s parse.
Source§

fn debug_sql<'a>(&'a self, resolver: &'a dyn Resolver) -> DebugSql<'a, Self>
where Self: Sized,

Render this node for debugging against an explicitly-supplied resolver (the debug-SQL mitigation), returning a Display adapter. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.