https://github.com/MagicStack/asyncpg

A fast PostgreSQL Database Client Library for Python/asyncio.
https://github.com/MagicStack/asyncpg

async-programming async-python asyncio database-driver high-performance postgresql python python-3

Last synced: 7 days ago
JSON representation

A fast PostgreSQL Database Client Library for Python/asyncio.

• Host: GitHub
• URL: https://github.com/MagicStack/asyncpg
• Owner: MagicStack
• License: apache-2.0
• Created: 2016-07-19T02:25:20.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-02T18:49:17.000Z (6 months ago)
• Last Synced: 2024-05-16T21:45:45.705Z (6 months ago)
• Topics: async-programming, async-python, asyncio, database-driver, high-performance, postgresql, python, python-3
• Language: Python
• Homepage:
• Size: 10.5 MB
• Stars: 6,646
• Watchers: 121
• Forks: 391
• Open Issues: 227
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

• awesome-asyncio - asyncpg - Fast PostgreSQL Database Client Library for Python/asyncio. (Database Drivers)
• awesome-starts - MagicStack/asyncpg - A fast PostgreSQL Database Client Library for Python/asyncio. (Python)
• awesome-asyncio-cn - asyncpg - 快速访问 PostgreSQL 数据库客户端的异步驱动。 (数据库驱动)
• awesome-asyncio - asyncpg - Fast PostgreSQL Database Client Library for Python/asyncio. (Database Drivers)
• starred-awesome - asyncpg - A fast PostgreSQL Database Client Library for Python/asyncio. (Python)

README

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

=======================================================================

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

framework.  You can read more about asyncpg in an introductory

`blog post `_.

asyncpg requires Python 3.8 or later and is supported for PostgreSQL

versions 9.5 to 17.  Other PostgreSQL versions or other databases

implementing the PostgreSQL protocol *may* work, but are not being

actively tested.

Documentation

-------------

The project documentation can be found

`here `_.

Performance

-----------

In our testing asyncpg is, on average, **5x** faster than psycopg3.

.. image:: https://raw.githubusercontent.com/MagicStack/asyncpg/master/performance.png?fddca40ab0

    :target: https://gistpreview.github.io/?0ed296e93523831ea0918d42dd1258c2

The above results are a geometric mean of benchmarks obtained with PostgreSQL

`client driver benchmarking toolbench `_

in June 2023 (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.  When not using GSSAPI/SSPI authentication it

has no dependencies.  Use pip to install::

    $ pip install asyncpg

If you need GSSAPI/SSPI authentication, use::

    $ pip install 'asyncpg[gssauth]'

For more details, please `see the documentation

`_.

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 WHERE id = $1',

            10,

        )

        await conn.close()

    asyncio.run(run())

License

-------

asyncpg is developed and distributed under the Apache 2.0 license.