182 lines
5.1 KiB
Plaintext
182 lines
5.1 KiB
Plaintext
Metadata-Version: 2.1
|
|
Name: PyMySQL
|
|
Version: 0.9.3
|
|
Summary: Pure Python MySQL Driver
|
|
Home-page: https://github.com/PyMySQL/PyMySQL/
|
|
Author: yutaka.matsubara
|
|
Author-email: yutaka.matsubara@gmail.com
|
|
Maintainer: INADA Naoki
|
|
Maintainer-email: songofacandy@gmail.com
|
|
License: "MIT"
|
|
Project-URL: Documentation, https://pymysql.readthedocs.io/
|
|
Keywords: MySQL
|
|
Platform: UNKNOWN
|
|
Classifier: Development Status :: 5 - Production/Stable
|
|
Classifier: Programming Language :: Python :: 2
|
|
Classifier: Programming Language :: Python :: 2.7
|
|
Classifier: Programming Language :: Python :: 3
|
|
Classifier: Programming Language :: Python :: 3.4
|
|
Classifier: Programming Language :: Python :: 3.5
|
|
Classifier: Programming Language :: Python :: 3.6
|
|
Classifier: Programming Language :: Python :: 3.7
|
|
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: MIT License
|
|
Classifier: Topic :: Database
|
|
Provides-Extra: rsa
|
|
Requires-Dist: cryptography ; extra == 'rsa'
|
|
|
|
.. image:: https://readthedocs.org/projects/pymysql/badge/?version=latest
|
|
:target: https://pymysql.readthedocs.io/
|
|
:alt: Documentation Status
|
|
|
|
.. image:: https://badge.fury.io/py/PyMySQL.svg
|
|
:target: https://badge.fury.io/py/PyMySQL
|
|
|
|
.. image:: https://travis-ci.org/PyMySQL/PyMySQL.svg?branch=master
|
|
:target: https://travis-ci.org/PyMySQL/PyMySQL
|
|
|
|
.. image:: https://coveralls.io/repos/PyMySQL/PyMySQL/badge.svg?branch=master&service=github
|
|
:target: https://coveralls.io/github/PyMySQL/PyMySQL?branch=master
|
|
|
|
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
|
|
:target: https://github.com/PyMySQL/PyMySQL/blob/master/LICENSE
|
|
|
|
|
|
PyMySQL
|
|
=======
|
|
|
|
.. contents:: Table of Contents
|
|
:local:
|
|
|
|
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.
|
|
|
|
.. _`PEP 249`: https://www.python.org/dev/peps/pep-0249/
|
|
|
|
|
|
Requirements
|
|
-------------
|
|
|
|
* Python -- one of the following:
|
|
|
|
- CPython_ : 2.7 and >= 3.4
|
|
- PyPy_ : Latest version
|
|
|
|
* MySQL Server -- one of the following:
|
|
|
|
- MySQL_ >= 5.5
|
|
- MariaDB_ >= 5.5
|
|
|
|
.. _CPython: https://www.python.org/
|
|
.. _PyPy: https://pypy.org/
|
|
.. _MySQL: https://www.mysql.com/
|
|
.. _MariaDB: https://mariadb.org/
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
Package is uploaded on `PyPI <https://pypi.org/project/PyMySQL>`_.
|
|
|
|
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
|
|
<https://stackoverflow.com/questions/tagged/pymysql>`_.
|
|
|
|
Example
|
|
-------
|
|
|
|
The following examples make use of a simple table
|
|
|
|
.. code:: sql
|
|
|
|
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 ;
|
|
|
|
|
|
.. code:: python
|
|
|
|
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:
|
|
|
|
.. code:: python
|
|
|
|
{'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.
|
|
|
|
|