dirsql (Python SDK)
Ephemeral SQL index over a local directory. dirsql watches a filesystem, ingests structured files into an in-memory SQLite database, and exposes a SQL query interface -- the filesystem is always the source of truth.
Also available as dirsql on crates.io and dirsql on npm.
Installation
pip install dirsql
Requires Python >= 3.12. Ships as a native extension (Rust via PyO3); prebuilt binary wheels are provided for common platforms.
Quick start
DirSQL is async by default: the constructor returns immediately, scanning runs in a background thread, and you await db.ready() before querying. Each table is a (ddl, glob, extract) triple: the DDL defines the SQLite schema, the glob selects files (relative to the root), and extract turns a matched file into a list of row dicts. dirsql does not read file contents -- if extract needs the file body it reads path itself; return an empty list to skip a file.
import asyncio
import json
from dirsql import DirSQL, Table
async def main():
db = DirSQL(
"./my-blog",
tables=[
Table(
ddl="CREATE TABLE posts (title TEXT, author TEXT)",
glob="posts/*.json",
extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
),
],
)
await db.ready()
posts = await db.query("SELECT * FROM posts WHERE author = 'alice'")
print(posts)
asyncio.run(main())
Multiple tables and joins
db = DirSQL(
"./my-blog",
tables=[
Table(
ddl="CREATE TABLE posts (title TEXT, author_id TEXT)",
glob="posts/*.json",
extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
),
Table(
ddl="CREATE TABLE authors (id TEXT, name TEXT)",
glob="authors/*.json",
extract=lambda path: [json.loads(open(path, encoding="utf-8").read())],
),
],
)
await db.ready()
results = await db.query("""
SELECT posts.title, authors.name
FROM posts JOIN authors ON posts.author_id = authors.id
""")
Ignoring files
Pass ignore patterns to skip files during scanning and watching:
db = DirSQL(
"./my-blog",
ignore=["**/drafts/**", "**/.git/**"],
tables=[...],
)
Path-table scans (SELECT ... FROM './') respect .gitignore files by
default. Pass no_ignore=True to restore the full walk; the built-in
node_modules/.git defaults and any ignore patterns still apply:
db = DirSQL("./my-blog", no_ignore=True)
Loading SQLite extensions
Pass extensions to load SQLite extension shared libraries onto the connection at startup (before any CREATE TABLE). Each entry is a dict with a path and an optional entrypoint init-symbol override:
db = DirSQL(
"./my-blog",
tables=[...],
extensions=[
{"path": "./ext/vec0.dylib", "entrypoint": "sqlite3_vec_init"},
{"path": "./ext/myext.so"}, # entrypoint derived from the filename
],
)
await db.ready()
# The extension's functions are now callable in queries:
rows = await db.query("SELECT vec_version() AS v")
dirsql enables extension loading only while loading the configured libraries, then disables it again, so the SQL load_extension() function is never exposed to your queries. Programmatic entries load first, followed by any [[dirsql.extension]] entries declared in a config file. See the config reference.
Watching for changes
db.watch() returns an async iterator of row-level change events as files change on disk:
async for event in db.watch():
print(f"{event.action} on {event.table}: {event.row}")
if event.action == "error":
print(f" error: {event.error}")
Each event has .action ("insert", "update", "delete", or "error"), .table, .row (the new row, or the deleted row on delete), .old_row (the previous row, on update), .file_path, and .error (on error).
CLI
pip install dirsql also installs a dirsql console script. dirsql "<sql>" (or uvx dirsql "<sql>") runs one query and prints the rows as JSON — the default. dirsql server starts an HTTP server exposing the SDK over HTTP: POST /query for SQL and GET /events for a Server-Sent Events change stream. See the CLI reference.
License
MIT
1 maintainer
Release files for dirsql 0.4.54
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dirsql-0.4.54.tar.gz | 486.1 kB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| dirsql-0.4.54-cp310-abi3-win_amd64.whl | CPython 3.10 | abi3 | Windows x86-64 | Details |
| dirsql-0.4.54-cp310-abi3-manylinux_2_28_x86_64.whl | CPython 3.10 | abi3 | Linux glibc 2.28+ x86-64 | Details |
| dirsql-0.4.54-cp310-abi3-manylinux_2_28_aarch64.whl | CPython 3.10 | abi3 | Linux glibc 2.28+ ARM64 | Details |
| dirsql-0.4.54-cp310-abi3-macosx_11_0_arm64.whl | CPython 3.10 | abi3 | macOS 11.0+ ARM64 | Details |
| dirsql-0.4.54-cp310-abi3-macosx_10_12_x86_64.whl | CPython 3.10 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 15.9 MB
Release files / dirsql-0.4.54.tar.gz
| Download URL | dirsql-0.4.54.tar.gz |
|---|---|
| Size | 486.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
96268ebd8ec7366332cc5d10353cfd36108cf194776a9db47e20ed2307725d9f
|
|
BLAKE2b-256 checksum How to use checksums |
8e4ad8c25addef08b5c535d47dd523db92d365bdc99360ae7fa760545d5fd415
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / dirsql-0.4.54-cp310-abi3-win_amd64.whl
| Download URL | dirsql-0.4.54-cp310-abi3-win_amd64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.10 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
74c4d4aaebfc378a05b8c5d4ca15aa166f5c4e284c3cb6717d0bc98f07b5cc54
|
|
BLAKE2b-256 checksum How to use checksums |
56ff5d42609bcf97d9c93eb6c116539fbd42edcea0502737514a5cb80f07d57c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / dirsql-0.4.54-cp310-abi3-manylinux_2_28_x86_64.whl
| Download URL | dirsql-0.4.54-cp310-abi3-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
2318c75dc94cf4a9f7b9b27097b54aa274d2d05de04be9b9db19dfc9a948e2d6
|
|
BLAKE2b-256 checksum How to use checksums |
ececca065eecb826f4ce7ff7c3433eb8ae310563d94b31d953440d95d7a2a366
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / dirsql-0.4.54-cp310-abi3-manylinux_2_28_aarch64.whl
| Download URL | dirsql-0.4.54-cp310-abi3-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 3.1 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
a6d187ac8e5db10acf1e7f84e82cc927f9641ff65356d6bf0ae132b77ac738c7
|
|
BLAKE2b-256 checksum How to use checksums |
e91c889061a94ea21dbd273a71452f72aae2a1f0ed9e2f3c9bae2811da33cfae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / dirsql-0.4.54-cp310-abi3-macosx_11_0_arm64.whl
| Download URL | dirsql-0.4.54-cp310-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 2.9 MB |
| Tags | CPython 3.10 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ed4a098c774ac2aa8d0e94c2d43fe3bb145b6a3be524abdc72a01cb7125ecf10
|
|
BLAKE2b-256 checksum How to use checksums |
ef2c073198c777edff6142837353bff317c96df8153d95c301dc4bb99b5dab03
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency logRelease files / dirsql-0.4.54-cp310-abi3-macosx_10_12_x86_64.whl
| Download URL | dirsql-0.4.54-cp310-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 3.0 MB |
| Tags | CPython 3.10 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
d96498b4232ce2e47473f0adbaac3d99b6ba1c9798041e69878b2f1934443c44
|
|
BLAKE2b-256 checksum How to use checksums |
71494be01014812152e2a27a03301b18e5464cce74a934114b516eed3b91b66a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 20, 2026.
Transparency log
