AsyncDB
AsyncDB is a collection of different Database Drivers using asyncio-based connections and binary connectors (as asyncpg) but providing an abstraction layer to easily connect to different data sources, a high-level abstraction layer for various non-blocking database connectors, on other blocking connectors (like MS SQL Server) we are using ThreadPoolExecutors to run in a non-blocking manner.
Why AsyncDB?
The finality of AsyncDB is to provide us with a subset of drivers (connectors) for accessing different databases and data sources for data interaction. The main goal of AsyncDB is to use asyncio-based technologies.
Getting Started
Requirements
Python 3.9+
Installation
$ pip install asyncdb
---> 100%
Successfully installed asyncdb
Can also install only drivers required like:
$ pip install asyncdb[pg] # this install only asyncpg
Or install all supported drivers as:
$ pip install asyncdb[all]
Requirements
- Python >= 3.8
- asyncio (https://pypi.python.org/pypi/asyncio/)
Currently AsyncDB supports the following databases:
- PostgreSQL (supporting two different connectors: asyncpg or aiopg)
- SQLite (requires aiosqlite)
- mySQL/MariaDB (requires aiomysql and mysqlclient)
- ODBC (using aioodbc)
- JDBC(using JayDeBeApi and JPype)
- RethinkDB (requires rethinkdb)
- Redis (requires aioredis)
- Memcache (optional, requires aiomcache:
pip install asyncdb[memcache]) - MS SQL Server (non-asyncio using freeTDS and pymssql)
- Apache Cassandra (requires official cassandra driver)
- InfluxDB (using influxdb)
- CouchBase (using aiocouch)
- MongoDB (using motor and pymongo)
- SQLAlchemy (requires sqlalchemy async (+3.14))
- Oracle (requires oracledb)
- Redpanda (Kafka-compatible, requires aiokafka)
Platform Support
AsyncDB's core package (pip install asyncdb) and the default extra
(pip install asyncdb[default]) are supported on Linux, macOS, and Windows
for Python 3.10–3.14. uvloop remains an optional performance extra
(pip install asyncdb[uvloop]): it is only available on POSIX platforms and
is never required to import or run AsyncDB. On Windows, uvloop activation
is automatically and safely skipped, and the standard asyncio event loop
policy is used instead.
The default extra covers SQLite (aiosqlite), RethinkDB, InfluxDB, Redis,
MS SQL Server (pymssql), Delta Lake, and DuckDB, in addition to the
PostgreSQL support (asyncpg) that ships with the core package.
Other provider extras (Cassandra, ScyllaDB, MySQL/MySQLdb, ODBC, Oracle,
JDBC, ClickHouse, etc.) depend on native or platform-sensitive client
libraries and are not guaranteed to be installable or fully supported on
every platform, including Windows. Selecting a driver whose optional
dependency is not installed raises a focused error naming the provider and
the extra required to install it (e.g. pip install asyncdb[mysql]).
Quick Tutorial
from asyncdb import AsyncDB
db = AsyncDB('pg', dsn='postgres://user:password@localhost:5432/database')
# Or you can also passing a dictionary with parameters like:
params = {
"user": "user",
"password": "password",
"host": "localhost",
"port": "5432",
"database": "database",
"DEBUG": True,
}
db = AsyncDB('pg', params=params)
async with await db.connection() as conn:
result, error = await conn.query('SELECT * FROM test')
And that's it!, we are using the same methods on all drivers, maintaining a consistent interface between all of them, facilitating the re-use of the same code for different databases.
Every Driver has a simple name to call it:
- pg: AsyncPG (PostgreSQL)
- postgres: aiopg (PostgreSQL)
- mysql: aiomysql (mySQL)
- influx: influxdb (InfluxDB)
- redis: redis-py (Redis)
- memcache: aiomcache (Memcache, async, no system libraries required)
- odbc: aiodbc (ODBC)
- oracle: oracle (oracledb)
- redpanda: Redpanda/Kafka (aiokafka)
Output Support
With Output Support results can be returned into a wide-range of variants:
from datamodel import BaseModel
class Point(BaseModel):
col1: list
col2: list
col3: list
db = AsyncDB('pg', dsn='postgres://user:password@localhost:5432/database')
async with await d.connection() as conn:
# changing output format to Pandas:
conn.output_format('pandas') # change output format to pandas
result, error = await conn.query('SELECT * FROM test')
conn.output_format('csv') # change output format to CSV
result, _ = await conn.query('SELECT TEST')
conn.output_format('dataclass', model=Point) # change output format to Dataclass Model
result, _ = await conn.query('SELECT * FROM test')
Currently AsyncDB supports the following Output Formats:
- CSV (comma-separated or parametrized)
- JSON (using orjson)
- iterable (returns a generator)
- Recordset (Internal meta-Object for list of Records)
- Pandas (a pandas Dataframe)
- Datatable (Dt Dataframe)
- Dataclass (exporting data to a dataclass with -optionally- passing Dataclass instance)
- PySpark Dataframe
And others to come:
- Apache Arrow (using pyarrow)
- Polars (Using Python polars)
- Dask Dataframe
Contribution guidelines
Please have a look at the Contribution Guide
- Writing tests
- Code review
Who do I talk to?
- Repo owner or admin
- Other community or team contact
License
AsyncDB is copyright of Jesus Lara (https://phenobarbital.info) and is licensed under BSD. I am providing code in this repository under an open source licenses, remember, this is my personal repository; the license that you receive is from me and not from my employeer.
2 maintainers
Release files for asyncdb 2.16.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
Total release size: 6.9 MB
Release files / asyncdb-2.16.1-cp314-cp314-win_amd64.whl
| Download URL | asyncdb-2.16.1-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 254.1 kB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ddc48e9361953a5b4c9a24dcd74e2a52a618c804b67e1a5d2a4811d1160de174
|
|
BLAKE2b-256 checksum How to use checksums |
30a2d1eaa7db0f75d553c7df44c5f15938275bf9cb102054c7d1b77e2b37d0c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
| Download URL | asyncdb-2.16.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl |
|---|---|
| Size | 591.4 kB |
| Tags | CPython 3.14 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
1493155d0218e0b3fc1723969f0fb63118064163dde995ebb070ccbb1b9009e2
|
|
BLAKE2b-256 checksum How to use checksums |
b643185610e90af6199a65dd6efcd212f6ca972aa3472860241f7d0fccafdf88
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp314-cp314-macosx_11_0_arm64.whl
| Download URL | asyncdb-2.16.1-cp314-cp314-macosx_11_0_arm64.whl |
|---|---|
| Size | 266.4 kB |
| Tags | CPython 3.14 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a2b46e529ac262ef0f6e98bd5e895f943af12fd1c8113d43ed73209a774135c1
|
|
BLAKE2b-256 checksum How to use checksums |
bccb81a9d5e3ba5cc2bb628ba815e43bc9c19db67272b5830ddc37f0bc1bc694
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp314-cp314-macosx_10_15_x86_64.whl
| Download URL | asyncdb-2.16.1-cp314-cp314-macosx_10_15_x86_64.whl |
|---|---|
| Size | 267.5 kB |
| Tags | CPython 3.14 macOS 10.15+ x86-64 |
|
SHA-256 checksum How to use checksums |
8cd024072afe45b358218f28d57c9461be812287fe2b6f39bb1a454459266bbf
|
|
BLAKE2b-256 checksum How to use checksums |
34e1016cae00ec73703de40913015d2d800c7cd38c7af8605c73e5b2b71e64f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp313-cp313-win_amd64.whl
| Download URL | asyncdb-2.16.1-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 254.2 kB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
98b9427a529ef318c3598d00b32d0f4547f083fdd1ae0acdf46cff94a9544660
|
|
BLAKE2b-256 checksum How to use checksums |
8127df3de60496106f21729ba1cc08e498e12dbd2919cb9760cafb1a1a299daa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
| Download URL | asyncdb-2.16.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl |
|---|---|
| Size | 594.1 kB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
e08ffa4897fd87407dbadaecd99f7ad273161418078b301dc1fa435493b7ba71
|
|
BLAKE2b-256 checksum How to use checksums |
3952a49da78322ef987efed2e57f0819348981f0f9c3f4e12a031be1a9ba4380
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | asyncdb-2.16.1-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 266.5 kB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
3aa68604478256b286bf2f0ae300e5ac2cf3345fc74933a2318daa2b963a441b
|
|
BLAKE2b-256 checksum How to use checksums |
cb7f9961d4c9b86f14d3775bf648420bda7dba550a5b623f760b7d2af71aead5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp313-cp313-macosx_10_13_x86_64.whl
| Download URL | asyncdb-2.16.1-cp313-cp313-macosx_10_13_x86_64.whl |
|---|---|
| Size | 267.4 kB |
| Tags | CPython 3.13 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
cb82b209a5865e52ae7183f73b70dbaddc76c5eb1fc5faed27a02248a349ad56
|
|
BLAKE2b-256 checksum How to use checksums |
84e1aefebde96147424a52d46dea9d8b0495bd6d462ac00231f0a5ee846bd874
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp312-cp312-win_amd64.whl
| Download URL | asyncdb-2.16.1-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 254.4 kB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ac041a6dfa5753d61acd6cc4030050f8ddd2e7f4efdd611755e14ac26c17f315
|
|
BLAKE2b-256 checksum How to use checksums |
f1792ca96b745b26d3efaac3162df269c4fd7df2257727fd1189275873f95b72
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
| Download URL | asyncdb-2.16.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl |
|---|---|
| Size | 596.5 kB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
b968ba3cfbae287666328b341c44dbee69bf435f99c39432c84eba1a2bb7da58
|
|
BLAKE2b-256 checksum How to use checksums |
9fc7ef2d93b1c405d93caa61b124e9560fa7e933e731945f77a2414486848909
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | asyncdb-2.16.1-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 267.7 kB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
0e8ce268a85d4986a44925c6ac162a9cc9ae2c2d92f29031266956a1b119c842
|
|
BLAKE2b-256 checksum How to use checksums |
bf73e13c8d1ccb28dd4f9bbc466da16b1cac2a4e910c1bb4042898aa637533db
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp312-cp312-macosx_10_13_x86_64.whl
| Download URL | asyncdb-2.16.1-cp312-cp312-macosx_10_13_x86_64.whl |
|---|---|
| Size | 268.5 kB |
| Tags | CPython 3.12 macOS 10.13+ x86-64 |
|
SHA-256 checksum How to use checksums |
d0b4c481607251a8d4c165717a218cd211645f679e85cc86081a8cd4d0e9842c
|
|
BLAKE2b-256 checksum How to use checksums |
b8553fa7a2d61b208ac32b79d939f4d3ce8d1bd1e0ef0c1c23cbf6a7040884aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp311-cp311-win_amd64.whl
| Download URL | asyncdb-2.16.1-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 254.8 kB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
25e796f735ff025ec8164d361f8218f9bb8ee7cbf028b83c7dfb4ca27556002b
|
|
BLAKE2b-256 checksum How to use checksums |
47ddce5be9eaf853e9c93e6e88f237ecdaa1d1efb368bfb154380e6db7d58d09
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
| Download URL | asyncdb-2.16.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl |
|---|---|
| Size | 594.5 kB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
c0157b563d9c0e3090ba65f208517738c21877313719fa676d48768d2e325953
|
|
BLAKE2b-256 checksum How to use checksums |
c566611b11bca2e38fdd63c4a09b6bcdc5a2411eb67b1a04b02d5c73cb3aeda7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | asyncdb-2.16.1-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 266.2 kB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
1d1c12fa59a7b082d12ff30f1e1bd7cb267bc571f86aeec5ed2ae34bdb51ca2a
|
|
BLAKE2b-256 checksum How to use checksums |
21c9530cebb6d4d1acf36ac2ce87cc0e65bca600be93f5cba845c2347dbef731
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp311-cp311-macosx_10_9_x86_64.whl
| Download URL | asyncdb-2.16.1-cp311-cp311-macosx_10_9_x86_64.whl |
|---|---|
| Size | 267.2 kB |
| Tags | CPython 3.11 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
c7776d41e84740328a1a11f80aee7f70d4b9b28ddae6a91cb946a65b212ba5af
|
|
BLAKE2b-256 checksum How to use checksums |
bc9e090dd9cd0c6b5f3b11c6c0dd34de30a6c1d90a8067c0f3fae7ef9f8b06ad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp310-cp310-win_amd64.whl
| Download URL | asyncdb-2.16.1-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 254.3 kB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
3aa50228b4cb079b05160be3f5a529d53cf3e5f16469845b0e697b010a23c947
|
|
BLAKE2b-256 checksum How to use checksums |
077d0a421bc87e331fd74f832c8d94ea713bba915a3bd992ecb86c2ab76dcdea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl
| Download URL | asyncdb-2.16.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl |
|---|---|
| Size | 559.2 kB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 Linux glibc 2.5+ x86-64 |
|
SHA-256 checksum How to use checksums |
d280711a667ce8aaf87dc0c2700976a7453fb771bdd58e0ce6b5b143f174df00
|
|
BLAKE2b-256 checksum How to use checksums |
b44b7770656bbd69fb6a6934841e09218ecc664bb95db5ba3d5031a11113ec13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | asyncdb-2.16.1-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 266.1 kB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
8b2b6cc216bba19d6786b1fba01e464fc132d4003f406bbd1edde08766a3f238
|
|
BLAKE2b-256 checksum How to use checksums |
60309cf4a59fe593b39c2f44f03fbaaf0da1e9a4334d56835c191ed0db1eec57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / asyncdb-2.16.1-cp310-cp310-macosx_10_9_x86_64.whl
| Download URL | asyncdb-2.16.1-cp310-cp310-macosx_10_9_x86_64.whl |
|---|---|
| Size | 267.1 kB |
| Tags | CPython 3.10 macOS 10.9+ x86-64 |
|
SHA-256 checksum How to use checksums |
4eb90e5a63ed3cf147e350384c3272f595360d224d70ce99263a6dd95121b863
|
|
BLAKE2b-256 checksum How to use checksums |
c5f9f76b60944fd0eca5588b08a618f1365ced7c17c928bddf8f9ef0fcf2c564
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
