{
"id": "config-yaml-reference",
"title": "Write-behind configuration file",
"url": "https://redis.io/docs/latest/integrate/write-behind/reference/config-yaml-reference/",
"summary": "Write-behind configuration file reference",
"tags": [
"docs",
"integrate",
"rs",
"rdi"
],
"last_updated": "2026-04-01T08:10:08-05:00",
"page_type": "content",
"content_hash": "de0006c27cb1b57953a39ba756d92671d5b935f6d18c2357643b4ea73ec44a17",
"sections": [
{
"id": "write-behind-configuration-file",
"title": "Write-behind Configuration File",
"role": "overview",
"text": "**Properties**\n\n| Name | Type | Description | Required |\n| ------------------------------------------------------------------------------------------ | ---------------- | ----------- | -------- |\n| [**applier**](#applier)
(Configuration details of Write-behind Applier Gear) | `object`, `null` | | |\n| [**connections**](#connections) | `object` | | |\n\n"
},
{
"id": "applier-configuration-details-of-write-behind-applier-gear",
"title": "applier: Configuration details of Write-behind Applier Gear",
"role": "content",
"text": "**Properties**\n\n| Name | Type | Description | Required |\n| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ | --- |\n| **on_failed_retry_interval**
(Interval \\(in seconds\\) on which to perform retry on failure) | `integer`, `string` | Default: `5`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **read_batch_size**
(The batch size for reading data from source database) | `integer`, `string` | Default: `2000`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **debezium_lob_encoded_placeholder**
(Enable Debezium LOB placeholders) | `string` | Default: `\"X19kZWJleml1bV91bmF2YWlsYWJsZV92YWx1ZQ==\"`
| |\n| **dedup**
(Enable deduplication mechanism) | `boolean` | Default: `false`
| |\n| **dedup_max_size**
(Max size of the deduplication set) | `integer` | Default: `1024`
Minimum: `1`
| |\n| **duration**
(Time \\(in ms\\) after which data will be read from stream even if read_batch_size was not reached) | `integer`, `string` | Default: `100`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **write_batch_size**
(The batch size for writing data to target Redis database\\. Should be less or equal to the read_batch_size) | `integer`, `string` | Default: `200`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **error_handling**
(Error handling strategy: ignore \\- skip, dlq \\- store rejected messages in a dead letter queue) | `string` | Default: `\"dlq\"`
Pattern: ``^\\${.\\*}$ | ignore | dlq``
| |\n| **dlq_max_messages**
(Dead letter queue max messages per stream) | `integer`, `string` | Default: `1000`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **target_data_type**
(Target data type: hash/json \\- RedisJSON module must be in use in the target DB) | `string` | Default: `\"hash\"`
Pattern: ``^\\${.\\*}$ | hash | json``
| |\n| **json_update_strategy**
(Target update strategy: replace/merge \\- RedisJSON module must be in use in the target DB) | `string` | (DEPRECATED)
Property 'json_update_strategy' will be deprecated in future releases. Use 'on_update' job-level property to define the json update strategy.
Default: `\"replace\"`
Pattern: ``^\\${.\\*}$ | replace | merge``
| |\n| **initial_sync_processes**
(Number of processes Write-behind Engine creates to process the initial sync with the source) | `integer`, `string` | Default: `4`
Pattern: `^\\${.*}$`
Minimum: `1`
Maximum: `32`
| |\n| **wait_enabled**
(Checks if the data has been written to the replica shard of the target database) | `boolean` | Default: `false`
| |\n| **wait_timeout**
(Timeout in milliseconds when checking write to the replica shard of the target database) | `integer`, `string` | Default: `1000`
Pattern: `^\\${.*}$`
Minimum: `1`
| |\n| **retry_on_replica_failure**
(Ensures that the data has been written to the replica shard and keeps retrying if not) | `boolean` | Default: `true`
| |\n\n**Additional Properties:** not allowed \n"
},
{
"id": "connections-connections",
"title": "connections: Connections",
"role": "content",
"text": "**Properties (Pattern)**\n\n| Name | Type | Description | Required |\n| ------------------------ | ---- | ----------- | -------- |\n| **\\.\\*** | | | |\n| **additionalProperties** | | | |"
}
],
"examples": []
}