Scrypath (scrypath v0.3.0)

Runtime reflection helpers for searchable schemas declared with use Scrypath.

Phase 1 keeps the public runtime surface small:

These functions keep reflection under Scrypath.* modules instead of generating schema-specific runtime verbs.

Examples

iex> config = Scrypath.schema_config(SearchablePost)
iex> config.fields
[:title, :body]

@spec backfill(
  module(),
  keyword()
) :: {:ok, map()} | {:error, term()}

@spec delete_document(module(), term(), keyword()) :: {:ok, term()} | {:error, term()}

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

@spec delete_record(module(), struct() | map(), keyword()) ::
  {:ok, term()} | {:error, term()}

@spec document_id_field(module()) :: atom()

@spec document_source(module()) :: atom()

@spec reindex(
  module(),
  keyword()
) :: {:ok, map()} | {:error, term()}

@spec schema_config(module()) :: map()

@spec schema_fields(module()) :: [atom()]

@spec schema_settings(module()) :: map()

@spec search(module(), String.t(), keyword()) :: {:ok, term()} | {:error, term()}

@spec search!(module(), String.t(), keyword()) :: term()

@spec sync_record(module(), struct() | map(), keyword()) ::
  {:ok, term()} | {:error, term()}

@spec sync_records(module(), [struct() | map()], keyword()) ::
  {:ok, term()} | {:error, term()}

@spec sync_status(
  module(),
  keyword()
) :: {:ok, Scrypath.Operator.Status.t()} | {:error, term()}