TantivyEx.IndexWarming (TantivyEx v0.4.1)

View Source

Index warming and caching functionality for TantivyEx.

Summary

Types

warming_resource()

@type warming_resource() :: reference()

Functions

add_preload_queries(warming_resource, queries)

@spec add_preload_queries(warming_resource(), [String.t()]) :: :ok | {:error, term()}

clear_cache(warming_resource)

@spec clear_cache(warming_resource()) :: :ok | {:error, term()}

configure(warming_resource, cache_size_mb, ttl_seconds, strategy, eviction_policy, background_warming)

@spec configure(
  warming_resource(),
  non_neg_integer(),
  non_neg_integer(),
  String.t(),
  String.t(),
  boolean()
) :: :ok | {:error, term()}

evict_cache(warming_resource, force_all)

@spec evict_cache(warming_resource(), boolean()) :: :ok | {:error, term()}

get_searcher(warming_resource, cache_key)

@spec get_searcher(warming_resource(), String.t()) ::
  {:ok, reference()} | {:error, term()}

get_stats(warming_resource)

@spec get_stats(warming_resource()) :: {:ok, String.t()} | {:error, term()}

new()

@spec new() :: {:ok, warming_resource()} | {:error, term()}

warm_index(warming_resource, index_resource, cache_key)

@spec warm_index(warming_resource(), reference(), String.t()) ::
  :ok | {:error, term()}