Couchbase Client Library: PHP 1.0 - Chapter 8. Update Operations

Chapter 8. Update Operations
Prev		Next

Chapter 8. Update Operations

Table 8.1. PHP Client Library Update Methods

Method	Title
`$object->append($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ])`	Append a value to an existing key
`$object->cas($casunique, $key, $value [, $expiry ])`	Compare and set a value providing the supplied CAS key matches
`$object->decrement($key, $offset)`	Decrement the value of an existing numeric key
`$object->delete($key [, $casunique ])`	Delete a key/value
`$object->flush()`	Deletes all values from the corresponding bucket
`$object->increment($key [, $offset ] [, $create ] [, $expiry ] [, $initial ])`	Increment the value of an existing numeric key
`$object->keyDurability($key, $casunique, $durability)`	Wait until the durability of a document has been reached
`$object->keyDurabilityMulti($keycollection, $durability)`	Wait until the durability of a document has been reached
`$object->observe($key, $casunique, $observedetails)`	Get the durability of a document
`$object->observeMulti($keycollection, $observedetails)`	Get the durability of a document
`$object->prepend($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ])`	Prepend a value to an existing key
`$object->touch($key, $expiry)`	Update the expiry time of an item
`$object->touchMulti($keyarray, $expiry)`	Change the expiration time for multiple documents

API Call	`$object->append($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ])`
Asynchronous	no
Description	Append a value to an existing key
Returns	`scalar`; supported values:
	`COUCHBASE_E2BIG`	The Object is too big to be stored on the server
	`COUCHBASE_ENOMEM`	Out of Resources
	`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 on success
Arguments
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).
`$casunique`	Unique value used to verify a key/value combination
`$persistto`	Specify the number of nodes on which the document must be persisted to before returning.
`$replicateto`	Specify the number of nodes on which the document must be replicated to before returning
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->cas($casunique, $key, $value [, $expiry ])`
Asynchronous	no
Description	Compare and set a value providing the supplied CAS key matches
Returns	`boolean`; supported values:
	`COUCHBASE_E2BIG`	The Object is too big to be stored on the server
	`COUCHBASE_ENOMEM`	Out of Resources
	`COUCHBASE_ETMPFAIL`	Temporary failure; try the operation again
	`COUCHBASE_KEY_EEXISTS`	The key exists, but the supplied CAS ID did not match the one for the object in the cluster
	`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
	`COUCHBASE_SUCCESS`	Operation succeeded
Arguments
`$casunique`	Unique value used to verify a key/value combination
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->decrement($key, $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	`scalar`; supported values:
	`COUCHBASE_DELTA_BADVAL`	Decrement on an object that isn't a number
	`COUCHBASE_E2BIG`	The Object is too big to be stored on the server
	`COUCHBASE_ENOMEM`	Out of Resources
	`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
	`scalar`	Updated value of the object on success
Arguments
`string $key`	Document ID used to identify the value
`$offset`	Integer offset value to increment/decrement (default 1)
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->delete($key [, $casunique ])`
Asynchronous	no
Description	Delete a key/value
Returns	`scalar`; 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
`$casunique`	Unique value used to verify a key/value combination

API Call	`$object->increment($key [, $offset ] [, $create ] [, $expiry ] [, $initial ])`
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	`scalar`; supported values:
	`COUCHBASE_DELTA_BADVAL`	Increment on an object that isn't a number
	`COUCHBASE_E2BIG`	The Object is too big to be stored on the server
	`COUCHBASE_ENOMEM`	Out of Resources
	`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
	`scalar`	Updated value of the object on success
Arguments
`string $key`	Document ID used to identify the value
`$offset`	Integer offset value to increment/decrement (default 1)
`boolean $create`	Create the document if it does not already exist
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).
`boolean $initial`	Initial value for the document
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->prepend($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ])`
Asynchronous	no
Description	Prepend a value to an existing key
Returns	`scalar`; supported values:
	`COUCHBASE_E2BIG`	The Object is too big to be stored on the server
	`COUCHBASE_ENOMEM`	Out of Resources
	`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 on success
Arguments
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).
`$casunique`	Unique value used to verify a key/value combination
`$persistto`	Specify the number of nodes on which the document must be persisted to before returning.
`$replicateto`	Specify the number of nodes on which the document must be replicated to before returning
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->appendByKey($master_key, $key, $value [, $expiry ])`
Asynchronous	no
Description	Append to a key on a specific server
Returns	`scalar` ( Binary object )
Arguments
`$master_key`	Master key used for consistent server references
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).

API Call	`$object->prependByKey($master_key, $key, $value)`
Asynchronous	no
Description	Prepend a value to a key on a specific server
Returns	`scalar` ( Binary object )
Arguments
`$master_key`	Master key used for consistent server references
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored

API Call	`$object->replaceByKey($master_key, $key, $value [, $expiry ])`
Asynchronous	no
Description	Replace a value on a specific server
Returns	`scalar` ( Binary object )
Arguments
`$master_key`	Master key used for consistent server references
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).

API Call	`$object->deleteByKey($master_key, $key)`
Asynchronous	no
Description	Delete a key/value on a specific server
Returns	`scalar`; 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
`$master_key`	Master key used for consistent server references
`string $key`	Document ID used to identify the value
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

API Call	`$object->casByKey($casunique, $master_key, $key, $value [, $expiry ])`
Asynchronous	no
Description	Compare and set a value providing the supplied CAS key matches
Returns	`scalar` ( Binary object )
Arguments
`$casunique`	Unique value used to verify a key/value combination
`$master_key`	Master key used for consistent server references
`string $key`	Document ID used to identify the value
`object $value`	Value to be stored
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).

API Call	`$object->touch($key, $expiry)`
Asynchronous	no
Description	Update the expiry time of an item
Returns	`boolean`; supported values:
	`COUCHBASE_ENOMEM`	Out of Resources
	`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
	`COUCHBASE_SUCCESS`	Operation succeeded
Arguments
`string $key`	Document ID used to identify the value
`$expiry`	Expiry time for key. Values larger than 302460*60 seconds (30 days) are interpreted as absolute times (from the epoch).
Errors
`CouchbaseAuthenticationException`	Authentication to the Couchbase cluster failed
`CouchbaseException`	Base exception class for all Couchbase exceptions
`CouchbaseIllegalKeyException`	The key provided is not a legal key identifier
`CouchbaseLibcouchbaseException`	An error occurred within the libcouchbase library used by th PHP extension
`CouchbaseServerException`	An error occurred within the Couchbase cluster

Prev		Next
Chapter 7. Retrieve Operations	Home	Chapter 9. Statistic Operations