Skip to main content
https://travis-ci.com/aio-libs/aiomysql.svg?branch=master Code coverage Latest Version Documentation Status 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/

Mailing List

https://groups.google.com/forum/#!forum/aio-libs

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.

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.:

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

Changes

0.0.21 (2020-11-26)

  • Allow to use custom Cursor subclasses #374

  • Fill Connection class with actual client version #388

  • Fix legacy __aiter__ methods #403

  • Fix & update docs #418 #437

  • Ignore pyenv’s .python-version file #424

  • Replace asyncio.streams.IncompleteReadError with asyncio.IncompleteReadError #460 #454

  • Add support for SQLAlchemy default parameters #455 #466

  • Update dependencies #485

  • Support Python 3.7 & 3.8 #493

0.0.20 (2018-12-19)

  • Fixed connect_timeout #360

  • Fixed support for SQLA executemany #324

  • Fix the python 3.7 compatibility #357

  • Fixed reuse connections when StreamReader has an exception #339

  • Fixes warning when inserting binary strings #326

0.0.19 (2018-07-12)

  • See v0.0.18

0.0.18 (2018-07-09)

  • Updated to support latest PyMySQL changes.

  • aiomysql now sends client connection info.

  • MySQL8+ Support including sha256_password and cached_sha2_password authentication plugins.

  • Default max packet length sent to the server is no longer 1.

  • Fixes issue where cursor.nextset can hang on query sets that raise errors.

0.0.17 (2018-07-06)

  • Pinned version of PyMySQL

0.0.16 (2018-06-03)

  • Added ability to execute precompiled sqlalchemy queries #294 (Thanks @vlanse)

0.0.15 (2018-05-20)

  • Fixed handling of user-defined types for sqlalchemy #290

  • Fix KeyError when server reports unknown collation #289

0.0.14 (2018-04-22)

  • Fixed SSL connection finalization #282

0.0.13 (2018-04-19)

  • Added SSL support #280 (Thanks @terrycain)

  • Fixed __all__ in aiomysql/__init__ #270 (Thanks @matianjun1)

  • Added docker fixtures #275 (Thanks @terrycain)

0.0.12 (2018-01-18)

  • Fixed support for SQLAlchemy 1.2.0

  • Fixed argument for cursor.execute in sa engine #239 (Thanks @NotSoSuper)

0.0.11 (2017-12-06)

  • Fixed README formatting on pypi

0.0.10 (2017-12-06)

  • Updated regular expressions to be compatible with pymysql #167 (Thanks @AlexLisovoy)

  • Added connection recycling in the pool #216

0.0.9 (2016-09-14)

  • Fixed AttributeError in _request_authentication function #104 (Thanks @ttlttl)

  • Fixed legacy auth #105

  • uvloop added to test suite #106

  • Fixed bug with unicode in json field #107 (Thanks @methane)

0.0.8 (2016-08-24)

  • Default min pool size reduced to 1 #80 (Thanks @Drizzt1991)

  • Update to PyMySQL 0.7.5 #89

  • Fixed connection cancellation in process of executing a query #79 (Thanks @Drizzt1991)

0.0.7 (2016-01-27)

  • Fix for multiple results issue, ported from pymysql #52

  • Fixed useless warning with no_delay option #55

  • Added async/await support for Engine, SAConnection, Transaction #57

  • pool.release returns future so we can wait on it in __aexit__ #60

  • Update to PyMySQL 0.6.7

0.0.6 (2015-12-11)

  • Fixed bug with SA rollback (Thanks @khlyestovillarion!)

  • Fixed issue with default no_delay option (Thanks @khlyestovillarion!)

0.0.5 (2015-10-28)

  • no_delay option is deprecated and True by default

  • Add Cursor.mogrify() method

  • Support for “LOAD LOCAL INFILE” query.

  • Check connection inside pool, in case of timeout drop it, fixes #25

  • Add support of python 3.5 features to pool, connection and cursor

0.0.4 (2015-05-23)

  • Allow to call connection.wait_closed twice.

  • Fixed sqlalchemy 1.0.0 support.

  • Fix #11: Rename Connection.wait_closed() to .ensure_closed()

  • Raise ResourceWarning on non-closed Connection

  • Rename Connection.connect to _connect

0.0.3 (2015-03-10)

  • Added support for PyMySQL up to 0.6.6.

  • Ported improvements from PyMySQL.

  • Added basic documentation.

  • Fixed and added more examples.

0.0.2 (2015-02-17)

  • Added MANIFEST.in.

0.0.1 (2015-02-17)

  • Initial release.

  • Implemented plain connections: connect, Connection, Cursor.

  • Implemented database pools.

  • Ported sqlalchemy optional support.

Metadata

Release files for aiomysql 0.0.21

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aiomysql 0.0.21
File Size Uploaded
aiomysql-0.0.21.tar.gz 61.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aiomysql 0.0.21
File Interpreter ABI Platform
aiomysql-0.0.21-py3-none-any.whl Python 3 none any Details

Total release size: 102.4 kB

Release files / aiomysql-0.0.21.tar.gz

Download URL aiomysql-0.0.21.tar.gz
Size 61.3 kB
Tags Source
SHA-256 checksum
How to use checksums
811569c0db118dd2685f0878f5cebf17a11e89a995fa14261d5fa0254113842c
BLAKE2b-256 checksum
How to use checksums
a97fd5a409cc0bb8349d6475ee4ea42ac2a5664646fe8a85e81ce3d91f63c474
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.7

Release files / aiomysql-0.0.21-py3-none-any.whl

Download URL aiomysql-0.0.21-py3-none-any.whl
Size 41.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a81a97da3dd732635926a8ea6adbbf2d1345799680bf61b5f89e730bcec88cc5
BLAKE2b-256 checksum
How to use checksums
c7b4251fcc71a116d765382a9462dee499f019a639db56464b1039ab84bd82ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via Python-urllib/3.7

Release history Release notifications | RSS feed

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.22

2 release files

This release

0.0.21 This release

2 release files

0.0.20

2 release files

0.0.19

2 release files

0.0.15

1 release file

0.0.14

1 release file

0.0.13

1 release file

0.0.12

1 release file

0.0.11

1 release file

0.0.10

1 release file

0.0.9

1 release file

0.0.8

1 release file

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page