Liking cljdoc? Tell your friends :D

aerospike-clj.client


ClientEventscljprotocol

Continuation functions that are registered when an async DB operation is called. The DB passed is IAerospikeClient. The value returned from those function will be the value of the returned deferred from the async operation.

Continuation functions that are registered when an async DB operation is called.
The DB passed is IAerospikeClient.
The value returned from those function will be the value of the returned deferred from the async operation.

on-failureclj

(on-failure _ op-name op-ex index op-start-time db)

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 _ op-name op-result index op-start-time db)

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.
sourceraw docstring

createclj

(create db index set-name data expiry)

put with a create-only policy

put with a create-only policy
sourceraw docstring

create-clientclj

(create-client hosts client-policy)
source

create-client-policyclj

(create-client-policy event-loops conf)
source

create-event-loopsclj

(create-event-loops conf)

Called internally to create the event loops of for the client. Can also be used to share event loops between several clients

Called internally to create the event loops of for the client. Can also be used to share event loops between several clients
sourceraw docstring

deleteclj

(delete db index set-name)

deletes the record stored for key <index>. Returns async true/false for deletion success (hit)

deletes the record stored for key <index>. Returns async true/false for deletion success (hit)
sourceraw docstring

EPOCHclj

source

exists?clj

(exists? db index set-name)
(exists? db index set-name conf)

Asynchronously check if an index exists

Asynchronously check if an index exists
sourceraw docstring

expiry-unixclj

(expiry-unix ttl)

Returns the epoch time of now + <ttl> seconds

Returns the epoch time of now + <ttl> seconds
sourceraw docstring

get-cluster-statsclj

(get-cluster-stats db)

For each xdr client, returns 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.

For each xdr client, returns 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.
sourceraw docstring

get-default-read-policyclj

source

get-default-write-policyclj

source

get-multipleclj

(get-multiple db indices sets)
(get-multiple db indices sets conf)

returns a (future) sequence of AerospikeRecords returned by get-single with records in corresponding places to the required keys. Indices and sets should be sequences

returns a (future) sequence of AerospikeRecords returned by get-single
with records in corresponding places to the required keys. Indices and sets should be sequences
sourceraw docstring

get-singleclj

(get-single db index set-name)
(get-single db index set-name conf)

returns: (transcoder AerospikeRecord).

returns: (transcoder AerospikeRecord).
sourceraw docstring

get-single-no-metaclj

(get-single-no-meta db index set-name)

returns record payload only.

returns record payload only.
sourceraw docstring

healty?clj

(healty? db 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 (including 2 retries so an 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 (including 2 retries so an small over estimation is advised to avoid false negatives.
sourceraw docstring

IAerospikeClientcljprotocol

get-all-clientsclj

(get-all-clients _)

Returns all AerospikeClient objects

Returns all AerospikeClient objects

get-clientclj

(get-client ac index)

Returns the relevant AerospikeClient object for the specific shard

Returns the relevant AerospikeClient object for the specific shard

get-client-policyclj

(get-client-policy _)

Returns the ClientPolicy used by the AerospikeClient

Returns the ClientPolicy used by the AerospikeClient
source

init-simple-aerospike-clientclj

(init-simple-aerospike-client hosts aero-ns)
(init-simple-aerospike-client hosts aero-ns conf)

hosts should be a seq of known hosts to bootstrap from supported config: {username: string password: string event-loops: com.aerospike.client.async.NioEventLoops max-commands-in-process: int max-commands-in-queue: int enable-logging: true (default)}

hosts should be a seq of known hosts to bootstrap from
supported config: {username: string password: string event-loops: com.aerospike.client.async.NioEventLoops
max-commands-in-process: int max-commands-in-queue: int enable-logging: true (default)}
sourceraw docstring

MAX_KEY_LENGTHclj

source

operateclj

(operate db index set-name expiry record-exists-action & 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.

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.
sourceraw docstring

putclj

(put db index set-name data expiry)
(put db index set-name data expiry conf)

Writes <data> into a record with the key <index>, with the ttl of <expiry> seconds. Data should be string.

Writes <data> into a record with the key <index>, with the ttl of <expiry> seconds.
Data should be string.
sourceraw docstring

stop-aerospike-clientclj

(stop-aerospike-client db)
source

touchclj

(touch db index set-name expiry)

updates the ttl of the record stored under the key of <index> to <expiry> seconds from now.

updates the ttl of the record stored under the key of <index> to <expiry> seconds from now.
sourceraw docstring

updateclj

(update db index set-name new-record generation new-expiry)
(update db index set-name new-record generation new-expiry conf)

Writing 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).

Writing 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).  
sourceraw docstring

write-policiesclj

source

write-policyclj

(write-policy expiry record-exists-action)

Create a write policy to be passed to put methods via {:policy wp} or just pass {:record-exists-action rea} to create one for you.

Create a write policy to be passed to put methods via {:policy wp} or just pass {:record-exists-action rea} to create one for you.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close