FerricStore.Flow.MetadataExtension behaviour (ferricstore v0.10.0)

Frozen edition boundary for hidden Flow system metadata.

Providers resolve trusted ingress authority once. Core validates and seals their output before it enters a replicated command or physical query plan.

Summary

query_scope()

@type query_scope() ::
  :unscoped
  | {:required, [{non_neg_integer(), :eq, term()}]}
  | {:required_union, [[{non_neg_integer(), :eq, term()}]]}

@callback bind_query(atom(), map(), FerricStore.Flow.MetadataExtension.Snapshot.t()) ::
  {:ok, query_scope()} | {:error, term()}

@callback bind_write(atom(), map(), FerricStore.Flow.MetadataExtension.Snapshot.t()) ::
  {:ok, map()} | {:error, term()}

@callback configure(keyword()) ::
  {:ok,
   %{mode: :dedicated | :shared, generation: non_neg_integer(), fields: [map()]}}
  | {:error, term()}

@spec bind_query(map(), atom()) :: {:ok, query_scope()} | {:error, atom()}

@spec bind_query(FerricStore.Flow.MetadataExtension.Snapshot.t(), atom(), map()) ::
  {:ok, query_scope()} | {:error, atom()}

@spec bind_write(map(), atom()) ::
  {:ok, Ferricstore.Flow.SystemMetadata.t()} | {:error, atom()}

@spec bind_write(FerricStore.Flow.MetadataExtension.Snapshot.t(), atom(), map()) ::
  {:ok, Ferricstore.Flow.SystemMetadata.t()} | {:error, atom()}

@spec configure(
  module(),
  keyword()
) :: {:ok, FerricStore.Flow.MetadataExtension.Snapshot.t()} | {:error, atom()}

@spec configured_implementation(keyword()) :: module()

@spec snapshot(term()) ::
  {:ok, FerricStore.Flow.MetadataExtension.Snapshot.t()}
  | {:error, :flow_metadata_extension_unavailable}

@spec validate_configuration(term()) ::
  {:ok, map()} | {:error, :invalid_flow_metadata_schema}

@spec validate_implementation!(term()) :: module()