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.

Documentation

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

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.4.35)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for thekevinscott from gravatar.com thekevinscott

Credits

Author: Kevin Scott

License expression

MIT
View SPDX License List

Requires

Python >=3.10

Tags

sql filesystem directory sqlite index

Report project as malware

Download files

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

Source Distribution

dirsql-0.4.23.tar.gz (420.8 kB view details)

Uploaded Source

Built Distributions

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

dirsql-0.4.23-cp310-abi3-win_amd64.whl (2.9 MB view details)

Uploaded CPython 3.10+Windows x86-64

dirsql-0.4.23-cp310-abi3-manylinux_2_28_x86_64.whl (2.9 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ x86-64

dirsql-0.4.23-cp310-abi3-manylinux_2_28_aarch64.whl (2.7 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.28+ ARM64

dirsql-0.4.23-cp310-abi3-macosx_11_0_arm64.whl (2.5 MB view details)

Uploaded CPython 3.10+macOS 11.0+ ARM64

dirsql-0.4.23-cp310-abi3-macosx_10_12_x86_64.whl (2.7 MB view details)

Uploaded CPython 3.10+macOS 10.12+ x86-64

File details

Details for the file dirsql-0.4.23.tar.gz.

File metadata

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

File hashes

Hashes for dirsql-0.4.23.tar.gz
Algorithm Hash digest
SHA256 83c0b39235fba304ae2bfcf8da345d077a138da5165defc542e1e8630ad55d8e
MD5 b5cbc1e11926e89cb03815327a552b55
BLAKE2b-256 c06f021f977dd746cca3f89b388f62e8351c93f0b5a4b1986c22f50e82f0e29e

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23.tar.gz:

Publisher: release.yml on thekevinscott/dirsql

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

File details

Details for the file dirsql-0.4.23-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: dirsql-0.4.23-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: CPython 3.10+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dirsql-0.4.23-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 0beca123e51dc087b68561db510b368aa1f3f4ef56a7fdc5a4ce4fa0941d47c3
MD5 83743cbd7d17a0faead7a63ea49e0975
BLAKE2b-256 91220844142ddce1a6e5a35d16d5ba957c3965fec7441a05d99552b80e39f0cd

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23-cp310-abi3-win_amd64.whl:

Publisher: release.yml on thekevinscott/dirsql

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

File details

Details for the file dirsql-0.4.23-cp310-abi3-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.23-cp310-abi3-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 a27b9b1e9efdfaad33e1ae6391a1fa31b501f71ebd519d15d2e23c5486643e06
MD5 840862a50b18d8d714d85a0e497e971b
BLAKE2b-256 08bcbae4ce7ce19415e15962fa358e4c521f69a6646da8b0fd867c1074225bd2

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23-cp310-abi3-manylinux_2_28_x86_64.whl:

Publisher: release.yml on thekevinscott/dirsql

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

File details

Details for the file dirsql-0.4.23-cp310-abi3-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.23-cp310-abi3-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 c324c3d269b27113e69058dde395ca38e85c19d2f7e7b04afda0453505983a75
MD5 50b265bd207e58d85491c5572a6a59c1
BLAKE2b-256 c8d712cc0b4214165dcf14c0bc923f871ec3e025eb8d724cbbcaa601548f7530

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23-cp310-abi3-manylinux_2_28_aarch64.whl:

Publisher: release.yml on thekevinscott/dirsql

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

File details

Details for the file dirsql-0.4.23-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.23-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f65e02eb601d5a5dd78e26c965171c014bcfb9936b1a4c9d4b221970a5da6029
MD5 527abc0e86f1bb0f9a14e289e3afd80e
BLAKE2b-256 d0b7c86c448b9d70e603082dc7b6df373579dcb9e5446e41012b318a1023305b

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23-cp310-abi3-macosx_11_0_arm64.whl:

Publisher: release.yml on thekevinscott/dirsql

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

File details

Details for the file dirsql-0.4.23-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.23-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8e6228ac945b7e5afc5ea493466bc1e239bd9a9f26e0f89ea0d56423073f4b54
MD5 47ffffed3662f8e2dcb12b122d5e5cea
BLAKE2b-256 9f8ab399e08fe289b8b7e73137f2f65a7e3704bbb463c6960861ff0c5f85045e

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.23-cp310-abi3-macosx_10_12_x86_64.whl:

Publisher: release.yml on thekevinscott/dirsql

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.4.35

6 files

0.4.34

6 files

0.4.33

6 files

0.4.32

6 files

0.4.31

6 files

0.4.30

6 files

0.4.29

6 files

0.4.28

6 files

0.4.27

6 files

0.4.26

6 files

0.4.25

6 files

0.4.24

6 files

This release

0.4.23 This release

6 files

0.4.22

6 files

0.4.21

6 files

0.4.20

6 files

0.4.19

6 files

0.4.18

6 files

0.4.17

6 files

0.4.16

6 files

0.4.15

6 files

0.4.14

6 files

0.4.13

6 files

0.4.12

6 files

0.4.11

6 files

0.4.10

6 files

0.4.9

6 files

0.4.8

6 files

0.4.7

6 files

0.4.6

6 files

0.4.5

6 files

0.4.4

6 files

0.4.3

6 files

0.4.2

6 files

0.4.1

6 files

0.4.0

6 files

0.3.127

6 files

0.3.126

6 files

0.3.125

6 files

0.3.124

6 files

0.3.123

6 files

0.3.122

6 files

0.3.121

6 files

0.3.120

6 files

0.3.119

6 files

0.3.118

6 files

0.3.101

6 files

0.3.100

6 files

0.3.99

6 files

0.3.98

6 files

0.3.97

6 files

0.3.96

6 files

0.3.95

6 files

0.3.94

6 files

0.3.93

6 files

0.3.92

6 files

0.3.91

6 files

0.3.90

6 files

0.3.89

6 files

0.3.88

6 files

0.3.87

6 files

0.3.86

6 files

0.3.85

6 files

0.3.84

6 files

0.3.83

6 files

0.3.82

6 files

0.3.81

21 files

0.3.80

21 files

0.3.79

21 files

0.3.78

21 files

0.3.77

21 files

0.3.76

21 files

0.3.75

21 files

0.3.74

21 files

0.3.73

21 files

0.3.72

21 files

0.3.71

21 files

0.3.70

21 files

0.3.69

21 files

0.3.67

21 files

0.3.66

21 files

0.3.65

21 files

0.3.64

21 files

0.3.63

21 files

0.3.62

21 files

0.3.61

21 files

0.3.60

21 files

0.3.59

21 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