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.18.tar.gz (404.1 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.18-cp310-abi3-win_amd64.whl (2.8 MB view details)

Uploaded CPython 3.10+Windows x86-64

dirsql-0.4.18-cp310-abi3-manylinux_2_39_x86_64.whl (2.9 MB view details)

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

dirsql-0.4.18-cp310-abi3-manylinux_2_39_aarch64.whl (2.7 MB view details)

Uploaded CPython 3.10+manylinux: glibc 2.39+ ARM64

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

Uploaded CPython 3.10+macOS 11.0+ ARM64

dirsql-0.4.18-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.18.tar.gz.

File metadata

  • Download URL: dirsql-0.4.18.tar.gz
  • Upload date:
  • Size: 404.1 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.18.tar.gz
Algorithm Hash digest
SHA256 dd0dc24e8828e35f11f9a193654386436cd3f7030527a297d03137bb1631507f
MD5 ae2ee591fbc04627126727c37e3003e6
BLAKE2b-256 24e9b400fe1b44956384a95d5f3f0ac1ed306e721c0150f7114b269cc5227091

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18.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.18-cp310-abi3-win_amd64.whl.

File metadata

  • Download URL: dirsql-0.4.18-cp310-abi3-win_amd64.whl
  • Upload date:
  • Size: 2.8 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.18-cp310-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 71b02bf1a7d711708910d9a529e8f0fb386306e651371043bb8d0bad03208f67
MD5 a0865bf4c0903a7e0a6d0e1ea4f2b84e
BLAKE2b-256 3f635d2eecd3899eeebb82e052e43bbfe85b9588e0c3ecf98bbd2ec86133bba8

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18-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.18-cp310-abi3-manylinux_2_39_x86_64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.18-cp310-abi3-manylinux_2_39_x86_64.whl
Algorithm Hash digest
SHA256 a1e700fc062537e890c270cf1ad8f83052a6f30b8137ef236c3a538b0d9ba9dc
MD5 548cfbd76fa6518b4f777f373b052147
BLAKE2b-256 9ce1a42ec048e228cf1810a869d0ea083ed224941017c689c6da7e02df8bfbcf

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18-cp310-abi3-manylinux_2_39_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.18-cp310-abi3-manylinux_2_39_aarch64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.18-cp310-abi3-manylinux_2_39_aarch64.whl
Algorithm Hash digest
SHA256 1ac1a0cc1c85de693d6641b5d0c6663c9eb17495bcb5b5d7191c48a137932967
MD5 f752a70b59ece3001638cfd430e8cccb
BLAKE2b-256 20d5c995397cd809b9149e81b4ca3b2ffcac6102de7826270d3e921e5fbe523a

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18-cp310-abi3-manylinux_2_39_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.18-cp310-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.18-cp310-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 3cb76593e63414d505d85c808d03481702305a548f7de9d5ce87973bf343f875
MD5 e32cca9c100a208784ca71e4604bd181
BLAKE2b-256 695454807dbf7a0fced97a7108d2c8ee85f74ac21555b3a45159b8577eb57dae

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18-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.18-cp310-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for dirsql-0.4.18-cp310-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 d2a6731e9e7b9729d18ca6923559470eb581d2f4cdfcd889e379627e0760be6c
MD5 879d78df672abdfb09fcc7c187ea5a17
BLAKE2b-256 948c1f6d790bb31c7aac14e7cb7807b377779a2e1b87a638ba978686592fade6

See more details on using hashes here.

Provenance

The following attestation bundles were made for dirsql-0.4.18-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

0.4.23

6 files

0.4.22

6 files

0.4.21

6 files

0.4.20

6 files

0.4.19

6 files

This release

0.4.18 This release

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