MySQL Integration with Orkes Conductor

Available since

• v5.3.0 and later

Integrating MySQL with Orkes Conductor lets you build workflows that interact with the MySQL database using the following operations:

• Create Table
• Delete Table
• Insert Rows
• Update Rows
• Upsert Rows
• Select Rows
• Delete Rows
• Execute SQL

This guide explains how to set up and use the integration. Here's an overview:

1. Get the required credentials from MySQL.
2. Configure a new MySQL integration in Orkes Conductor.
3. Use MySQL integration in workflows.

Step 1: Get the MySQL credentials

note

You can use this integration in either of the following scenarios:

• Conductor is running locally, and MySQL server is running locally.
• Conductor is running in the cloud, and the MySQL server is exposed via a secure tunnel or hosted on a cloud database service.

To integrate MySQL with Orkes Conductor, get the following credentials from your MySQL server:

• Host
• Port
• Database name
• Username
• Password

If you are enabling SSL, also obtain the following:

• CA Certificate (ca.pem)
• Client Private Key (client-key.pem) (required together with Client Certificate)
• Client Certificate (client-cert.pem) (required together with Client Private Key)

Step 2: Add an integration for MySQL

After obtaining the credentials, add a MySQL integration to your Conductor cluster.

To create an integration:

1. Go to Integrations > Connected Apps from the left navigation menu on your Conductor cluster.
2. Select + New integration.
3. In the Database section, choose MySQL.
4. Select + Add and enter the following parameters:

Parameter	Description	Required/Optional
Integration name	A name for the integration.	Required.
Host	The MySQL server hostname or IP address.	Required.
Database	The name of the database to connect to.	Required.
User	The MySQL username.	Required.
Password	The password for the MySQL user.	Required.
Port	The MySQL server port. Default is 3306.	Required.
Connection Timeout	The time to wait before timing out a connection attempt, in milliseconds. Default is 10000.	Optional.
SSL Enabled	Whether to use an SSL-encrypted connection. Set to true or false.	Optional.
CA Certificate	The CA certificate content in PEM format. Paste the contents of the ca.pem file.	Optional.
Client Private Key	The client private key content in PEM format. Paste the contents of the client-key.pem file.	Optional.
Client Certificate	The client certificate content in PEM format. Paste the contents of the client-cert.pem file.	Optional.
Description	A description of the integration.	Required.

note

CA Certificate, Client Private Key, and Client Certificate are applicable only when SSL Enabled is set to true. Within SSL mode, these fields are optional — CA Certificate is applied if provided, and Client Certificate and Client Private Key are applied only if both are provided.

5. (Optional) Toggle the Active button off if you don't want to activate the integration instantly.
6. Select Save.

Step 3: Use MySQL integration in workflows

Once the integration is ready, this can be used directly within the workflows.

To use MySQL integration in a workflow:

1. Go to Definitions > Workflow from the left navigation menu on your Conductor cluster.
2. Select + Define workflow.
3. In your workflow, select the (+) icon and select Connected Apps.

4. In Add Task panel on the right, search for MySQL, and select the integration created in Step 2.

The following operations are available for use with this integration.

Operation	Description
Create Table	Creates a new table in the database.
Delete Table	Deletes an existing table from the database.
Insert Rows	Inserts one or more rows into a table.
Update Rows	Updates existing rows in a table.
Upsert Rows	Inserts rows or updates them if they already exist.
Select Rows	Retrieves rows from a table based on specified conditions.
Delete Rows	Deletes rows from a table based on specified conditions.
Execute SQL	Executes a raw SQL query against the database.

5. Select the required operation, configure the parameters, and select Save > Confirm.
6. Select Execute to run the workflow.

For the complete operations parameters and output reference, see MySQL Operations Reference.