Skip to main content

sqlalchemy-dqlite

A SQLAlchemy 2.0 dialect for dqlite, Canonical's distributed SQLite. Point SQLAlchemy (and Alembic, and most ORMs built on it) at a dqlite cluster with a dqlite:// URL and use it like any other backend.

It supports both the synchronous and the async SQLAlchemy engines, and builds on dqlite's SQLite roots, so SQLAlchemy treats it as a SQLite-family dialect.

Is this the package you want?

Yes, if you use SQLAlchemy or an ORM/migration tool on top of it (Alembic, Flask-SQLAlchemy, etc.) and want it backed by dqlite. If you want a plain database driver without SQLAlchemy, use dqlite-dbapi.

Installation

pip install sqlalchemy-dqlite

Requires Python 3.13+ and SQLAlchemy 2.0+.

Usage

from sqlalchemy import create_engine, text

engine = create_engine("dqlite://localhost:9001/mydb")
with engine.connect() as conn:
    print(conn.execute(text("SELECT 1")).fetchone())

Async:

from sqlalchemy.ext.asyncio import create_async_engine

engine = create_async_engine("dqlite+aio://localhost:9001/mydb")
async with engine.connect() as conn:
    result = await conn.execute(text("SELECT 1"))
    print(result.fetchone())

URL format: dqlite://host:port/database (or dqlite+aio://… for async). The host:port is the bootstrap node — the cluster is discovered from there. See Connection URL for details.

The dqlite Python stack

This is the top of four layered packages. Each builds on the one below:

Package Role
sqlalchemy-dqlite — this package SQLAlchemy 2.0 dialect
dqlite-dbapi PEP 249 (DB-API 2.0) driver — sync & async
dqlite-client Async wire client — pooling, leader discovery
dqlite-wire Wire-protocol codec

Documentation

  • Transactions — SQLAlchemy owns BEGIN/COMMIT; no AUTOCOMMIT.
  • Connection URL — URL format, the bootstrap address, and query parameters.
  • Limitations & notes — STRICT tables, savepoint naming, and a server-version NULL gotcha.

Development

See DEVELOPMENT.md for setup, contribution guidelines, and how to run the SQLAlchemy compliance test suite.

License

MIT

Download files

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

Source Distribution

sqlalchemy_dqlite-0.5.0.tar.gz (233.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sqlalchemy_dqlite-0.5.0-py3-none-any.whl (48.7 kB view details)

Uploaded Python 3

File details

Details for the file sqlalchemy_dqlite-0.5.0.tar.gz.

File metadata

  • Download URL: sqlalchemy_dqlite-0.5.0.tar.gz
  • Upload date:
  • Size: 233.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for sqlalchemy_dqlite-0.5.0.tar.gz
Algorithm Hash digest
SHA256 61ea183967c46fef863772de7fad43287eb7a8f4b3ec3a4ff30df6c490ac4965
MD5 4b7c9c7e4d7bdfd2ef78018fdf4820a4
BLAKE2b-256 0ab75159e08a72b607abb43f57bddadc48e7992fabfc7b2def0917cc829ddace

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_dqlite-0.5.0.tar.gz:

Publisher: publish-to-pypi.yml on letsdiscodev/sqlalchemy-dqlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sqlalchemy_dqlite-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_dqlite-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 59227c37214dcd4298b2629a618fc506c9a7750198e41ffa0ef7903301654b20
MD5 238b7c82c49a43dd6cfacb18391742c2
BLAKE2b-256 1fafcd63af89494c3b3e59ca2a9d2dbeeaf377c0b54081ce8e12896d9bc9aa26

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_dqlite-0.5.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on letsdiscodev/sqlalchemy-dqlite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

This release

0.5.0 This release

2 files

0.4.0

2 files

0.3.0

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 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