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.8.0.tar.gz (103.1 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.8.0-py3-none-any.whl (21.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sqlalchemy_dqlite-0.8.0.tar.gz
  • Upload date:
  • Size: 103.1 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.8.0.tar.gz
Algorithm Hash digest
SHA256 d34dc1884fd39e301156d6d7a7c0440ae5f1bccc0a681069727cdcf4550ce24d
MD5 76df6b8e7ca8b7d2ff057fb0f0f761b1
BLAKE2b-256 c40bc360b69e9154447d6f57fbc73245833777e43dee01655589f09b23c33565

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_dqlite-0.8.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.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sqlalchemy_dqlite-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a3522364839a0771740bf757ebadd55f2333143d47682d049dc58343abdca8f
MD5 7719dd3b240b057e6e4f19d7661e1803
BLAKE2b-256 95d75e61cb00f6cd72057292136328f1daf43830caceb1fef1cd0f0a32dfb020

See more details on using hashes here.

Provenance

The following attestation bundles were made for sqlalchemy_dqlite-0.8.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

This release

0.8.0 This release

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

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