Key-Value Store

O módulo store fornece armazenamento key-value com TTL opcional. Ele pode manter dados em cache, sessões e outros estados temporários.

Esta página é uma referência de API. Os exemplos pressupõem um store configurado, as permissões listadas abaixo e valores fornecidos pela aplicação, como owner ou new_value. Depois da aquisição, os exemplos usam um handle cache ativo já existente e não são funções independentes.

Para configurar o store, veja Store.

Carregamento

local store = require("store")

Adquirindo um Store

Obter um recurso store por ID do registro:

local cache, err = store.get("app:cache")
if err then
    return nil, err
end

local _, set_err = cache:set("user:123", {name = "Alice"}, 3600)
if set_err then
    cache:release()
    return nil, set_err
end

local user, get_err = cache:get("user:123")

cache:release()
if get_err then return nil, get_err end
return user

Retorna: Store, error

Armazenando Valores

Armazenar um valor com TTL opcional:

-- Simple set
local _, err = cache:set("user:123:name", "Alice")
if err then return nil, err end

-- Set with TTL (expires in 300 seconds)
local ok, ttl_err = cache:set("session:abc", {user_id = 123, role = "admin"}, 300)
if ttl_err then return nil, ttl_err end
return ok

Retorna: boolean, error

Recuperando Valores

Obter um valor por chave:

local errors = require("errors")

local user, err = cache:get("user:123")
if err then
    if err:kind() == errors.NOT_FOUND then
        return nil -- key missing or expired
    end
    return nil, err
end
return user

Retorna: any, error

Retorna nil e um erro errors.NOT_FOUND se a chave não existe ou expirou.

Verificando Existencia

Verificar se uma chave existe sem recuperar:

if cache:has("lock:" .. resource_id) then
    return nil, errors.new({ kind = errors.CONFLICT, message = "Resource is locked" })
end

Retorna: boolean, error

Deletando Chaves

Remover uma chave do store:

local deleted, err = cache:delete("session:" .. session_id)
if err then return nil, err end
return deleted

Retorna: boolean, error

Retorna true se deletado, false se chave não existia.

Lendo Metadados da Entrada

entry retorna o valor junto com sua version — uma string opaca usada para concorrência otimista:

local e, err = cache:entry("user:123")
if err then return nil, err end
if e then
    print(e.key, e.value, e.version)
end

Retorna: Entry, error — {key: string, value: any, version: string}

Listando Chaves

Listar entradas em ordem determinística de chave, com paginação:

local page, err = cache:list({ prefix = "session:", limit = 100 })
if err then return nil, err end
for _, e in ipairs(page.items) do
    print(e.key, e.value)
end

-- next page
if page.has_more then
    local next_page, next_err = cache:list({ prefix = "session:", after = page.cursor })
    if next_err then return nil, next_err end
    page = next_page
end

Retorna: Page, error — {items: Entry[], cursor: string, has_more: boolean}

Escritas Condicionais

put escreve um valor e retorna sua nova Entry. As opções habilitam concorrência otimista:

local errors = require("errors")

-- create only if the key does not exist
local e, err = cache:put("lock:job-1", owner, { only_if_absent = true })
if err and err:kind() == errors.ALREADY_EXISTS then
    -- outra pessoa a detém
end

-- compare-and-set: write only if the version still matches
local cur, read_err = cache:entry("config")
if read_err then return nil, read_err end
local e2, err2 = cache:put("config", new_value, { if_version = cur.version })
if err2 and err2:kind() == errors.CONFLICT then
    -- um escritor concorrente a alterou; releia e tente novamente
end

only_if_absent e if_version são mutuamente exclusivos.

Retorna: Entry, error

Capacidades do Store

info informa o backend e o que ele suporta, para que o código possa se adaptar a qualquer store vinculado:

local info, err = cache:info()
if err then return nil, err end
-- info.backend      -> one of store.backend.* (e.g. "kv.raft")
-- info.consistency  -> one of store.consistency.* (e.g. "linearizable")
-- info.durable / info.list / info.versioned / info.conditional_put / info.ttl  (booleans)

Retorna: Info, error — {id, backend, consistency, durable, list, versioned, conditional_put, ttl}

Constantes

local info, err = cache:info()
if err then return nil, err end
if info.consistency == store.consistency.LINEARIZABLE then
    -- safe to use compare-and-set
end

Métodos do Store

Permissões

Operações de store estao sujeitas a avaliação de política de segurança.

Erros

store.get() e todos os métodos do handle do store (get, entry, set, put, list, has, delete, info) retornam erros estruturados (use err:kind()), exceto que uma negação de permissão em store.get, get, set, has e delete levanta um erro Lua em vez disso.

Veja Tratamento de Erros para trabalhar com erros.