Packages
spawn_statestores
2.0.0-RC1
2.0.0-RC9
2.0.0-RC8
2.0.0-RC7
2.0.0-RC6
2.0.0-RC5
2.0.0-RC4
2.0.0-RC3
2.0.0-RC2
2.0.0-RC14
2.0.0-RC13
2.0.0-RC12
2.0.0-RC11
2.0.0-RC10
2.0.0-RC1
1.4.3
1.4.2
1.4.1
1.4.0
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.1
1.1.0
1.0.1
1.0.0
1.0.0-rc4
1.0.0-rc3
1.0.0-rc2
1.0.0-rc16
1.0.0-rc15
1.0.0-rc14
1.0.0-rc13
1.0.0-rc1
1.0.0-rc.38
1.0.0-rc.37
1.0.0-rc.36
1.0.0-rc.35
1.0.0-rc.34
1.0.0-rc.33
1.0.0-rc.32
1.0.0-rc.31
1.0.0-rc.30
1.0.0-rc.29
1.0.0-rc.28
1.0.0-rc.27
1.0.0-rc.26
1.0.0-rc.25
1.0.0-rc.24
1.0.0-rc.23
1.0.0-rc.22
1.0.0-rc.21
1.0.0-rc.20
1.0.0-rc.19
1.0.0-rc.18
1.0.0-rc.17
1.0.0-beta1
0.6.3
0.6.2
0.6.1
0.6.0
0.5.5
0.5.4
0.5.3
0.5.1
0.5.0
0.5.0-rc.13
0.5.0-rc.12
0.5.0-rc.11
0.5.0-rc.10
0.5.0-rc.9
0.5.0-rc.8
0.5.0-rc.7
0.5.0-rc.6
0.5.0-rc.5
0.5.0-rc.3
0.5.0-alpha.13
0.5.0-alpha.12
0.5.0-alpha.11
0.5.0-alpha.10
0.5.0-alpha.9
0.5.0-alpha.6
0.5.0-alpha.5
0.5.0-alpha.4
0.5.0-alpha.3
0.5.0-alpha.2
0.5.0-alpha.1
0.1.0
Spawn Statestores is the storage lib for the Spawn Actors System
Current section
Files
Jump to
Current section
Files
lib/statestores/adapters/projection_behaviour.ex
defmodule Statestores.Adapters.ProjectionBehaviour do
@moduledoc """
Defines the default behavior for each Statestore Provider.
"""
alias Scrivener.Page
alias Statestores.Schemas.Projection
@type metadata_key :: String.t()
@type metadata_value :: String.t()
@type page :: integer()
@type page_size :: integer()
@type page_data :: Page.t()
@type projection :: Projection.t()
@type projections :: list(Projection.t())
@type projection_name :: String.t()
@type projection_id :: String.t()
@type revision :: integer()
@type time_start :: String.t()
@type time_end :: String.t()
@callback create_table(projection_name()) :: {:ok, String.t()}
@callback get_last(projection_name()) :: {:error, any} | {:ok, projection()}
@callback get_last_by_projection_id(projection_name(), projection_id()) ::
{:error, any} | {:ok, projection()}
@callback get_all(projection_name(), page(), page_size()) :: {:error, any} | {:ok, page_data()}
@callback get_all_by_projection_id(projection_name(), projection_id(), page(), page_size()) ::
{:error, any} | {:ok, page_data()}
@callback get_by_interval(
projection_name(),
time_start(),
time_end(),
page(),
page_size()
) :: {:error, any} | {:ok, page_data()}
@callback get_by_projection_id_and_interval(
projection_name(),
projection_id(),
time_start(),
time_end(),
page(),
page_size()
) :: {:error, any} | {:ok, page_data()}
@callback search_by_metadata(
projection_name(),
metadata_key(),
metadata_value(),
page(),
page_size()
) ::
{:error, any} | {:ok, page_data()}
@callback search_by_projection_id_and_metadata(
projection_name(),
projection_id(),
metadata_key(),
metadata_value(),
page(),
page_size()
) :: {:error, any} | {:ok, page_data()}
@callback save(projection()) :: {:error, any} | {:ok, projection()}
@callback default_port :: <<_::32>>
defmacro __using__(_opts) do
quote do
alias Statestores.Adapters.ProjectionBehaviour
import Statestores.Util, only: [init_config: 1, generate_key: 1]
@behaviour Statestores.Adapters.ProjectionBehaviour
def init(_type, config), do: init_config(config)
end
end
end