Scrypath.Backend behaviour (scrypath v0.3.0)

Copy Markdown View Source

Internal backend behavior for Scrypath runtime adapters.

This behavior is documented so architecture references remain valid, but it is still considered an internal seam for v1 rather than a stable extension API.

Summary

Callbacks

delete_documents(module, list, keyword)
index_name(module, keyword)
name()
search(module, t, keyword)
upsert_documents(module, list, keyword)

Callbacks

delete_documents(module, list, keyword)

@callback delete_documents(module(), [term()], keyword()) ::
  {:ok, term()} | {:error, term()}

index_name(module, keyword)

@callback index_name(
  module(),
  keyword()
) :: String.t()

name()

@callback name() :: atom()

search(module, t, keyword)

@callback search(module(), Scrypath.Query.t(), keyword()) ::
  {:ok, map()} | {:error, term()}

upsert_documents(module, list, keyword)

@callback upsert_documents(module(), [Scrypath.Document.t()], keyword()) ::
  {:ok, term()} | {:error, term()}