Skip to content

Latest commit

 

History

History
158 lines (108 loc) · 3.66 KB

README.rst

File metadata and controls

158 lines (108 loc) · 3.66 KB
Raw

CyMySQL

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 and supports Python versions 2 and 3.

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

Requirements

  • Python 2.7, 3.5+
  • MySQL 5.7 or higher, MariaDB

Installation

Install Cython (optional)

Installation of Cython is optional. CyMySQL will run faster if installed, but will also run without it.

Since the bottleneck is often in MySQL queries, installing Cython may not be effective in many cases.

For most versions of pip and setuptools installation of Cython is not required as it's listed in pyproject.tompl as a required build-time dependency and will be installed automatically in the isolated build environemnt. This means it's not possible to install CyMySQL in pure-Python mode without cythonized extensions.

For older versions of pip and setuptools that don't obey pyproject.tompl install Cython yourself:

# pip install cython

Install cymysql

# pip install cymysql

Install pycryptodome(depending on a situation)

# pip install pycryptodome

If you use caching_sha2_password authentication plugin and connect with 'not ssl and not unix_socket', it means that if the following error occur ...

ModuleNotFoundError: No module named 'Crypto'

you shoud install pycryptodome.

Install pyzstd (compress="zstd")

# pip install pyzstd

connect() has a compress parameter, and it can be set either "zlib" or "zstd".

If "zstd" is specified, pyzstd must be installed.

Install numpy (VECTOR type)

# pip install numpy

If you fetch a VECTOR type (MySQL 9.0), you can get the result in ndarray.

The value type returned by the VECTOR type may change in future versions of 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

In Python3, you can use asyncio to write the following.

This API is experimental. If there are any mistakes, please correct them in the pull request and send.

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()