# ferricstore_sdk v0.6.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.Flow.QueryExplainCapabilities](FerricStore.Flow.QueryExplainCapabilities.md): Specialized executor contracts reported by a bounded FQL `EXPLAIN` plan.

- [FerricStore.Flow.QueryExplainResult](FerricStore.Flow.QueryExplainResult.md): Value-redacted physical plan returned by FQL `EXPLAIN` or `EXPLAIN ANALYZE`.

- [FerricStore.Flow.QueryIndex](FerricStore.Flow.QueryIndex.md): Stable identity and query-relevant storage metadata for one index generation.
- [FerricStore.Flow.QueryIndexBuild](FerricStore.Flow.QueryIndexBuild.md): Durable build progress for an index generation.
- [FerricStore.Flow.QueryIndexCoverage](FerricStore.Flow.QueryIndexCoverage.md): Shard coverage and validation state for an index generation.
- [FerricStore.Flow.QueryIndexField](FerricStore.Flow.QueryIndexField.md): One component of a composite query-index key.
- [FerricStore.Flow.QueryIndexFormat](FerricStore.Flow.QueryIndexFormat.md): Opaque derived-storage codec identities for one query-index generation.
- [FerricStore.Flow.QueryIndexRetirement](FerricStore.Flow.QueryIndexRetirement.md): Durable cleanup progress for a retiring index generation.
- [FerricStore.Flow.QueryIndexServices](FerricStore.Flow.QueryIndexServices.md): Availability of the replicated query-index management services.
- [FerricStore.Flow.QueryIndexStatistics](FerricStore.Flow.QueryIndexStatistics.md): Freshness summary for bounded query-index statistics samples.
- [FerricStore.Flow.QueryIndexStatus](FerricStore.Flow.QueryIndexStatus.md): Bounded OSS query-index catalog returned by `FLOW.QUERY.INDEXES`.

- [FerricStore.Flow.QueryIndexValidation](FerricStore.Flow.QueryIndexValidation.md): Exact validation progress for an index generation.
- [FerricStore.Flow.QueryProjection](FerricStore.Flow.QueryProjection.md): Builds bounded, source-aware sparse return projections for FQL1 queries.
- [FerricStore.Flow.QueryResult](FerricStore.Flow.QueryResult.md): Typed result returned by `FerricStore.Flow.query/4`.
- [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.QueryError](FerricStore.Flow.QueryError.md): Actionable, value-redacted FQL diagnostic returned by FerricStore.

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

