Struct CopyStatement 

pub struct CopyStatement<X: Extension = NoExt> {
    pub binary: bool,
    pub source: CopySource<X>,
    pub direction: CopyDirection,
    pub target: CopyTarget,
    pub delimiters: Option<Literal>,
    pub parenthesized: bool,
    pub options: ThinVec<CopyOption>,
    pub filter: Option<Expr<X>>,
    pub meta: Meta,
}

A PostgreSQL COPY bulk data-transfer statement.

Moves rows between an external location and either a table or the result of a query: COPY {<table> [(cols)] | (<query>)} {FROM | TO} {'file' | STDIN | STDOUT | PROGRAM 'cmd'} [ [WITH] (options) | <legacy options> ]. The two row sources ride source; the query source makes this node generic over the extension X, since it embeds a Statement.

One canonical shape: the legacy un-parenthesized option list and the modern parenthesized list share one options list, with the parenthesized surface tag recording which spelling was written so the construct round-trips. FROM/TO is recorded by direction (always TO for the query source, which PostgreSQL forbids FROM on); the STDIN/STDOUT keyword that is only semantically valid for one direction is preserved verbatim rather than gated (PostgreSQL accepts either with either direction).

A handful of legacy table-only surfaces ride dedicated fields rather than the generic option list: the very-old opt_binary prefix (binary), the [USING] DELIMITERS '<str>' clause (delimiters), and the COPY <table> FROM '<file>' WHERE <predicate> filter (filter, FROM-only — PostgreSQL rejects it on COPY TO). None are valid on the query source, which the parser enforces.

Fields

binary: bool

The very-old opt_binary prefix (COPY BINARY <table> ...), distinct from the BINARY option. Table source only. true renders the leading BINARY keyword.

source: CopySource<X>

Input source for this syntax.

direction: CopyDirection

Whether the copy is FROM (load) or TO (export); see CopyDirection.

target: CopyTarget

Object targeted by this syntax.

delimiters: Option<Literal>

The legacy [USING] DELIMITERS '<str>' clause (PostgreSQL copy_delimiter), written between the endpoint and the options; None when absent. Only the delimiter string is kept: the optional USING is non-load-bearing (PostgreSQL opt_using) and canonicalizes away like the WITH before the options and the AS in DELIMITER AS '<str>'.

parenthesized: bool

Whether the parenthesized WITH (opt, ...) option-list spelling was used (the always-present surface tag); false is the legacy space-separated list (CSV, DELIMITER ','). Irrelevant when options is empty, where neither spelling renders.

options: ThinVec<CopyOption>

Options supplied in source order.

filter: Option<Expr<X>>

The WHERE <predicate> row filter of a COPY <table> FROM <source>; None when absent. PostgreSQL admits it for COPY FROM only (it errors “WHERE clause not allowed with COPY TO”), so the parser only ever populates this on a FROM table source.

meta: Meta

Source location and node identity.

Trait Implementations

impl<X: Clone + Extension> Clone for CopyStatement<X>

fn clone(&self) -> CopyStatement<X>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<X: Debug + Extension> Debug for CopyStatement<X>

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

Formats the value using the given formatter.

impl<'de, X> Deserialize<'de> for CopyStatement<X>

where X: Deserialize<'de> + Extension,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<X: Eq + Extension> Eq for CopyStatement<X>

impl<X: Hash + Extension> Hash for CopyStatement<X>

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<X: PartialEq + Extension> PartialEq for CopyStatement<X>

fn eq(&self, other: &CopyStatement<X>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<X: Extension + Render> Render for CopyStatement<X>

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

Return the render for this value.

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.

impl<X> Serialize for CopyStatement<X>

where X: Serialize + Extension,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<X: Extension> Spanned for CopyStatement<X>

fn span(&self) -> Span

Return the span for this value.

impl<X: PartialEq + Extension> StructuralPartialEq for CopyStatement<X>