Struct CopyQueryParams 

pub struct CopyQueryParams {
    pub sql: String,
    pub target_table: String,
    pub mode: String,
    pub target_database: Option<String>,
    pub temp_attach: Option<Vec<AttachSpec>>,
}

Parameters for the copy_query tool. Runs a read-only SELECT / WITH / VALUES statement and lands the result into a target table.

The inner sql may reference tables in the primary workspace (unqualified) as well as tables in any attachment by its fully qualified form — e.g. src.public.customers. The destination is resolved via target_database (main workspace by default).

Fields

sql: String

Read-only SQL statement whose result rows will be inserted into target_table. Must begin with SELECT, WITH, or VALUES. EXPLAIN / SHOW are rejected because their output shape isn’t row-compatible with a target table.

target_table: String

Unqualified destination table name. Always lands in the public schema of the database identified by target_database.

mode: String

How to reconcile with any existing target table:

• "create" — error if the target already exists; create from the query’s result schema via CREATE TABLE AS.
• "append" — error if the target does not exist; rows are appended via INSERT INTO ... SELECT.
• "replace" — drop (if any) and recreate, atomically.

target_database: Option<String>

Alias of the destination database. None and "local" both mean the server’s primary workspace. Any other value must refer to an attachment registered with writable: true.

temp_attach: Option<Vec<AttachSpec>>

Optional list of databases to attach for the duration of this call only. Detached automatically even if the query fails. Aliases used here must not already be in use.

Trait Implementations

impl Debug for CopyQueryParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CopyQueryParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for CopyQueryParams

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.