adrien/ZipponDB
1
0
Fork 0
Code Actions Releases Activity

Small doc update

Browse Source
This commit is contained in:
Adrien Bouvais 2025-01-23 17:31:55 +01:00
parent b2bd1e373b
commit c3db03fe4c
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/Benchmark.md
View File

@ -53,8 +53,16 @@ Duration: 93.530622 ms
=====================================
```
## Cloud
I started to benchmark using fly.io
Using a 1x shared cpu I get around 40ms to parse and write 5000 users, not bad.
## File Parsing
The majority of time taken by query come more from writting the response rather than parsing files.
In this example I create a random dataset of Users using this schema:
```lua
User (

7
docs/index.md
View File

@ -19,27 +19,30 @@
---
ZipponDB is a relational database built from the ground up in Zig, with zero external dependencies. Designed for simplicity,
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 is small, ~200kb for small and ~3Mb for fast.
* **Small Binary:** ~300kb.
* **Fast:** Parse millions of entities in milliseconds.
* **Relationship:** Build with focus on easy relationship.
* **Query Language:** Use it's own simple 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.
* **Portable:** Easily compiled and deployed across various platforms.*
* **Low memory and safe:** Low memory footprint. (~8Mb / 100k entities)**.
<small>* Plan for more platforms like arm, 32 bit system.</small>
<small>** Plan for optimizations.</small>
### After
* **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>

2
docs/ziql/add.md
View File

@ -27,8 +27,6 @@ ADD User
('Bob2', 33, 'bob2@email.com', [])
```
## Soon
* Default value
* Array default is empty
* Link default is none