PyMySQL

https://travis-ci.org/PyMySQL/PyMySQL.svg?branch=master

https://img.shields.io/badge/license-MIT-blue.svg

PyMySQL

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

Most public APIs are compatible with mysqlclient and MySQLdb.

NOTE: PyMySQL doesn’t support low level APIs _mysql provides like data_seek, store_result, and use_result. You should use high level APIs defined in PEP 249. But some APIs like autocommit and ping are supported because PEP 249 doesn’t cover their usecase.

Requirements

Python – one of the following:
- CPython : 2.7 and >= 3.5
- PyPy : Latest version
MySQL Server – one of the following:
- MySQL >= 5.5
- MariaDB >= 5.5

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=utf8 COLLATE=utf8_bin
AUTO_INCREMENT=1 ;

import pymysql.cursors

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

try:
    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)
finally:
    connection.close()

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.

Release files for PyMySQL 0.10.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 0.10.1
File	Size	Uploaded
PyMySQL-0.10.1.tar.gz	77.4 kB	Sep 10, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for PyMySQL 0.10.1
File	Interpreter	ABI	Platform	Reset
PyMySQL-0.10.1-py2.py3-none-any.whl 47.9 kB Sep 10, 2020	Python 2, Python 3	none	any	Details

Total release size: 125.2 kB

Release files / PyMySQL-0.10.1.tar.gz

Download URL	PyMySQL-0.10.1.tar.gz
Size	77.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`263040d2779a3b84930f7ac9da5132be0fefcd6f453a885756656103f8ee1fdd`
BLAKE2b-256 checksum How to use checksums	`af8b9ada3812353923974364337ac6b56be2876d04f86099bac20d992214d5af`
Upload date	Sep 10, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5`

Release files / PyMySQL-0.10.1-py2.py3-none-any.whl

Download URL	PyMySQL-0.10.1-py2.py3-none-any.whl
Size	47.9 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`44f47128dda8676e021c8d2dbb49a82be9e4ab158b9f03e897152a3a287c69ea`
BLAKE2b-256 checksum How to use checksums	`1aeadd9c81e2d85efd03cfbf808736dd055bd9ea1a78aea9968888b1055c3263`
Upload date	Sep 10, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5`