Fact.Context (Fact v0.2.0)

View Source

The context for a Fact database.

A Fact.Context holds all the configuration, file handlers, encoders/decoders, and metadata necessary to operate a database instance. It provides a central place to access:

  • Database identity and versioning information
  • Event and record schemas
  • File and storage handlers for ledgers, records, indexes, checkpoints, and locks

Summary

Types

t()

Functions

from_genesis_event_data(event_data)

Constructs a Fact.Context from a genesis event (Fact.Genesis.Event.DatabaseCreated.V1) data.

from_record(record) deprecated

Constructs a Fact.Context from a genesis event record.

Types

t()

@type t() :: %Fact.Context{
  database_id: Fact.database_id(),
  database_name: Fact.database_name(),
  elixir_version: binary(),
  erts_version: binary(),
  event_id: Fact.Seam.Instance.t(),
  event_schema: Fact.Seam.Instance.t(),
  fact_version: binary(),
  index_checkpoint_file_decoder: Fact.Seam.Instance.t(),
  index_checkpoint_file_encoder: Fact.Seam.Instance.t(),
  index_checkpoint_file_name: Fact.Seam.Instance.t(),
  index_checkpoint_file_reader: Fact.Seam.Instance.t(),
  index_checkpoint_file_writer: Fact.Seam.Instance.t(),
  index_file_decoder: Fact.Seam.Instance.t(),
  index_file_encoder: Fact.Seam.Instance.t(),
  index_file_name: Fact.Seam.Instance.t(),
  index_file_reader: Fact.Seam.Instance.t(),
  index_file_writer: Fact.Seam.Instance.t(),
  ledger_file_decoder: Fact.Seam.Instance.t(),
  ledger_file_encoder: Fact.Seam.Instance.t(),
  ledger_file_name: Fact.Seam.Instance.t(),
  ledger_file_reader: Fact.Seam.Instance.t(),
  ledger_file_writer: Fact.Seam.Instance.t(),
  lock_file_decoder: Fact.Seam.Instance.t(),
  lock_file_encoder: Fact.Seam.Instance.t(),
  lock_file_name: Fact.Seam.Instance.t(),
  lock_file_reader: Fact.Seam.Instance.t(),
  lock_file_writer: Fact.Seam.Instance.t(),
  os_version: binary(),
  otp_version: binary(),
  record_file_decoder: Fact.Seam.Instance.t(),
  record_file_encoder: Fact.Seam.Instance.t(),
  record_file_name: Fact.Seam.Instance.t(),
  record_file_reader: Fact.Seam.Instance.t(),
  record_file_writer: Fact.Seam.Instance.t(),
  storage: Fact.Seam.Instance.t()
}

Functions

from_genesis_event_data(event_data)

(since 0.2.0)

Constructs a Fact.Context from a genesis event (Fact.Genesis.Event.DatabaseCreated.V1) data.

from_record(record)

(since 0.1.0)
This function is deprecated. Use from_genesis_event_data/1 instead.

Constructs a Fact.Context from a genesis event record.