# Aerospike Driver v0.3.1 - Table of Contents

Aerospike driver for Elixir with an OTP-native cluster runtime

## Pages

- [Overview](readme.md)
- [Changelog](changelog.md)

- Guides
  - [Getting Started](getting-started.md)
  - [Record Operations](record-operations.md)
  - [Batch Operations](batch-operations.md)
  - [Operate, CDT, And Geo](operate-cdt-and-geo.md)
  - [Queries And Scans](queries-and-scans.md)
  - [Expressions And Server Features](expressions-and-server-features.md)
  - [UDFs And Aggregates](udfs-and-aggregates.md)
  - [Operator And Admin Tasks](operator-and-admin-tasks.md)
  - [Security And XDR](security-and-xdr.md)
  - [Transactions](transactions.md)
  - [Telemetry And Runtime Metrics](telemetry-and-runtime-metrics.md)

## Modules

- Core API
  - [Aerospike](Aerospike.md): Public entry point for the Aerospike Elixir driver.
  - [Aerospike.Cluster](Aerospike.Cluster.md): Read-side helpers over published cluster state.
  - [Aerospike.Error](Aerospike.Error.md): Exception raised for Aerospike client and server errors.
  - [Aerospike.Key](Aerospike.Key.md): Record key: namespace, set, optional user key, and server digest.
  - [Aerospike.Record](Aerospike.Record.md): A single Aerospike record returned by read operations.
  - [Aerospike.Repo](Aerospike.Repo.md): Generates an application-owned facade for one supervised Aerospike cluster.
  - [Aerospike.RetryPolicy](Aerospike.RetryPolicy.md): Retry configuration and error classification for the command path.

- Record Operations
  - [Aerospike.Ctx](Aerospike.Ctx.md): Context path steps for nested CDT operations.
  - [Aerospike.Exp](Aerospike.Exp.md): Server-side expression builder.
  - [Aerospike.Exp.Bit](Aerospike.Exp.Bit.md): Bit expression helpers for blob expressions.

  - [Aerospike.Exp.HLL](Aerospike.Exp.HLL.md): HyperLogLog expression helpers.

  - [Aerospike.Exp.List](Aerospike.Exp.List.md): List CDT expression helpers.
  - [Aerospike.Exp.Map](Aerospike.Exp.Map.md): Map CDT expression helpers.

  - [Aerospike.Op](Aerospike.Op.md): Primitive record operations for `Aerospike.operate/4`.
  - [Aerospike.Op.Bit](Aerospike.Op.Bit.md): Bit operations on a byte-array bin for `Aerospike.operate/4`.
  - [Aerospike.Op.Exp](Aerospike.Op.Exp.md): Expression operations for `Aerospike.operate/4`.
  - [Aerospike.Op.HLL](Aerospike.Op.HLL.md): HyperLogLog operations for `Aerospike.operate/4`.
  - [Aerospike.Op.List](Aerospike.Op.List.md): List CDT operations for `Aerospike.operate/4`.
  - [Aerospike.Op.Map](Aerospike.Op.Map.md): Map CDT operations for `Aerospike.operate/4`.

- Batch
  - [Aerospike.Batch](Aerospike.Batch.md): Constructors for heterogeneous `Aerospike.batch_operate/3` requests.
  - [Aerospike.Batch.Delete](Aerospike.Batch.Delete.md): Batch delete entry built by `Aerospike.Batch.delete/1`.
  - [Aerospike.Batch.Operate](Aerospike.Batch.Operate.md): Batch operate entry built by `Aerospike.Batch.operate/2`.
  - [Aerospike.Batch.Put](Aerospike.Batch.Put.md): Batch put entry built by `Aerospike.Batch.put/2`.
  - [Aerospike.Batch.Read](Aerospike.Batch.Read.md): Batch read entry built by `Aerospike.Batch.read/1`.
  - [Aerospike.Batch.UDF](Aerospike.Batch.UDF.md): Batch record-UDF entry built by `Aerospike.Batch.udf/4`.
  - [Aerospike.BatchResult](Aerospike.BatchResult.md): Per-key outcome returned by batch helpers that need record-level metadata.

- Queries, Scans, And Indexes
  - [Aerospike.Cursor](Aerospike.Cursor.md): Opaque partition-resume cursor for paged queries.
  - [Aerospike.ExecuteTask](Aerospike.ExecuteTask.md): Tracks background query execution progress.

  - [Aerospike.Filter](Aerospike.Filter.md): Secondary-index predicate values for query builders.
  - [Aerospike.IndexTask](Aerospike.IndexTask.md): Tracks secondary-index build progress.

  - [Aerospike.Page](Aerospike.Page.md): One page of collected query results with a resumable partition cursor.
  - [Aerospike.PartitionFilter](Aerospike.PartitionFilter.md): Describes which partitions participate in a scan or query.
  - [Aerospike.Query](Aerospike.Query.md): Composable query description with separate predicate lanes.
  - [Aerospike.Scan](Aerospike.Scan.md): Composable scan description.

- Server Features
  - [Aerospike.Geo](Aerospike.Geo.md): Typed geospatial values for Aerospike GeoJSON bins.
  - [Aerospike.Geo.Circle](Aerospike.Geo.Circle.md): Aerospike `AeroCircle` geometry using center longitude, latitude, and radius.

  - [Aerospike.Geo.Point](Aerospike.Geo.Point.md): GeoJSON Point geometry using `[longitude, latitude]` coordinates.

  - [Aerospike.Geo.Polygon](Aerospike.Geo.Polygon.md): GeoJSON Polygon geometry using rings of `[longitude, latitude]` coordinates.

  - [Aerospike.RegisterTask](Aerospike.RegisterTask.md): Tracks UDF package registration progress across the currently active cluster nodes.
  - [Aerospike.Txn](Aerospike.Txn.md): Transaction handle for multi-record transactions.
  - [Aerospike.UDF](Aerospike.UDF.md): Metadata for one registered server-side UDF package.

- Runtime
  - [Aerospike.Cluster.NodeTransport](Aerospike.Cluster.NodeTransport.md): Behaviour for per-node I/O, isolating cluster logic from transport details.
  - [Aerospike.Cluster.Supervisor](Aerospike.Cluster.Supervisor.md): Top-level supervisor for one named Aerospike cluster.
  - [Aerospike.Telemetry](Aerospike.Telemetry.md): Event-name constants for the telemetry taxonomy emitted by this driver.

- Security
  - [Aerospike.Privilege](Aerospike.Privilege.md): Security privilege assigned to an Aerospike role.
  - [Aerospike.Role](Aerospike.Role.md): Security role as returned by Aerospike role metadata queries.

  - [Aerospike.User](Aerospike.User.md): Security user metadata returned by Aerospike user queries.

- Transports
  - [Aerospike.Transport.Tcp](Aerospike.Transport.Tcp.md): Plaintext `:gen_tcp` implementation of `Aerospike.Cluster.NodeTransport`.
  - [Aerospike.Transport.Tls](Aerospike.Transport.Tls.md): TLS (`:ssl`) implementation of `Aerospike.Cluster.NodeTransport`.