No Result

MySQL is a popular open source relational DBMS.

RudderStack supports MySQL as a source from which you can ingest data and route it to your desired downstream destinations.

Granting permissions

RudderStack requires you to grant certain user permissions on your MySQL database to successfully access data from it.

Run the SQL queries listed in the following sections in the exact order to grant these permissions:

Step 1: Creating the user

  • Create a new user RUDDER with a password <strong_unique_password> in MySQL, as shown:
CREATE USER RUDDER IDENTIFIED BY '<strong_unique_password>';
Set a strong, unique password for creating the user in MySQL.

Step 2: Creating the RudderStack schema and granting permissions

  1. Create a dedicated schema _rudderstack.
CREATE SCHEMA _rudderstack;
The _rudderstack schema is used by RudderStack for storing the state of each data sync. This name should not be changed.
  1. Grant full access to the schema _rudderstack for the user RUDDER.
GRANT ALL PRIVILEGES ON _rudderstack.* TO RUDDER;

Setting up the MySQL source in RudderStack

To set up MySQL as a source in RudderStack, follow these steps:

Naming the source

  1. Log into your RudderStack dashboard.
  2. From the left navigation bar, go to Source > New Source > Reverse ETL. Then, select MySQL.
  3. Assign a name to your source and click Continue.

Configuring the connection credentials

  1. Enter the relevant connection details in the Connection Credentials, as shown:
mysql connection settings
  • Host: Enter the host name of your MySQL service.
  • Port: Enter the port number of your MySQL service.
  • Database: Enter the database name in your MySQL instance where the data is loaded.
  • User: Specify the username which has the required read/write access to the above database.
  • Password: Enter the password for the above user.
If you've configured a MySQL source before, you can select the existing credentials under the Use existing credentials option.
  1. Click Continue. RudderStack will then verify and validate your credentials.
For more information on these validation steps, refer to the FAQ section.
  1. Once verified, click Continue to proceed.

Schedule settings

  1. Specify the Schedule Settings to schedule the data syncs from your MySQL instance.

RudderStack lets you schedule data syncs for your Reverse ETL sources and specify how and when the syncs will run. For more information on the Basic, CRON, and Manual schedule types, refer to the Sync Schedule Settings guide.

  1. After specifying the schedule type and run settings, click Continue to finish the setup.

MySQL is now successfully configured as a source in your RudderStack dashboard. You can further connect this source to your preferred destination by clicking on Add Destination button, as shown:

Add destination in RudderStack
  • If you have already configured a destination in RudderStack, select the Use Existing Destinations option which will take you to the Schema tab in the source settings.
  • To add a new destination from scratch, select the Create New Destination option which will take you to the destination configuration page.

Specifying the data to import

While connecting your MySQL source to a destination, you can configure the data to be imported using any one of the following methods:

FAQ

What do the three validations under Verifying Credentials imply?

When setting up a Reverse ETL source, once you proceed after entering the connection credentials, you will see the following three validations under the Verifying Credentials option:

Validations

These options are explained below:

  • Verifying Connection: This option indicates that RudderStack is trying to connect to the warehouse with the information specified in the connection credentials.

If this option gives an error, it means that one or more fields specified in the connection credentials are incorrect. Verify your credentials in this case.

  • Able to List Schema: This option checks if RudderStack is able to fetch all the schema details using the provided credentials.
  • Able to Access RudderStack Schema: This option implies that RudderStack is able to access the _rudderstack schema you have created by successfully running all the commands in the User Permissions section.
If this option gives an error, verify if you have successfully created the `_rudderstack` schema and given RudderStack the required permissions to access it. For more information, refer to the User Permissions sections.

Contact us

For more information on the topics covered on this page, email us or start a conversation in our Slack community.

On this page