Pure Python MySQL Driver
Project description
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.
Requirements
- Python – one of the following:
- CPython >= 2.6 or >= 3.3
- PyPy >= 4.0
- IronPython 2.7
- MySQL Server – one of the following:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size PyMySQL-0.7.0-py2.py3-none-any.whl (75.3 kB) | File type Wheel | Python version 3.5 | Upload date | Hashes View |
Filename, size PyMySQL-0.7.0.tar.gz (67.0 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for PyMySQL-0.7.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 889339d51c1e5f34b7161e9ba2fe88a85eba23c8c7ad53a9ef56f42076ec5bf8 |
|
MD5 | 4e3754cea8cb7e8ea213d7eab44eaab7 |
|
BLAKE2-256 | 0873b22e8df52687c30bbd53dc74e1241ca137a8625a24095a2451b569a5975b |