Free cookie consent management tool by TermsFeed

Migrate Aurora MySQL Driver

This page applies to Appian Cloud only. It may not reflect the differences with Appian Government Cloud.

Overview

Caution:  Appian Cloud customers using Aurora MySQL databases have until May 25, 2023 to migrate their data sources to use the new AWS JDBC Driver for MySQL. After that period, sites may experience connectivity issues.

Self-managed customers using Aurora MySQL data sources and Appian Cloud customers using a MySQL data source will not be impacted by this change.

In the latest version of Appian, you should begin using the AWS JDBC Driver for MySQL for your sites that connect to an Aurora MySQL database.

Previously, Appian Cloud used the MariaDB Connector/J (release 2.7) to connect to Aurora MySQL data sources; however, a recent patch to the Connector/J introduced a backwards compatibility issue that impacts how Appian sites connect to Aurora MySQL instances.

To continue connecting to an Aurora MySQL database from Appian, you must update or change your data sources that connect to an Aurora MySQL database instance:

This page details the steps needed to update your data sources to use the AWS JDBC Driver for MySQL. If you are unable to make these updates to your site(s) before May 25, 2023, please open a support case with Appian.

Update a Tomcat resource that connects to an Aurora MySQL database

If your site connects to an Aurora MySQL data source via a Tomcat resource that uses a MariaDB driver, you must:

Update connection URL

In your Tomcat resource, the connection URL must begin with jdbc:mysql:aws:// and include the following parameter nullCatalogMeansCurrent=true.

For example:

1

url="jdbc:mysql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:3306/your_db_name?useOldAliasMetadataBehavior=true&disableMariaDbDriver=true&nullCatalogMeansCurrent=true"

Update driver class

Additionally, the driver class in your Tomcat resource should be set to:

1

driverClassName="software.aws.rds.jdbc.mysql.Driver"

Update an existing Aurora MySQL Data Source Connected System object

If your site connects to an Aurora MySQL data source using an Aurora MySQL data source connected system, you must update the Connection URL in your connected system. It must begin with jdbc:mysql:aws://.

For example:

1

url="jdbc:mysql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:3306/your_db_name?useOldAliasMetadataBehavior=true&disableMariaDbDriver=true&nullCatalogMeansCurrent=true"

Create a new Aurora MySQL data source to replace an existing MariaDB data source that connects to an Aurora MySQL database.

You must create a new Aurora MySQL data source to connect to an Aurora MySQL instance using the AWS JDBC Driver for MySQL. All existing MariaDB Admin Console data sources and MariaDB Data Source Connected System objects will continue to rely on the MariaDB Connector/J, which is no longer supported.

To create a new Aurora MySQL Admin Console data source, you must:

To create a new Aurora MySQL Data Source Connected System, you must:

Create a new Aurora MySQL Admin Console data source

To create a new Admin Console data source:

  1. In your application, click and choose Admin Console.
  2. Under INTEGRATIONS, click Data Sources.
  3. Click New Data Source and select Aurora MySQL as the type.
  4. Provide a value for the username and password fields
  5. Configure your new Aurora MySQL data source with a Connection String beginning with jdbc:mysql:aws://.

For example:

1

url="jdbc:mysql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:3306/your_db_name?useOldAliasMetadataBehavior=true&disableMariaDbDriver=true&nullCatalogMeansCurrent=true"

Create a new Aurora MySQL Data Source Connected System

To create a new Data Source Connected System:

  1. In your application, go to the Build view.
  2. Click NEW > Connected System.
  3. Select Aurora MySQL Data Source.
  4. Provide a value for the username and password fields
  5. Configure your new Aurora MySQL data source with a Connection String beginning with jdbc:mysql:aws://.

For example:

1

url="jdbc:mysql:aws://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:3306/your_db_name?useOldAliasMetadataBehavior=true&disableMariaDbDriver=true&nullCatalogMeansCurrent=true"

Update objects that reference the existing MariaDB data source

After you create your new data source, any objects referencing the previously-used MariaDB Data Source (like the Query Database Smart Service) will need to be reconfigured to reflect the new Aurora MySQL data source.

To easily find and replace existing references to your MariaDB Data Source Connected System, use impact analysis to identify any existing precedent/dependent object relationships.

Feedback