キーバリューストア

store モジュールは、必要に応じて TTL を指定できるキーバリューストレージを提供します。キャッシュデータ、セッション、その他の一時的な状態を保持できます。

このページは API リファレンスです。スニペットでは、構成済みのストア、後述する権限、アプリケーションが提供する owner や new_value などの値を前提としています。取得後のスニペットは既存の有効な cache ハンドルを使用するため、単独で実行できる関数ではありません。

ストアの構成については、ストアを参照してください。

ロード

local store = require("store")

ストアの取得

レジストリIDでストアリソースを取得:

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

戻り値: Store, error

値の保存

オプションのTTL付きで値を保存:

-- 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

戻り値: boolean, error

値の取得

キーで値を取得:

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

戻り値: any, error

キーが存在しないか期限切れの場合はnilとerrors.NOT_FOUNDエラーを返す。

存在確認

取得せずにキーが存在するか確認:

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

戻り値: boolean, error

キーの削除

ストアからキーを削除:

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

戻り値: boolean, error

削除された場合はtrue、キーが存在しなかった場合はfalseを返す。

エントリメタデータの読み取り

entry は値と、その楽観的並行性制御に使われる不透明なバージョン文字列 version を返します:

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

戻り値: Entry, error — {key: string, value: any, version: string}

キーの一覧

エントリを決定的なキー順でページング付きで一覧します:

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

戻り値: Page, error — {items: Entry[], cursor: string, has_more: boolean}

条件付き書き込み

put は値を書き込み、新しい Entry を返します。オプションで楽観的並行性制御が可能です:

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
    -- 他の誰かが保持している
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
    -- 並行ライターが変更した。再読み取りして再試行
end

only_if_absent と if_version は相互に排他的です。

戻り値: Entry, error

ストア機能

info はバックエンドとそのサポート内容を報告します。これによりコードはバインドされたストアに適応できます:

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)

戻り値: Info, error — {id, backend, consistency, durable, list, versioned, conditional_put, ttl}

定数

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

ストアメソッド

権限

ストア操作はセキュリティポリシー評価の対象。

エラー

store.get() とストアハンドルのすべてのメソッド（get、entry、set、put、list、has、delete、info）は構造化エラーを返します（err:kind() を使用）。ただし store.get、get、set、has、delete での権限拒否は、エラーを返す代わりに Lua エラーとして送出されます。

エラーの処理についてはエラー処理を参照。

エラーの処理については、エラー処理を参照してください。