How to use IBM App Connect with MySQL

MySQL is an open source relational database management system that is based on structured query language (SQL). MySQL is a fast, reliable, scalable, and easy-to-use database system with querying and connectivity capabilities that offers robust data structure and platform integration.

Availability:
  • A connector in IBM App Connect Enterprise as a ServiceApp Connect Enterprise as a Service connector
  • A local connector in a Designer instance of IBM App Connect in containers (Continuous Delivery release)Local connector in containers (Continuous Delivery release) 12.0.11.1-r1 or later
Restriction: Only MySQL Enterprise Edition account with Progress JDBC driver is supported.

Installing MySQL Enterprise Edition

Complete the following steps to install MySQL enterprise edition for the first time:
  1. Go to the MySQL Enterprise web page and download the MySQL Installer.
    Note: You need an Oracle account to download the MySQL Enterprise Edition Installer. If you do not have an Oracle account, you can create a new account from the Oracle page.
  2. Run the downloaded Installer file.
  3. Choose the products that you would like to install.
  4. Follow the Installer instructions, which include configuring the server, setting a root password, and choosing additional settings if required.

    Once the installation is complete, you can start using MySQL by starting MySQL Workbench or accessing it via the command line.

    Note: If the MySQL Workbench was not part of your installation, you can download it manually from MySQL Community Downloads.
    Tip: For adding a new user to your database, see CREATE USER Statement on the MySQL documentation page.

Connecting to MySQL

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your MySQL administrator to obtain these values.

MySQL connection fields:
Connection field Description Applicability
Database hostname The fully qualified hostname or the IP address of the MySQL database server. For example, myserver.abc.com or 192.0.2.24. App Connect in containers and App Connect Enterprise as a Service
Database port The port number used by the MySQL database server to listen for incoming client connections
Database name The name of the MySQL database to which you are connected
Username The username to access your MySQL database account
Password The password to access your MySQL database account
Maximum pool size The maximum number of database connections that are allowed within a single connection pool. If unspecified, the value defaults to 0 (zero).
Additional parameters The name or value pairs of additional parameters in the format name1=value1;name2=value2
Private network connection

Select the name of a private network connection that App Connect uses to connect to your private network. This list is populated with the names of private network connections that are created from the Private network connections page in the Designer instance. You see this field only if a switch server is configured for this Designer instance. For more information, see Connecting to a private network from App Connect Designer. (In App Connect Designer 12.0.10.0-r1 or earlier instances that include this field, the display name is shown as Agent name.)

To connect to a MySQL endpoint from the App Connect Designer Catalog page for the first time, expand MySQL, then click Connect.

Tip:

Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Catalog page, select the account, open its options menu (⋮), then click Rename Account.

General considerations

Before you use App Connect Designer with MySQL, take note of the following considerations:

  • MySQL connector supports dynamic discovery and is developed by using the JDBC framework.
  • The metadata fields and their associated descriptions are dynamically loaded on runtime and displayed in a tabular format. The display, order, and case of these fields cannot be controlled, as they are presented as is from the endpoint.
  • The table names in the catalog page also have dynamic behavior, and their display order cannot be controlled at the App Connect level.
  • (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

    For some applications, the events and actions in the catalog depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

  • (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

MySQL events

These events are for changes in this application that trigger a flow to start completing the actions in the flow.

Show configurable events

Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.

MySQL actions

Your flow completes these actions on this application.

Object Action Description
Custom SQL Execute custom SQL Runs a custom SQL query. Only supports selected statements.

Other available items are listed when you have connected App Connect to MySQL.

Examples

Dashboard tile for a template that uses MySQL

Use templates to quickly create flows for MySQL

Learn how to use App Connect templates to quickly create flows that complete actions on MySQL. For example, open the Templates gallery, and then search for MySQL.

MySQL flow in detailed view

Use IBM App Connect to build flows that integrate with MySQL.

Read the blog in the IBM Community to learn how to create a new row in a Google Sheets worksheet for each new opportunity retrieved from the MySQL record. Click Read the blog to go to the blog.