Skip to main content
Version: Next
MySQL is a popular open-source relational database.
Installation
Required packages: mysqlclient
Drivers
PyPI Package: mysqlclient
mysql://{username}:{password}@{host}/{database}
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
Troubleshooting
Common error messages you may encounter when connecting to or querying MySQL, along with their causes and solutions.
Compatible Databases
The following databases are compatible with the MySQL driver:
MariaDBMariaDB
MariaDB is a community-developed fork of MySQL, fully compatible with MySQL.
mysql://{username}:{password}@{host}:{port}/{database}
Amazon Aurora MySQLAmazon 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:
ParameterDescription
aws_access_idAWS Access Key ID
aws_secret_access_keyAWS Secret Access Key
database_nameDatabase name
aurora_cluster_arnAurora cluster ARN
secret_arnSecrets Manager ARN for credentials
region_nameAWS region (e.g., us-east-1)
Help improve this documentation by editing the engine spec: