CitrusleafClient MembersAerospike

The CitrusleafClient type exposes the following members.
Constructors

  NameDescription
Public methodCitrusleafClient
Construct a CirusleafClient object and initialize logging framework.
Back to Top
Methods

  NameDescription
Public methodAdd(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.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodAdd(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.
Public methodAdd(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.
Public methodAdd(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.
Public methodAddDigest( 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.
  • DefaultNamespace
  • DefaultBin
Public methodAddDigest(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.
Public methodAddDigest(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.
Public methodAddDigest(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.
Public methodAddHost
Add a host to the client's cluster map. 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 the cluster.
  • Add these nodes to the 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.
Public methodBatchGet(ICollection Object ,  Object  ,  UInt32  , Int32)
Batch mulitple get requests into a single call. The following properties must be set before using this method.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodBatchGet(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.
Public methodBatchGet(String, String, ICollection Object , String,  Object  ,  UInt32  , Int32)
Batch multiple get requests into a single call.
Public methodBatchGetAll
Batch multiple get requests into a single call. Return a list of dictionaries, each dictionary containing a collection of bin name/value pairs.
Public methodBatchTouch
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.
Public methodStatic memberComputeDigest
Generate digest from a combination of key and set name attributes.
Public methodDelete(Object, CitrusleafWriteInfo)
Delete a record for specified key. The following properties must be set before using this method.
  • DefaultNamespace
  • DefaultSet
Public methodDelete(String, String, Object, CitrusleafWriteInfo)
Delete record for specified key.
Public methodDeleteDigest( 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.
  • DefaultNamespace
Public methodDeleteDigest(String,  Byte , CitrusleafWriteInfo)
Delete record for specified key digest.
Public methodDispose
Close client connections to servers.
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an OnlineObject to attempt to free resources and perform other cleanup operations before the OnlineObject is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodGet(Object, Object , UInt32 , Int32)
Get bin value and record generation for specified key. The following properties must be set before using this method.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodGet(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.
Public methodGet(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.
Public methodGetActiveNodes
Get list of active nodes in the cluster.
Public methodGetAll
Get all bins for specified key. The record generation count is also returned.
Public methodGetAllDigest
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.
Public methodGetDigest( 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.
  • DefaultNamespace
  • DefaultBin
Public methodGetDigest(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.
Public methodGetDigest(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.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodGetWithTouch
Get bin value for specified key and bin name. If the record exists, reset record time to expiration and increment record generation count.
Public methodStatic memberInfo(String, Int32, IDictionary String, String  , ClLog, Dictionary String, String )
Get all server status data. Please see handbook for detailed statistics returned.
Public methodStatic memberInfo(String, Int32, IList String , IDictionary String, String  , ClLog, Dictionary String, String )
Get server status attributes for specified list of names.
Public methodStatic memberInfo(String, Int32, String, String , ClLog, Dictionary String, String )
Get server status attribute for specified name.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodScan(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.
Public methodScan(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.
Public methodScan(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.
Public methodScanNode
Scan a single node in the cluster.
Public methodSet(Object, Object, CitrusleafWriteInfo)
Set bin value for specified key. The following properties must be set before using this method.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodSet(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.
Public methodSet(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.
Public methodSet(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.
Public methodSet(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.
Public methodSetBinUnique(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.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodSetBinUnique(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.
Public methodSetBinUnique(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.
Public methodSetBinUnique(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.
Public methodSetBinUniqueDigest( 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.
  • DefaultNamespace
  • DefaultBin
Public methodSetBinUniqueDigest(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.
Public methodSetDigest( 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.
  • DefaultNamespace
  • DefaultBin
Public methodSetDigest(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.
Public methodSetDigest(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.
Public methodSetDigest(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.
Public methodSetLogging
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.
Public methodSetUnique(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.
  • DefaultNamespace
  • DefaultSet
  • DefaultBin
Public methodSetUnique(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.
Public methodSetUnique(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.
Public methodSetUnique(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.
Public methodSetUniqueDigest( 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.
  • DefaultNamespace
  • DefaultBin
Public methodSetUniqueDigest(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.
Public methodSetUniqueDigest(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.
Public methodSetUniqueDigest(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.
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Public methodTouch(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.
  • DefaultNamespace
  • DefaultSet
Public methodTouch(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.
Public methodTouchDigest( 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.
  • DefaultNamespace
  • DefaultSet
Public methodTouchDigest(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.
  • DefaultNamespace
  • DefaultSet
Back to Top
Properties

  NameDescription
Public propertyCreateValueFormatter
Factory method for creating formatters.
Public propertyDefaultBin
Default bin name. If the bin name is not specified in the API call, DefaultBin will be used. Set to empty string if server nodes are configured as "single-bin". The default should be modified before multiple client library threads are created.
Public propertyDefaultNamespace
Default namespace. If the namespace is not specified in the API call, DefaultNamespace will be used. The default should be modified before multiple client library threads are created.
Public propertyDefaultSet
Default set name. If the set name is not specified in the API call, DefaultSet will be used. The default should be modified before multiple client library threads are created.
Public propertyDefaultSettings
Default settings used for managing client connections.
Back to Top
See Also