Dynamic connections

WHAT IS THE DYNAMIC CONNECTION FEATURE?

Dynamic connection is a new feature which allows you to replace database connections in source and destination components at package runtime. This is a convenient and scalable approach to running jobs across multiple database connections while using a single package!

To use this feature, reach out to Integrate.io Support and request it to be enabled on your account!

Overview

  1. Set variable for connection
  2. Find connection IDs
  3. Update variable value

Set variable for connection

1. Open any existing package or create a new one.

2. Add a database source or destination component         

3. Open the component and specify any available connection

undefined

4. Check the checkbox for “Set variable for connection”
    • It is not possible to change the variable name.
    • The value of the variable defaults to the connection ID from the connection dropdown.

undefined

5. Configure “Source properties” and “Schema” sections, then “Save” the component.

6. Configure the rest of the package as needed, then "Save" the package.

Find connection IDs

You are ready to override the dynamic connection variable with a valid database connection ID, but first you need to find suitable connection IDs on the Connections page.

Make sure that you only use IDs of database connections, and that the type of database is the same as the type defined in the source / destination component. I.e. for a MySQL database, only specify the ID of another MySQL database connection.

undefined

Update connection variable value

Replace the dynamic connection variable value with the ID(s) you identified from the connections page.

  • 1. When running a job, “Run job” in the package designer

undefined

undefined

  • 2. “Run job” on the Packages page

Screenshot 2022-04-18 at 18.57.54.pngScreenshot 2022-04-18 at 18.56.55.png

  • 3. “Run job” on the Jobs page

Screenshot 2022-04-18 at 18.55.01.pngScreenshot 2022-04-18 at 18.52.01.pngScreenshot 2022-04-18 at 18.52.09.png

  • 4. When creating a schedule, “Add package” in the “New schedule” window

Screenshot 2022-04-18 at 18.59.45.pngScreenshot 2022-04-18 at 19.00.02.pngScreenshot 2022-04-18 at 19.00.10.pngScreenshot 2022-04-18 at 19.00.23.pngScreenshot 2022-04-18 at 19.00.39.png

  • 5. When creating a Workflow package, “Run package” task window

Screenshot 2022-04-18 at 19.04.56.pngScreenshot 2022-04-18 at 19.05.40.pngScreenshot 2022-04-18 at 19.05.47.png

Limitations

• Dynamic connection is available only on database source and destination components
• The connection in the variable must be the same type as the original input connection
   For example, when selecting a MySQL connection from the dropdown in the source component, the dynamic connection variable specified at runtime must also be a MySQL connection
• The schema of the dynamic connection must be the same as the original input connection's (selected in the source / destination component)