tidesdb-lua

Official Lua binding for TidesDB

Setup

This is a Lua wrapper library for TidesDB therefore first you need a copy of TidesDB

git clone https://github.com/tidesdb/tidesdb.git
git clone https://github.com/tidesdb/tidesdb-lua.git
cd tidesdb-lua
cmake --debug-output  -S . -B build
cd build
make

As a result libtidesdb_lua.so library is built

Basic operations

-- Open lua wrapper library
local db = require("libtidesdb_lua")

-- Open a TidesDB database
local code, message = db.open("my_db")
--assert error codes for failures
assert(code == 0, message)

-- Create a column family
code, message = db.create_column_family(
    "my_column_family", 
    1024*1024*64,    -- Flush threshold (64MB)
    12,              -- Max level skip list, if using hash table is irrelevant
    0.24,            -- Probability skip list, if using hash table is irrelevant
    true,            -- Enable compression
    db.COMPRESS_SNAPPY, -- Compression algorithm can be NO_COMPRESSION, COMPRESS_SNAPPY, COMPRESS_LZ4, COMPRESS_ZSTD
    true,               -- Enable bloom filter
    db.TDB_MEMTABLE_SKIP_LIST, -- Use skip list for memtable
)

-- Put key-value pair into the database
code, message = db.put("my_column_family", "key", "value", 3600)

-- Get the value for the key
code, message, value = db.get("my_column_family", "key")

-- Delete the key-value pair
db.delete("my_column_family", "key")

--- Close the database
db.close()

Test lua wrapper-library

cd build
lua ../test_lua.lua