Struct ExportOptions 

pub struct ExportOptions {
    pub sql: Option<String>,
    pub table: Option<String>,
    pub path: String,
    pub format: String,
    pub overwrite: bool,
    pub format_options: Option<Map<String, Value>>,
    pub source_db: Option<String>,
}

Specifies what to export and where.

For row-oriented formats (csv, parquet, arrow_ipc, iceberg) exactly one of sql or table must be provided; sql takes priority if both are set. For hyper format both are ignored — every user table in the workspace is copied into a new .hyper file.

Fields

sql: Option<String>

A SELECT query whose results will be exported. Ignored when format = "hyper".

table: Option<String>

Table name — converted to SELECT * FROM "<table>" when sql is None. Ignored when format = "hyper".

path: String

Destination file path.

format: String

One of "csv", "parquet", "arrow_ipc", "iceberg", or "hyper".

overwrite: bool

Whether to overwrite an existing file at path. When false and path already exists, export_to_file returns a ErrorCode::PermissionDenied error without touching the file.

format_options: Option<Map<String, Value>>

Extra options passed through verbatim into the WITH (...) clause of hyperd’s COPY TO. Keys must match hyperd’s own option names (e.g. codec, rows_per_row_group, max_file_size, table_scheme, delimiter, header). Values may be strings, booleans, or numbers; anything else is rejected. Ignored for "hyper" format (which is not a COPY at all).

source_db: Option<String>

Source database to snapshot when format = "hyper". None → the primary (ephemeral) workspace; Some("persistent") or Some("user_alias") snapshots that attached database. Ignored for the row-oriented formats which already qualify via sql or via scoped_search_path.

Trait Implementations

impl Debug for ExportOptions

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

Formats the value using the given formatter.

impl Default for ExportOptions

fn default() -> ExportOptions

Returns the “default value” for a type.