|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aerospike.client.AerospikeClient
net.citrusleaf.CitrusleafClient
public class CitrusleafClient
Legacy compatibility Layer. This class should only be used for legacy code.
Please use com.aerospike.client.AerospikeClient
for new code.
Instantiate a CitrusleafClient
object to access a Citrusleaf
database cluster and perform database operations.
Your application uses this class API to perform database operations such as writing and reading records, and scanning sets of records. Write operations include specialized functionality such as append/prepend and arithmetic addition.
Records are stored and identified using a specified namespace, an optional set name, and a key which must be unique within a set.
Each record may have multiple bins, unless the Citrusleaf server nodes are configured as "single-bin". In "multi-bin" mode, partial records may be written or read by specifying the relevant subset of bins.
Nested Class Summary | |
---|---|
static class |
CitrusleafClient.ClBin
Container object for record bin name/value pair. |
static class |
CitrusleafClient.ClLogLevel
Log escalation level. |
static class |
CitrusleafClient.ClOptions
Container object for transaction policy attributes used in all database operation calls. |
static class |
CitrusleafClient.ClResult
Container object for database operation results. |
static class |
CitrusleafClient.ClResultCode
Database operation result codes. |
static class |
CitrusleafClient.ClScanningOptions
Container object for optional parameters used in scan operations. |
static class |
CitrusleafClient.ClScanningPriority
Priority of scan operations on database server. |
static class |
CitrusleafClient.ClWriteOptions
Container object for policy attributes used in write operations. |
static interface |
CitrusleafClient.LogCallback
An object implementing this interface may be passed in setLogging() , so the caller can channel Citrusleaf client
logs as desired. |
static interface |
CitrusleafClient.ScanCallback
An object implementing this interface is passed in scan...()
calls, so the caller can be notified with scan results. |
Constructor Summary | |
---|---|
CitrusleafClient()
Constructor, creates CitrusleafClient object and initializes
logging framework. |
|
CitrusleafClient(java.lang.String hostname,
int port)
Constructor, combines default constructor CitrusleafClient() and
addHost() . |
Method Summary | |
---|---|
CitrusleafClient.ClResultCode |
add(java.lang.Object key,
java.lang.Object value)
For integer values, and server nodes configured as "single-bin" only - add value to existing record value for specified key, using default namespace, no set name, and default options. |
CitrusleafClient.ClResultCode |
add(java.lang.Object key,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values, and server nodes configured as "single-bin" only - add value to existing record value for specified key, using default namespace and no set name. |
CitrusleafClient.ClResultCode |
add(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
add(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
add(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for specified key. |
CitrusleafClient.ClResult |
addAndGet(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key, and return the results. |
CitrusleafClient.ClResult |
addAndGet(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key, and return the results. |
CitrusleafClient.ClResultCode |
addDigest(java.lang.String namespace,
byte[] digest,
CitrusleafClient.ClBin bin,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for specified key digest. |
CitrusleafClient.ClResultCode |
addDigest(java.lang.String namespace,
byte[] digest,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key digest. |
CitrusleafClient.ClResultCode |
addDigest(java.lang.String namespace,
byte[] digest,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for each bin for specified key digest. |
CitrusleafClient.ClResultCode |
addDigest(java.lang.String namespace,
byte[] digest,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For integer values only - add value to existing bin value for specified key digest. |
CitrusleafClient.ClResultCode |
addHost(java.lang.String hostname,
int port)
Add a server database host to the client's cluster map. |
CitrusleafClient.ClResultCode |
append(java.lang.Object key,
java.lang.Object value)
For server nodes configured as "single-bin" only - append value to existing record value for specified key, using default namespace, no set name, and default options. |
CitrusleafClient.ClResultCode |
append(java.lang.Object key,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For server nodes configured as "single-bin" only - append value to existing record value for specified key, using default namespace and no set name. |
CitrusleafClient.ClResultCode |
append(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Append value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
append(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Append value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
append(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Append value to existing bin value for specified key. |
CitrusleafClient.ClResult[] |
batchExists(java.lang.String namespace,
java.lang.String set,
java.util.Collection<java.lang.Object> keys,
CitrusleafClient.ClOptions opts)
Batch multiple exists() requests into a single call. |
CitrusleafClient.ClResult[] |
batchGet(java.lang.String namespace,
java.lang.String set,
java.util.Collection<java.lang.Object> keys,
java.util.Collection<java.lang.String> binNames,
CitrusleafClient.ClOptions opts)
Batch multiple get() requests into a single call. |
CitrusleafClient.ClResult[] |
batchGet(java.lang.String namespace,
java.lang.String set,
java.util.Collection<java.lang.Object> keys,
java.lang.String binName,
CitrusleafClient.ClOptions opts)
Batch multiple get() requests into a single call. |
CitrusleafClient.ClResult[] |
batchGetAll(java.lang.String namespace,
java.lang.String set,
java.util.Collection<java.lang.Object> keys,
CitrusleafClient.ClOptions opts)
Batch multiple getAll() requests into a single call. |
static void |
ClLog(CitrusleafClient.ClLogLevel logLevel,
java.lang.String msg)
|
static byte[] |
computeDigest(java.lang.String set,
java.lang.Object key)
Generate digest from key and set name. |
boolean |
connect()
Deprecated. |
CitrusleafClient.ClResultCode |
delete(java.lang.Object key,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Delete record for specified key, using default namespace and no set name. |
CitrusleafClient.ClResultCode |
delete(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Delete record for specified key. |
CitrusleafClient.ClResultCode |
deleteDigest(java.lang.String namespace,
byte[] digest,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Delete record for specified key digest. |
CitrusleafClient.ClResultCode |
exists(java.lang.Object key)
Check if specified key exists, using default namespace, no set name, and default options. |
CitrusleafClient.ClResultCode |
exists(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
CitrusleafClient.ClOptions opts)
Check if specified key exists. |
java.lang.Object |
get(java.lang.Object key)
For server nodes configured as "single-bin" only - get record value for specified key, using default namespace, no set name, and default options. |
CitrusleafClient.ClResult |
get(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<java.lang.String> binNames,
CitrusleafClient.ClOptions opts)
Get bin name/value pairs for specified key and list of bin names. |
CitrusleafClient.ClResult |
get(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String[] binNames,
CitrusleafClient.ClOptions opts)
Get bin name/value pairs for specified key and list of bin names. |
CitrusleafClient.ClResult |
get(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String binName,
CitrusleafClient.ClOptions opts)
Get bin value for specified key and bin name. |
CitrusleafClient.ClResult |
getAll(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
CitrusleafClient.ClOptions opts)
Get all bin name/value pairs for specified key. |
CitrusleafClient.ClResult |
getAllDigest(java.lang.String namespace,
byte[] digest,
CitrusleafClient.ClOptions opts)
Get all bin name/value pairs for specified key digest. |
CitrusleafClient.ClResult |
getDigest(java.lang.String namespace,
byte[] digest,
java.util.Collection<java.lang.String> binNames,
CitrusleafClient.ClOptions opts)
Get bin name/value pairs for specified key digest and list of bin names. |
CitrusleafClient.ClResult |
getDigest(java.lang.String namespace,
byte[] digest,
java.lang.String binName,
CitrusleafClient.ClOptions opts)
Get bin value for specified key digest and bin name. |
java.util.List<java.lang.String> |
getNodeNameList()
Return a list of server nodes in the cluster. |
CitrusleafClient.ClResult |
getWithTouch(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<java.lang.String> binNames,
int expiration,
CitrusleafClient.ClOptions opts)
Get bin name/value pairs for specified key and list of bin names, and if the record exists, reset record time to expiration. |
void |
log(Log.Level level,
java.lang.String message)
Implementation of com.aerospike.client.Log.Callback |
CitrusleafClient.ClResult |
operate(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<java.lang.String> readBinNames,
java.util.Collection<CitrusleafClient.ClBin> writeBins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Combine get() and set() operations for a
specified record. |
CitrusleafClient.ClResultCode |
prepend(java.lang.Object key,
java.lang.Object value)
For server nodes configured as "single-bin" only - prepend value to existing record value for specified key, using default namespace, no set name, and default options. |
CitrusleafClient.ClResultCode |
prepend(java.lang.Object key,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For server nodes configured as "single-bin" only - prepend value to existing record value for specified key, using default namespace and no set name. |
CitrusleafClient.ClResultCode |
prepend(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Prepend value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
prepend(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Prepend value to existing bin value for each bin for specified key. |
CitrusleafClient.ClResultCode |
prepend(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Prepend value to existing bin value for specified key. |
CitrusleafClient.ClResult |
scan(java.lang.String namespace,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Deprecated. |
CitrusleafClient.ClResult |
scan(java.lang.String namespace,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData,
boolean noBinData)
Deprecated. |
CitrusleafClient.ClResult |
scan(java.lang.String namespace,
java.lang.String set,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Deprecated. |
CitrusleafClient.ClResult |
scan(java.lang.String namespace,
java.lang.String set,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData,
boolean noBinData)
Deprecated. |
CitrusleafClient.ClResultCode |
scan(java.lang.String namespace,
java.lang.String set,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Scan the database nodes in parallel, using specified namespace and set filters, and default options, returning a single result code. |
java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> |
scanAllNodes(java.lang.String namespace,
java.lang.String set,
boolean noBinData,
int scanPercent,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClScanningOptions scanOpts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Scan the database nodes in parallel, using specified namespace and set filters, retrieving records or digests only, as specified. |
java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> |
scanAllNodes(java.lang.String namespace,
java.lang.String set,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClScanningOptions scanOpts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Scan the database nodes in parallel, using specified namespace and set filters. |
java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> |
scanAllNodes(java.lang.String namespace,
java.lang.String set,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Scan the database nodes in parallel, using specified namespace and set filters, and default options. |
CitrusleafClient.ClResultCode |
scanNode(java.lang.String nodeName,
java.lang.String namespace,
java.lang.String set,
boolean noBinData,
int scanPercent,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClScanningOptions scanOpts,
CitrusleafClient.ScanCallback scanCb,
java.lang.Object userData)
Scan a single database node, using specified namespace and set filters, retrieving records or digests only, as specified. |
CitrusleafClient.ClResultCode |
set(java.lang.Object key,
java.lang.Object value)
For server nodes configured as "single-bin" only - set record value for specified key, using default namespace, no set name, and default options. |
CitrusleafClient.ClResultCode |
set(java.lang.Object key,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
For server nodes configured as "single-bin" only - set record value for specified key, using default namespace and no set name. |
CitrusleafClient.ClResultCode |
set(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin values for specified key and bin names. |
CitrusleafClient.ClResultCode |
set(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin values for specified key and bin names. |
CitrusleafClient.ClResultCode |
set(java.lang.String namespace,
java.lang.String set,
java.lang.Object key,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin value for specified key and bin name. |
void |
setDefaultNamespace(java.lang.String namespace)
Specify namespace to use in database operation calls that do not have a namespace parameter. |
CitrusleafClient.ClResultCode |
setDigest(java.lang.String namespace,
byte[] digest,
CitrusleafClient.ClBin bin,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin value for specified key digest and bin name. |
CitrusleafClient.ClResultCode |
setDigest(java.lang.String namespace,
byte[] digest,
java.util.Collection<CitrusleafClient.ClBin> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin values for specified key digest and bin names. |
CitrusleafClient.ClResultCode |
setDigest(java.lang.String namespace,
byte[] digest,
java.util.Map<java.lang.String,java.lang.Object> bins,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin values for specified key digest and bin names. |
CitrusleafClient.ClResultCode |
setDigest(java.lang.String namespace,
byte[] digest,
java.lang.String binName,
java.lang.Object value,
CitrusleafClient.ClOptions opts,
CitrusleafClient.ClWriteOptions wOpts)
Set record bin value for specified key digest and bin name. |
static void |
setLogging(CitrusleafClient.ClLogLevel level,
CitrusleafClient.LogCallback logCb)
Set logging level filter and optional log callback implementation. |
Methods inherited from class com.aerospike.client.AerospikeClient |
---|
add, append, close, createIndex, delete, dropIndex, execute, execute, exists, exists, get, get, get, get, getHeader, getHeader, getLargeList, getLargeMap, getLargeSet, getLargeStack, getNodeNames, getNodes, isConnected, operate, prepend, put, query, queryAggregate, register, scanAll, scanNode, scanNode, touch |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CitrusleafClient()
CitrusleafClient
object and initializes
logging framework.
This constructor does not add hosts.
public CitrusleafClient(java.lang.String hostname, int port)
CitrusleafClient()
and
addHost()
.
hostname
- host nameport
- host portMethod Detail |
---|
public static void setLogging(CitrusleafClient.ClLogLevel level, CitrusleafClient.LogCallback logCb)
This method may only be called once, at startup.
level
- only show logs at this or more urgent levellogCb
- CitrusleafClient.LogCallback
implementation, pass
null
to let Citrusleaf client write
logs to System.err
public void log(Log.Level level, java.lang.String message)
log
in interface Log.Callback
level
- log level
message
- log messagepublic CitrusleafClient.ClResultCode addHost(java.lang.String hostname, int port)
The following actions occur upon the first invocation of this method:
- create new cluster map
- add host to cluster map
- connect to host server
- request host's list of other nodes in cluster
- add these nodes to cluster map
Further invocations will add hosts to the cluster map if they don't
already exist. In most cases, only one addHost()
call is
necessary. When this call succeeds, the client is ready to process
database requests.
hostname
- host nameport
- host port
result status
@Deprecated public boolean connect()
AerospikeClient.isConnected()
.
public java.util.List<java.lang.String> getNodeNameList()
public void setDefaultNamespace(java.lang.String namespace)
namespace
- namespace to use in calls that have no namepsace
parameterpublic static byte[] computeDigest(java.lang.String set, java.lang.Object key)
set
- set namekey
- record identifier, unique within set
public CitrusleafClient.ClResultCode set(java.lang.Object key, java.lang.Object value)
If the record does not exist, it will be created. If it exists its value is replaced.
key
- record identifier, unique within setvalue
- single-bin value
result status
public CitrusleafClient.ClResultCode set(java.lang.Object key, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record does not exist, it will be created. If it exists its value is replaced.
key
- record identifier, unique within setvalue
- single-bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode set(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode set(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode set(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode setDigest(java.lang.String namespace, byte[] digest, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode setDigest(java.lang.String namespace, byte[] digest, CitrusleafClient.ClBin bin, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebin
- bin name/value pairopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode setDigest(java.lang.String namespace, byte[] digest, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode setDigest(java.lang.String namespace, byte[] digest, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created. If the bin exists its value is replaced. Others bins are ignored.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode append(java.lang.Object key, java.lang.Object value)
If the record does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
key
- record identifier, unique within setvalue
- value to append
result status
public CitrusleafClient.ClResultCode append(java.lang.Object key, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
key
- record identifier, unique within setvalue
- value to appendopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode append(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- value to appendopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode append(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode append(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode prepend(java.lang.Object key, java.lang.Object value)
If the record does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
key
- record identifier, unique within setvalue
- value to prepend
result status
public CitrusleafClient.ClResultCode prepend(java.lang.Object key, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
key
- record identifier, unique within setvalue
- value to prependopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode prepend(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- value to prependopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode prepend(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode prepend(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
This call works only if the specified value's type matches the existing
value's type, and the type is not an integer (i.e. Integer
or Long
.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode add(java.lang.Object key, java.lang.Object value)
If the record does not exist, it will be created with the specified value.
key
- record identifier, unique within setvalue
- bin value
result status
public CitrusleafClient.ClResultCode add(java.lang.Object key, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record does not exist, it will be created with the specified value.
key
- record identifier, unique within setvalue
- bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode add(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode add(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode add(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResult addAndGet(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairs
with new valuespublic CitrusleafClient.ClResult addAndGet(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairs
with new valuespublic CitrusleafClient.ClResultCode addDigest(java.lang.String namespace, byte[] digest, java.lang.String binName, java.lang.Object value, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebinName
- bin name, pass ""
if server nodes
are configured as "single-bin"value
- bin valueopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode addDigest(java.lang.String namespace, byte[] digest, CitrusleafClient.ClBin bin, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebin
- bin name/value pairopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode addDigest(java.lang.String namespace, byte[] digest, java.util.Collection<CitrusleafClient.ClBin> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebins
- bin name/value pairs as Collection
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode addDigest(java.lang.String namespace, byte[] digest, java.util.Map<java.lang.String,java.lang.Object> bins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
If the record or bin does not exist, it will be created with the specified value.
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebins
- bin name/value pairs as Map
opts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode delete(java.lang.Object key, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
key
- record identifier, unique within setopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode delete(java.lang.String namespace, java.lang.String set, java.lang.Object key, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResultCode deleteDigest(java.lang.String namespace, byte[] digest, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
nameopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
result status
public java.lang.Object get(java.lang.Object key)
key
- record identifier, unique within set
CitrusleafClient.ClResult
containing single-bin valuepublic CitrusleafClient.ClResult get(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String binName, CitrusleafClient.ClOptions opts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinName
- bin name filter, pass ""
if server
nodes are configured as "single-bin"opts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin valuepublic CitrusleafClient.ClResult get(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.lang.String[] binNames, CitrusleafClient.ClOptions opts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinNames
- bin names filter as arrayopts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResult get(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<java.lang.String> binNames, CitrusleafClient.ClOptions opts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinNames
- bin names filter as Collection
opts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResult getAll(java.lang.String namespace, java.lang.String set, java.lang.Object key, CitrusleafClient.ClOptions opts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setopts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResult getWithTouch(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<java.lang.String> binNames, int expiration, CitrusleafClient.ClOptions opts)
This operation will increment the record generation.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setbinNames
- bin names filter as Collection
expiration
- new record expiration (see
CitrusleafClient.ClWriteOptions.expiration
)opts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResult[] batchGet(java.lang.String namespace, java.lang.String set, java.util.Collection<java.lang.Object> keys, java.lang.String binName, CitrusleafClient.ClOptions opts)
get()
requests into a single call.
Elements of keys
are positionally matched with elements of
result array.
namespace
- namespaceset
- optional set namekeys
- batch of keys as Collection
binName
- bin name filter, pass ""
if server
nodes are configured as "single-bin"opts
- transaction policy attributes
,
pass null
to use defaults
result
array where each element
contains bin name/value pairspublic CitrusleafClient.ClResult[] batchGet(java.lang.String namespace, java.lang.String set, java.util.Collection<java.lang.Object> keys, java.util.Collection<java.lang.String> binNames, CitrusleafClient.ClOptions opts)
get()
requests into a single call.
Elements of keys
are positionally matched with elements of
result array.
namespace
- namespaceset
- optional set namekeys
- batch of keys as Collection
binNames
- bin names filter as Collection
opts
- transaction policy attributes
,
pass null
to use defaults
result
array where each element
contains bin name/value pairspublic CitrusleafClient.ClResult[] batchGetAll(java.lang.String namespace, java.lang.String set, java.util.Collection<java.lang.Object> keys, CitrusleafClient.ClOptions opts)
getAll()
requests into a single call.
Elements of keys
are positionally matched with elements of
result array.
namespace
- namespaceset
- optional set namekeys
- batch of keys as Collection
opts
- transaction policy attributes
,
pass null
to use defaults
result
array where each element
contains bin name/value pairspublic CitrusleafClient.ClResult getDigest(java.lang.String namespace, byte[] digest, java.lang.String binName, CitrusleafClient.ClOptions opts)
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebinName
- bin name filter, pass ""
if server
nodes are configured as "single-bin"opts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin valuepublic CitrusleafClient.ClResult getDigest(java.lang.String namespace, byte[] digest, java.util.Collection<java.lang.String> binNames, CitrusleafClient.ClOptions opts)
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
namebinNames
- bin names filter as Collection
opts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResult getAllDigest(java.lang.String namespace, byte[] digest, CitrusleafClient.ClOptions opts)
Non-Digest database methods send the normal key and set name to the server which converts them to a digest. Digest methods send the digest directly.
namespace
- namespacedigest
- unique identifier generated from key and set
nameopts
- transaction policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
containing bin name/value pairspublic CitrusleafClient.ClResultCode exists(java.lang.Object key)
key
- record identifier, unique within set
result status
public CitrusleafClient.ClResultCode exists(java.lang.String namespace, java.lang.String set, java.lang.Object key, CitrusleafClient.ClOptions opts)
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setopts
- transaction policy attributes
,
pass null
to use defaults
result status
public CitrusleafClient.ClResult[] batchExists(java.lang.String namespace, java.lang.String set, java.util.Collection<java.lang.Object> keys, CitrusleafClient.ClOptions opts)
exists()
requests into a single call.
Elements of keys
are positionally matched with elements of
result array.
namespace
- namespaceset
- optional set namekeys
- batch of keys as Collection
opts
- transaction policy attributes
,
pass null
to use defaults
result
array where each element
indicates whether its corresponding key exists@Deprecated public CitrusleafClient.ClResult scan(java.lang.String namespace, CitrusleafClient.ClOptions opts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceopts
- transaction policy attributes
,
pass null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
CitrusleafClient.ClResult
for final record@Deprecated public CitrusleafClient.ClResult scan(java.lang.String namespace, java.lang.String set, CitrusleafClient.ClOptions opts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, not supported as scan filteropts
- transaction policy attributes
,
pass null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
CitrusleafClient.ClResult
for final record@Deprecated public CitrusleafClient.ClResult scan(java.lang.String namespace, CitrusleafClient.ClOptions opts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData, boolean noBinData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceopts
- transaction policy attributes
,
pass null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
CitrusleafClient.ClResult
for final record@Deprecated public CitrusleafClient.ClResult scan(java.lang.String namespace, java.lang.String set, CitrusleafClient.ClOptions opts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData, boolean noBinData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, not supported as scan filteropts
- transaction policy attributes
,
pass null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined datanoBinData
- true
to retrieve digests only,
false
to retrieve bin data
CitrusleafClient.ClResult
for final recordpublic CitrusleafClient.ClResultCode scanNode(java.lang.String nodeName, java.lang.String namespace, java.lang.String set, boolean noBinData, int scanPercent, CitrusleafClient.ClOptions opts, CitrusleafClient.ClScanningOptions scanOpts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
nodeName
- node to scannamespace
- namespaceset
- set name, pass null
to retrieve all
records in the namespacenoBinData
- true
to retrieve digests only,
false
to retrieve bin datascanPercent
- fraction of data to scan - not yet supportedopts
- transaction policy attributes
,
pass null
to use defaultsscanOpts
- parallel scan policy attributes, pass
null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
result status
public CitrusleafClient.ClResultCode scan(java.lang.String namespace, java.lang.String set, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call is the same as
scanAllNodes()
but returns only one result code.
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, pass null
to retrieve all
records in the namespacescanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
result status
,
OK
if all nodes
succeeded, else first error code encounteredpublic java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> scanAllNodes(java.lang.String namespace, java.lang.String set, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, pass null
to retrieve all
records in the namespacescanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
result status
for each nodepublic java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> scanAllNodes(java.lang.String namespace, java.lang.String set, CitrusleafClient.ClOptions opts, CitrusleafClient.ClScanningOptions scanOpts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, pass null
to retrieve all
records in the namespaceopts
- transaction policy attributes
,
pass null
to use defaultsscanOpts
- parallel scan policy attributes, pass
null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
result status
for each nodepublic java.util.Map<java.lang.String,CitrusleafClient.ClResultCode> scanAllNodes(java.lang.String namespace, java.lang.String set, boolean noBinData, int scanPercent, CitrusleafClient.ClOptions opts, CitrusleafClient.ClScanningOptions scanOpts, CitrusleafClient.ScanCallback scanCb, java.lang.Object userData)
This call will block until the scan is complete - callbacks are made within the scope of this call.
namespace
- namespaceset
- set name, pass null
to retrieve all
records in the namespacenoBinData
- true
to retrieve digests only,
false
to retrieve bin datascanPercent
- fraction of data to scan - not yet supportedopts
- transaction policy attributes
,
pass null
to use defaultsscanOpts
- parallel scan policy attributes, pass
null
to use defaultsscanCb
- CitrusleafClient.ScanCallback
implementationuserData
- pass-through user-defined data
result status
for each nodepublic CitrusleafClient.ClResult operate(java.lang.String namespace, java.lang.String set, java.lang.Object key, java.util.Collection<java.lang.String> readBinNames, java.util.Collection<CitrusleafClient.ClBin> writeBins, CitrusleafClient.ClOptions opts, CitrusleafClient.ClWriteOptions wOpts)
get()
and set()
operations for a
specified record.
namespace
- namespaceset
- optional set namekey
- record identifier, unique within setreadBinNames
- bin names filter for readwriteBins
- bin name/value pairs to writeopts
- transaction policy attributes
,
pass null
to use defaultswOpts
- write policy attributes
,
pass null
to use defaults
CitrusleafClient.ClResult
for read, containing bin
name/value pairspublic static void ClLog(CitrusleafClient.ClLogLevel logLevel, java.lang.String msg)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |