Skip to main content

An asyncio PosgtreSQL driver

Project description

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


Documentation
-------------

The project documentation can be found
`here <https://magicstack.github.io/asyncpg/>`_.


Performance
-----------

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

.. image:: performance.png

The above results are a geometric mean of benchmarks obtained with PostgreSQL
client driver benchmarking toolbench available
`here <https://github.com/MagicStack/pgbench>`_.


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 requires Python 3.5 and is available on PyPI.
Use pip to install it::

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asyncpg-0.5.1.tar.gz (326.3 kB view details)

Uploaded Source

File details

Details for the file asyncpg-0.5.1.tar.gz.

File metadata

  • Download URL: asyncpg-0.5.1.tar.gz
  • Upload date:
  • Size: 326.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for asyncpg-0.5.1.tar.gz
Algorithm Hash digest
SHA256 5e97dfc0b949416cd5be81de9ad14b1ceb85fa5e1a2630e7efc6771abcbed4a1
MD5 9c189e627dc09781981d83e4bb1c87b4
BLAKE2b-256 767621404859d6f2a2bae0db45e3d5fc0fce3e9144bab5c79285c4e028a428cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page