phpfastcache / couchdb
CouchDB Client (PhpFastCache fork)
1.0.0
2017-04-21 18:52 UTC
This package is auto-updated.
Last update: 2024-11-05 19:22:43 UTC
README
Simple API that wraps around CouchDBs HTTP API.
Features
- Create, Delete, List Databases
- Create, Update, Delete Documents
- Bulk API for Creating/Updating Documents
- Find Documents by ID
- Generate UUIDs
- Design Documents
- Query
_all_docs
view - Query Changes Feed
- Query Views
- Compaction Info and Triggering APIs
- Replication API
- Symfony Console Commands
Installation
With Composer:
{
"require": {
"PHPSocialNetwork/couchdb": "@dev"
}
}
Usage
Basic Operations
Covering the basic CRUD Operations for databases and documents:
<?php $client = \Doctrine\CouchDB\CouchDBClient::create(array('dbname' => 'doctrine_example')); // Create a database. $client->createDatabase($client->getDatabase()); // Create a new document. list($id, $rev) = $client->postDocument(array('foo' => 'bar')); // Update a existing document. This will increment the revision. list($id, $rev) = $client->putDocument(array('foo' => 'baz'), $id, $rev); // Fetch single document by id. $doc = $client->findDocument($id); // Fetch multiple documents at once. $docs = $client->findDocuments(array($id)); // Return all documents from database (_all_docs?include_docs=true). $allDocs = $client->allDocs(); // Delete a single document. $client->deleteDocument($id, $rev); // Delete a database. $client->deleteDatabase($client->getDatabase());
Views
A simple example demonstrating how to create views and query them:
<?php class ArticlesDesignDocument implements \Doctrine\CouchDB\View\DesignDocument { public function getData() { return array( 'language' => 'javascript', 'views' => array( 'by_author' => array( 'map' => 'function(doc) { if(\'article\' == doc.type) { emit(doc.author, doc._id); } }', 'reduce' => '_count' ), ), ); } } $client->createDesignDocument('articles', new ArticlesDesignDocument()); // Fill database with some data. foreach (array('Alice', 'Bob', 'Bob') as $author) { $client->postDocument(array( 'type' => 'article', 'author' => $author, 'content' => 'Lorem ipsum' )); } // Query all articles. $query = $client->createViewQuery('articles', 'by_author'); $query->setReduce(false); $query->setIncludeDocs(true); $result = $query->execute(); foreach ($result as $row) { $doc = $row['doc']; echo 'Article by ', $doc['author'], ': ', $doc['content'], "\n"; } // Article by Alice: Lorem ipsum // Article by Bob: Lorem ipsum // Article by Bob: Lorem ipsum // Query all articles written by bob. $query = $client->createViewQuery('articles', 'by_author'); $query->setKey('Bob'); // ... // Query the _count of articles each author has written. $query = $client->createViewQuery('articles', 'by_author'); $query->setReduce(true); $query->setGroupLevel(1); // group_level=1 means grouping by author. $result = $query->execute(); foreach ($result as $row) { echo 'Author ', $row['key'], ' has written ', $row['value'], ' articles', "\n"; } // Author Alice has written 1 articles // Author Bob has written 2 articles
* Due to the fact that the authors seem to have abandoned the main library, we decided to fork and maintain it for the PhpFastCache needs.