Configure Connector

About 2 min

All connectors share a common set of configuration options that can be used to customize their behavior.

Sink Options

Below, you will find a comprehensive list of configuration settings that you can use to define the connection parameters and other necessary details for your sink connector.

Tips

Individual connectors also include their own specific settings. To view them, go to their individual pages.

Instance configuration

Name	Details
`instanceTypeName`	required Type: string Description: The name of the instance type for the sink. Refer to the sink's individual page for more details on the available instance types.

Subscription configuration

Name	Details
`subscription:filter:scope`	Type: enum Description: Determines the scope of event filtering for the subscription. Use `stream` to filter events by stream ID, or `record` to filter events by event type. Accepted Values: - `stream`, `record`, `unspecified`. Default: `unspecified`
`subscription:filter:filterType`	Type: enum Description: Specifies the method used to filter events. Accepted Values: - `streamId`, `regex`, `prefix`, `jsonPath`, `unspecified`. Default: `unspecified`
`subscription:filter:expression`	Type: string Description: A filter expression (regex, JsonPath, or prefix) for records. If `scope` is specified and the expression is empty, it consumes from `$all` including system events. If `scope` is unspecified, it consumes from `$all` excluding system events. Default: `""`
`subscription:initialPosition`	Type: enum Description: The position in the message stream from which a consumer starts consuming messages when there is no prior checkpoint. Accepted Values: - `latest`, `earliest`. Default: `latest`

For details and examples on subscriptions, see Filters.

Transformation configuration

Name	Details
`transformer:enabled`	Type: bool Description: Enables or disables the event transformer. Default: `false`
`transformer:function`	required (if enabled) Type: string Description: Base64 encoded JavaScript function for transforming events. See Transformations for examples. Default: `""`

For details and examples on transformations, see Transformations.

Resilience configuration

Name	Details
`resilience:enabled`	Type: bool Description: Enables or disables resilience. Default: `true`
`resilience:firstDelayBound:upperLimitMs`	Type: int Description: The upper limit for the first delay bound in milliseconds. Default: `60000` (1 minute)
`resilience:firstDelayBound:delayMs`	Type: int Description: The delay for the first delay bound in milliseconds. Default: `5000` (5 seconds)
`resilience:secondDelayBound:upperLimitMs`	Type: int Description: The upper limit for the second delay bound in milliseconds. Default: `3600000` (1 hour)
`resilience:secondDelayBound:delayMs`	Type: int Description: The delay for the second delay bound in milliseconds. Default: `600000` (10 minutes)
`resilience:thirdDelayBound:upperLimitMs`	Type: int Description: The upper limit for the third delay bound in milliseconds. A value of `-1` indicates forever. Default: `-1` (forever)
`resilience:thirdDelayBound:delayMs`	Type: int Description: The delay for the third delay bound in milliseconds. Default: `3600000` (1 hour)

For details on resilience, see Resilience.

Auto-Commit configuration

Name	Details
`autocommit:enabled`	Type: bool Description: Enable or disables auto-commit Default: `true`
`autocommit:interval`	Type: int Description: The interval, in milliseconds at which auto-commit occurs Default: `5000`
`autocommit:recordsThreshold`	Type: int Description: The threshold of records that triggers an auto-commit Default: `1000`

Logging configuration

Name	Details
`logging:enabled`	Type: bool Description: Enables or disables logging. Default: `true`

Disable the Plugin

The Connector plugin is pre-installed in all EventStoreDB binaries and is enabled by default. It can be disabled with the following configuration.

Refer to the configuration guide for configuration mechanisms other than YAML.

Connectors:
  Enabled: false