PyMySQL

Table of Contents

• Requirements
• Installation
• Documentation
• Example
• Resources
• License

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]

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

CREATETABLE `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 ;

importpymysql.cursors# Connect to the databaseconnection=pymysql.connect(host='localhost',
user='user',
password='passwd',
db='db',
charset='utf8mb4',
cursorclass=pymysql.cursors.DictCursor)
try:
withconnection.cursor() ascursor:
# Create a new recordsql="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()
withconnection.cursor() ascursor:
# Read a single recordsql="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.