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 asyncio framework.
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.
Performance
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 in November 2020 (click on the chart to see full details).
Features
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:
- prepared statements
- scrollable cursors
- partial iteration on query results
- automatic encoding and decoding of composite types, arrays, and any combination of those
- straightforward support for custom data types
Installation
asyncpg is available on PyPI and has no dependencies. Use pip to install:
$ pip install asyncpg
Basic Usage
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())
