Skip to main content

Databasic

A small async database interface built on SQLAlchemy Core and psycopg. PostgreSQL is the only supported database.

SQLAlchemy Core handles query construction and compilation. Databasic handles connection and transaction lifetimes and executes the resulting queries directly through psycopg.

SQLAlchemy bind processors convert input values for psycopg, including JSON/JSONB values and custom TypeDecorator bind processing. Returned values are decoded by psycopg; SQLAlchemy result processors are not applied.

Keep one Databasic instance and its connection pool open for the lifetime of your application. Open separate sessions as needed for individual units of work; each session borrows a connection from the pool, runs a transaction, and returns the connection when it exits. Close the pool when the application shuts down.

Installation

uv add databasic

# or

pip install databasic

Quickstart

You need Python 3.11 or newer and Docker/Podman. Run the following commands from the root of a local checkout of this repository.

1. Install Databasic

python3 -m venv .venv
source .venv/bin/activate
python -m pip install .

2. Start PostgreSQL

Start a disposable local database (port 5432 must be available):

docker run --name databasic-quickstart \
  -e POSTGRES_USER=databasic \
  -e POSTGRES_PASSWORD=databasic \
  -e POSTGRES_DB=databasic \
  -p 127.0.0.1:5432:5432 \
  -d postgres:17

until docker exec databasic-quickstart pg_isready -U databasic -d databasic; do
  sleep 1
done

These credentials are for local development only.

3. Create a table, insert a row, and read it back

Save this as quickstart.py:

import asyncio

import sqlalchemy as sa

from databasic import Databasic


users = sa.Table(
    "quickstart_users",
    sa.MetaData(),
    sa.Column("id", sa.Integer, primary_key=True),
    sa.Column("name", sa.Text, nullable=False),
)


async def main():
    async with Databasic(
        "postgresql://databasic:databasic@localhost:5432/databasic"
    ) as db:
        async with db.session() as session:
            await session.execute(sa.schema.CreateTable(users, if_not_exists=True))
            inserted = await session.fetch_one(
                users.insert().values(name="Alice").returning(users.c.id)
            )
            assert inserted is not None

        # The first session has committed. Read the row in a new transaction.
        async with db.session() as session:
            user = await session.fetch_one(
                users.select().where(users.c.id == inserted["id"])
            )
            print(user)


if __name__ == "__main__":
    asyncio.run(main())

Run it:

python quickstart.py

On a fresh database, the output is:

{'id': 1, 'name': 'Alice'}

Each run inserts another row, so its ID will increase. The table is created by CreateTable, not by defining the SQLAlchemy Table object. Sessions commit on successful exit and roll back on exceptions; the outer async with closes the connection pool when the program finishes.

4. Clean up

When you are done, remove the container and its database storage:

docker rm -fv databasic-quickstart

Usage

import sqlalchemy as sa

from databasic import Databasic

users = sa.Table(
    "users",
    sa.MetaData(),
    sa.Column("id", sa.Integer, primary_key=True),
    sa.Column("name", sa.Text, nullable=False),
)

db = Databasic("postgresql://user:password@localhost/database")

async with db:
    async with db.session() as session:
        rows = await session.fetch_all(
            users.select().where(users.c.name == "Alice")
        )

Databasic can also be connected and disconnected explicitly. Both forms have the same semantics; explicit lifecycle management is useful when the lifetime is controlled by an application or framework.

db = Databasic("postgresql://user:password@localhost/database")

await db.connect()

try:
    async with db.session() as session:
        rows = await session.fetch_all(users.select())
finally:
    await db.disconnect()

A session is a transaction. It commits when the context exits successfully and rolls back when it exits with an exception.

A previously closed database cannot be reused. This will throw an exception.

db = Databasic("postgresql://user:password@localhost/database")

async with db:
    pass

# Will throw an exception.
async with db:
    pass

API

Databasic

db = Databasic(conninfo, force_rollback=False)

connect()

Open the connection pool.

await db.connect()

disconnect()

Close the connection pool.

await db.disconnect()

session()

Create a transactional session.

async with db.session() as session:
    ...

Successful exit commits the transaction. An exception rolls it back.

Session

execute()

Execute a statement without returning rows. Returns an int containing the number of rows affected, or -1 if the row count cannot be determined (for example, for DDL statements).

rows_affected = await session.execute(
    users.insert().values(name="Alice")
)
assert rows_affected == 1

execute_many()

Execute the same statement multiple times with different parameters. Returns an int containing the total number of rows affected across all executions, or -1 if the row count cannot be determined.

query = users.insert().values(
    name=sa.bindparam("name"),
)

rows_affected = await session.execute_many(
    query,
    [
        {"name": "Alice"},
        {"name": "Bob"},
    ],
)
assert rows_affected == 2

The statement must define its values using explicit bind parameters. Values are supplied exclusively through the parameter mappings. Expanding parameters (such as variable-length IN lists) and literal-execute parameters are not supported by execute_many().

fetch_one()

Execute a statement and return one row, or None if there is no row.

user = await session.fetch_one(
    users.select().where(users.c.id == 1)
)

A row is simply a dict[str, Any]:

{"id": 1, "name": "Alice"}

There is no result or row wrapper.

fetch_all()

Execute a statement and return all rows as a list of dictionaries.

users = await session.fetch_all(
    users.select()
)

The result has the shape:

[
    {"id": 1, "name": "Alice"},
    {"id": 2, "name": "Bob"},
]

transaction()

Create a nested transaction within the current session.

async with db.session() as session:
    await session.execute(
        users.insert().values(name="Alice")
    )

    async with session.transaction():
        await session.execute(
            users.insert().values(name="Bob")
        )

Nested transactions use database savepoints. An exception rolls back the nested transaction. Catch it within the outer session to preserve earlier work; otherwise, it also causes the session to roll back.

Testing

force_rollback=True runs all sessions within an outer transaction that is rolled back when Databasic is disconnected.

async with Databasic(
    "postgresql://user:password@localhost/test_database",
    force_rollback=True,
) as db:
    ...

This allows integration tests to use normal sessions and transactions without leaving persistent database state.

Metadata

Release files for databasic 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for databasic 0.3.0
File Size Uploaded
databasic-0.3.0.tar.gz 7.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for databasic 0.3.0
File Interpreter ABI Platform
databasic-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 14.7 kB

Release files / databasic-0.3.0.tar.gz

Download URL databasic-0.3.0.tar.gz
Size 7.2 kB
Tags Source
SHA-256 checksum
How to use checksums
7e5dcb984f1814638dd3cdc9f81b4abce8515f0915fc0d2da9f0cec97ec356e5
BLAKE2b-256 checksum
How to use checksums
3232e062256213c00d8b0b95a00bf5da5d258f08f6689272355a126e327fd2f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / databasic-0.3.0-py3-none-any.whl

Download URL databasic-0.3.0-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a3c3aee473e296df6d260aebca6a7dfe36c0ba2dfbf6c5307a0218f007fb3497
BLAKE2b-256 checksum
How to use checksums
65b3fb3de76aa6a471acc0d4c57eac5bf6cddd14850f7441e9760dab2735eae2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

1.0.0

2 release files

This release

0.3.0 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page