This package contains a pure-Python MySQL and MariaDB client library, based on PEP 249.

• Python -- one of the following:
  • CPython : 3.9 and newer
  • PyPy : Latest 3.x version
• MySQL Server -- one of the following:
  • MySQL LTS versions
  • MariaDB LTS versions

Package is uploaded on PyPI.

You can install it with pip:

$ python3 -m pip install PyMySQL

To use "sha256_password" or "caching_sha2_password" for authenticate, you need to install additional dependency:

$ python3 -m pip install PyMySQL[rsa]

To use MariaDB's "ed25519" authentication method, you need to install additional dependency:

$ python3 -m pip install PyMySQL[ed25519]

Protocol compression can be enabled with pymysql.connect(..., compress=True). This prefers zstd when available and supported by the server, otherwise it uses zlib. Servers that support neither algorithm use an uncompressed connection. Use compress="zlib" or compress="zstd" to require a specific algorithm. On Python 3.14 and newer, zstd uses the standard library's compression.zstd. On older Python versions, install the optional extra to use the API-compatible backports.zstd implementation:

$ python3 -m pip install 'PyMySQL[zstd]'

The backport dependency is installed only on Python versions below 3.14. Outgoing compression payloads below 400 bytes, or those that do not become smaller, are sent uncompressed within the compressed protocol.

Documentation is available online: https://pymysql.readthedocs.io/

For support, please refer to the StackOverflow.

The following examples make use of a simple table

CREATE TABLE `users` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `email` varchar(255) COLLATE utf8_bin NOT NULL,
    `password` varchar(255) COLLATE utf8_bin NOT NULL,
    PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin
AUTO_INCREMENT=1 ;

import pymysql.cursors

# Connect to the database
connection = pymysql.connect(
    host="localhost",
    user="user",
    password="passwd",
    database="db",
    cursorclass=pymysql.cursors.DictCursor,
)

with connection:
    with connection.cursor() as cursor:
        # Create a new record
        sql = "INSERT INTO `users` (`email`, `password`) VALUES (%s, %s)"
        cursor.execute(sql, ("webmaster@python.org", "very-secret"))

    # connection is not autocommit by default. So you must commit to save
    # your changes.
    connection.commit()

    with connection.cursor() as cursor:
        # Read a single record
        sql = "SELECT `id`, `password` FROM `users` WHERE `email`=%s"
        cursor.execute(sql, ("webmaster@python.org",))
        result = cursor.fetchone()
        print(result)

This example will print:

{"password": "very-secret", "id": 1}

• DB-API 2.0: https://www.python.org/dev/peps/pep-0249/
• MySQL Reference Manuals: https://dev.mysql.com/doc/
• Getting Help With MariaDB https://mariadb.com/kb/en/getting-help-with-mariadb/
• MySQL client/server protocol: https://dev.mysql.com/doc/internals/en/client-server-protocol.html
• "Connector" channel in MySQL Community Slack: https://lefred.be/mysql-community-on-slack/
• PyMySQL mailing list: https://groups.google.com/forum/#!forum/pymysql-users

PyMySQL is released under the MIT License. See LICENSE for more information.