A bit better docs README

2025-01-12 01:41:42 +01:00
parent 67546d69a9
commit 83ff27c3f2
4 changed files with 72 additions and 37 deletions
@@ -1,6 +1,59 @@
+# Benchmark
+
 ***Benchmark are set to quicly evolve. I have currently multiple ideas to improve perf***

-# Intro
+## Command
+
+You can run `zig build benchmark` if you clone the repo to benchmark your machine.
+
+Here an example on my machine:
+
+```
+=====================================
+
+Populating with 500000 users.
+Populate duration: 8.605314 seconds
+
+Database path: benchmark
+Total size: 50.99Mb
+LOG: 0.00Mb
+BACKUP: 0.00Mb
+DATA: 50.93Mb
+  User: 50.92683124542236Mb 500000 entities
+
+--------------------------------------
+
+Query:          GRAB User {}
+Duration:       457.758686 ms
+
+Query:          GRAB User [1] {}
+Duration:       1.285849 ms
+
+Query:          GRAB User [name] {}
+Duration:       138.041888 ms
+
+Query:          GRAB User {name = 'Charlie'}
+Duration:       63.094060 ms
+
+Query:          GRAB User {age > 30}
+Duration:       335.654647 ms
+
+Query:          GRAB User {bday > 2000/01/01}
+Duration:       52.896498 ms
+
+Query:          GRAB User {age > 30 AND name = 'Charlie' AND bday > 2000/01/01}
+Duration:       56.295173 ms
+
+Query:          GRAB User {best_friend IN {name = 'Charlie'}}
+Duration:       69.165272 ms
+
+Query:          DELETE User {}
+Duration:       93.530622 ms
+
+=====================================
+```
+
+## File Parsing

 In this example I create a random dataset of Users using this schema:
 ```lua
@@ -21,13 +74,13 @@ Here a user example:
 run "ADD User (name = 'Diana Lopez',age = 2,email = 'allisonwilliams@example.org',scores=[37 85 90 71 88 85 68],friends = [],bday=1973/11/13,last_order=1979/07/18-15:05:26.590261,a_time=03:04:06.862213)
 ```

-First let's do a query that parse all file but dont return anything, so we have the time to read and evaluate file but not writting and sending output.
+Let's do a query that parse all file but dont return anything, so we have the time to read and evaluate file but not writting and sending output.
 ```lua
 run "GRAB User {name = 'asdfqwer'}"
 ```

 ## 50 000 000 Users
-This take 6.24GB space on disk, seperated into xx files of xx MB
+This take 6.24GB space on disk.

 | Thread | Time (s) | Usage (%) |
 | --- | --- | --- |
@@ -58,10 +111,3 @@ This take 127MB space on disk, sperated into 24 files of 5.2MB

 ![Chart](images/time_usage_per_thread_1_000_000.png)

-## TODO
-
- [ ] Benchmark per files size, to find the optimal one. For 10kB, 5MB, 100MB, 1GB
- [ ] Create a build command to benchmark. For 1_000, 1_000_000, 50_000_000 users
-    - [ ] Create a random dataset
-    - [ ] Do simple query, get average and +- time by set of 25 query
-    - [ ] Return the data to do a chart
@@ -22,7 +22,7 @@
 #### v0.3 - QoL 
 - [X] Docs website
 - [ ] Schema migration   
- [ ] Dump/Bump data  
+- [~] Dump/Bump data  
 - [ ] Recovery
 - [ ] Better CLI
 - [ ] Linked query  
@@ -53,6 +53,7 @@
 ### Gold
 #### v0.8 - Advanced  
 - [ ] Query optimizer  
+- [ ] Single file

 #### v0.9 - Docs  
 - [ ] ZiQL tuto