| 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 30*24*60*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
|