Skip to main content

Pure Python MySQL Driver

Project description

Documentation Status https://badge.fury.io/py/PyMySQL.svg https://travis-ci.org/PyMySQL/PyMySQL.svg?branch=master https://coveralls.io/repos/PyMySQL/PyMySQL/badge.svg?branch=master&service=github 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:

  • MySQL Server – one of the following:

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

License

PyMySQL is released under the MIT License. See LICENSE for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

PyMySQL-0.10.1.tar.gz (77.4 kB view details)

Uploaded Source

Built Distribution

PyMySQL-0.10.1-py2.py3-none-any.whl (47.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file PyMySQL-0.10.1.tar.gz.

File metadata

  • Download URL: PyMySQL-0.10.1.tar.gz
  • Upload date:
  • Size: 77.4 kB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for PyMySQL-0.10.1.tar.gz
Algorithm Hash digest
SHA256 263040d2779a3b84930f7ac9da5132be0fefcd6f453a885756656103f8ee1fdd
MD5 4a1fe973afbbdd78928650118ce8ff68
BLAKE2b-256 af8b9ada3812353923974364337ac6b56be2876d04f86099bac20d992214d5af

See more details on using hashes here.

File details

Details for the file PyMySQL-0.10.1-py2.py3-none-any.whl.

File metadata

  • Download URL: PyMySQL-0.10.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 47.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using 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

File hashes

Hashes for PyMySQL-0.10.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 44f47128dda8676e021c8d2dbb49a82be9e4ab158b9f03e897152a3a287c69ea
MD5 f799dfb67b051d94bcb921df709a45e9
BLAKE2b-256 1aeadd9c81e2d85efd03cfbf808736dd055bd9ea1a78aea9968888b1055c3263

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page