Struct DuckdbSourceConfig 

pub struct DuckdbSourceConfig {
    pub database: String,
    pub query: String,
    pub read_only: bool,
    pub batch_size: usize,
}

Available on crate features source-duckdb and source-rest only.

Configuration for the DuckDB query source.

Fields

database: String

Path to the DuckDB database file, or :memory: for an in-memory database. A duckdb:// / duckdb: scheme prefix is accepted and stripped.

query: String

SQL query to execute.

read_only: bool

Open the database read-only. Defaults to false (read-write).

Set true to attach to a database file another process holds open — DuckDB permits multiple read-only connections to one file but only a single read-write connection.

batch_size: usize

Records per emitted StreamPage. Rows are drained from the DuckDB result and yielded whenever the buffer reaches this size. Defaults to DEFAULT_BATCH_SIZE.

batch_size = 0 is the “no batching” sentinel: the entire result set is emitted in a single page. Useful for small lookup tables.

Implementations

impl DuckdbSourceConfig

pub fn new( database: impl Into<String>, query: impl Into<String>, ) -> DuckdbSourceConfig

Create a new config with the required database path and query.

pub fn with_batch_size(self, batch_size: usize) -> DuckdbSourceConfig

Set the per-page row count for Source::stream_pages.

Pass 0 to opt out of batching — the entire result set is emitted in a single StreamPage.

pub fn read_only(self, read_only: bool) -> DuckdbSourceConfig

Open the database read-only.

Trait Implementations

impl Clone for DuckdbSourceConfig

fn clone(&self) -> DuckdbSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DuckdbSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DuckdbSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for DuckdbSourceConfig

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.

impl Serialize for DuckdbSourceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.