Properties

Name Type Description Required
applier
(Configuration details of Redis Data Integration Applier Gear)
object, null
connections object

Additional Properties: not allowed

applier: Configuration details of Redis Data Integration Applier Gear

Properties

Name Type Description Required
on_failed_retry_interval
(Interval (in seconds) on which to perform retry on failure)
integer, string Default: 5
Pattern: ^\${.*}$
Minimum: 1
read_batch_size
(The batch size for reading data from source database)
integer, string Default: 2000
Pattern: ^\${.*}$
Minimum: 1
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
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
error_handling
(Error handling strategy: ignore - skip, dlq - store rejected messages in a dead letter queue)
string Default: "dlq"
Pattern: ``^${.*}$
ignore
dlq_max_messages
(Dead letter queue max messages per stream)
integer, string Default: 1000
Pattern: ^\${.*}$
Minimum: 1
target_data_type
(Target data type: hash/json - RedisJSON module must be in use in the target DB)
string Default: "hash"
Pattern: ``^${.*}$
hash
json_update_strategy
(Target update strategy: replace/merge - RedisJSON module must be in use in the target DB)
string Default: "replace"
Pattern: ``^${.*}$
replace
initial_sync_processes
(Number of processes RDI Engine creates to process the initial sync with the source)
integer, string Default: 4
Pattern: ^\${.*}$
Minimum: 1
Maximum: 32
wait_enabled
(Checks if the data has been written to the replica shard)
boolean Default: false
wait_timeout
(Timeout in milliseconds when checking write to the replica shard)
integer, string Default: 1000
Pattern: ^\${.*}$
Minimum: 1
retry_on_replica_failure
(Ensures that the data has been written to the replica shard and keeps retrying if not)
boolean Default: true

Additional Properties: not allowed

connections: Connections

Properties

Name Type Description Required
target
(Redis DB connection details)
object yes

Properties (Pattern)

Name Type Description Required
^(?!.*target).*$
additionalProperties

Example

target: {}

connections.target: Redis DB connection details

Properties

Name Type Description Required
type string DB type
Enum: "redis"
no
host
(Redis target DB host)
string yes
port
(Redis DB port)
integer, string Pattern: ^\${.*}$
Minimum: 1
Maximum: 65535
yes
user
(Redis DB user)
string no
password
(Redis DB password)
string no
key
(Private key file to authenticate with)
string no
cert
(Client certificate file to authenticate with)
string no
cacert
(CA certificate file to verify with)
string no

Additional Properties: not allowed

If property key is defined, property/ies cert, cacert is/are required.

If property cert is defined, property/ies key, cacert is/are required.