HeadCouch - CouchDB PHP Client

Table of Content
1. Requirements
2. Server
3. Database
4. Document
5. Design Document
6. Further reading

1. Requirements
● PHP 5.x
● cURL

2. Server
<?php
require_once 'HeadCouch.php';
$result = HeadCouchServer::newInstance()->ping();
?>
2.1. Accessing the root of a CouchDB instance

2. Server
<?php
$result = HeadCouchServer::newInstance()->uuid();
?>
2.2. Requests a Universally Unique Identifier from the CouchDB instance

2. Server
<?php
$result = HeadCouchServer::newInstance()->allDbs();
?>
2.3. Returns a list of all the databases

2. Server
<?php
$result = HeadCouchServer::newInstance()->activeTasks();
?>
2.4. List of running tasks

2. Server
<?php
$result = HeadCouchServer::newInstance()->dbUpdates();
?>
2.5. Returns a list of all database events in the CouchDB instance

2. Server
<?php
$result = HeadCouchServer::newInstance()->log();
?>
2.6. Gets the CouchDB log

2. Server
<?php
$result = HeadCouchServer::newInstance()->restart();
?>
2.7. Restarts the CouchDB instance

2. Server
<?php
$result = HeadCouchServer::newInstance()->stats();
?>
2.8. Returns the statistics for the running server

3. Database
<?php
$result = HeadCouchDatabase::newInstance('db_name')->create();
?>
3.1. Create database

3. Database
<?php
$result = HeadCouchDatabase::newInstance('db_name')->delete();
?>
3.2. Delete database

3. Database
<?php
$result = HeadCouchDatabase::newInstance('db_name')->get();
?>
3.3. Gets information about the specified database

3. Database
<?php
$result = HeadCouchDatabase::newInstance('db_name')->head();
?>
3.4. Returns the HTTP Headers about the specified database

3. Database
<?php
$result = HeadCouchDatabase::newInstance('db_name')->post(array(
'key1' => 'val1',
'key2' => 'val2'
));
?>
3.5. Creates a new document in the specified database

4. Document
<?php
$result = HeadCouchDocument::newInstance('db_name', 'doc_name')->create
(array(
'key1' => 'val1',
'key2' => 'val2'
));
?>
4.1. Creates a new document

4. Document
<?php
$result = HeadCouchDocument::newInstance('db_name', 'doc_name')-
>delete();
?>
4.2. Deletes the specified document from the database

4. Document
<?php
$result = HeadCouchDocument::newInstance('db_name', 'doc_name')->get();
?>
4.3. Returns document

4. Document
<?php
$result = HeadCouchDocument::newInstance('db_name', 'doc_name')-
>getRevision();
?>
4.4. Returns document's revision token

4. Document
<?php
$result = HeadCouchDocument::newInstance('db_name', 'doc_name')->head();
?>
4.5. Returns the HTTP Headers about the specified document

5. Design Document
<?php
$result = HeadCouchDdoc::newInstance('db_name', 'doc_name')->head();
?>
5.1. Returns the HTTP Headers about the specified design document

5. Design Document
<?php
$result = HeadCouchDdoc::newInstance('db_name', 'doc_name')->get();
?>
5.2. Returns design document

5. Design Document
<?php
$result = HeadCouchDdoc::newInstance('db_name', 'doc_name')->put();
?>
5.3. Creates a new design document

5. Design Document
<?php
$result = HeadCouchDdoc::newInstance('db_name', 'doc_name')->delete();
?>
5.4. Deletes the specified document from the database

5. Design Document
<?php
$result = HeadCouchDdoc::newInstance('db_name', 'doc_name')-
>getRevision();
?>
5.5. Returns document's revision token

6. Further reading
● http://zinoui.com/blog/headcouch-couchdb-
php-client
● https://github.com/riverside/HeadCouch

https://twitter.com/DimitarIvanov
Dimitar Ivanov

HeadCouch - CouchDB PHP Client

More Related Content

What's hot (20)

Similar to HeadCouch - CouchDB PHP Client (20)

Recently uploaded (20)

HeadCouch - CouchDB PHP Client