MySQL
Quick Start
To set up a MySQL connector, follow these minimum required steps:
- Create a read-only MySQL user with sufficient permissions to replicate data.
- Set up a new MySQL source in the Airbyte UI using CDC logical replication.
Connecting via SSL or SSH Tunnel
SSL Connection Modes
The available SSL connection modes are as follows:
- required: Always mandates encryption. The connection will fail if the source doesn’t support encryption.
- preferred: Allows unencrypted communication only if the source does not support encryption.
- verify_ca: Requires encryption and verifies that the source has a valid SSL certificate.
- verify_identity: Requires encryption and ensures that the source’s identity is verified.
- disabled: Disables encryption for communication between xGen and the source.
- allow: Enables encrypted communication only when required by the source.
Connection via SSH Tunnel
You can connect to a MySQL server using an SSH tunnel. In this setup, xGen connects to an intermediate server (also known as a bastion or jump server) that has direct access to the MySQL database. After establishing a connection to the bastion, xGen requests it to connect directly to the MySQL server.
To connect via an SSH tunnel:
- In the MySQL source setup, under the SSH tunnel dropdown, select the preferred authentication method:
- SSH Key Authentication: Use a private key for the SSH tunnel authentication.
- Password Authentication: Use a password for the SSH tunnel authentication.
- Enter the hostname or IP address of the bastion server in the SSH Tunnel Jump Server Host field.
- Specify the SSH connection port. The default port is 22.
- Enter the SSH login username for the bastion server. This is the operating system username, not the MySQL username.
- For authentication:
- If SSH Key Authentication is selected, provide the private key used to establish the SSH connection.
- If Password Authentication is selected, provide the password for the operating system user to authenticate with the bastion server. This is the operating system password, not the MySQL password.