Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

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:
  • 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:

1. Click +Create new to open the Create Connection page.
2. 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.
3. 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 63 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 (Preview):
      • 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.

   Note: You can customize the connection node values only if you are a Pay-as-you-go customer.
   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 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.
   10. Optional: To add a label to the connection, click +Add Label.
   11. Click Next.
   12. 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.
         1. In the Host address field, specify the hostname or IP address of the destination.
            1. If you want to establish a private connection to your backend systems, follow these steps:
               1. Create a PSC service attachment.
               2. Create an endpoint attachment and then enter the details of the endpoint attachment in the Host address field.
            2. 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.
   13. 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.
4. In the Review section, review your connection and authentication details.
5. 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.

Note: You can view the entities, operations, and actions of a connector in the Connectors task.

• 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. For example, the Pub/Sub connector doesn't have any entity, but only has the publishMessage action.

• 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, it is possible that a connector doesn't support any entity operations, in which case the Operations list will be empty.

• 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. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

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 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.