Search:

Search all manuals
Search this manual
Manual
Couchbase Client Library: PHP 1.1
Community Wiki and Resources
Wiki: PHP Client Library
PHP Client Library
Couchbase Developer Guide 2.0
Couchbase Server Manual 2.0
SDK Forum
Additional Resources
Community Wiki
Community Forums
Couchbase SDKs
Parent Section
Couchbase Client Library: PHP 1.1
Child Sections
Chapters

Chapter 3. PHP Method Summary

Table of Contents

3.1. Error Handling
3.1.1. Exceptions
3.1.2. Error Codes and Constants

Table 3.1. PHP Client Library Method Summary

MethodTitle
$object->add($key, $value [, $expiry ] [, $persistto ] [, $replicateto ]) Add a value with the specified key that does not already exist
$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->fetch($key [, $keyn ]) Fetch the next delayed result set document
$object->fetchAll($key [, $keyn ]) Fetch all the delayed result set documents
$object->flush() Deletes all values from the corresponding bucket
$object->get($key [, $callback ] [, $casunique ]) Get one or more key values
$object->getDelayed($keyn [, $with_cas ] [, $callback ]) Get a key to be fetched later
$object->getMulti($keycollection [, $casarray ]) Get one or more key values
$object->getAndLock($key [, $casarray ] [, $getl-expiry ]) Get the value for a key, lock the key from changes
$object->getAndLockMulti($keycollection [, $casarray ] [, $getl-expiry ]) Get the value for a key, lock the key from changes
$object->getAndTouch($key, $expiry) Get a value and update the expiration time for a given key
$object->getAndTouchMulti($key, $expiry) Get a value and update the expiration time for a given key
$object->getClientVersion() Returns the version of the client library
$object->getNumReplicas() Returns the number of replicas for the configured bucket
$object->getOption($option) Retrieve an option
$object->getStats() Get the database statistics
$object->getTimeout() Get the currently configured timeout value for operations
$object->getVersion() Returns the versions of all servers in the server pool
$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->new Couchbase([ $url ] [, $username ] [, $password ] [, $bucket ] [, $persistent ]) Create connection to Couchbase Server
$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->replace($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ]) Update an existing key with a new value
$object->set($key, $value [, $expiry ] [, $casunique ] [, $persistto ] [, $replicateto ]) Store a value using the specified key
$object->setMulti($kvarray [, $expiry ]) Set multiple key/value items at once
$object->setOption($option, $mixed) Specify an option
$object->setTimeout($timeout) Set the configured timeout value for operations
$object->touch($key, $expiry) Update the expiry time of an item
$object->touchMulti($keyarray, $expiry) Change the expiration time for multiple documents
$object->unlock($key, $casunique) Unlock a previously locked key
$object->view($ddocname [, $viewname ] [, $viewoptions ]) Execute a view request
$object->view() Query a view
$object->viewGenQuery($ddocname [, $viewname ] [, $viewoptions ]) Generate a view request, but do not execute the query

For convenience, all distributions include a stub API reference file that contains the definitions for all the different methods and constants supported. The API information is provided in the couchbase-api.php file.