Skip to main content

Vitess

The Vitess destination connector loads data into a Vitess cluster using a MySQL-compatible connection. It uses the same loading behavior as our MySQL-compatible destinations.

Setup​

  1. Ensure you have a reachable Vitess endpoint (typically a vtgate address) from the environment running the sync.
  2. Create (or choose) a target database/schema in Vitess where tables will be created/updated.
  3. Create a database user with permissions to create and write to tables in the target database.

Authentication​

Authenticate using standard MySQL-style credentials:

  • Host: Vitess vtgate hostname or IP
  • Port: MySQL protocol port exposed by vtgate (commonly 3306)
  • Username / Password
  • Database: default database/schema to write into

If your Vitess deployment requires TLS, configure SSL/TLS settings as supported by your MySQL-compatible connection.

Configuration​

Provide the following configuration fields when creating the destination:

FieldTypeRequiredDescription
hoststring✓Vitess vtgate host to connect to.
portnumber✓Port for the MySQL protocol endpoint.
userstring✓Username for the Vitess/MySQL connection.
passwordstring✓Password for the user.
databasestring✓Target database/schema to load data into.

Streams​

This is a destination connector. It does not define source streams. Instead, it receives records from your selected source streams and writes them into tables in Vitess.

Table naming and write behavior follow the platform’s standard destination semantics for MySQL-compatible systems (creating tables as needed and loading records into them).

Data types​

Vitess is MySQL-compatible, so column types are mapped using MySQL-compatible type mappings. Exact types may vary depending on your Vitess/MySQL version and configuration.

Limitations​

  • Vitess behavior can differ from stock MySQL depending on your topology and configuration (for example, sharding and DDL support). Ensure your Vitess cluster supports the required DDL/DML operations for your intended workloads.