https://github.com/aio-libs/aiomysql

aiomysql is a library for accessing a MySQL database from the asyncio
https://github.com/aio-libs/aiomysql

aiomysql async asyncio mariadb mysql python sqlalchemy

Last synced: about 2 months ago
JSON representation

aiomysql is a library for accessing a MySQL database from the asyncio

• Host: GitHub
• URL: https://github.com/aio-libs/aiomysql
• Owner: aio-libs
• License: mit
• Created: 2015-01-07T20:14:48.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-18T19:07:27.000Z (5 months ago)
• Last Synced: 2024-05-21T03:15:23.184Z (4 months ago)
• Topics: aiomysql, async, asyncio, mariadb, mysql, python, sqlalchemy
• Language: Python
• Homepage: https://aiomysql.rtfd.io
• Size: 1.34 MB
• Stars: 1,703
• Watchers: 47
• Forks: 252
• Open Issues: 112
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.txt
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome-asyncio - aiomysql - Library for accessing a MySQL database (Database Drivers)
• awesome-asyncio-cn - aiomysql - 访问 MySQL 数据库的异步驱动。 (数据库驱动)
• awesome-asyncio - aiomysql - Library for accessing a MySQL database (Database Drivers)

README

        
aiomysql

========

.. image:: https://github.com/aio-libs/aiomysql/actions/workflows/ci-cd.yml/badge.svg?branch=master

    :target: https://github.com/aio-libs/aiomysql/actions/workflows/ci-cd.yml

.. image:: https://codecov.io/gh/aio-libs/aiomysql/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/aio-libs/aiomysql

    :alt: Code coverage

.. image:: https://badge.fury.io/py/aiomysql.svg

    :target: https://badge.fury.io/py/aiomysql

    :alt: Latest Version

.. image:: https://readthedocs.org/projects/aiomysql/badge/?version=latest

    :target: https://aiomysql.readthedocs.io/

    :alt: Documentation Status

.. image:: https://badges.gitter.im/Join%20Chat.svg

    :target: https://gitter.im/aio-libs/Lobby

    :alt: Chat on Gitter

**aiomysql** is a "driver" for accessing a `MySQL` database

from the asyncio_ (PEP-3156/tulip) framework. It depends on and reuses most

parts of PyMySQL_ . *aiomysql* tries to be like awesome aiopg_ library and

preserve same api, look and feel.

Internally **aiomysql** is copy of PyMySQL, underlying io calls switched

to async, basically ``yield from`` and ``asyncio.coroutine`` added in

proper places)). `sqlalchemy` support ported from aiopg_.

Documentation

-------------

https://aiomysql.readthedocs.io/

Basic Example

-------------

**aiomysql** based on PyMySQL_ , and provides same api, you just need

to use  ``await conn.f()`` or ``yield from conn.f()`` instead of calling

``conn.f()`` for every method.

Properties are unchanged, so ``conn.prop`` is correct as well as

``conn.prop = val``.

.. code:: python

    import asyncio

    import aiomysql

    async def test_example(loop):

        pool = await aiomysql.create_pool(host='127.0.0.1', port=3306,

                                          user='root', password='',

                                          db='mysql', loop=loop)

        async with pool.acquire() as conn:

            async with conn.cursor() as cur:

                await cur.execute("SELECT 42;")

                print(cur.description)

                (r,) = await cur.fetchone()

                assert r == 42

        pool.close()

        await pool.wait_closed()

    loop = asyncio.get_event_loop()

    loop.run_until_complete(test_example(loop))

Example of SQLAlchemy optional integration

------------------------------------------

Sqlalchemy support has been ported from aiopg_ so api should be very familiar

for aiopg_ user.:

.. code:: python

    import asyncio

    import sqlalchemy as sa

    from aiomysql.sa import create_engine

    metadata = sa.MetaData()

    tbl = sa.Table('tbl', metadata,

                   sa.Column('id', sa.Integer, primary_key=True),

                   sa.Column('val', sa.String(255)))

    async def go(loop):

        engine = await create_engine(user='root', db='test_pymysql',

                                     host='127.0.0.1', password='', loop=loop)

        async with engine.acquire() as conn:

            await conn.execute(tbl.insert().values(val='abc'))

            await conn.execute(tbl.insert().values(val='xyz'))

            async for row in conn.execute(tbl.select()):

                print(row.id, row.val)

        engine.close()

        await engine.wait_closed()

    loop = asyncio.get_event_loop()

    loop.run_until_complete(go(loop))

Requirements

------------

* Python_ 3.7+

* PyMySQL_

.. _Python: https://www.python.org

.. _asyncio: http://docs.python.org/3.5/library/asyncio.html

.. _aiopg: https://github.com/aio-libs/aiopg

.. _PyMySQL: https://github.com/PyMySQL/PyMySQL

.. _Tornado-MySQL: https://github.com/PyMySQL/Tornado-MySQL