Struct ExportParams 

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

Parameters for the export tool.

Fields

sql: Option<String>

SQL query to export (if omitted, exports whole table)

table: Option<String>

Table name (used if sql omitted)

path: String

Output file path

format: String

Format: csv, parquet, arrow_ipc, iceberg, or hyper. For iceberg the path is a directory that hyperd will create (the table root with a metadata/ and data/ subdir); for all other formats it is a single file.

overwrite: Option<bool>

If false, refuse to overwrite an existing file at path and return a PERMISSION_DENIED error instead. Defaults to true (overwrite silently) to match pre-flag behavior.

format_options: Option<Value>

Optional per-format options passed through into hyperd’s COPY (query) TO '…' WITH (…) clause. Keys must match hyperd’s own option names exactly; values must be strings, numbers, or booleans (null / nested object / array are rejected). Common knobs:

• parquet — codec ("snappy" default, "zstd", "gzip", "uncompressed", …), rows_per_row_group (int).
• iceberg — everything Parquet accepts, plus table_scheme ("metastore" default, "filesystem"), max_file_size (bytes; split data across multiple parquet files).
• csv — header (bool, default true), delimiter (1-char string, default ","), null (string printed for NULL, default ""), quote (1-char string).
• arrow_ipc — none commonly needed.

Ignored for format = "hyper" (which isn’t a COPY).

Trait Implementations

impl Debug for ExportParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ExportParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ExportParams

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.