The CitrusleafClient type exposes the following members.
Back to Top
Methods
Name | Description | |
---|---|---|
![]() | Add(Object, Object, CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for specified key.
If the record or bin does not exist, it will be created with the specified value.
The following properties must be set before using this method.
|
![]() | Add(String, String, Object, IDictionary String, Object , CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for each bin for specified key.
If the record or bin does not exist, it will be created with the specified value.
|
![]() | Add(String, String, Object, IList String , IList Object , CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for each bin for specified key.
If the record or bin does not exist, it will be created with the specified value.
|
![]() | Add(String, String, Object, String, Object, CitrusleafWriteInfo) |
Used for integer values only. Add value to existing bin value for specified key.
If the record or bin does not exist, it will be created with the specified value.
|
![]() | AddDigest( Byte , Object, CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for specified key digest.
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.
The following properties must be set before using this method.
|
![]() | AddDigest(String, Byte , IDictionary String, Object , CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for each bin for specified key digest.
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.
|
![]() | AddDigest(String, Byte , IList String , IList Object , CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for each bin for specified key digest.
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.
|
![]() | AddDigest(String, Byte , String, Object, CitrusleafWriteInfo) |
Used for integer values only.
Add value to existing bin value for specified key digest.
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.
|
![]() | AddHost |
Add a host to the client's cluster map. The following actions occur upon the first
invocation of this method:
|
![]() | BatchGet(ICollection Object , Object , UInt32 , Int32) |
Batch mulitple get requests into a single call.
The following properties must be set before using this method.
|
![]() | BatchGet(String, String, ICollection Object , IList String , IDictionary String, Object , UInt32 , Int32) |
Batch multiple get requests into a single call. Return a list of dictionaries, each dictionary
containing a collection of bin name/value pairs.
|
![]() | BatchGet(String, String, ICollection Object , String, Object , UInt32 , Int32) |
Batch multiple get requests into a single call.
|
![]() | BatchGetAll |
Batch multiple get requests into a single call.
Return a list of dictionaries, each dictionary containing a collection of bin name/value pairs.
|
![]() | BatchTouch |
Batch multiple touch requests into a single call.
For each key, reset record time to expiration without changing its value
and increment record generation count.
This method returns KEY_NOT_FOUND_ERROR for each key that does not exist.
|
![]() ![]() | ComputeDigest |
Generate digest from a combination of key and set name attributes.
|
![]() | Delete(Object, CitrusleafWriteInfo) |
Delete a record for specified key.
The following properties must be set before using this method.
|
![]() | Delete(String, String, Object, CitrusleafWriteInfo) |
Delete record for specified key.
|
![]() | DeleteDigest( Byte , CitrusleafWriteInfo) |
Delete a row for specified key digest.
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.
The following properties must be set before using this method.
|
![]() | DeleteDigest(String, Byte , CitrusleafWriteInfo) |
Delete record for specified key digest.
|
![]() | Dispose |
Close client connections to servers.
|
![]() | ![]() | (Inherited from ![]() |
![]() | ![]() | Allows an (Inherited from ![]() ![]() ![]() |
![]() | Get(Object, Object , UInt32 , Int32) |
Get bin value and record generation for specified key.
The following properties must be set before using this method.
|
![]() | Get(String, String, Object, IList String , IDictionary String, Object , UInt32 , Int32) |
Get dictionary of bin name/value pairs for specified key and list of bin names.
The get will timeout if the server does not respond within the specified time period.
|
![]() | Get(String, String, Object, String, Object , UInt32 , Int32) |
Get bin value and generation for specified key and bin name. The get will timeout if the server
does not respond within the specified time period.
|
![]() | GetActiveNodes |
Get list of active nodes in the cluster.
|
![]() | GetAll |
Get all bins for specified key. The record generation count is also returned.
|
![]() | GetAllDigest |
Get all bins for specified key digest. The record generation count is also returned.
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.
|
![]() | GetDigest( Byte , Object , UInt32 , Int32) |
Get bin value and record generation for specified key digest.
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.
The following properties must be set before using this method.
|
![]() | GetDigest(String, Byte , IList String , IDictionary String, Object , UInt32 , Int32) |
Get dictionary of bin name/value pairs for specified key digest and list of bin names.
The get will timeout if the server does not respond within the specified time period.
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.
|
![]() | GetDigest(String, Byte , String, Object , UInt32 , Int32) |
Get bin value and generation for specified key digest and bin name. The get will timeout if
the server does not respond within the specified time period.
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.
|
![]() | ![]() | Serves as a hash function for a particular type. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | GetWithTouch |
Get bin value for specified key and bin name.
If the record exists, reset record time to expiration and increment record generation count.
|
![]() ![]() | Info(String, Int32, IDictionary String, String , ClLog, Dictionary String, String ) |
Get all server status data. Please see handbook for detailed statistics returned.
|
![]() ![]() | Info(String, Int32, IList String , IDictionary String, String , ClLog, Dictionary String, String ) |
Get server status attributes for specified list of names.
|
![]() ![]() | Info(String, Int32, String, String , ClLog, Dictionary String, String ) |
Get server status attribute for specified name.
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | Scan(String, String, Int32, CitrusleafClient IScanCallback) |
Read records in the database using specified namespace filter, set name filter and the
latest callback interface arguments. This method issues scan requests to every server
node in the cluster in parallel threads. The client parses the returned scan data and
calls the supplied user-defined callback method for each record returned.
The user can terminate the scan by returning false in the callback method.
This method will block until the scan is complete or terminated by the callback
method. Callbacks are made within the scope of this method call.
|
![]() | Scan(String, String, Int32, ScanCallback2) | Obsolete.
Scan the database using specified namespace and set filters.
The supplied user-defined method is called for each record returned.
The user can terminate the scan by returning false in the callback method.
This method will block until the scan is complete or terminated by the callback
method. Callbacks are made within the scope of this method call.
|
![]() | Scan(String, String, Int32, ScanCallback, Object) | Obsolete.
Scan the database using specified namespace and set filters.
The supplied user-defined method is called for each record returned.
This method will block until the scan is complete. Callbacks are
made within the scope of this method call.
This method exists for backwards compatibility.
|
![]() | ScanNode |
Scan a single node in the cluster.
|
![]() | Set(Object, Object, CitrusleafWriteInfo) |
Set bin value for specified key.
The following properties must be set before using this method.
|
![]() | Set(String, String, Object, IDictionary String, Object , CitrusleafWriteInfo) |
Set record bin values for specified key and bin names.
If the key or bin does not exist, it will be created.
If the bin exists its value is replaced. Others bins are ignored.
|
![]() | Set(String, String, Object, IList String , IList Object , CitrusleafWriteInfo) |
Set record bin values for specified key and bin names.
If the key or bin does not exist, it will be created.
If the bin exists its value is replaced. Others bins are ignored.
|
![]() | Set(String, String, Object, String, Object, CitrusleafWriteInfo) |
Set record bin value for specified key and bin name.
If the key or bin does not exist, it will be created.
If the bin exists its value is replaced. Others bins are ignored.
|
![]() | Set(String, String, Object, String, String, CitrusleafWriteInfo) |
Set record bin value for specified key and bin name.
If the key or bin does not exist, it will be created.
If the bin exists its value is replaced. Others bins are ignored.
|
![]() | SetBinUnique(Object, Object, CitrusleafWriteInfo) |
Set bin value for specified key. The set will fail if the default bin name already exists.
The following properties must be set before using this method.
|
![]() | SetBinUnique(String, String, Object, IDictionary String, Object , CitrusleafWriteInfo) |
Set bin values for specified key and bin names. The set will fail if the bin name
already exists.
|
![]() | SetBinUnique(String, String, Object, IList String , IList Object , CitrusleafWriteInfo) |
Set bin values for specified key and bin names. The set will fail if the bin name
already exists.
|
![]() | SetBinUnique(String, String, Object, String, Object, CitrusleafWriteInfo) |
Set bin value for specified key and bin name. The set will fail if the bin name already exists.
|
![]() | SetBinUniqueDigest( Byte , Object, CitrusleafWriteInfo) |
Set bin value for specified key digest. The set will fail if the bin name already exists.
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.
The following properties must be set before using this method.
|
![]() | SetBinUniqueDigest(String, Byte , String, Object, CitrusleafWriteInfo) |
Set bin value for specified key and bin name digest and bin name. The set will fail if the bin name exists.
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.
|
![]() | SetDigest( Byte , Object, CitrusleafWriteInfo) |
Set bin value for specified key digest.
If the key 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.
The following properties must be set before using this method.
|
![]() | SetDigest(String, Byte , IDictionary String, Object , CitrusleafWriteInfo) |
Set record bin values for specified key digest and bin names.
If the key 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.
|
![]() | SetDigest(String, Byte , IList String , IList Object , CitrusleafWriteInfo) |
Set record bin values for specified key digest and bin names.
If the key 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.
|
![]() | SetDigest(String, Byte , String, Object, CitrusleafWriteInfo) |
Set bin value for specified key and bin name digest.
If the key 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.
|
![]() | SetLogging |
Set the logging level of citrusleaf. Allows the specification of a callback delegate,
which will be called whenever a message of greater verbosity than the set level happens.
|
![]() | SetUnique(Object, Object, CitrusleafWriteInfo) |
Set bin value for specified key. The set will fail if the key already exists.
The following properties must be set before using this method.
|
![]() | SetUnique(String, String, Object, IDictionary String, Object , CitrusleafWriteInfo) |
Set record bin values for specified key and bin names. The set will fail if the
key already exists.
|
![]() | SetUnique(String, String, Object, IList String , IList Object , CitrusleafWriteInfo) |
Set record bin values for specified key and bin names. The set will fail if the
key already exists.
|
![]() | SetUnique(String, String, Object, String, Object, CitrusleafWriteInfo) |
Set record bin value for specified key and bin name. The set will fail if the
key already exists.
|
![]() | SetUniqueDigest( Byte , Object, CitrusleafWriteInfo) |
Set bin value for specified key digest. The set will fail if the key already exists.
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.
The following properties must be set before using this method.
|
![]() | SetUniqueDigest(String, Byte , IDictionary String, Object , CitrusleafWriteInfo) |
Set record bin values for specified key digest and bin names. The set will fail if the
key digest already exists.
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.
|
![]() | SetUniqueDigest(String, Byte , IList String , IList Object , CitrusleafWriteInfo) |
Set record bin values for specified key and bin names. The set will fail if the
key already exists.
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.
|
![]() | SetUniqueDigest(String, Byte , String, Object, CitrusleafWriteInfo) |
Set bin value for specified key and bin name digest. The set will fail if the key already exists.
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.
|
![]() | ![]() | (Inherited from ![]() |
![]() | Touch(Object, Int32, Int32) |
Reset record time to expiration without changing its value for specified key.
The record generation count will also be incremented.
This method returns KEY_NOT_FOUND_ERROR if the record does not exist.
The following properties must be set before using this method.
|
![]() | Touch(String, String, Object, Int32, Int32) |
Reset record time to expiration without changing its value for specified key.
The record generation count will also be incremented.
This method returns KEY_NOT_FOUND_ERROR if the record does not exist.
|
![]() | TouchDigest( Byte , Int32, Int32) |
Reset record time to expiration without changing its value for specified key digest.
The record generation count will also be incremented.
This method returns KEY_NOT_FOUND_ERROR if the record does not exist.
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.
The following properties must be set before using this method.
|
![]() | TouchDigest(String, Byte , Int32, Int32) |
Reset record time to expiration without changing its value for specified key digest.
The record generation count will also be incremented.
This method returns KEY_NOT_FOUND_ERROR if the record does not exist.
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.
The following properties must be set before using this method.
|
See Also