# ferricstore_sdk v0.4.2 - Table of Contents

> Official Elixir SDK for FerricStore over the native ferric:// protocol.

## Modules

- [FerricStore](FerricStore.md): High-level FerricStore and FerricFlow API over the topology-aware native client.
- [FerricStore.AsyncRequest](FerricStore.AsyncRequest.md): Handle for an asynchronous FerricStore request.
- [FerricStore.Client](FerricStore.Client.md): Public client facade backed by the topology-aware native coordinator.
- [FerricStore.Codec](FerricStore.Codec.md): Value codec behaviour used by Flow helpers.
- [FerricStore.Codec.Raw](FerricStore.Codec.Raw.md): Raw binary codec. Non-binary values are converted with `to_string/1`.

- [FerricStore.Codec.Term](FerricStore.Codec.Term.md): Erlang external term codec for Elixir-only applications.
- [FerricStore.Compatibility](FerricStore.Compatibility.md): FerricStore server and native wire compatibility for this SDK release.
- [FerricStore.Flow](FerricStore.Flow.md): High-level FerricFlow command helpers.
- [FerricStore.Flow.PolicySnapshot](FerricStore.Flow.PolicySnapshot.md): Typed snapshot returned by Flow policy reads and mutations.
- [FerricStore.Protocol](FerricStore.Protocol.md): Encoder and decoder facade for the FerricStore native TCP protocol.

- [FerricStore.Queue](FerricStore.Queue.md): Queue-style API built on FerricFlow states.

- [FerricStore.SDK](FerricStore.SDK.md): Topology-aware Elixir SDK entry points.
- [FerricStore.SDK.Admin](FerricStore.SDK.Admin.md): Native FerricStore cluster and observability commands.

- [FerricStore.SDK.Flow](FerricStore.SDK.Flow.md): Native FerricStore Flow commands.
- [FerricStore.SDK.Invocation](FerricStore.SDK.Invocation.md): FerricStore Enterprise invocation helpers.
- [FerricStore.SDK.KV](FerricStore.SDK.KV.md): Native FerricStore key/value commands.

- [FerricStore.SDK.Management](FerricStore.SDK.Management.md): Narrow control-plane helpers for FerricStore management commands.
- [FerricStore.SDK.Native.Client](FerricStore.SDK.Native.Client.md): FerricStore native protocol client with topology-aware shard routing.
- [FerricStore.SDK.Native.Topology](FerricStore.SDK.Native.Topology.md): Read-only snapshot of the cluster topology used by the topology-aware SDK.
- [FerricStore.Types](FerricStore.Types.md): Helpers for reading and normalizing native protocol maps.

- [FerricStore.Workflow](FerricStore.Workflow.md): State-machine workflow convenience API.

- Exceptions
  - [FerricStore.Error](FerricStore.Error.md): Raised when FerricStore returns a protocol or command error.

  - [FerricStore.Flow.StalePolicyGenerationError](FerricStore.Flow.StalePolicyGenerationError.md): Returned when a Flow policy compare-and-swap uses a stale generation.

