@type cluster() :: atom() | pid()

Cluster identity accepted by read-side helpers.

Pass the cluster registration atom used at startup, or the pid of a process registered under that atom. Unregistered pids raise ArgumentError.

@type node_info() :: %{name: String.t(), host: String.t(), port: :inet.port_number()}

Active node metadata returned by nodes/1.

The host and port are the direct-connect endpoint captured from the Tender's current node handle. Unknown handles are represented with an empty host and port 0.

@type replica_policy() :: :master | :sequence

Replica selection policy used by read routing.

:master always routes to the partition master. :sequence walks the available replica list using the retry attempt index.

@type route_result() :: {:ok, String.t()} | {:error, :cluster_not_ready | :no_master}

Result returned by cluster routing helpers.

Successful routes return the selected node name. :cluster_not_ready means the namespace has no complete partition map yet; :no_master means the map is present but the target partition has no eligible owner.

@type tables() :: %{
  owners: atom(),
  node_gens: atom(),
  meta: atom(),
  txn_tracking: atom()
}

ETS table names published for one cluster runtime.

These names are derived from the cluster identity and are used by the read-side helpers to inspect partition ownership, node generation, runtime metadata, and transaction tracking state.

@type warm_up_node_result() :: %{
  host: String.t(),
  port: :inet.port_number() | 0,
  status: :ok | :partial | :error,
  requested: non_neg_integer(),
  warmed: non_neg_integer(),
  error: Aerospike.Error.t() | nil
}

Per-node warm-up result returned inside warm_up_result/0.

:status is :ok, :partial, or :error. :requested is the capped per-node target and :warmed is the number of successful checkouts. :error is nil on full success or the checkout failure returned by the pool.

@type warm_up_option() ::
  {:count, non_neg_integer()} | {:pool_checkout_timeout, non_neg_integer()}

Warm-up option accepted by warm_up/2.

• :count — number of connections to check out per active node. 0 or omitted means the configured pool size. Values above the pool size are capped to the pool size.
• :pool_checkout_timeout — timeout in milliseconds for each individual pool checkout. Defaults to 5_000.

@type warm_up_result() :: %{
  status: :ok | :partial | :error,
  requested_per_node: non_neg_integer(),
  total_requested: non_neg_integer(),
  total_warmed: non_neg_integer(),
  nodes_total: non_neg_integer(),
  nodes_ok: non_neg_integer(),
  nodes_partial: non_neg_integer(),
  nodes_error: non_neg_integer(),
  nodes: %{required(String.t()) => warm_up_node_result()}
}

Aggregate warm-up report returned by warm_up/2.

The :nodes map is keyed by node name and contains one warm_up_node_result/0 per active node.