MySQL

The MySQL connector lets you insert, read, update and delete rows in a MySQL database.

Supported versions

MySQL versions 5.0 to 8.0

Before you begin

Before using the MySQL connector, do the following tasks:

In your Google Cloud project:
- Ensure that network connectivity is set up. For information about network patterns, see Network connectivity.
- Grant the roles/connectors.admin IAM role to the user configuring the connector.
- Grant the following IAM roles to the service account that you want to use for the connector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.
- Enable the following services:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

Click +Create new to open the Create Connection page.
In the Location section, choose the location for the connection.
1. From the Region list, select the region where you want to create the connection.
  For the list of all the supported regions, see Locations.
2. Click Next.
In the Connection Details section, enter the following details:
1. From the Connector list, select MySQL (Preview).
2. From the Connector version list, select the connector version.
3. In the Connection Name field, enter a name for the connection instance.
  Connection names must meet the following criteria:
  - Use letters, numbers, or hyphens.
  - Letters must be lower-case.
  - Names must begin with a letter and end with a letter or number.
  - Names cannot exceed 49 characters.
4. Optional: In the Description field, add a description of the connection instance.
5. Optional: Enable Cloud Logging.
6. From the Service Account list, select a service account that has the required roles.
7. In the Database name field, enter the name of the MySQL database.
8. Optionally, configure the Connection node settings:
  - Minimum number of nodes: Enter the minimum number of connection nodes.
  - Maximum number of nodes: Enter the maximum number of connection nodes.
  A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
9. Use proxy: Select this checkbox to configure a proxy server for the connection and configure the following values:
- Proxy Auth Scheme: Select the authentication type to authenticate with the proxy server. The following authentication types are supported:
  - Basic: Basic HTTP authentication.
  - Digest: Digest HTTP authentication.
- Proxy User: A user name to be used to authenticate with the proxy server.
- Proxy Password: The Secret manager secret of the user's password.
- Proxy SSL Type: The SSL type to use when connecting to the proxy server. The following authentication types are supported:
  - Auto: Default setting. If the URL is an HTTPS URL, then the Tunnel option is used. If the URL is an HTTP URL, then the NEVER option is used.
  - Always: The connection is always SSL enabled.
  - Never: The connection is not SSL enabled.
  - Tunnel: The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.
- In the Proxy Server section, enter details of the proxy server.
  1. Click + Add destination.
  2. Select a Destination Type.
    - Host address: Specify the hostname or IP address of the destination.
      If you want to establish a private connection to your backend system, do the following:
      - Create a PSC service attachment.
      - Create an endpoint attachment and then enter the details of the endpoint attachment in the Host address field.
Optional: To add a label to the connection, click +Add Label.
Click Next.
In the Destinations section, enter details of the remote host (backend system) to which you want to connect.
- From the Destination Type list, select a host address.
  - Select Host address from the list to specify the hostname or IP address of the destination.
  - If you want to establish a private connection to your backend systems, select Endpoint attachment from the list, and then select the required endpoint attachment from the Endpoint Attachment list.
    Note: To understand how to create an endpoint attachment, see PSC service attachment and endpoint attachment. After you have created the endpoint attachment, it will be visible in the Endpoint Attachment list.
  If you want to establish a public connection to your backend systems with additional security, you can consider configuring static outbound IP addresses for your connections, and then configure your firewall rules to allowlist only the specific static IP addresses.
  
  To enter additional destinations, click +Add Destination.
- Click Next.
In the Authentication section, you can provide credentials:
- In the Username field, enter the MySQL username for the connection.
- In the Password field, enter the Secret Manager secret containing the password associated with the MySQL username.
  - If you have previously created a secret, and it is not available in the list, select Enter Secret Manually. In the Add a secret by resource ID dialog, copy and paste the resource ID from the Secret Manager.
    - To use the latest version, copy and paste the resource ID from the parent secret, in the format: "projects/project-number/secrets/secret-name"
    - To select a specific version, copy and paste the resource ID for that specific version, in the format "projects/project-number/secrets/secret-name/versions/1"
    To add the secret, click Add Secret.
  - If you have not created a secret for use with MySQL, click Create New Secret. In the Create Secret dialog enter the following details:
    - In the Name field, enter the secret name.
    - In the Secret value field, enter the contents of the secret or upload a file that contains the secret.
    - Click Create Secret.
- From the Secret version list, select the version of the Password secret from the list of available versions in the drop-down.
- Click Next.

In the Review section, review your connection and authentication details.

Click Create.

Configure authentication

Enter the details based on the authentication you want to use.

Username and password
- Username: The Mysql username to use for the connection.
- Password: Secret Manager Secret containing the password associated with the Mysql username.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.
Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
- List
- Get
- Create
- Update
- Delete
Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.
Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The MySQL connector can process 10 transaction per second, per node, and throttles any transactions beyond this limit. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Note: The number of Integration Connectors nodes will autoscale dynamically based on your usage. However, if you want to reserve capacity for large volumes without waiting for autoscaling, you can adjust the minimum node value for a connection. More nodes are required to process more transactions for a connection. Conversely, fewer nodes are required if a connection processes fewer transactions. To configure the node values, do the following:

If you are a pay-as-you-go customer, configure the minimum and maximum node value in the edit connection page.
If you are a subscription based customer, contact support.

The maximum transactions that a node can handle depends on various factors. So, before adjusting the minimum nodes for better throughput, it is recommended you check if your backend systems are set up optimally to handle the required traffic.

Supported data types

The following are the supported data types for this connector:

BIGINT
BINARY
BIT
BOOLEAN
CHAR
DATE
DECIMAL
DOUBLE
FLOAT
INTEGER
LONGN VARCHAR
LONG VARCHAR
NCHAR
NUMERIC
NVARCHAR
REAL
SMALL INT
TIME
TIMESTAMP
TINY INT
VARBINARY
VARCHAR

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
database_name	STRING	True	The name of the Mysql database to connect to.
proxy_enabled	BOOLEAN	False	Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme	ENUM	False	The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user	STRING	False	A user name to be used to authenticate to the ProxyServer proxy.
proxy_password	SECRET	False	A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype	ENUM	False	The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Actions

This connector supports execution of the following actions:

User-defined stored procedures and functions. If you have any stored procedures and functions in your backend, those are listed in the Actions column of the Configure connector task dialog.
Custom SQL queries. To execute custom SQL queries, the connector provides the Execute custom query action.
To create a custom query, follow these steps:
1. Follow the detailed instructions to add a connectors task.
2. When you configure the connector task, in the type of action you want to perform, select Actions.
3. In the Action list, select Execute custom query, and then click Done.
4. Expand the Task input section, and then do the following:
  1. In the Timeout after field, enter the number of seconds to wait till the query executes.
    Default value: 180 seconds.
  2. In the Maximum number of rows field, enter the maximum number of rows to be returned from the database.
    Default value: 25.
  3. To update the custom query, click Edit Custom Script. The Script editor dialog opens.
  4. In the Script editor dialog, enter the SQL query and click Save.
    You can use a question mark (?) in a SQL statement to represent a single parameter that must be specified in the query parameters list. For example, the following SQL query selects all rows from the Employees table that matches the values specified for the LastName column:
```
SELECT * FROM Employees where LastName=?
```
    Note: Data manipulation language (DML) and data definition language (DDL) statements are supported.
  5. If you've used question marks in your SQL query, you must add the parameter by clicking + Add Parameter Name for each question mark. While executing the integration, these parameters replace the question marks (?) in the SQL query sequentially. For example, if you have added three question marks (?), then you must add three parameters in order of sequence.
    
    To add query parameters, do the following:
    1. From the Type list, select the data type of the parameter.
    2. In the Value field, enter the value of the parameter.
    3. To add multiple parameters, click + Add Query Parameter.

Action examples

Example - Find the greater value

This example shows how to execute a user-defined function. The find_greater function in this example, compares two integers and returns the integer which is greater.

In the Configure connector task dialog, click Actions.
Select the find_greater action, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"$1": 1.0,
"$2": 5.0
}
```

If the action execution is successful, the connector task's connectorOutputPayload field will have a value similar to the following:

[{
"bignum": 5.0
}]

Entity operation examples

Example - List records of an entity

This example lists the records of the Users entity.

In the Configure connector task dialog, click Entities.
Select Users from the Entity list.
Select the List operation, and then click Done.
In the Task Input section of the Connectors task, you can set the filterClause as per your requirement.
For example, setting the filter clause to employeeCode='5100' and startDate='2010-01-01 00:00:00', lists only those records whose employeeCode is 5100 and startDate is 2010-01-01 00:00:00.

Example - Get a single record from an entity

This example fetches a record from the Users entity.

In the Configure connector task dialog, click Entities.
Select User from the Entity list.
Select the Get operation, and then click Done.
In the Task Input section of the Connectors task, click entityId and then enter 103032 in the Default Value field.
Here, 103032 is the primary key value of the Users entity.

Example - Delete a record from an entity

This example deletes a record from the Users entity.

In the Configure connector task dialog, click Entities.
Select Users from the Entity list.
Select the Delete operation, and then click Done.
In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.
Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Example - Create a record in an entity

This example creates a record in the Users entity.

In the Configure connector task dialog, click Entities.
Select Users from the Entity list.
Select the Create operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"employeeCode": "5100",
"startDate": "2010-01-01 00:00:00.0",
"country": "US"
}
```

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the create operation.

Example - Update a record in an entity

This example updates a record in the Users entity.

In the Configure connector task dialog, click Entities.
Select Users from the Entity list.
Select the Update operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"country": "IN"
}
```
In the Task Input section of the Connectors task, click entityId and then enter 113132 in the Default Value field.
Alternately, if the entity has composite primary keys instead of specifying the entityId, you can set the filterClause. For example, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

If the integration is successful, the connector task's connectorOutputPayload field will have the response of the update operation.

Use the MySQL connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Also, see the Perform CRUD operations on a MySQL database tutorial that shows how to create a MySQL connection, and use the connection in an integration to perform read and write operations.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

Understand how to suspend and resume a connection.
Understand how to monitor connector usage.
Understand how to view connector logs.