Skip to main content

Redis

Sync overview​

Output schema​

The incoming Airbyte data is structured depending on the target Redis cache/data type. This connector maps an incoming data from a namespace and stream to a unique Redis key.

For the hash implementation as a Redis data type the keys and the hashes are structured in the following way:

key:

namespace:stream:id

hash:

  • _airbyte_ab_id: Sequential id for a given key generated by using the INCR Redis command.
  • _airbyte_emitted_at: a timestamp representing when the event was received from the data source.
  • _airbyte_data: a json text/object representing the data that was received from the data source.

Performance considerations​

As long as you have the necessary memory capacity for your cache, Redis should be able to handle even millions of records without any issues since the data is stored in-memory with the option to save snapshots periodically on disk.

Supported sync modes​

Sync modeSupported?
Full Refresh - OverwriteYes
Full Refresh - AppendYes
Full Refresh - Overwrite + DedupedNo
Incremental Sync - AppendYes
Incremental Sync - Append + DedupedNo

Getting started​

Requirements​

  • The connector is fully compatible with redis 2.8.x, 3.x.x and above
  • Configuration
    • host: Hostname or address of the Redis server where to connect.
    • port: Port of the Redis server where to connect.
    • username: Username for authenticating with the Redis server.
    • password: Password for authenticating with the Redis server.
    • cache_type: Redis cache/data type to use when storing the incoming messages. i.e hash,set,list,stream,etc.
  • SSL toggle the switch to connect using SSL
  • For SSL Modes, select:
    • disable to disable encrypted communication between Airbyte and the source
    • verify-full to always require encryption and verify the identity of the source

Setup guide​

This section has not been written.

Namespace support​

This destination supports namespaces.

Reference​

Config fields reference

Field
Type
Property name
string
cache_type
string
host
integer
port
string
username
string
password
boolean
ssl
object
ssl_mode
object
tunnel_method

Changelog​

Expand to review
VersionDatePull RequestSubject
0.1.42022-10-25#18358TLS support
0.1.32022-10-18#17951Add SSH support