CData connectors
MySQL

MySQL

Overview

This page contains the setup guide and reference information for the MySQL source connector. We utilise the official CData Python (opens in a new tab) connector to ingest your data.

Features

FeatureSupportedNotes
Full Refresh SyncYes
Incremental SyncYes

Getting started

Requirements and prerequisites

Setup guide

Step 1: (Optional) Create a dedicated read-only user

This stage is optional but strongly suggested to allow better permission management and auditing.

  1. To create a dedicated database user, execute the following commands on your database:

_10
CREATE USER 'y42'@'%' IDENTIFIED BY 'your_password_here';

  • The appropriate permissions vary between the STANDARD and CDC replication methods. For the STANDARD replication method, only the SELECT permission is needed.

    _10
    GRANT SELECT ON <database name>.* TO 'y42'@'%';

Step 2: Set up the MySQL source

  1. Create a new source, select CData - MySQL from the Source type dropdown and enter a name for it.
  2. On the source setup page, create a new MySQL secret, enter a unique name for it.
  3. For the Host, Port, and DB Name, enter the hostname, port number, and name for your MySQL database.
  4. For User and Password, enter the username and password you created in Step 1.
  5. (Optional) If you want to connect via SSH tunnel, select "SSH Tunnel Method": SSH Key Authentication or Password Authentication.

Step 3: (Optional) Connect via SSH tunnel

In case of an SSH connection, select "SSH Tunnel Method" other than "No Tunnel" and configure SSH tunneling:

  1. For SSH Tunnel Jump Server Host, enter the hostname or IP address for the intermediate (bastion) server that Y42 will connect to.
  2. For SSH Connection Port, enter the port on the bastion server. The default port for SSH connections is 22.
  3. For SSH Login Username, enter the username to use when connecting to the bastion server. Note: This is the operating system username and not the MySQL username.
  4. For authentication:
    • If you selected SSH Key Authentication, set the SSH Private Key to the private key that you are using to create the SSH connection. To generate a private key for SSH Tunneling, execute the following command:

      _10
      ssh-keygen -t rsa -m PEM -f myuser_rsa

      The command produces the private key in PEM format and the public key remains in the standard format used by the authorized_keys file on your bastion server. Add the public key to your bastion host to the user you want to use for data sync. The private key is provided via copy-and-paste to the configuration screen.
    • If you selected Password Authentication, enter the password for the operating system user to connect to the bastion server. Note: This is the operating system password and not the MySQL password.
MongoDBPinterest