Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 1,127 Commits
.github		.github
ci		ci
docs		docs
pymysql		pymysql
tests		tests
.coveragerc		.coveragerc
.gitignore		.gitignore
.readthedocs.yaml		.readthedocs.yaml
CHANGELOG.md		CHANGELOG.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
README.md		README.md
SECURITY.md		SECURITY.md
codecov.yml		codecov.yml
example.py		example.py
pyproject.toml		pyproject.toml
renovate.json		renovate.json
requirements-dev.txt		requirements-dev.txt

Repository files navigation

PyMySQL

This package contains a pure-Python MySQL and MariaDB client library, based onPEP 249.

Requirements

Python -- one of the following:
- CPython : 3.7 and newer
- PyPy : Latest 3.x version
MySQL Server -- one of the following:
- MySQL >= 5.7
- MariaDB >= 10.4

Installation

Package is uploaded onPyPI.

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 installadditional dependency:

$ python3 -m pip install PyMySQL[ed25519]

Documentation

Documentation is available online:https://pymysql.readthedocs.io/

For support, please refer to theStackOverflow.

Example

The following examples make use of a simple table

CREATETABLE `users` (`id`int(11)NOT NULL AUTO_INCREMENT,`email`varchar(255) COLLATE utf8_binNOT NULL,`password`varchar(255) COLLATE utf8_binNOT NULL,PRIMARY KEY (`id`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_binAUTO_INCREMENT=1 ;

importpymysql.cursors# Connect to the databaseconnection=pymysql.connect(host='localhost',user='user',password='passwd',database='db',cursorclass=pymysql.cursors.DictCursor)withconnection:withconnection.cursor()ascursor:# Create a new recordsql="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()withconnection.cursor()ascursor:# Read a single recordsql="SELECT `id`, `password` FROM `users` WHERE `email`=%s"cursor.execute(sql, ('webmaster@python.org',))result=cursor.fetchone()print(result)