ReplicationUpdate

Replication update request. source/target replace wholesale.

name object

anyOf

• string
• null

string

Possible values: non-empty and <= 63 characters, Value must match regular expression ^[a-z][a-z0-9_]{0,62}(?![\s\S])

alias object

anyOf

• string
• null

string

collection_id object

anyOf

• string
• null

string

Possible values: non-empty

folder_id object

anyOf

• string
• null

string

tags object

anyOf

• string[]
• null

Array [

string

]

description object

anyOf

• string
• null

string

type object

anyOf

• string
• null

string

Constant value: cdc

source object

anyOf

• ReplicationSource
• null

connector_idConnector Id (string)required

Minimum length: 1.

Possible values: non-empty

slotSlot (string)required

Logical replication slot name (required)

Possible values: non-empty

publicationPublication (string)

Publication that decides which tables are streamed

Possible values: non-empty

Default value: datacdc

create_slotCreate Slot (boolean)

Create the slot on start when it does not exist

Default value: true

schema object

Single-relation filter (with table). Omit both to stream the whole publication

anyOf

• string
• null

string

table object

Single-relation filter (with schema)

anyOf

• string
• null

string

tlsTls (boolean)

Connect with TLS

Default value: false

tls_verifyTls Verify (boolean)

Verify the server certificate when tls is on

Default value: true

fetch_timeoutFetch Timeout (string)

Idle wait between change fetches

Default value: 1s

max_changesMax Changes (integer)

Max changes fetched per round

Possible values: >= 1

Default value: 256

commit_intervalCommit Interval (string)

Batch commit interval

Default value: 5s

target object

anyOf

• ReplicationTarget
• null

connector_idConnector Id (string)required

Minimum length: 1.

Possible values: non-empty

schema object

Override the target schema for every event; defaults to the event's own

anyOf

• string
• null

string

tables object

Per-relation target name mapping; unmapped relations keep their source name

property name*string

columns object

Per-relation column selection and rename; a mapped relation keeps only the listed columns

property name* object

property name*string

keystring[]

Key columns for upsert / UPDATE / DELETE. Empty uses the target table's primary key. This is a sink-wide setting in datasink, so a keyless table needs its own Replication

tlsTls (boolean)

Connect with TLS

Default value: false

tls_verifyTls Verify (boolean)

Verify the server certificate when tls is on

Default value: true

ReplicationUpdate

{
  "name": "string",
  "alias": "string",
  "collection_id": "string",
  "folder_id": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "type": "cdc",
  "source": {
    "connector_id": "string",
    "slot": "string",
    "publication": "datacdc",
    "create_slot": true,
    "schema": "string",
    "table": "string",
    "tls": false,
    "tls_verify": true,
    "fetch_timeout": "1s",
    "max_changes": 256,
    "commit_interval": "5s"
  },
  "target": {
    "connector_id": "string",
    "schema": "string",
    "tables": {},
    "columns": {},
    "key": [
      "string"
    ],
    "tls": false,
    "tls_verify": true
  }
}