Skip to main content

PostgresSinkConfig

Struct PostgresSinkConfig 

Source
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,
}
Expand description

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.

§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.

Implementations§

Source§

impl PostgresSinkConfig

Source

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

Create a new config with required fields and sensible defaults.

Source

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

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

Source

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

Set the column mapping strategy.

Source

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

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.

Source

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

Set the maximum number of connections in the pool.

Trait Implementations§

Source§

impl Clone for PostgresSinkConfig

Source§

fn clone(&self) -> PostgresSinkConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PostgresSinkConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for PostgresSinkConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Serialize for PostgresSinkConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,