Vettore v0.3.1

View Source Vettore.Store behaviour (Vettore v0.3.1)

Storage behaviour for Vettore collections.

Stores own records and metadata. Indexes and native accelerators are separate from this layer so ETS can remain the canonical source of collection state.

Link to this section Summary

Types

config()
id()
state()

Callbacks

all(state)
count(state)
delete(state, id)
fold(state, acc, function)
get(state, id)
load_snapshot(t)
new(config)
put(state, t)
put_many(state, list)
snapshot(state, t)

Link to this section Types

Link to this type

config()

View Source 
@type config() :: map()
Link to this type

id()

View Source 
@type id() :: String.t()
Link to this type

state()

View Source 
@type state() :: term()

Link to this section Callbacks

Link to this callback

all(state)

View Source 
@callback all(state()) :: {:ok, [Vettore.Embedding.t()]} | {:error, term()}
Link to this callback

count(state)

View Source 
@callback count(state()) :: non_neg_integer()
Link to this callback

delete(state, id)

View Source 
@callback delete(state(), id()) :: :ok | {:error, term()}
Link to this callback

fold(state, acc, function)

View Source 
@callback fold(state(), acc, (Vettore.Embedding.t(), acc -> acc)) :: {:ok, acc}
when acc: term()
Link to this callback

get(state, id)

View Source 
@callback get(state(), id()) :: {:ok, Vettore.Embedding.t()} | {:error, term()}
Link to this callback

load_snapshot(t)

View Source 
@callback load_snapshot(Path.t()) :: {:ok, {state(), config()}} | {:error, term()}
Link to this callback

new(config)

View Source 
@callback new(config()) :: {:ok, state()} | {:error, term()}
Link to this callback

put(state, t)

View Source 
@callback put(state(), Vettore.Embedding.t()) :: :ok | {:error, term()}
Link to this callback

put_many(state, list)

View Source 
@callback put_many(state(), [Vettore.Embedding.t()]) :: :ok | {:error, term()}
Link to this callback

snapshot(state, t)

View Source 
@callback snapshot(state(), Path.t()) :: :ok | {:error, term()}