Skip to content

Commit d553e31

Browse files
authored
Merge pull request #22 from tidesdb/kornev/fix_readme_master
readme: fix readme based on current implementation
2 parents 7b42769 + 6662ec4 commit d553e31

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,35 @@ a copy of TidesDB
1010

1111
```bash
1212
git clone https://github.com/tidesdb/tidesdb.git
13+
14+
```
15+
Build it and install
16+
```bash
17+
cd tidesdb
18+
cmake -DTIDESDB_WITH_SANITIZER=OFF -S . -B build && make -C build/
19+
sudo cmake --install build
20+
```
21+
22+
Build Lua library
23+
```bash
1324
git clone https://github.com/tidesdb/tidesdb-lua.git
1425
cd tidesdb-lua
15-
cmake --debug-output -S . -B build
16-
cd build
17-
make
26+
cmake -S . -B build && make -C build/
1827
```
1928
As a result libtidesdb_lua.so library is built
2029
#### Basic operations
2130

2231
```lua
2332
-- Open lua wrapper library
24-
local db = require("libtidesdb_lua")
33+
local lib = require("libtidesdb_lua")
2534

2635
-- Open a TidesDB database
27-
local code, message = db.open("my_db")
36+
local code, message, db = lib.open("my_db")
2837
--assert error codes for failures
2938
assert(code == 0, message)
3039

3140
-- Create a column family
32-
code, message = db.create_column_family(
41+
code, message = db:create_column_family(
3342
"my_column_family",
3443
1024*1024*64, -- Flush threshold (64MB)
3544
12, -- Max level skip list, if using hash table is irrelevant
@@ -40,16 +49,16 @@ code, message = db.create_column_family(
4049
)
4150

4251
-- Put key-value pair into the database
43-
code, message = db.put("my_column_family", "key", "value", 3600)
52+
code, message = db:put("my_column_family", "key", "value", 3600)
4453

4554
-- Get the value for the key
46-
code, message, value = db.get("my_column_family", "key")
55+
code, message, value = db:get("my_column_family", "key")
4756

4857
-- Delete the key-value pair
49-
db.delete("my_column_family", "key")
58+
db:delete("my_column_family", "key")
5059

5160
--- Close the database
52-
db.close()
61+
lib.close(db)
5362
```
5463

5564
#### Test lua wrapper-library

0 commit comments

Comments
 (0)