You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-4Lines changed: 20 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@ SariDB is a minimalist, file-reconstructible key-value database. It can be embed
19
19
-**Concurrency First:** SariDB provides built-in concurrency safety mechanisms, allowing multiple threads to operate on the database simultaneously without compromising data consistency.
20
20
21
21
## Usage Example
22
-
(Subject to change)
22
+
23
+
### Embedded Example
23
24
24
25
```java
25
26
SariDB sariDB =SariDB
@@ -28,12 +29,27 @@ SariDB sariDB = SariDB
28
29
.filePath("path/to/db.parquet") // Save your .parquet wherever!
29
30
.reconstruct(false) // Reconstruct or start anew?
30
31
.build(); // That's all folks.
31
-
sariDB.start(); // 🚀
32
+
33
+
sariDB.set("key", "someValue")
34
+
sariDB.get("key") // returns "someValue"
35
+
```
36
+
37
+
### Standalone Example
38
+
```java
39
+
SariDB sariDB =SariDB
40
+
.builder()
41
+
.isEmbedded(true) // Embedded or standalone?
42
+
.filePath("path/to/db.parquet") // Save your .parquet wherever!
43
+
.reconstruct(false) // Reconstruct or start anew?
44
+
.portNumber(1337) // Set the port number..
45
+
.build(); // ..And that's all folks!
46
+
sariDB.start(); // Listening on port 1337 🚀!
47
+
32
48
```
33
49
34
50
35
-
## Add to your project (NOT YET IMPLEMENTED -- SOON!)
36
-
## Downloads
51
+
## Add to your project (NOT YET IMPLEMENTED)
52
+
###Downloads
37
53
38
54
[Download latest version (Not yet implemented)](https://google.com) or add to `pom.xml`:
0 commit comments