Aurora MySQL (Data API)

https://www.mysql.com/

MySQL is a popular open-source relational database.

Installation

Required packages: mysqlclient

Drivers

mysqlclientRecommended

mysql-connector-python

PyPI Package: mysqlclient

mysql://{username}:{password}@{host}/{database}

Recommended driver. May fail with caching_sha2_password auth.

Supported Features

JOINsSubqueriesDynamic SchemaCatalog SupportDynamic CatalogSSH TunnelingQuery CancellationFile UploadUser ImpersonationCost EstimationSQL Validation

Feature Score: 59/201

Time Grains

Common Time Grains:

SECONDMINUTEHOURDAYWEEKMONTHQUARTERYEAR

Extended Time Grains:

FIVE_SECONDSTHIRTY_SECONDSFIVE_MINUTESTEN_MINUTESFIFTEEN_MINUTESTHIRTY_MINUTESHALF_HOURSIX_HOURSWEEK_STARTING_SUNDAYWEEK_STARTING_MONDAYWEEK_ENDING_SATURDAYWEEK_ENDING_SUNDAYQUARTER_YEAR

Compatible Databases

The following databases are compatible with the Aurora MySQL (Data API) driver:

MariaDB

MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.

mysql://{username}:{password}@{host}:{port}/{database}

Amazon Aurora MySQL

Amazon Aurora MySQL is a fully managed, MySQL-compatible relational database with up to 5x the throughput of standard MySQL.

mysql+auroradataapi://{aws_access_id}:{aws_secret_access_key}@/{database_name}?aurora_cluster_arn={aurora_cluster_arn}&secret_arn={secret_arn}&region_name={region_name}

Parameters:

Parameter	Description
aws_access_id	AWS Access Key ID
aws_secret_access_key	AWS Secret Access Key
database_name	Database name
aurora_cluster_arn	Aurora cluster ARN
secret_arn	Secrets Manager ARN for credentials
region_name	AWS region (e.g., us-east-1)

Uses the Data API for serverless access. Standard MySQL connections also work with mysqlclient.

Help improve this documentation by editing the engine spec:

Edit superset.db_engine_specs.aurora.py