Databasez¶

🚀 Async database support for Python. 🚀

Documentation: https://databasez.dymmond.com 📚

Source Code: https://github.com/dymmond/databasez

Motivation¶

There is a great package from Encode that was doing what this package was forked to do.

From a need to extend to new drivers and newest technologies and adding extra features common and useful to the many, Databases was forked to become Databasez.

This package is 100% backwards compatible with Databases from Encode and will remain like this for the time being but adding extra features and regular updates as well as continuing to be community driven.

By the time this project was created, Databases was yet to merge possible SQLAlchemy 2.0 changes from the author of this package and therefore, this package aims to unblock a lot of the projects out there that want SQLAlchemy 2.0 with the best of databases with new features.

A lot of packages depends of Databases and this was the main reason for the fork of Databasez.

It allows you to make queries using the powerful SQLAlchemy Core expression language, and provides support for PostgreSQL, MySQL, SQLite and MSSQL.

Databasez is suitable for integrating against any async Web framework, such as Esmerald, Starlette, Sanic, Responder, Quart, aiohttp, Tornado, or FastAPI.

Databasez was built for Python 3.8+ and on the top of the newest SQLAlchemy 2 and gives you simple asyncio support for a range of databases.

Special notes¶

This package couldn't exist without Databases and the continuous work done by the amazing team behind it. For that reason, thank you!

Installation¶

$ pip install databasez

If you are interested in using the test client, you can just use it.

What does databasez support at the moment¶

Databasez currently supports nearly all async drivers of sqlalchemy.

If this is not enough there are two special dialects with restricted features:

jdbc: can load nearly any jdbc driver
dbapi2: can load nearly any dbapi2 driver (python standard), async as well as sync.

Driver installation¶

You can install the required database drivers with:

Postgres¶

$ pip install databasez[asyncpg]

MySQL/MariaDB¶

$ pip install databasez[aiomysql]

or

$ pip install databasez[asyncmy]

SQLite¶

$ pip install databasez[aiosqlite]

MSSQL¶

$ pip install databasez[aioodbc]

Note

Note that if you are using any synchronous SQLAlchemy functions such as engine.create_all() or alembic migrations then you still have to install a synchronous DB driver: psycopg for PostgreSQL, pymysql for MySQL and pyodbc for SQL Server.

Quickstart¶

For a simple quickstart example, we will be creating a simple SQLite database to run some queries against.

First, install the required drivers for SQLite and ipython. The ipython is to have an interactive python shell with some extras. IPython also supports await, which is exactly what we need. See more details about it.

Install the required drivers

$ pip install databases[aiosqlite]
$ pip install ipython

Now from the console, we can run a simple example.

# Create a database instance, and connect to it.
import copy

from databasez import Database

# non captured arguments are passed through to create_async_engine
database = Database("sqlite+aiosqlite:///example.db", echo=True)
await database.connect()

# Create a table.
query = """CREATE TABLE HighScores (id INTEGER PRIMARY KEY, name VARCHAR(100), score INTEGER)"""
await database.execute(query=query)

# Insert some data.
query = "INSERT INTO HighScores(name, score) VALUES (:name, :score)"
values = [
    {"name": "Daisy", "score": 92},
    {"name": "Neil", "score": 87},
    {"name": "Carol", "score": 43},
]
await database.execute_many(query=query, values=values)

# Run a database query.
query = "SELECT * FROM HighScores"
rows = await database.fetch_all(query=query)

print("High Scores:", rows)

# new Database object with the same parameters required? No problem, we can copy:
database2 = copy.copy(database)
# or
database2 = Database(database)
await database2.connect()
await database2.disconnect()
assert database.is_connected == True

Check out the documentation on making database queries for examples of how to start using databases together with SQLAlchemy core expressions.