aerospike-clj.protocols
AerospikeAdminOpscljprotocol
Admin operations of an Aerospike client.
Admin operations of an Aerospike client.
get-cluster-statsclj
(get-cluster-stats this)Return a vector of [metric-name metric-val] 2-tuples. The metric name is a dot separated string that should be convenient for reporting to statsd/graphite. All values are gauges.
Return a vector of [metric-name metric-val] 2-tuples. The metric name is a dot separated string that should be convenient for reporting to statsd/graphite. All values are gauges.
get-nodesclj
(get-nodes this)Returns a vector of the client's cluster's nodes.
Returns a vector of the client's cluster's nodes.
healthy?clj
(healthy? this)(healthy? this operation-timeout-ms)Returns true iff the cluster is reachable and can take reads and writes.
Uses __health-check set to avoid data collisions. operation-timeout-ms is
for total timeout of reads (default is 1s) including 2 retries so a small
over estimation is advised to avoid false negatives.
Returns `true` iff the cluster is reachable and can take reads and writes. Uses __health-check set to avoid data collisions. `operation-timeout-ms` is for total timeout of reads (default is 1s) including 2 retries so a small over estimation is advised to avoid false negatives.
infoclj
(info this node info-commands)(info this node info-commands conf)Asynchronously make info commands to a node. A node can be retrieved from get-nodes.
commands is a seq of strings available from https://www.aerospike.com/docs/reference/info/index.html
The returned future contains a map from and info command to its response.
conf can contain {:policy InfoPolicy}.
Asynchronously make info commands to a node. A node can be retrieved from `get-nodes`.
`commands` is a seq of strings available from https://www.aerospike.com/docs/reference/info/index.html
The returned future contains a map from and info command to its response.
`conf` can contain {:policy InfoPolicy}.stopclj
(stop this)Gracefully stop a client, waiting until all async operations finish. The underlying EventLoops instance is closed iff it was not provided externally.
Gracefully stop a client, waiting until all async operations finish. The underlying EventLoops instance is closed iff it was not provided externally.
AerospikeBatchOpscljprotocol
batch-operateclj
(batch-operate this batch-records)(batch-operate this batch-records conf)Asynchronously perform multiple read/write operations on a single key in one batch call.
This method registers the command with an event loop and returns. The event loop thread
will process the command and send the results to the listener.
commands is a sequence of Aerospike CDT operations.
Asynchronously perform multiple read/write operations on a single key in one batch call. This method registers the command with an event loop and returns. The event loop thread will process the command and send the results to the listener. `commands` is a sequence of Aerospike CDT operations.
AerospikeDeleteOpscljprotocol
Delete operations of a single Aerospike record.
Delete operations of a single Aerospike record.
deleteclj
(delete this index set-name)(delete this index set-name conf)Delete the record stored at index.
Returns async true/false for deletion success (hit).
Delete the record stored at `index`. Returns async true/false for deletion success (hit).
delete-binsclj
(delete-bins this index set-name bin-names new-expiration)(delete-bins this index set-name bin-names new-expiration conf)Delete bins from an existing record. The bin-names must be a vector of strings.
Delete bins from an existing record. The `bin-names` must be a vector of strings.
AerospikeReadOpscljprotocol
Read operations of a single Aerospike record.
Read operations of a single Aerospike record.
exists-batchclj
(exists-batch this indices)(exists-batch this indices conf)Check for each key in a batch if it exists. indices is a collection of maps
of the form {:index "key-name" :set "set-name"}. The result is a
vector of booleans in the same order as indices.
Check for each key in a batch if it exists. `indices` is a collection of maps
of the form `{:index "key-name" :set "set-name"}`. The result is a
vector of booleans in the same order as indices.exists?clj
(exists? this index set-name)(exists? this index set-name conf)Test if an index exists.
Test if an index exists.
get-batchclj
(get-batch this batch-reads)(get-batch this batch-reads conf)Get a batch of records from the cluster asynchronously. batch-reads is a collection of maps
of the form {:index "foo" :set "someset" :bins [...]}. the :bins key can have required
bins for the batched keys or missing/[:all] to get all the bins (see _get). The result is a
vector of AerospikeRecord in the same order of keys. Missing keys result in nil in corresponding
positions.
Get a batch of records from the cluster asynchronously. `batch-reads` is a collection of maps
of the form `{:index "foo" :set "someset" :bins [...]}`. the `:bins` key can have required
bins for the batched keys or missing/[:all] to get all the bins (see `_get`). The result is a
vector of `AerospikeRecord` in the same order of keys. Missing keys result in `nil` in corresponding
positions.get-singleclj
(get-single this index set-name)(get-single this index set-name conf)(get-single this index set-name conf bin-names)Returns a single record: (transcoder AerospikeRecord). The default transcoder is identity.
Pass a :policy in conf to use a non-default ReadPolicy.
Returns a single record: `(transcoder AerospikeRecord)`. The default transcoder is `identity`. Pass a `:policy` in `conf` to use a non-default `ReadPolicy`.
get-single-no-metaclj
(get-single-no-meta this index set-name)(get-single-no-meta this index set-name bin-names)Shorthand to return a single record payload only.
Shorthand to return a single record payload only.
AerospikeSetOpscljprotocol
scan-setclj
(scan-set this aero-namespace set-name conf)Scans through the given set and calls a user defined callback for each record that was found.
Returns a future response that resolves once the scan completes. When the scan completes
successfully it returns true. The scan may be aborted by returning :abort-scan from the callback.
In that case the return value is false.
The conf argument should be a map with the following keys:
:callback - Function that accepts a com.aerospike.client.Value and an AerospikeRecord.
:policy - Optional. com.aerospike.client.policy.ScanPolicy.
:bins - Optional. Vector of bin names to return. Returns all bins by default.
Scans through the given set and calls a user defined callback for each record that was found. Returns a future response that resolves once the scan completes. When the scan completes successfully it returns `true`. The scan may be aborted by returning :abort-scan from the callback. In that case the return value is `false`. The `conf` argument should be a map with the following keys: :callback - Function that accepts a com.aerospike.client.Value and an AerospikeRecord. :policy - Optional. com.aerospike.client.policy.ScanPolicy. :bins - Optional. Vector of bin names to return. Returns all bins by default.
AerospikeSingleIndexBatchOpscljprotocol
operateclj
(operate this index set-name expiration operations)(operate this index set-name expiration operations conf)Asynchronously perform multiple read/write operations on a single key in one batch call.
This method registers the command with an event loop and returns. The event loop thread
will process the command and send the results to the listener.
commands is a sequence of Aerospike CDT operations.
Asynchronously perform multiple read/write operations on a single key in one batch call. This method registers the command with an event loop and returns. The event loop thread will process the command and send the results to the listener. `commands` is a sequence of Aerospike CDT operations.
AerospikeUpdateOpscljprotocol
Update operations of a single Aerospike record.
Update operations of a single Aerospike record.
add-binsclj
(add-bins this index set-name new-data new-expiration)(add-bins this index set-name new-data new-expiration conf)Add bins to an existing record without modifying old data. The new-data must be a
Clojure map.
Add bins to an existing record without modifying old data. The `new-data` must be a Clojure map.
replace-onlyclj
(replace-only this index set-name data expiration)(replace-only this index set-name data expiration conf)put with a replace-only policy.
`put` with a `replace-only` policy.
set-singleclj
(set-single this index set-name data expiration)(set-single this index set-name data expiration conf)put with an update policy.
`put` with an `update` policy.
touchclj
(touch this index set-name expiration)(touch this index set-name expiration conf)Updates the TTL of the record stored under at index to expiration seconds from now.
Expects records to exist.
Updates the TTL of the record stored under at `index` to `expiration` seconds from now. Expects records to exist.
updateclj
(update this index set-name new-record generation new-expiration)(update this index set-name new-record generation new-expiration conf)Write a new value for the key index.
Generation: the expected modification count of the record (i.e. how many times was it
modified before my current action). Pass a function in (:transcoder conf) to modify
data before it is sent to the DB.
Write a new value for the key `index`. Generation: the expected modification count of the record (i.e. how many times was it modified before my current action). Pass a function in `(:transcoder conf)` to modify `data` before it is sent to the DB.
AerospikeWriteOpscljprotocol
Write operations of a single Aerospike record.
Write operations of a single Aerospike record.
createclj
(create this index set-name data expiration)(create this index set-name data expiration conf)put with a create-only policy.
`put` with a `create-only` policy.
putclj
(put this index set-name data expiration)(put this index set-name data expiration conf)Writes data into a record with the key index, with the TTL of expiration seconds.
index should be string. Pass a function in (:transcoder conf) to modify data before it
is sent to the DB.
Pass a WritePolicy in (:policy conf) to uses the non-default policy.
When a Clojure map is provided for the data argument, a multiple bin record will be created.
Each key-value pair in the map will be treated as a bin-name, bin-value pair. Bin-names must be
strings. Bin-values can be any nested data structure.
Writes `data` into a record with the key `index`, with the TTL of `expiration` seconds. `index` should be string. Pass a function in `(:transcoder conf)` to modify `data` before it is sent to the DB. Pass a `WritePolicy` in `(:policy conf)` to uses the non-default policy. When a Clojure map is provided for the `data` argument, a multiple bin record will be created. Each key-value pair in the map will be treated as a bin-name, bin-value pair. Bin-names must be strings. Bin-values can be any nested data structure.
put-multipleclj
(put-multiple this indices set-names payloads expirations)(put-multiple this indices set-names payloads expirations conf)Put multiple payloads by invoking put. All arguments should be mutually
corresponding sequences.
Put multiple payloads by invoking `put`. All arguments should be mutually corresponding sequences.
ClientEventscljprotocol
Continuation functions that are registered when an async DB operation is called. The value returned from those function will be the value of the returned future from the async operation.
Continuation functions that are registered when an async DB operation is called. The value returned from those function will be the value of the returned future from the async operation.
on-failureclj
(on-failure this op-name op-ex index op-start-time)A continuation function. Registered on the operation future and called when operations fails.
A continuation function. Registered on the operation future and called when operations fails.
on-successclj
(on-success this op-name op-result index op-start-time)A continuation function. Registered on the operation future and called when operations succeeds.
A continuation function. Registered on the operation future and called when operations succeeds.
UserKeycljprotocol
Use create-key directly to pass a pre-made custom key to the public API.
When passing a simple String/Integer/Long/ByteArray the key will be created
automatically for you. If you pass a ready made key, as-namespace and
set-name are ignored in API calls.
Use `create-key` directly to pass a pre-made custom key to the public API. When passing a simple String/Integer/Long/ByteArray the key will be created automatically for you. If you pass a ready made key, `as-namespace` and `set-name` are ignored in API calls.
create-keyclj
(create-key this as-namespace set-name)cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close