PyMySQL

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

Requirements

Python -- one of the following:
- CPython : 3.7 and newer
- PyPy : Latest 3.x version
MySQL Server -- one of the following:
- MySQL >= 5.7
- MariaDB >= 10.4

Installation

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]

Documentation

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

For support, please refer to the StackOverflow.

Example

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}

Resources

DB-API 2.0: https://www.python.org/dev/peps/pep-0249/
MySQL Reference Manuals: https://dev.mysql.com/doc/
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

License

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

Metadata

Release files for PyMySQL 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for PyMySQL 1.1.1
File	Size	Uploaded
pymysql-1.1.1.tar.gz	47.7 kB	May 21, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for PyMySQL 1.1.1
File	Interpreter	ABI	Platform	Reset
PyMySQL-1.1.1-py3-none-any.whl 45.0 kB May 21, 2024	Python 3	none	any	Details

Total release size: 92.7 kB

Release files / pymysql-1.1.1.tar.gz

Download URL	pymysql-1.1.1.tar.gz
Size	47.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`e127611aaf2b417403c60bf4dc570124aeb4a57f5f37b8e95ae399a42f904cd0`
BLAKE2b-256 checksum How to use checksums	`b38fce59b5e5ed4ce8512f879ff1fa5ab699d211ae2495f1adaa5fbba2a1eada`
Upload date	May 21, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.2`

Release files / PyMySQL-1.1.1-py3-none-any.whl

Download URL	PyMySQL-1.1.1-py3-none-any.whl
Size	45.0 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`4de15da4c61dc132f4fb9ab763063e693d521a80fd0e87943b9a453dd4c19d6c`
BLAKE2b-256 checksum How to use checksums	`0c94e4181a1f6286f545507528c78016e00065ea913276888db2262507693ce5`
Upload date	May 21, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.12.2`