https://github.com/visorcraft/grexa-db
Flat-file database engine: records are files, joins are directories of symlinks
https://github.com/visorcraft/grexa-db
Last synced: 1 day ago
JSON representation
Flat-file database engine: records are files, joins are directories of symlinks
- Host: GitHub
- URL: https://github.com/visorcraft/grexa-db
- Owner: visorcraft
- License: apache-2.0
- Created: 2026-06-19T00:08:48.000Z (11 days ago)
- Default Branch: master
- Last Pushed: 2026-06-19T00:28:04.000Z (11 days ago)
- Last Synced: 2026-06-19T02:17:34.881Z (11 days ago)
- Language: Rust
- Size: 68.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grexa-db
A flat-file database engine where records are plain files in a directory tree
and relational joins materialize as directories of symlinks. The filesystem is
the interface: any tool that reads files (`rg`, `grep`, editors, file managers)
is a client without knowing the database exists.
> Extracted from the [Grexa](https://github.com/visorcraft/grexa) workspace into
> its own repository so it can be embedded standalone. `Apache-2.0`, so it stays
> usable in proprietary applications.
## Workspace layout
| Crate | What |
|-------|------|
| [`crates/grexa-db`](crates/grexa-db) | The engine (library). See its [README](crates/grexa-db/README.md) for the quick start. |
| [`crates/grexa-db-cli`](crates/grexa-db-cli) | `grexa-db-cli` — standalone CLI over a database directory. |
## Use it as a dependency
```toml
# Git dependency, pinned to a tag:
grexa-db = { git = "https://github.com/visorcraft/grexa-db", tag = "v1.9.1" }
```
## Docs
- [`docs/grexa-db-design.md`](docs/grexa-db-design.md) — full design spec:
storage layout, schema format, field types, query API, view materialization,
concurrency model, reference-path safety.
- [`docs/grexa-db-implementation-plan.md`](docs/grexa-db-implementation-plan.md)
— phase status, what's done, what's deferred.
- [`docs/grexa-db-scaling-rnd.md`](docs/grexa-db-scaling-rnd.md) — scaling R&D:
the parallel scan, the held secondary index, and the measured numbers.
## Build
```bash
cargo build
cargo test
```
## License
`Apache-2.0` — see [LICENSE](LICENSE).