Current section
Files
Jump to
Current section
Files
lib/nebulex/adapter/queryable.ex
defmodule Nebulex.Adapter.Queryable do
@moduledoc """
Specifies the query API required from adapters.
"""
@type cache :: Nebulex.Cache.t()
@type opts :: Nebulex.Cache.opts()
@doc """
Fetches all entries from cache matching the given `query`.
If the `query` is `nil`, it fetches all entries from cache; this is common
for all adapters. However, the `query` could be any other value, that
depends entirely on the adapter's implementation. Therefore, it is
recommended to check out adapters' documentation. For instance, the built-in
`Nebulex.Adapters.Local` adapter supports `:ets.match_spec()` as query.
May raise `Nebulex.QueryError` if query validation fails.
See `c:Nebulex.Cache.all/2`.
"""
@callback all(cache, query :: nil | any, opts) :: [any]
@doc """
Streams the given `query`.
It returns a stream of values.
May raise `Nebulex.QueryError` if query validation fails.
See `c:Nebulex.Cache.stream/2`.
"""
@callback stream(cache, query :: nil | any, opts) :: Enumerable.t()
end