Struct PostgresSinkConfig 

pub struct PostgresSinkConfig {
    pub connection_url: String,
    pub table_name: String,
    pub schema: Option<String>,
    pub column_mapping: PostgresColumnMapping,
    pub batch_size: usize,
    pub max_connections: u32,
    pub write: WriteSpec,
    pub write_method: PostgresWriteMethod,
}

Available on crate feature sink-postgres only.

Configuration for the PostgreSQL sink.

Fields

connection_url: String

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

table_name: String

Target table name.

schema: Option<String>

Optional schema (namespace) qualifying table_name.

When set, both the AutoMap column-discovery probe and the INSERT target schema.table_name explicitly. When unset (the default), the table resolves against the connection’s search_path, and column discovery is scoped to whichever schema the INSERT actually resolves to — so a same-named table in another schema no longer pollutes the AutoMap column set (#146 M13).

column_mapping: PostgresColumnMapping

How to map JSON records to columns. Defaults to a single jsonb column named data.

batch_size: usize

Maximum rows per multi-row INSERT statement. Defaults to DEFAULT_BATCH_SIZE.

When the upstream StreamPage carries more records than batch_size, the sink slices the page into batch_size-row chunks and issues one multi-row INSERT per chunk. When batch_size = 0, the entire slice is sent in a single INSERT — useful when the source already chunks to a Postgres-friendly size.

batch_size = 0 is the “no batching” sentinel: the entire upstream page is forwarded in one statement, subject to Postgres’ natural per-statement bind-parameter limit of 65 535. AutoMap mode binds one parameter per column per row, so the safe ceiling is roughly 65_535 / num_columns rows per call; JSONB mode binds a single array parameter and has no such ceiling. Keep the default unless the upstream page size is already tuned for Postgres.

Recommended value: ~1000 — Postgres’ multi-row INSERT sweet spot. Larger chunks rarely add throughput and risk hitting the 65 535-parameter ceiling in AutoMap mode.

max_connections: u32

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

Bounded on purpose: the pool must be finite so a wide fan-out (many matrix rows / shards) cannot exhaust the server’s own max_connections. There is no “unlimited” setting — raise this explicitly if you need more.

write: WriteSpec

Write mode, key columns, and optional delete marker. write_mode defaults to append. Upsert/delete require column_mapping: auto_map and a UNIQUE/PRIMARY KEY constraint on key.

write_method: PostgresWriteMethod

How append-mode rows are shipped: multi-row insert (default) or the copy bulk-load fast-path (COPY … FROM STDIN, typically 5–10× faster for bulk append). copy is append-only — it is rejected with write_mode: upsert|delete — and the exactly-once path always stays on insert so data + watermark commit in one transaction.

Implementations

impl PostgresSinkConfig

pub fn new( connection_url: impl Into<String>, table_name: impl Into<String>, ) -> PostgresSinkConfig

Create a new config with required fields and sensible defaults.

pub fn with_schema(self, schema: impl Into<String>) -> PostgresSinkConfig

Set the schema (namespace) that qualifies the table. When unset, the table resolves against the connection’s search_path.

pub fn column_mapping( self, mapping: PostgresColumnMapping, ) -> PostgresSinkConfig

Set the column mapping strategy.

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

Set the per-statement row count for multi-row INSERT.

Pass 0 to opt out of re-chunking — the sink forwards each upstream StreamPage as a single INSERT statement. Postgres’ multi-row INSERT sweet spot is ~1000 rows.

pub fn max_connections(self, n: u32) -> PostgresSinkConfig

Set the maximum number of connections in the pool.

pub fn with_write_method( self, method: PostgresWriteMethod, ) -> PostgresSinkConfig

Choose how append-mode rows are shipped (insert vs the copy bulk-load fast-path). See PostgresWriteMethod.

Trait Implementations

impl Clone for PostgresSinkConfig

fn clone(&self) -> PostgresSinkConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PostgresSinkConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PostgresSinkConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PostgresSinkConfig

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 PostgresSinkConfig

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.