ravener/luvel

A LevelDB wrapper for LuaJIT and Luvit

Luvel

luvel is a LuaJIT FFI wrapper for leveldb

Install

luvel only runs on LuaJIT and Luvit.

If you are using LuaJIT just copy the luvel.lua file into your project.

If you are using luvit then you may install the lit package:

$ lit install ravener/luvel

Usage

local luvel = require("luvel")
local db = luvel.open("database", { createIfMissing = true })

-- Putting keys
db:put("key", "value")
db:put("another", "two")

-- Getting keys
print(db:get("key"))

-- Iterators
for k, v in pairs(db) do
  print(k, v)
end

-- Close the database.
db:close()

See also the full documentation

TODO

The library is usable, although I'm still cleaning it up and things are bound to change a lot.

Here's a list of things left to do:

• Snapshots support
• Support more options
• More documentation
• Tests

And more, expect it to be stable after a 1.0.0 release. In the meantime sending feedback regarding the design will help a lot.

License

Released under MIT License

The initial code started as a modification of Codezerker/lua_leveldb but has since evolved into a much higher level wrapper.

luvel's Issues

Iterator:key() and Iterator:value()?

Maybe for more flexible use of iterators, one may not always need both key and value so exposing a seperate key function that returns the current key and a value function returning the current value may optimize some large iterators. Maybe they prefer to read the value after checking the key for example.

How is that?

Snapshots

Add support for database snapshots.

Remove db:each and db:newIteratorWith

Functions existed from the original library, I don't think we need these anymore.

db:each is no longer needed due to __pairs

And they were mostly there to make it easy to manage the memory since they clean up after executing user's callback. No longer needed because we have __gc for auto clean up.

Fix __gc

__gc on tables is not supported on Lua 5.1.

Switch the datatypes to use ffi.metatype which allows us to attach a metatable that supports __gc

Read options

Currently wherever a read options object is expected is just a placeholder, no actual options can be passed.

Support these options.

Support more database options

There are more database options that can be tweaked, support them all.