docs/server/features/connectors/settings.md
All connectors share a common set of configuration options that can be used to customize their behavior.
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.
::: tip Individual connectors also include their own specific settings. To view them, go to their individual pages. :::
| Name | Details |
|---|---|
instanceTypeName | required |
Description: Specifies the type of connector instance.
Accepted Values:
<ul><li>`elasticsearch-sink`</li><li>`http-sink`</li><li>`kafka-sink`</li><li>`mongo-db-sink`</li><li>`rabbit-mq-sink`</li><li>`serilog-sink`</li><li>`sql-sink`</li></ul>For details about each type, see the individual connector [page](/server/features/connectors/). || Name | Details |
|---|---|
subscription:filter:scope | 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".Default: unspecified |
| subscription:filter:filterType | Description:
Specifies the method used to filter events.
Accepted Values:
"streamId", "regex", "prefix", "jsonPath".Default: unspecified |
| subscription:filter:expression | 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 not specified, it consumes from $all excluding system events.
Default: "" |
| subscription:initialPosition | 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.
| Name | Details |
|---|---|
transformer:enabled | Description: |
| Enables or disables the event transformer. |
Default: "false" |
| transformer:function | required
Description: Base64 encoded JavaScript function for transforming events. See Transformations for examples.
Default: "" |
For details and examples on transformations, see Transformations.
| Name | Details |
|---|---|
resilience:enabled | Description: |
| Enables or disables resilience. |
Default: "true" |
| resilience:firstDelayBound:upperLimitMs | Description:
The upper limit for the first delay bound in milliseconds.
Default: "60000" |
| resilience:firstDelayBound:delayMs | Description:
The delay for the first delay bound in milliseconds.
Default: "5000" |
| resilience:secondDelayBound:upperLimitMs | Description:
The upper limit for the second delay bound in milliseconds.
Default: "3600000" |
| resilience:secondDelayBound:delayMs | Description:
The delay for the second delay bound in milliseconds.
Default: "600000" |
| resilience:thirdDelayBound:upperLimitMs | Description:
The upper limit for the third delay bound in milliseconds. A value of "-1" indicates forever.
Default: "-1" |
| resilience:thirdDelayBound:delayMs | Description:
The delay for the third delay bound in milliseconds.
Default: "3600000" |
::: note Not all connectors use every resilience setting listed here. Some may have additional or different resilience options. If a connector’s individual documentation page does not explicitly mention support for these settings, it does not use them. :::
For more details on resilience, see Resilience.
| Name | Details |
|---|---|
autocommit:enabled | Description: |
| Enable or disables auto-commit |
Default: "true" |
| autocommit:interval | Description:
The interval, in milliseconds at which auto-commit occurs
Default: "5000" |
| autocommit:recordsThreshold | Description:
The threshold of records that triggers an auto-commit
Default: "1000" |
| Name | Details |
|---|---|
logging:enabled | Description: |
| Enables or disables logging. |
Default: "true" |
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 source connector.
::: tip Individual connectors also include their own specific settings. To view them, go to their individual pages. :::
| Name | Details |
|---|---|
instanceTypeName | required |
Description: Specifies the type of connector instance.
Accepted Values:
<ul><li>`kafka-source`</li><li>`webhook-source`</li></ul>For details about each type, see the individual connector [page](/server/features/connectors/). || Name | Details |
|---|---|
logging:enabled | Description: |
| Enables or disables logging. |
Default: "true" |
The Connector plugin is pre-installed in all KurrentDB 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