Fact.EventStreamCategoryIndexer (Fact v0.2.0)

View Source

Indexes events by the category portion of an event stream, by splitting the string on a specified separator and returns the first segment.

Summary

Types

id()

The id for a Fact.EventStreamCategoryIndexer.

option()

Custom option values passed to the Fact.EventIndexer.index_event/3 callback function.

options()

Custom options passed to the Fact.EventIndexer.index_event/3 callback function.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

index_event(schema, event, opts)

Extracts a category from an event stream id.

indexer_name()

Gets the friendly name for the indexer.

start_link(opts \\ [])

Starts the indexer process.

Types

id()

@type id() :: {Fact.EventStreamCategoryIndexer, nil}

The id for a Fact.EventStreamCategoryIndexer.

option()

@type option() :: {:separator, String.t()} | Fact.EventIndexer.indexer_option()

Custom option values passed to the Fact.EventIndexer.index_event/3 callback function.

options()

@type options() :: [option()]

Custom options passed to the Fact.EventIndexer.index_event/3 callback function.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

index_event(schema, event, opts)

Extracts a category from an event stream id.

Options

  • :separator - optional delimiter used to split the stream name. Defaults to "-".

Examples

iex> event = %{
...>   "event_type" => "ClutchLaid", 
...>   "event_data" => %{"turtle_id" => "t1", "clutch_id" => "c1", "eggs" => 42}, 
...>   "event_tags" => ["turtle:t1", "clutch:c1"], 
...>   "stream_id" => "turtle_mating-1234"
...> }
iex> Fact.EventStreamCategoryIndexer.index_event(event, [])
"turtle_mating"

iex> event = %{
...>   "event_type" => "EggHatched", 
...>   "event_data" => %{"turtle_id" => "t2", "clutch_id" => "c1"}, 
...>   "event_tags" => ["turtle:t2", "clutch:c1"], 
...> }
iex> Fact.EventStreamCategoryIndexer.index_event(event, [])
nil

iex> event = %{
...>   "event_type" => "DatabaseCreated", 
...>   "event_data" => %{"database_id" => "RVX27QR6PFDORJZF24C4DIICSQ"}, 
...>   "stream_id" => "__fact", 
...>   "stream_position" => 1
...> }
iex> Fact.EventStreamCategoryIndexer.index_event(event, [])
"__fact"

indexer_name()

(since 0.1.2) 
@spec indexer_name() :: String.t()

Gets the friendly name for the indexer.

This is included in the file path where index files are stored on disk.

start_link(opts \\ [])

@spec start_link([Fact.EventIndexer.option()]) :: GenServer.on_start()

Starts the indexer process.