couchdb 0.2.1

Library for interacting with CouchDB from both a server and browser environment

A library for Dart developers for work with CouchDB

Created under a MIT-style license.

Overview

CouchDB is a database that completely embraces the web. Store your data with JSON documents. Access your documents with your web browser, via HTTP.

A basic understanding of CouchDB is required to use this library. Detailed information can be found at the official documentation site.

API

The connection to the database, along with authentication, is hadled via one of the Client classes: either CouchDbServerClient or CouchDbWebClient. You will use the web client if your application is running in the browser, and the server client otherwise. At the current time only Basic authorization is implemented.

You can communicate with the server directly if you wish via the http client methods such as get() and post(), however, other classes provide functions which can abstract away the particulars of HTTP, therefore using these client methods directly is not the way you will typically use this library.

Every supported method: HEAD, GET, POST, PUT and COPY - has an Accept header with default value as application/json, and POST and PUT both have a Content-Type header with default value as application/json. You can override this if you need.

All requests, both those by the basic http methods, as well as those by the other classes we will go over in a moment, return a DbResponse object. It is contain an DbResponse.json property (Map type) that contain JSON that was sent by CouchDB, DbResponse.raw property (String type) for responses that aren't valid JSON (numbers, lists, files) and DbResponse.headers property that contains headers of the response. In order to gets concrete object representation of the response you may call methods of the DbResponse class that can return:

- ServerModelResponse
- DatabaseModelResponse
- DocumentModelResponse
- DesignDocumentModelResponse
- LocalDocumentModelResponse
- ErrorResponse

Each of these class have specific properties that can be provided by CouchDB according to categories of API decribed below.

Categories

All of the API is divided into five areas or categories, each representing a different aspect of the database overall. These five categories are:

1. Server
2. Database
3. Documents
4. Design documents
5. Local documents

1: Server

Represented by the ServerModel class. This class provides server-level interaction with CouchDB, such as managing replication or obtaining basic information about the server.

2: Database

A Database in CouchDB is a single document store located on the given database server. This part of the API is represented by the DatabaseModel class. You will use this class for interacting with your data on a database level; for example creating a new database or preforming a query to search for certain documents.

3: Documents

You will use the DocumentModel class to interact with the data on a document level. This would include functions such as fetching a specific document, adding a new document, or attaching a file to a document. Note that this class does not model the documents themselves, but rather your interactions with them. The documents themselves are represented as Maps.

4: Design Documents

Represented by the DesignDocumentModel, design documents provide views of data in the database.

5: Local Documents

Local documents are no different than normal documents, with the exception that they are not copied to other instances of CouchDB during replication. You will interact with them via the LocalDocumentModel class.

CORS

If your application aren't on the same origin with CouchDB instance or you using different ports on server, then the remote CouchDB must be configured with the following options:

[httpd]
enable_cors = true
[cors]
origins = *
credentials = true
methods = GET, PUT, POST, HEAD, DELETE, COPY
headers = accept, authorization, content-type, origin, referer, x-csrf-token

(Change these settings either in Fauxton or in the local.ini file).

Usage

A simple usage example:

import 'package:couchdb/couchdb.dart';
import 'package:couchdb/couchdb_server_client.dart';

Future<void> main() async {
  final client = CouchDbServerClient(username: 'name', password: 'password');
  final dbModel = DatabaseModel(client);
  final docModel = DocumentModel(client)

  try {
    final DbResponse commonResponse = await dbModel.allDocs('some_db');
    final DatabaseModelResponse response1 = commonResponse.databaseModelResponse();

    for (var i in response1.rows) {
      // Some code here
    }

    final DbResponse response2 = await docModel.doc('another_db', 'some_id');

    var thing = response2.json['some_attribute'];

  } on CouchDbException catch (e) {
    print('$e - error');
  }
}

Features and bugs

Please file feature requests and bugs at the issue tracker.

With ❤️ to CouchDB