Key-Value-Speicher

Das Modul store stellt Key-Value-Speicher mit optionalen TTLs bereit. Es eignet sich für Cache-Daten, Sitzungen und andere temporäre Zustände.

Diese Seite ist eine API-Referenz. Ihre Ausschnitte setzen einen konfigurierten Store, die unten aufgeführten Berechtigungen und von der Anwendung bereitgestellte Werte wie owner oder new_value voraus. Ausschnitte nach dem Abrufen verwenden ein bereits vorhandenes, aktives cache-Handle und sind keine eigenständigen Funktionen.

Informationen zur Store-Konfiguration finden Sie unter Store.

Laden

local store = require("store")

Store abrufen

Rufen Sie eine Store-Ressource anhand ihrer Registry-ID ab:

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

Gibt zurück: Store, error

Werte speichern

Speichern Sie einen Wert mit optionaler 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

Gibt zurück: boolean, error

Werte abrufen

Holen Sie einen Wert anhand des Schlüssels:

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

Gibt zurück: any, error

Gibt nil und einen errors.NOT_FOUND-Fehler zurück, wenn der Schlüssel nicht existiert oder abgelaufen ist.

Existenz prüfen

Prüfen Sie, ob ein Schlüssel existiert, ohne ihn abzurufen:

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

Gibt zurück: boolean, error

Schlüssel löschen

Entfernen Sie einen Schlüssel aus dem Store:

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

Gibt zurück: boolean, error

Die Methode gibt true zurück, wenn sie den Schlüssel löscht, und false, wenn der Schlüssel nicht existiert.

Eintrags-Metadaten lesen

entry gibt den Wert zusammen mit seiner version zurück — einer opaken Zeichenkette, die für optimistische Nebenläufigkeit verwendet wird:

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

Gibt zurück: Entry, error — {key: string, value: any, version: string}

Schlüssel auflisten

Listen Sie Einträge in deterministischer Schlüsselreihenfolge mit Seitennavigation auf:

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

Gibt zurück: Page, error — {items: Entry[], cursor: string, has_more: boolean}

Bedingte Schreibvorgänge

put schreibt einen Wert und gibt seinen neuen Entry zurück. Optionen ermöglichen optimistische Nebenläufigkeit:

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
    -- jemand anderes hält ihn
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
    -- ein gleichzeitiger Schreiber hat ihn geändert; erneut lesen und wiederholen
end

only_if_absent und if_version schließen sich gegenseitig aus.

Gibt zurück: Entry, error

Store-Fähigkeiten

info meldet das Backend und was es unterstützt, sodass Code sich an den jeweils gebundenen Store anpassen kann:

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)

Gibt zurück: Info, error — {id, backend, consistency, durable, list, versioned, conditional_put, ttl}

Konstanten

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

Berechtigungen

Store-Operationen unterliegen der Auswertung der Sicherheitsrichtlinien.

Fehler

store.get() und alle Methoden des Store-Handles (get, entry, set, put, list, has, delete, info) geben strukturierte Fehler zurück (verwenden Sie err:kind()), außer dass eine Berechtigungsverweigerung in store.get, get, set, has und delete stattdessen einen Lua-Fehler auslöst.

Informationen zum Umgang mit Fehlern finden Sie unter Fehlerbehandlung.