Struct PostgresSourceConfig 

pub struct PostgresSourceConfig {
    pub connection_url: String,
    pub query: String,
    pub params: Vec<Value>,
    pub max_connections: u32,
    pub batch_size: usize,
}

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

Configuration for the PostgreSQL query source.

Fields

connection_url: String

PostgreSQL connection URL (e.g. postgres://user:pass@host/db).

query: String

SQL query to execute.

params: Vec<Value>

Bind parameters for the query. Defaults to empty.

max_connections: u32

Maximum number of connections in the pool. Defaults to 10.

batch_size: usize

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

batch_size = 0 is the “no batching” sentinel: the cursor is fully drained and the entire result set is emitted in a single page. Useful for small lookup tables or for sinks (e.g. SQL COPY, BigQuery load jobs) that prefer one large request to many small ones.

Implementations

impl PostgresSourceConfig

pub fn new( connection_url: impl Into<String>, query: impl Into<String>, ) -> PostgresSourceConfig

Create a new config with the required connection URL and query.

pub fn params(self, params: Vec<Value>) -> PostgresSourceConfig

Set bind parameters for the query.

pub fn with_max_connections(self, max_connections: u32) -> PostgresSourceConfig

Set the maximum number of connections in the pool.

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

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.

Trait Implementations

impl Clone for PostgresSourceConfig

fn clone(&self) -> PostgresSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PostgresSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PostgresSourceConfig

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 PostgresSourceConfig

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.