Integration CouchDB

Component ID

2711725

Component name

Integration CouchDB

Component type

module

Maintenance status

Development status

Component security advisory coverage

not-covered

Downloads

152

Component created

Component changed

Component body

A CouchDB backend implementation for the Integration module.

This module allows storing and retrieving content using the Integration module and a CouchDB database, while sharing this content with other Drupal instances or other systems.

Installation

Install the module as usual.

Configuration

Create a new backend at admin/config/integration/backend/add
Choose the 'CouchDB backend' backend plugin, and select the applicable resource schema(s).

Backend settings

  • Base URL: enter the base URL of your CouchDB database, e.g. http://localhost:5984/mydatabase
  • ID endpoint: if your setup provides an endpoint which can translate producer IDs to backend IDs, enter its URI here, e.g. /uuid

Resource schemas settings

  • Resource endpoint: enter the base endpoint to get documents for this resource, while providing an ID, e.g. /articles
  • Resource _all_docs endpoint: enter the endpoint which returns the list of all documents for this resource, e.g. /articles/all (default: /_all_docs)
  • Changes endpoint: enter the endpoint which returns the history of changes for this resource, e.g. /articles/changes

Authentication

Basic HTTP authentication and Cookie authentication are supported.
The login path is required for the Cookie authentication only, enter its URI, e.g. /_session

Drush integration

Drush commands provided by the Integration module are available, i.e. you can export or import items to or from the backend using Drush.

The integration-couchdb-test-connection command simply tests the backend connection and displays a result message.