Struct PostgresConfig

pub struct PostgresConfig {
    pub endpoint: String,
    pub table: String,
    pub pool_size: u32,
    pub batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>,
    pub request: TowerRequestConfig,
    pub acknowledgements: AcknowledgementsConfig,
}

Configuration for the postgres sink.

Fields

endpoint: String

The PostgreSQL server connection string. It can contain the username and password. See PostgreSQL documentation about connection strings for more information about valid formats and options that can be used.

table: String

The table that data is inserted into. This table parameter is vulnerable to SQL injection attacks as Vector does not validate or sanitize it, you must not use untrusted input. This parameter will be directly interpolated in the SQL query statement, as table names as parameters in prepared statements are not allowed in PostgreSQL.

pool_size: u32

The postgres connection pool size. See this for more information about why a connection pool should be used.

batch: BatchConfig<RealtimeSizeBasedDefaultBatchSettings>

Event batching behavior.

Note that as PostgreSQL’s jsonb_populate_recordset function is used to insert events, a single event in the batch can make the whole batch to fail. For example, if a single event within the batch triggers a unique constraint violation in the destination table, the whole event batch will fail.

As a workaround, triggers on constraint violations can be defined at a database level to change the behavior of the insert operation on specific tables. Alternatively, setting max_events batch setting to 1 will make each event to be inserted independently, so events that trigger a constraint violation will not affect the rest of the events.

request: TowerRequestConfig

acknowledgements: AcknowledgementsConfig

Trait Implementations

impl Clone for PostgresConfig

fn clone(&self) -> PostgresConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for PostgresConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for PostgresConfig

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

Formats the value using the given formatter.

impl Default for PostgresConfig

fn default() -> PostgresConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PostgresConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for PostgresConfig

fn generate_config() -> Value

impl NamedComponent for PostgresConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for PostgresConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for PostgresConfig

fn build<'life0, 'async_trait>( &'life0 self, _cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

fn files_to_watch(&self) -> Vec<&PathBuf>

Gets the files to watch to trigger reload

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

impl ToValue for PostgresConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.