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.3

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.0rc1

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.0rc1
File	Size	Uploaded
PyMySQL-1.1.0rc1.tar.gz	47.1 kB	May 25, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for PyMySQL 1.1.0rc1
File	Interpreter	ABI	Platform	Reset
PyMySQL-1.1.0rc1-py3-none-any.whl 44.7 kB May 25, 2023	Python 3	none	any	Details

Total release size: 91.9 kB

Release files / PyMySQL-1.1.0rc1.tar.gz

Download URL	PyMySQL-1.1.0rc1.tar.gz
Size	47.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`5cc02f2f60936c5d2d6122ffaff27783bd29ba7683ea45a8ab75c5083f00dc20`
BLAKE2b-256 checksum How to use checksums	`ae1159e26d78cf43841c0e014264c0490913cd2e2a91b7bc1d4bab479d215c53`
Upload date	May 25, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`pdm/2.6.1 CPython/3.11.3`

Release files / PyMySQL-1.1.0rc1-py3-none-any.whl

Download URL	PyMySQL-1.1.0rc1-py3-none-any.whl
Size	44.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`5072fb2637f8bfff0e7a15a9c02a0f4ba98f97800e12432e1d6d95936ec6d496`
BLAKE2b-256 checksum How to use checksums	`d242519430d16861c7a42b77de1ef75098b4f521302455c900da5ed7a5e5b4b2`
Upload date	May 25, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`pdm/2.6.1 CPython/3.11.3`