• This repository has been archived on 05/Feb/2024
  • Stars
    star
    122
  • Rank 292,031 (Top 6 %)
  • Language
    PHP
  • License
    MIT License
  • Created over 12 years ago
  • Updated about 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

CouchDB Client library

Doctrine CouchDB v2.x Client

Build Status StyleCI

Simple API that wraps around CouchDBs v2.x HTTP API.

For CouchDB 1.x, please check our release/1.0.0 branch.

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
  • Find Documents using Mango Query

Installation

With Composer:

{
    "require": {
        "doctrine/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());

//Search documents using Mango Query CouchDB v2.x

$selector = ['_id'=>['$gt'=>null]];
$options = ['limit'=>1,'skip'=>1,'use_index'=>['_design/doc','index'],'sort'=>[['_id'=>'desc']]];
$query = new \Doctrine\CouchDB\Mango\MangoQuery($selector,$options);
$docs = $client->find($query);

$query = new \Doctrine\CouchDB\Mango\MangoQuery();
$query->select(['_id', 'name'])->where(['$and'=> [
            [
              'name'=> [
                '$eq'=> 'Under the Dome',
              ],
              'genres'=> [
                '$in'=> ['Drama','Comedy'],
              ],
            ],
          ])->sort([['_id'=>'desc']])->limit(1)->skip(1)->use_index(['_design/doc','index']);
$docs = $client->find($query);

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

More Repositories

1

inflector

Doctrine Inflector is a small library that can perform string manipulations with regard to uppercase/lowercase and singular/plural forms of words.
PHP
11,213
star
2

lexer

Base library for a lexer that can be used in Top-Down, Recursive Descent Parsers.
PHP
11,034
star
3

instantiator

PHP
10,924
star
4

orm

Doctrine Object Relational Mapper (ORM)
PHP
9,887
star
5

dbal

Doctrine Database Abstraction Layer
PHP
9,412
star
6

cache

Doctrine Cache component
PHP
7,810
star
7

annotations

Annotations Docblock Parser
PHP
6,731
star
8

event-manager

The Doctrine Event Manager is a library that provides a simple event system.
PHP
5,905
star
9

collections

Collections Abstraction Library
PHP
5,860
star
10

common

Doctrine Common
PHP
5,773
star
11

DoctrineBundle

Symfony Bundle for Doctrine ORM and DBAL
PHP
4,703
star
12

migrations

Doctrine Database Migrations Library
PHP
4,659
star
13

DoctrineMigrationsBundle

Symfony integration for the doctrine/migrations library
PHP
4,182
star
14

persistence

The Doctrine Persistence project is a library that provides common abstractions for object mapper persistence.
PHP
3,921
star
15

reflection

The Doctrine Reflection project is a simple library used by the various Doctrine projects which adds some additional functionality on top of the reflection API that comes with PHP. It allows you to get the reflection information about classes, methods and properties statically.
PHP
2,948
star
16

data-fixtures

Doctrine2 ORM Data Fixtures Extensions
PHP
2,769
star
17

DoctrineCacheBundle

Symfony2 Bundle for Doctrine Cache
PHP
2,750
star
18

DoctrineFixturesBundle

Symfony integration for the doctrine/data-fixtures library
PHP
2,446
star
19

sql-formatter

A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting.
HTML
1,646
star
20

deprecations

Thin library around different deprecation strategies
PHP
1,604
star
21

mongodb-odm

The Official PHP MongoDB ORM/ODM
PHP
1,085
star
22

mongodb

PHP MongoDB Abstraction Layer
PHP
442
star
23

DoctrineORMModule

Doctrine ORM Module for Laminas
PHP
436
star
24

DoctrineModule

Doctrine Module for Laminas
PHP
397
star
25

DoctrineMongoDBBundle

Integrates Doctrine MongoDB ODM with Symfony
PHP
377
star
26

coding-standard

The coding standard of the Doctrine project.
PHP
310
star
27

search

Generic Search extension for indexing and querying ODM/ORM objects with different text-search engine implementations
PHP
272
star
28

KeyValueStore

Abstraction for Key-Value to Plain Old PHP Object mapping
PHP
201
star
29

phpcr-odm

Doctrine PHPCR ODM
PHP
182
star
30

DoctrinePHPCRBundle

This bundle integrates Doctrine PHPCR ODM and PHPCR backends into Symfony
PHP
155
star
31

orientdb-odm

A set of PHP libraries in order to use OrientDB from PHP
PHP
155
star
32

couchdb-odm

A Document Mapper based on CouchDB
PHP
150
star
33

doctrine2-orm-tutorial

Code for the ORM Tutorial
PHP
143
star
34

rest

Doctrine REST Server and Client Library
PHP
141
star
35

doctrine1

[Abandoned - please upgrade to Doctrine 2] Doctrine 1 Object Relational Mapper
PHP
132
star
36

skeleton-mapper

Doctrine Skeleton Object Mapper
PHP
101
star
37

orm-documentation

OUTDATED REPOSITORY - PLEASE MAKE PULL REQUESTS TO DOCTRINE2 REPOSITORY
Python
97
star
38

oxm

PHP Object to XML Mapping (OXM)
PHP
86
star
39

DoctrineMongoODMModule

Laminas Module for Doctrine MongoDB ODM
PHP
83
star
40

rst-parser

PHP
58
star
41

DoctrineCouchDBBundle

Symfony Bundle for DoctrineCouchDB
PHP
49
star
42

jira-github-issues

Scripts to migrate Jira to Github issues
PHP
38
star
43

mongodb-odm-softdelete

Soft delete functionality for the Doctrine MongoDB ODM
PHP
35
star
44

doctrine-laminas-hydrator

Doctrine hydrators for Laminas applications
PHP
33
star
45

doctrine1-documentation

Documentation for Doctrine 1
Python
30
star
46

doctrine-website

Source code for the doctrine-project.org website and documentation.
PHP
29
star
47

automatic-releases

Internal automatic release tool for doctrine/* projects
PHP
28
star
48

shards

Prototype sharding Extension for Doctrine
PHP
27
star
49

doctrine-website-sphinx

Sphinx-based Doctrine Website
CSS
18
star
50

doctrine-mongodb-odm-tailable-cursor-bundle

Doctrine MongoDB ODM Tailable Cursor Bundle
PHP
16
star
51

symfony-doctrine-static-website-generator

PHP
14
star
52

mongodb-odm-softdelete-bundle

Symfony2 bundle that integrates the Doctrine MongoDB ODM SoftDelete library.
PHP
14
star
53

dbal-documentation

MOVED TO DOCTRINE/DBAL REPOSITORY
Python
13
star
54

common-documentation

Documentation for the common Doctrine PHP extensions library.
Python
13
star
55

doctrine-zend-hydrator

Doctrine hydrators for Zend Framework applications
PHP
12
star
56

migrations-documentation

Documentation for the Doctrine Migrations
Python
12
star
57

.github

11
star
58

dbal-bundle

PHP
7
star
59

static-website-generator

Doctrine Static Website Generator
PHP
5
star
60

doctrine-website-build-prod

Generated website artifacts. See https://www.doctrine-project.org/contribute/website/
HTML
5
star
61

doctrine-build-common

Common Phing Build Scripts and Tasks for all Doctrine Projects
PHP
4
star
62

orm-benchmarking-suite

Suite to do functional ORM performance tests across versions
PHP
4
star
63

phpcr-odm-documentation

PHP Content Repository ODM Documentation
Python
4
star
64

couchdb-documentation

Documentation for Doctrine CouchDB ODM
Python
4
star
65

doctrine-sphinx-theme

Sphinx Theme for all Doctrine Documentations
CSS
4
star
66

DoctrineStaticWebsiteGeneratorBundle

DoctrineStaticWebsiteGeneratorBundle
PHP
2
star
67

vagrant-doctrine-website

Shell
1
star
68

jira-redirector

HTML
1
star
69

contributors-guide

A complete guide for Doctrine project collaborators and contributors.
1
star