asyncpg

by MagicStack

MagicStack / asyncpg

A fast PostgreSQL Database Client Library for Python/asyncio.

4.4K Stars 248 Forks Last release: 2 months ago (v0.21.0) Apache License 2.0 676 Commits 31 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

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

.. image:: https://travis-ci.org/MagicStack/asyncpg.svg?branch=master :target: https://travis-ci.org/MagicStack/asyncpg

.. image:: https://ci.appveyor.com/api/projects/status/9rwppnxphgc8bqoj/branch/master?svg=true :target: https://ci.appveyor.com/project/magicstack/asyncpg

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

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

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

.. image:: performance.png :target: http://magic.io/blog/asyncpg-1m-rows-from-postgres-to-python/

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

.. 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''') 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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.