Skip to navigation

Supports:

  • ✅ Models
  • ✅ Model sync destination
  • ✅ Bulk sync source
  • ✅ Bulk sync destination

Connection

Configuration

NameTypeDescriptionRequired
client_certsbooleanUse client certificates ↓optional
hostsstringHostname(s)

Comma-separated list
required
passwordstringPasswordoptional
sshbooleanConnect over SSH tunnel ↓optional
tlsbooleanUse TLS/SSL ↓optional
usernamestringUsernameoptional

client_certs

When client_certs is true:

NameTypeDescriptionRequired
client_certificatestringClient certificaterequired
client_keystringClient keyrequired
{
"name": "ScyllaDB connection",
"type": "scylladb",
"configuration": {
"client_certificate": "",
"client_certs": true,
"client_key": "",
"hosts": "scylla.example.com",
"password": "password",
"ssh": false,
"tls": false,
"username": "scylla"
}
}

ssh

When ssh is true:

NameTypeDescriptionRequired
ssh_hoststringSSH hostrequired
ssh_portintegerSSH portrequired
ssh_private_keystringPrivate keyrequired
ssh_userstringSSH userrequired
{
"name": "ScyllaDB connection",
"type": "scylladb",
"configuration": {
"client_certs": false,
"hosts": "scylla.example.com",
"password": "password",
"ssh": true,
"ssh_host": "bastion.example.com",
"ssh_port": 22,
"ssh_private_key": "",
"ssh_user": "root",
"tls": false,
"username": "scylla"
}
}

tls

When tls is true:

NameTypeDescriptionRequired
ca_certstringCA certificateoptional
skip_verifybooleanSkip certificate verificationoptional
{
"name": "ScyllaDB connection",
"type": "scylladb",
"configuration": {
"ca_cert": "",
"client_certs": false,
"hosts": "scylla.example.com",
"password": "password",
"skip_verify": false,
"ssh": false,
"tls": true,
"username": "scylla"
}
}

Example

{
"name": "ScyllaDB connection",
"type": "scylladb",
"configuration": {
"client_certs": false,
"hosts": "scylla.example.com",
"password": "password",
"ssh": false,
"tls": false,
"username": "scylla"
}
}

Model Sync

Source

Configuration

NameTypeDescriptionRequired
keyspacestringKeyspacerequired
tablestringTablerequired

Example

{
...
"configuration": {
"keyspace": "app",
"table": "users"
}
}

Target

ScyllaDB connections may be used as the destination in a model sync.

Target creation

ScyllaDB connections may be used to create a new target for a model sync. The following parameters are required to create a new target:

NAMEDESCRIPTIONENUM
keyspaceKeyspacefalse
nameTable namefalse

Bulk Sync

Source

ScyllaDB connections may be used as a bulk sync source. No additional configuration options are required.

Destination

Configuration

NameTypeDescriptionRequired
keyspacestringKeyspaceoptional

Example

{
...
"destination_configuration": {
"keyspace": ""
}
}