KV Class

KV.set(key, value, ttl?)

Store a value. Optionally set TTL in seconds.

KV.set("user:1", { "name": "Alice" })
KV.set("temp", "data", 60)  # expires in 60 seconds

KV.get(key)

Retrieve a value. Returns null if key doesn't exist.

let user = KV.get("user:1")  # => { "name": "Alice" }

KV.delete(key)

Delete a key. Returns true if the key was removed.

KV.exists(key)

Check if a key exists. Returns Bool.

KV.keys(pattern?)

List keys matching a glob pattern. Default: "*"

let all = KV.keys()             # all keys
let users = KV.keys("user:*")  # keys starting with "user:"

KV.type(key)

Get the type of a key (string, list, set, hash, etc.).

KV.rename(key, newkey)

Rename a key.

KV.ttl(key)

Get remaining TTL in seconds. Returns null if key doesn't exist or has no expiry.

KV.expire(key, seconds)

Set TTL on an existing key. Returns true if successful.

KV.persist(key)

Remove TTL from a key (make it persistent). Returns true if successful.

KV.incr(key) / KV.decr(key)

Atomically increment or decrement by 1. Creates the key with value 0 if it doesn't exist.

KV.incr("visits")     # => 1
KV.incr("visits")     # => 2
KV.decr("visits")     # => 1

KV.incrby(key, amount) / KV.decrby(key, amount)

Increment or decrement by a specified amount. Returns the new value.

KV.incrby("score", 10)   # => 10
KV.decrby("score", 3)   # => 7

KV.lpush(key, ...values) / KV.rpush(key, ...values)

Push values to the head (left) or tail (right) of a list. Returns the new list length.

KV.rpush("queue", "job1")
KV.rpush("queue", "job2")
KV.lpush("queue", "priority")

KV.lpop(key) / KV.rpop(key)

Remove and return the first (left) or last (right) element.

KV.lrange(key, start, stop)

Get a range of elements. Use 0, -1 for all elements.

let all = KV.lrange("queue", 0, -1)

KV.llen(key)

Get the length of a list.

KV.sadd(key, ...members) / KV.srem(key, ...members)

Add or remove members from a set. Returns the number of elements added/removed.

KV.sadd("tags", "rust")
KV.sadd("tags", "soli")
KV.srem("tags", "rust")

KV.smembers(key)

Get all members of a set.

KV.sismember(key, member)

Check if a value is a member of a set. Returns Bool.

KV.scard(key)

Get the number of members in a set.

KV.hset(key, field, value)

Set a field in a hash.

KV.hset("user:1", "name", "Alice")
KV.hset("user:1", "email", "[email protected]")

KV.hget(key, field)

Get a field value from a hash.

KV.hgetall(key)

Get all fields and values as a Hash.

let user = KV.hgetall("user:1")
# => { "name": "Alice", "email": "[email protected]" }

KV.hdel(key, ...fields)

Delete fields from a hash.

KV.hexists(key, field)

Check if a field exists in a hash. Returns Bool.

KV.hkeys(key) / KV.hlen(key)

Get all field names or the number of fields in a hash.

KV.ping()

Check connectivity. Returns "PONG".

KV.dbsize()

Get the total number of keys in the database.

KV.flushdb()

Delete all keys in the database. Use with caution.

KV.cmd(...args)

Run any raw SoliKV command.

KV.cmd("SET", "key", "value")
KV.cmd("GET", "key")
KV.cmd("EXPIRE", "key", 60)