========
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()
Raw data
{
"_id": null,
"home_page": "https://github.com/nakagami/CyMySQL/",
"name": "cymysql",
"maintainer": "Hajime Nakagami",
"docs_url": null,
"requires_python": null,
"maintainer_email": "nakagami@gmail.com",
"keywords": "MySQL",
"author": "Yutaka Matsubara",
"author_email": "yutaka.matsubara@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/1d/ec/9e16412e9ffbf4da4244c176f643450a2c9a74131080d969d00ac92c36d0/cymysql-1.0.6.tar.gz",
"platform": null,
"description": "========\nCyMySQL\n========\n\nWhat's CyMySQL\n--------------\n\nThis package contains a python MySQL client library.\n\nIt is a fork project from PyMySQL https://pymysql.readthedocs.io/en/latest/.\n\nCyMySQL is accerarated by Cython and supports Python versions 2 and 3.\n\nDocumentation on the MySQL client/server protocol can be found here:\nhttp://dev.mysql.com/doc/internals/en/client-server-protocol.html\n\nRequirements\n-------------\n\n- Python 2.7, 3.5+\n- MySQL 5.7 or higher, MariaDB\n\nInstallation\n--------------\n\nInstall Cython (optional)\n+++++++++++++++++++++++++\n\nInstallation of Cython is optional.\nCyMySQL will run faster if installed, but will also run without it.\n\nSince the bottleneck is often in MySQL queries, installing Cython may not be effective in many cases.\n\nFor most versions of pip and setuptools installation of Cython is not\nrequired as it's listed in pyproject.tompl as a required build-time\ndependency and will be installed automatically in the isolated build\nenvironemnt. This means it's not possible to install CyMySQL in\npure-Python mode without cythonized extensions.\n\nFor older versions of pip and setuptools that don't obey pyproject.tompl\ninstall Cython yourself:\n\n::\n\n # pip install cython\n\nInstall cymysql\n++++++++++++++++++++++++++++++\n\n::\n\n # pip install cymysql\n\nInstall pycryptodome(depending on a situation)\n++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n\n::\n\n # pip install pycryptodome\n\nIf you use caching_sha2_password authentication plugin and connect with 'not ssl and not unix_socket',\nit means that if the following error occur ...\n\n::\n\n ModuleNotFoundError: No module named 'Crypto'\n\nyou shoud install pycryptodome.\n\nInstall pyzstd (compress=\"zstd\")\n++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n\n::\n\n # pip install pyzstd\n\nconnect() has a `compress` parameter, and it can be set either \"zlib\" or \"zstd\".\n\nIf \"zstd\" is specified, `pyzstd` must be installed.\n\nInstall numpy (VECTOR type)\n++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n\n::\n\n # pip install numpy\n\nIf you fetch a VECTOR type (MySQL 9.0), you can get the result in ndarray.\n\nThe value type returned by the VECTOR type may change in future versions of CyMySQL.\n\nExample\n---------------\n\nPython Database API Specification v2.0\n+++++++++++++++++++++++++++++++++++++++++\n\nhttps://peps.python.org/pep-0249/\n\n::\n\n import cymysql\n conn = cymysql.connect(host='127.0.0.1', user='root', passwd='', db='database_name')\n cur = conn.cursor()\n cur.execute('select foo, bar from baz')\n for r in cur.fetchall():\n print(r[0], r[1])\n\nasyncio\n++++++++++++++++++++++++++++++++++++++\n\nIn Python3, you can use asyncio to write the following.\n\nThis API is experimental.\nIf there are any mistakes, please correct them in the pull request and send.\n\nUse connect\n::\n\n import asyncio\n import cymysql\n\n async def conn_example():\n conn = await cymysql.aio.connect(\n host=\"127.0.0.1\",\n user=\"root\",\n passwd=\"\",\n db=\"database_name\",\n )\n cur = conn.cursor()\n await cur.execute(\"SELECT 42\")\n print(await cur.fetchall())\n asyncio.run(conn_example())\n\nUse pool\n::\n\n import asyncio\n import cymysql\n\n async def pool_example(loop):\n pool = await cymysql.aio.create_pool(\n host=\"127.0.0.1\",\n user=\"root\",\n passwd=\"\",\n db=\"database_name\",\n loop=loop,\n )\n async with pool.acquire() as conn:\n async with conn.cursor() as cur:\n await cur.execute(\"SELECT 42\")\n print(await cur.fetchall())\n pool.close()\n await pool.wait_closed()\n\n loop = asyncio.get_event_loop()\n loop.run_until_complete(pool_example(loop))\n loop.close()\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python MySQL Driver using Cython",
"version": "1.0.6",
"project_urls": {
"Homepage": "https://github.com/nakagami/CyMySQL/"
},
"split_keywords": [
"mysql"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1dec9e16412e9ffbf4da4244c176f643450a2c9a74131080d969d00ac92c36d0",
"md5": "2613a87f9eb11c4bb5c9515b30cc3928",
"sha256": "6aa7b7b97a358d6acbdbca864da7ba51c86206abb92e2e0653b60064f74263c3"
},
"downloads": -1,
"filename": "cymysql-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "2613a87f9eb11c4bb5c9515b30cc3928",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 52944,
"upload_time": "2025-02-14T11:03:58",
"upload_time_iso_8601": "2025-02-14T11:03:58.983155Z",
"url": "https://files.pythonhosted.org/packages/1d/ec/9e16412e9ffbf4da4244c176f643450a2c9a74131080d969d00ac92c36d0/cymysql-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-14 11:03:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nakagami",
"github_project": "CyMySQL",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cymysql"
}
JSON
