Couchdb

Table of Contents

Introduction
Installing/Configuring
Predefined Constants
Examples
CouchdbClient — The CouchdbClient class
- CouchdbClient::compactDatabase — The compactDatabase purpose
- CouchdbClient::__construct — Creates a new CouchdbClient object
- CouchdbClient::copyDoc — Copies a CouchDB document
- CouchdbClient::createAdminUser — Creates a CouchDB admin user.
- CouchdbClient::createDatabase — Creates a CouchDB database
- CouchdbClient::deleteAttachment — Deletes an attachment.
- CouchdbClient::deleteDatabase — Deletes a CouchDB database.
- CouchdbClient::deleteDoc — Deletes a couchDB document.
- CouchdbClient::__destruct — The __destruct purpose
- CouchdbClient::dropDatabase — Drops (deletes) a CouchDB database.
- CouchdbClient::getAllDocs — Returns all documents in a database.
- CouchdbClient::getCAPath — Returns the CA information
- CouchdbClient::getDatabaseChanges — Returns the database change information.
- CouchdbClient::getDatabaseInfo — Returns database infomation.
- CouchdbClient::getDoc — Returns a couchDB document.
- CouchdbClient::getLastResponse — Returns the last response received from the CouchDB server.
- CouchdbClient::getServerConfig — Returns the CouchDB server configuration.
- CouchdbClient::getServerInfo — Returns the server information.
- CouchdbClient::getServerStats — Returns server stats
- CouchdbClient::getTempView — Executes a temporary view
- CouchdbClient::getUuids — Returns Uuids
- CouchdbClient::getView — Executes a CouchDB view.
- CouchdbClient::listActiveTasks — Returns the active tasks running on the server.
- CouchdbClient::listDatabases — Returns the list of databases on the server.
- CouchdbClient::selectDB — Selects the CouchDB database to use.
- CouchdbClient::setCAPath — Sets the CA information
- CouchdbClient::startReplication — Starts CouchDB replication.
- CouchdbClient::storeAttachment — Stores an attachment.
- CouchdbClient::storeDoc — Stores a CouchDB document.
- CouchdbClient::storeDocs — Stores multiple CouchDB documents
CouchdbClientException — The CouchdbClientException class

The CouchdbClient class

Introduction

CouchdbClient Class

Class synopsis

CouchdbClient

class CouchdbClient {

/* Methods */

public bool compactDatabase ([ string $db_name ] )

__construct ( string $uri = NULL [, bool $use_cookie_auth = FALSE [, string $db_name = NULL ]] )

public array copyDoc ( string $doc_id , string $new_doc_id [, string $new_doc_revision ] )

public bool createAdminUser ( string $user_name , string $password )

public bool createDatabase ([ string $db_name ] )

public array deleteAttachment ( string $doc_id , string $attachment_name [, string $doc_rev ] )

public bool deleteDatabase ([ string $db_name ] )

public bool deleteDoc ( string $doc_id , string $rev )

public void __destruct ( void )

public bool dropDatabase ([ string $db_name ] )

public array getAllDocs ([ string $by_sequence [, array $query_options ]] )

public array getCAPath ( void )

public array getDatabaseChanges ([ array $query_options ] )

public array getDatabaseInfo ([ string $db_name ] )

public object getDoc ( string $doc_id [, array $options ] )

public mixed getLastResponse ([ string $json_decode ] )

public array getServerConfig ( void )

public array getServerInfo ( void )

public array getServerStats ( void )

public object getTempView ( string $temp_view )

public array getUuids ([ int $count ] )

public object getView ( string $design_doc , string $view_name )

public array listActiveTasks ( void )

public array listDatabases ( void )

public bool selectDB ([ string $db_name ] )

public bool setCAPath ( string $ca_path , string $ca_info )

public bool startReplication ( string $source , string $destination [, bool $set_continuous ] )

public array storeAttachment ( string $doc_id , string $filename , string $attachment_name , string $content_type [, string $doc_rev ] )

public array storeDoc ( mixed $document )

public array storeDocs ( mixed $documents )

}

The CouchdbClientException class

Introduction

This exception is thrown when errors occur while using the CouchdbClient extension.

Class synopsis

CouchdbClientException

class CouchdbClientException extends Exception {

/* Properties */

/* Inherited methods */

final public string Exception::getMessage ( void )

final public Exception Exception::getPrevious ( void )

final public int Exception::getCode ( void )

final public string Exception::getFile ( void )

final public int Exception::getLine ( void )

final public array Exception::getTrace ( void )

final public string Exception::getTraceAsString ( void )

public string Exception::__toString ( void )

final private void Exception::__clone ( void )

}

Properties

message: Error message
code: Error code
file: File where exception was thrown
line: Line where exception was thrown