Skip to main content
Version: 3.0.0

Create a MySQL Connection

This guide shows you how to create a MySQL connection in Ascend

Prerequisites

  • An existing Ascend project (see: Create a Project)
  • An existing Ascend Workspace (see: Setting Up a Workspace)
  • Credentials for your MySQL database
    • Username: Username of the account used to connect to the MySQL server
    • Password: Password of the account used to connect to the MySQL server
  • Optional: If you are using an SSH tunnel, follow the steps in Setting up an SSH Tunnel.
  • Optional: If you would like to enable SSL, follow the steps in Setting up SSL.

Locate Your Project Folder

  1. From your Ascend Instance Homepage, click on your Workspace to open it.
  2. From here, click on the Files icon on the left navigation bar. This will open the File Tree in the left panel.
  3. In your File Tree, locate your top-level project folder and open it.
  4. Within the project folder, locate the connections folder.

Add a New Connection File

  1. Right-click on the connections folder and click New File.
  2. Provide the file with a name and a .yaml extension, such as mysql_connection.yaml. This will open the empty file in the build pane.
  3. From here, you can enter the details for your connection.

Enter Connection Details

Your new connection file will open in the build panel. Enter the following YAML configuration, replacing the placeholder values with your MySQL connection details:

/my_project/connections/mysql_connection.yaml
connection:
mysql:
host: <hostname>
port: 3306 # default value is 3306, can modify as needed
database: <database>
user: <username>
password: ${secret.<your_vault>.<password>}

To view all available connection options, see the MySQL Connection Reference.

Once you have entered your Connection details, click "Save" to save the file and click "Build Project" to apply the changes.

Now that you have created a MySQL connection, you can start ingesting data from MySQL or writing data out to MySQL.