Release Status Released Supported By Stitch
Availability Free Supported Versions n/a
SSL Connections Unsupported VPN Connections Unsupported
Whitelisting Tables and columns View Replication Unsupported
Destination Incompatibilities None

Connecting MariaDB

MariaDB Setup Requirements

To set up MariaDB in Stitch, you need:

  • Permissions in MariaDB that allow you to create/manage users. This is required to create the Stitch database user.

Step 1: Whitelist Stitch's IP Addresses

For the connection to be successful, you’ll need to configure your firewall to allow access from our IP addresses. Whitelist the following IPs before continuing onto the next step:





Step 2: Retrieve Your Public Key

The Stitch Public Key

The Public Key is used to authorize the Stitch Linux user. If the key isn’t properly installed, Stitch will be unable to access your database.

To retrieve the key:

  1. Sign into your Stitch account.

  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the MariaDB icon.

  4. Click the SSH Tunnel checkbox.

  5. The Public Key will display, along with the other SSH fields.

Leave this page open for now - you’ll need it to wrap things up at the end.

Step 3: Create a Stitch Linux User

Note: Anything inside square brackets - [like this] - is something you need to define when running the commands yourself.

  1. To create the new user, run the following commands as root on your Linux server:

    adduser --disabled-password [stitch_username]
    mkdir /home/[stitch_username]/.ssh
  2. Next, import the Public Key into authorized_keys. This will ensure the Stitch user has access to the database.

    Copy the entire key into the authorized_keys file by:

    "[PASTE KEY HERE]" >> /home/[stitch_username]/.ssh/authorized_keys
  3. Alter the permissions on the /home/[stitch_username] directory to allow access via SSH:

    chown -R [stitch_username]:[stitch_username] /home/[stitch_username]
    chmod -R 700 /home/[stitch_username]/.ssh

Step 4: Create a Stitch Database User

To create a database user for Stitch, run the following command when logged into MariaDB:

GRANT SELECT ON *.* TO '[stitch_username]'@'localhost' IDENTIFIED BY '[secure password here]';

Replace [secure password here] with a secure password, which can be different than the SSH password.

If you wish to restrict this user from accessing data in specific databases, tables, or columns, you can instead run GRANT queries that only allow access to the data you permit.

Step 5: Connect Stitch

  1. Sign into your Stitch account, if you haven’t already.
  2. On the Stitch Dashboard page, click the Add Integration button.

  3. Click the MariaDB icon.

  4. Fill in the fields as follows:

    • Integration Name: Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your data warehouse.

      For example, the name “Stitch MariaDB” would create a schema called stitch_mariadb in the data warehouse. Note: The schema name cannot be changed after the integration is saved.

    • Host (Endpoint): Enter the host address (endpoint) used by the MariaDB instance.

      In general, this will be (localhost), but could also be some other network address (ex: or your server’s public IP address. Note: This must be the actual address - entering localhost into this field will cause connection issues.

    • Port: Enter the port used by the MariaDB instance. The default is 3306.

    • Username: Enter the Stitch MariaDB database user’s username.

    • Password: Enter the password for the Stitch database user.

    • Database: Optional: Enter the name of the default database Stitch will connect to. Stitch will ‘find’ all databases you give the Stitch user access to - a default database is only used to test and complete the connection.

Enter SSH Connection Details

If you’re using an SSH tunnel to connect your MariaDB database to Stitch, you’ll also need to complete the following:

  1. Click the SSH Tunnel checkbox.

  2. Fill in the fields as follows:

    • SSH Host: Enter the IP address or hostname of the server Stitch will SSH into.

    • SSH Port: Enter the SSH port on your server. (22 by default)

    • SSH User: Enter the Stitch Linux (SSH) user’s username.

Step 6: Define the Replication Frequency

The Replication Frequency controls how often Stitch will attempt to extract data from your MariaDB integration.

Note: This setting only affects the frequency of data extraction from MariaDB, not the interval at which data is loaded into your data warehouse. For example: a one (1) minute Replication Frequency means Stitch will attempt to extract data every minute, but loading the extracted data may take longer than this.

Use the Default Frequency

To use the default Replication Frequency (30 minutes), leave the Use integration default box checked and click Check and Save to create the integration.

Customize the Frequency

To adjust the Replication Frequency:

  1. Uncheck the Use integration default checkbox. A slider with various frequencies will display.
  2. Click the desired frequency on the slider.
  3. Click Check and Save to create the integration.

To help prevent overages, consider setting the integration to replicate less frequently. See the Understanding & Reducing Your Row Usage guide for tips on reducing your usage.

Step 7: Select Data to Replicate

The last step is to select the tables and columns you want to replicate. When you track a table, you’ll also need to define its Replication Method and, if using Incremental Replication, its Replication Key.

You can track tables and columns by:

  1. In the Integration Details page, click the Tables to Replicate tab.
  2. Locate a table you want to replicate.
  3. Click the checkbox next to the object’s name. A green checkmark means the object is set to replicate.
  4. If there are child objects, they’ll automatically display and you’ll be prompted to select some.
  5. After you set a table to replicate, the Table Settings page will display. Note: When you track a table, by default all columns will also be tracked.
  6. In the Table Settings page, define the table’s Replication Method and, if using Incremental Replication, its Replication Key.

  7. Repeat this process for every table you want to replicate.

  8. Click the Finalize Your Selections button to save your data selections.

MariaDB’s Intial Replication Job

After you finish setting up MariaDB, you might see its Sync Status show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Extracting Data from MariaDB

When you connect a database as an input, Stitch only needs read-only access to the databases, tables, and columns you want to replicate. There are two processes Stitch runs during the Extraction phase of the replication process: a structure sync and a data sync.

Structure Sync

The first part of the replication process is called a structure sync. This process will detect any changes to the structure of your database. For example: a new column is added to one of the tables you’re syncing in Stitch.

Stitch runs the following queries on MariaDB databases to perform a structure sync:

  • SHOW KEYS FROM [table]

Data Sync

The second step in the Extraction phase is called a data sync. This is where Stitch “extracts” data and replicates it. The method Stitch uses is the same for all databases, but differs depending on the Replication Method that each table uses.

Full Table Replication

For tables using Full Table Replication, Stitch will run a single query and read out of the resulting cursor in batches:

SELECT column_a, column_b <,...>
FROM table_a

Incremental Replication

For tables using Incremental Replication, Stitch will run a single query and read out of the associated cursor in batches:

SELECT column_a, column_b <,...>
FROM table_a
WHERE replication_key_column >=’last_bookmark_value’
ORDER BY replication_key_column


While we make every effort to ensure the queries that Stitch runs don’t impart significant load on your databases, we still have some recommendations for guaranteeing database performance:

  • Use a replica database instead of connecting directly. We recommend using read replicas in lieu of directly connecting production databases with high availability and performance requirements.
  • Apply indexes to Replication Key columns. We restrict and order our replication queries by this column, so applying an index to the columns you’re using as Replication Keys can improve performance.

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.