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.0.tar.gz (76.1 kB view details)

Uploaded Source

Built Distribution

PyMySQL-0.10.0-py2.py3-none-any.whl (47.5 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: PyMySQL-0.10.0.tar.gz
  • Upload date:
  • Size: 76.1 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.47.0 CPython/3.8.4

File hashes

Hashes for PyMySQL-0.10.0.tar.gz
Algorithm Hash digest
SHA256 e14070bc84e050e0f80bf6063e31d276f03a0bb4d46b9eca2854566c4ae19837
MD5 d08058b1592724d5808c43f56050f245
BLAKE2b-256 2089f336b217bfa06a0c672d8653774361d0faec008f7d008ff04f538a5da6f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyMySQL-0.10.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 47.5 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.47.0 CPython/3.8.4

File hashes

Hashes for PyMySQL-0.10.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 adef15ceccf1ff544a23a6f46609f65187261dc8b0cf94c9644189c173b0a451
MD5 b5b6c65232a22b764fe87c0da3611f4f
BLAKE2b-256 2c57af502e0e113f139b3f3add4f1efba899a730a365d2264d476e85b9591da5

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