.. image:: https://github.com/MagicStack/asyncpg/workflows/Tests/badge.svg :target: https://github.com/MagicStack/asyncpg/actions?query=workflow%3ATests+branch%3Amaster :alt: GitHub Actions status .. image:: https://img.shields.io/pypi/v/asyncpg.svg :target: https://pypi.python.org/pypi/asyncpg
asyncpg is a database interface library designed specifically for
PostgreSQL and Python/asyncio. asyncpg is an efficient, clean implementation
of PostgreSQL server binary protocol for use with Python's
framework. You can read more about asyncpg in an introductory
blog post <http://magic.io/blog/asyncpg-1m-rows-from-postgres-to-python/>_.
asyncpg requires Python 3.5 or later and is supported for PostgreSQL versions 9.5 to 13. Older PostgreSQL versions or other databases implementing the PostgreSQL protocol may work, but are not being actively tested.
The project documentation can be found
In our testing asyncpg is, on average, 3x faster than psycopg2 (and its asyncio variant -- aiopg).
The above results are a geometric mean of benchmarks obtained with PostgreSQL
client driver benchmarking toolbench <https://github.com/MagicStack/pgbench>_
in November 2020 (click on the chart to see full details).
asyncpg implements PostgreSQL server protocol natively and exposes its features directly, as opposed to hiding them behind a generic facade like DB-API.
This enables asyncpg to have easy-to-use support for:
asyncpg is available on PyPI and has no dependencies. Use pip to install::
$ pip install asyncpg
.. code-block:: python
import asyncio import asyncpg async def run(): conn = await asyncpg.connect(user='user', password='password', database='database', host='127.0.0.1') values = await conn.fetch( 'SELECT * FROM mytable WHERE id = $1', 10, ) await conn.close() loop = asyncio.get_event_loop() loop.run_until_complete(run())
asyncpg is developed and distributed under the Apache 2.0 license.