cymysql · Python Simple Repository Browser

Project Links

Meta

Author: Yutaka Matsubara

Maintainer: Hajime Nakagami

Classifiers

Development Status

4 - Beta

Operating System

OS Independent

Programming Language

Python
Python :: 3

Topic

Database
Database :: Front-Ends
Software Development :: Libraries :: Python Modules

What’s CyMySQL

This package contains a python MySQL client library.

It is a fork project from PyMySQL https://pymysql.readthedocs.io/en/latest/.

CyMySQL is accerarated by Cython.

Documentation on the MySQL client/server protocol can be found here: http://dev.mysql.com/doc/internals/en/client-server-protocol.html

Requirements

Python 3.10+
MySQL 5.7 or higher, MariaDB

Installation

With cythonize

$ pip install cymysql

Or without cythonize

$ NO_CYTHON=1 pip install cymysql

Example

Python Database API Specification v2.0

https://peps.python.org/pep-0249/

import cymysql
conn = cymysql.connect(host='127.0.0.1', user='root', passwd='', db='database_name')
cur = conn.cursor()
cur.execute('select foo, bar from baz')
for r in cur.fetchall():
   print(r[0], r[1])

asyncio

You can use asyncio to write the following.

Use connect

import asyncio
import cymysql

async def conn_example():
    conn = await cymysql.aio.connect(
        host="127.0.0.1",
        user="root",
        passwd="",
        db="database_name",
    )
    cur = conn.cursor()
    await cur.execute("SELECT 42")
    print(await cur.fetchall())
asyncio.run(conn_example())

Use pool

import asyncio
import cymysql

async def pool_example(loop):
    pool = await cymysql.aio.create_pool(
        host="127.0.0.1",
        user="root",
        passwd="",
        db="database_name",
        loop=loop,
    )
    async with pool.acquire() as conn:
        async with conn.cursor() as cur:
            await cur.execute("SELECT 42")
            print(await cur.fetchall())
    pool.close()
    await pool.wait_closed()

loop = asyncio.get_event_loop()
loop.run_until_complete(pool_example(loop))
loop.close()