Skip to content
A fast PostgreSQL Database Client Library for Python/asyncio.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci asyncpg v0.18.0 Oct 30, 2018
.github Allow specifying the target version when generating the release log Nov 10, 2018
asyncpg Fix _StatementCache.clear() PS memory leak Mar 19, 2019
docs fix timezone type label in docs Mar 19, 2019
tests Fix _StatementCache.clear() PS memory leak Mar 19, 2019
tools Allow aliasing builtin types by name in set_builtin_type_codec() Sep 18, 2018
.coveragerc
.flake8 Add support for data types added in PostgreSQL 10. Oct 18, 2017
.gitignore Ignore vscode directory Oct 5, 2018
.gitmodules Factor out generic PostgreSQL protocol helpers into a separate package Oct 2, 2018
.travis.yml
AUTHORS
LICENSE
MANIFEST.in
Makefile
README.rst
performance.png Update performance.png (high-res version) Aug 4, 2016
pytest.ini
setup.py asyncpg v0.18.0 Oct 30, 2018

README.rst

asyncpg -- A fast PostgreSQL Database Client Library for Python/asyncio

https://travis-ci.org/MagicStack/asyncpg.svg?branch=master https://ci.appveyor.com/api/projects/status/9rwppnxphgc8bqoj/branch/master?svg=true

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. You can read more about asyncpg in an introductory blog post.

asyncpg requires Python 3.5 or later and is supported for PostgreSQL versions 9.2 to 11.

Documentation

The project documentation can be found here.

Performance

In our testing asyncpg is, on average, 3x faster than psycopg2 (and its asyncio variant -- aiopg).

performance.png

The above results are a geometric mean of benchmarks obtained with PostgreSQL client driver benchmarking toolbench.

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''')
    await conn.close()

loop = asyncio.get_event_loop()
loop.run_until_complete(run())

License

asyncpg is developed and distributed under the Apache 2.0 license.

You can’t perform that action at this time.