ZipponDB/docs/index.md
2025-01-30 21:21:02 +01:00

57 lines
2.0 KiB
Markdown

# ZipponDB: A Lightweight Database in Zig
<style>
.md-content .md-typeset h1 { display: none; }
</style>
<p align="center">
<a href="/ZipponDB"><img src="images/banner.png" alt="ZipponDB"></a>
</p>
<p align="center">
<em>Minimalist Database written in Zig</em>
</p>
---
**Documentation**: <a href="/ZipponDB" target="_blank">https://mrbounty.github.io/ZipponDB</a>
**Source Code**: <a href="https://github.com/MrBounty/ZipponDB" target="_blank">https://github.com/MrBounty/ZipponDB</a>
---
ZipponDB is a database built from the ground up in Zig, with zero external dependencies. Designed for simplicity,
performance, and portability, it's almost usable for small to
medium applications that want a quick and simple database.
## Key Features
* **Small Binary:** ~300kb.
* **Fast:** Parse millions of entities in milliseconds.*
* **Relationship:** Build with focus on easy relationship.
* **Query Language:** Use it's own stupid query language.
* **No dependencies:** Depend on nothing, every line of code running is in the codebase and written for ZipponDB.
* **Open-source:** Open-source under MIT licence.
<small>* Check <a href="/Benchmark">benchmark</a>.</small>
### Planned
* **Interface:** Small package to interact with ZipponDB from different programming language.
* **Single file:** Like SQLite, ZipponDB's database aim to be a single file.
* **Schema migration:** Update dynamically database schema.
* **Custom index:** Speed up query with custom indexing.
* **Safety and Performance:** Improve general safty and performance.
<small>More info in the Roadmap.</small>
### Maybe
Those are idea for very long term with 0 promesse, maybe as extension.
* **Web interface:** Similare to EdgeDB, getting a webapp to query and config the DB.
* **HTTP server:** Be able to start a simple HTTP server and send json.
* **Auth:** Be able to auth users, maybe third-party OAuth.
* **Per user database:** Like Turso.
* **Performace:** I'm sure I can do better.
* **Client side database:** Run it on the client side with WASM.