PyMySQL

This package contains a pure-Python MySQL client library. The goal of PyMySQL is to be a drop-in replacement for MySQLdb and work on CPython, PyPy and IronPython.

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 294. But some APIs like autocommit and ping are supported because PEP 294 doesn’t cover their usecase.

Requirements

Python – one of the following:
- CPython >= 2.6 or >= 3.3
- PyPy >= 4.0
- IronPython 2.7
MySQL Server – one of the following:
- MySQL >= 4.1 (tested with only 5.5~)
- MariaDB >= 5.1

Installation

The last stable release is available on PyPI and can be installed with pip:

$ pip install PyMySQL

Alternatively (e.g. if pip is not available), a tarball can be downloaded from GitHub and installed with Setuptools:

$ # X.X is the desired PyMySQL version (e.g. 0.5 or 0.6).
$ curl -L https://github.com/PyMySQL/PyMySQL/tarball/pymysql-X.X | tar xz
$ cd PyMySQL*
$ python setup.py install
$ # The folder PyMySQL* can be safely removed now.

Test Suite

If you would like to run the test suite, create database for test like this:

mysql -e 'create database test_pymysql  DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
mysql -e 'create database test_pymysql2 DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'

Then, copy the file .travis.databases.json to pymysql/tests/databases.json and edit the new file to match your MySQL configuration:

$ cp .travis.databases.json pymysql/tests/databases.json
$ $EDITOR pymysql/tests/databases.json

To run all the tests, execute the script runtests.py:

$ python runtests.py

A tox.ini file is also provided for conveniently running tests on multiple Python versions:

$ tox

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: http://www.python.org/dev/peps/pep-0249

MySQL Reference Manuals: http://dev.mysql.com/doc/

MySQL client/server protocol: http://dev.mysql.com/doc/internals/en/client-server-protocol.html

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 0.7.3

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.7.3
File	Size	Uploaded
PyMySQL-0.7.3.tar.gz	67.9 kB	May 19, 2016	Details

Built distribution (wheel)

Table of built distributions (wheels) for PyMySQL 0.7.3
File	Interpreter	ABI	Platform	Reset
PyMySQL-0.7.3-py2.py3-none-any.whl 77.0 kB May 19, 2016	Python 2, Python 3	none	any	Details

Total release size: 145.0 kB

Release files / PyMySQL-0.7.3.tar.gz

Download URL	PyMySQL-0.7.3.tar.gz
Size	67.9 kB
Tags	Source
SHA-256 checksum How to use checksums	`d5553d0ddbc7d14279f73b99886038399df8953998853764eecd8ad9ea3cab4b`
BLAKE2b-256 checksum How to use checksums	`6c0c2ec120b5607ae4a72546d660e0b836c6801fa3d0787c122db44faf6361a3`
Upload date	May 19, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No

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

Download URL	PyMySQL-0.7.3-py2.py3-none-any.whl
Size	77.0 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`25b58f365e0c84ef2f0be2b56692775869c8873fa7cc83c9761cced542b7489d`
BLAKE2b-256 checksum How to use checksums	`ad64dcec8965f6f26b0e69cc05c17ca638ed8b8bfba83b1e1496b42f531555bd`
Upload date	May 19, 2016
Uploaded using Trusted Publishing? What is trusted publishing?	No