Skip to content
Sprinkle Docs

MySQL

This page covers the details about integrating MySQL Database as Warehouse with Sprinkle.

When setting up MySQL as Data Warehouse, Sprinkle additionally requires a Cloud bucket. This guide covers the role of all the components and steps to set up.

Step by Step Guide

Section titled “Step by Step Guide”

Integrating MySQL

Section titled “Integrating MySQL”

STEP-1: Allow MySQL to accept connection from Sprinkle

Section titled “STEP-1: Allow MySQL to accept connection from Sprinkle”
  • If MySQL server is on public network, accessible over public IP, allow inbound connection on mysql port (default is 3306) from Sprinkle IPs (34.93.254.126, 34.93.106.136)
  • If MySQL server is on private network, configure SSH Tunnel in Advanced Settings.

STEP-2: Configure MySQL Connection

Section titled “STEP-2: Configure MySQL Connection”
  • Log into the Sprinkle application
  • Navigate to Admin -> Warehouse -> New Warehouse Connection
  • Select MySQL
  • Provide all the mandatory details
    • Distinct Name*: Name to identify this connection
    • Host: Provide the IP address or Host name.
    • Port: Provide the Port number.
    • Database: Provide a database name if there is any, it should be an existing database.
    • Username
    • Password
    • Advanced Settings: If Yes:-
      • Connection Properties: You can provide optional connection properties. ex- key1=value1&key2=value2
      • Change Tracking: If enabled, MySQL binlog is used to fetch changed/new rows. This setting cannot be changed later once selected.
      • Connect via SSH Host: Click on “Yes” to configure SSH Tunnel:-
        • SSH Host*: IP address or hostname of the SSH server
        • SSH Public Key*: Copy the SSH public key and paste it into the ~/.ssh/authorized_keys file of the SSH user on the ssh host machine
        • SSH Login Username*: Provide the SSH Login Username where you added the public key. Further, verify the provided details by testing the connection.
        • Networking rules from your end:
          • Make sure the SSH Host has public IP
          • Whitelist Sprinkle IPs (34.93.254.126, 34.93.106.136) in your SSH Host. SSH host should be able to accept traffic from these Sprinkle IPs.
          • Make sure SSH port 22 is open.
  • Test Connection.
  • Test and Save.

Create a Cloud Bucket

Section titled “Create a Cloud Bucket”

Sprinkle stores all intermediate data and report caches in the cloud bucket. Sprinkle supports creating a bucket in AWS, GCP, or Azure. Refer to respective documents for creating a configuring the Cloud Bucket.