Overview: Aerospike C# client

For the complete documentation index see: llms.txt

All documentation pages available in markdown.

Feature highlights

Execution models:

Synchronous client: Blocking operations through AerospikeClient with connection pooling per server node. See Connecting.
Asynchronous client: Non-blocking operations through AsyncClient using listener callbacks and a thread pool with non-blocking sockets. See Asynchronous API. AsyncClient inherits from AerospikeClient, so sync commands remain available.
Thread-safe: Share one client instance per cluster across application threads. See Best practices.

Advanced data operations:

Batch protocol: Combine reads, writes, deletes, and UDF calls in batch operations.
Transactions: Group create, update, read, and delete steps in multi-record transactions (C# client 8.0.0 and later, Database 8.0.0 and later, strong-consistency namespace).
Query types: Primary-index, secondary-index, and background queries.

Policy and expression enhancements:

Policies: Tune timeouts, retries, consistency, and write behavior with client policies.
Filter expressions: Conditional reads and writes with expressions.
Bin operations: Atomic single- and multi-bin updates with Operate.

Data model improvements:

Document model: Store and query JSON-like documents using Map bins and secondary indexes on nested values.
Type support: Aerospike scalar and collection data types, including Lists, Maps, HyperLogLog, and geospatial bins.
String operations: Search, transform, and normalize text in String bins on the server with String operations (C# client 8.5.0+, Database 8.2.0+).

Operations and observability:

Metrics: Collect standard and extended client metrics programmatically or through Dynamic Client Configuration (C# client 8.1.0+).
Error details: Read server subcodes, messages, and expression traces from AerospikeException when Database 8.2.0+ returns them (C# client 8.5.0+). See Error handling.
Security: Connect with TLS and mutual TLS (mTLS). See Connecting.

See the release notes for version history.

Quickstart

Check out the Aerospike client Quickstart for installation instructions and query examples.

Best practices

Already familiar with the C# client? The best practices guide can help you optimize for performance and reliability.

Error handling

Actionable errors with recovery suggestions. Know exactly what went wrong and how to fix it.

Usage examples

Want to dive straight into the API? We have usage examples for all the basic CRUD operations.