reckon_db_archive_file (reckon_db v1.2.6)

File-based archive backend for reckon-db

Stores archived events as Erlang term files on the local filesystem. Archives are organized in directories by store and stream.

Directory structure:

  {base_dir}/
    {store_id}/
      {stream_id}/
        0-99.archive
        100-199.archive

Summary

Types

event/0

Functions

archive(State, ArchiveKey, Events)

Archive events to a file.

delete(State, ArchiveKey)

Delete an archive file.

exists(State, ArchiveKey)

Check if an archive exists.

init(Opts)

Initialize the file archive backend.

list(State, StoreId, StreamId)

List all archive keys for a stream.

read(State, ArchiveKey)

Read events from an archive file.

Types

event/0

-type event() ::
          #event{event_id :: binary(),
                 event_type :: binary(),
                 stream_id :: binary(),
                 version :: non_neg_integer(),
                 data :: map() | binary(),
                 metadata :: map(),
                 tags :: [binary()] | undefined,
                 timestamp :: integer(),
                 epoch_us :: integer(),
                 data_content_type :: binary(),
                 metadata_content_type :: binary()}.

Functions

archive(State, ArchiveKey, Events)

-spec archive(#state{base_dir :: string()}, binary(), [event()]) ->
                 {ok, #state{base_dir :: string()}} | {error, term()}.

Archive events to a file.

delete(State, ArchiveKey)

-spec delete(#state{base_dir :: string()}, binary()) ->
                {ok, #state{base_dir :: string()}} | {error, term()}.

Delete an archive file.

exists(State, ArchiveKey)

-spec exists(#state{base_dir :: string()}, binary()) -> {boolean(), #state{base_dir :: string()}}.

Check if an archive exists.

init(Opts)

-spec init(map()) -> {ok, #state{base_dir :: string()}} | {error, term()}.

Initialize the file archive backend.

Options: - base_dir: Directory where archives are stored (required)

list(State, StoreId, StreamId)

-spec list(#state{base_dir :: string()}, atom(), binary()) ->
              {ok, [binary()], #state{base_dir :: string()}} | {error, term()}.

List all archive keys for a stream.

read(State, ArchiveKey)

-spec read(#state{base_dir :: string()}, binary()) ->
              {ok, [event()], #state{base_dir :: string()}} | {error, term()}.

Read events from an archive file.