Table 4.1. .NET Client Library
| Method | Title |
|---|---|
object.Append(key, value) | Append a value to an existing key |
object.Append(key, casunique, value) | Append a value to an existing key |
object.Cas(storemode, key, value) | Compare and set a value providing the supplied CAS key matches |
object.Cas(storemode, key, value, casunique) | Compare and set a value providing the supplied CAS key matches |
object.Cas(storemode, key, value, expiresat, casunique) | Compare and set a value using the specified key with a specific expiry time |
object.Cas(storemode, key, value, validfor, casunique) | Compare and set the specified key with expiry time |
object.Decrement(key, defaultvalue, offset) | Decrement the value of an existing numeric key |
object.Decrement(key, defaultvalue, offset, casunique) | Decrement the value of an existing numeric key |
object.Decrement(key, defaultvalue, offset, expiresat, casunique) | Decrement the value of an existing numeric key |
object.Decrement(key, defaultvalue, offset, validfor, casunique) | Decrement the value of an existing numeric key |
object.Decrement(key, defaultvalue, offset, expiresat) | Decrement the value of an existing numeric key |
object.Decrement(key, defaultvalue, offset, validfor) | Decrement the value of an existing numeric key |
object.ExecuteAppend(key, value) | Append a value to an existing key and return a concat operation result |
object.ExecuteAppend(key, casunique, value) | Append a value to an existing key and return a concat operation result |
object.ExecuteCas(storemode, key, value) | Store a value using the specified key and return a store operation result |
object.ExecuteCas(storemode, key, value, casunique) | Compare and set a value using the specified key and return a store operation result |
object.ExecuteCas(storemode, key, value, expiresat, casunique) | Compare and set a value using the specified key with a specific expiry time and return a store operation result |
object.ExecuteCas(storemode, key, value, validfor, casunique) | Compare and set a value using the specified key with expiry time and return a store operation result |
object.ExecuteDecrement(key, defaultvalue, offset) | Decrement the value of an existing numeric key |
object.ExecuteDecrement(key, defaultvalue, offset, casunique) | Decrement the value of an existing numeric key |
object.ExecuteDecrement(key, defaultvalue, offset, expiresat, casunique) | Decrement the value of an existing numeric key |
object.ExecuteDecrement(key, defaultvalue, offset, validfor, casunique) | Decrement the value of an existing numeric key |
object.ExecuteDecrement(key, defaultvalue, offset, expiresat) | Decrement the value of an existing numeric key |
object.ExecuteDecrement(key, defaultvalue, offset, validfor) | Decrement the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset) | Increment the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset, casunique) | Increment the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset, expiresat, casunique) | Increment the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset, validfor, casunique) | Increment the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset, expiresat) | Increment the value of an existing numeric key |
object.ExecuteIncrement(key, defaultvalue, offset, validfor) | Increment the value of an existing numeric key |
object.ExecutePrepend(key, value) | Prepend a value to an existing key and return a concat operation result |
object.ExecutePrepend(key, casunique, value) | Prepend a value to an existing key and return a concat operation result |
object.ExecuteRemove(key) | Delete a key/value and return a remove operation result |
object.ExecuteRemove-cas(key, casunique) | Delete a key with a CAS operation and return a remove operation result |
object.ExecuteRemove-observe(key, persistto) | Delete a key/value and return a remove operation result |
object.Increment(key, defaultvalue, offset) | Increment the value of an existing numeric key |
object.Increment(key, defaultvalue, offset, casunique) | Increment the value of an existing numeric key |
object.Increment(key, defaultvalue, offset, expiresat, casunique) | Increment the value of an existing numeric key |
object.Increment(key, defaultvalue, offset, validfor, casunique) | Increment the value of an existing numeric key |
object.Increment(key, defaultvalue, offset, expiresat) | Increment the value of an existing numeric key |
object.Increment(key, defaultvalue, offset, validfor) | Increment the value of an existing numeric key |
object.Prepend(key, value) | Prepend a value to an existing key |
object.Prepend(key, casunique, value) | Prepend a value to an existing key |
object.Remove(key) | Delete a key/value |
object.Touch(key, expiry) | Update the expiry time of an item |
| API Call | object.Append(key, value) | ||
| Asynchronous | no | ||
| Description | Append a value to an existing key | ||
| Returns | Object (
Binary object
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object value | Value to be stored | ||
| API Call | object.Append(key, casunique, value) | ||
| Asynchronous | no | ||
| Description | Append a value to an existing key | ||
| Returns | Object (
Binary object
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
ulong casunique | Unique value used to verify a key/value combination | ||
object value | Value to be stored | ||
| API Call | object.Decrement(key, defaultvalue, offset) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
| API Call | object.Decrement(key, defaultvalue, offset, validfor) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
TimeSpan validfor | Expiry time (in seconds) for key | ||
| API Call | object.Decrement(key, defaultvalue, offset, expiresat) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
DateTime expiresat | Explicit expiry time for key | ||
| API Call | object.Decrement(key, defaultvalue, offset, casunique) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
ulong casunique | Unique value used to verify a key/value combination | ||
| API Call | object.Decrement(key, defaultvalue, offset, validfor, casunique) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
TimeSpan validfor | Expiry time (in seconds) for key | ||
ulong casunique | Unique value used to verify a key/value combination | ||
| API Call | object.Decrement(key, defaultvalue, offset, expiresat, casunique) | ||
| Asynchronous | no | ||
| Description | Decrement the value of an existing numeric key. The Couchbase Server stores numbers as unsigned values. Therefore the lowest you can decrement is to zero. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
DateTime expiresat | Explicit expiry time for key | ||
ulong casunique | Unique value used to verify a key/value combination | ||
| API Call | object.Remove(key) | ||
| Asynchronous | no | ||
| Description | Delete a key/value | ||
| Returns | Object; supported values: | ||
COUCHBASE_ETMPFAIL | Temporary failure; try the operation again | ||
COUCHBASE_KEY_ENOENT | Requested document ID does not exist | ||
COUCHBASE_NOT_MY_VBUCKET | The command was sent to the wrong server; may be triggered during a rebalance or failover operation. Retry the operation | ||
COUCHBASE_NOT_STORED | The object was not stored | ||
docid | Document ID of deleted document | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
| API Call | object.Increment(key, defaultvalue, offset) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
| API Call | object.Increment(key, defaultvalue, offset, validfor) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
TimeSpan validfor | Expiry time (in seconds) for key | ||
| API Call | object.Increment(key, defaultvalue, offset, expiresat) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
DateTime expiresat | Explicit expiry time for key | ||
| API Call | object.Increment(key, defaultvalue, offset, casunique) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
ulong casunique | Unique value used to verify a key/value combination | ||
| API Call | object.Increment(key, defaultvalue, offset, validfor, casunique) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
TimeSpan validfor | Expiry time (in seconds) for key | ||
ulong casunique | Unique value used to verify a key/value combination | ||
| API Call | object.Increment(key, defaultvalue, offset, expiresat, casunique) | ||
| Asynchronous | no | ||
| Description | Increment the value of an existing numeric key. Couchbase Server stores numbers as unsigned numbers, therefore if you try to increment an existing negative number, it will cause an integer overflow and return a non-logical numeric result. If a key does not exist, this method will initialize it with the zero or a specified value. | ||
| Returns | CasResult<ulong> (
Cas result of bool
) | ||
| Arguments | |||
string key | Document ID used to identify the value | ||
object defaultvalue | Value to be stored if key does not already exist | ||
Integer offset | Integer offset value to increment/decrement (default 1) | ||
DateTime expiresat | Explicit expiry time for key | ||
ulong casunique | Unique value used to verify a key/value combination | ||