CouchDB2 1.9.3

CouchDB v2.x Python 3 interface in a single module. Also a command line tool.

CouchDB2

CouchDB v2.x Python 3 interface in a single module. Also a command line tool; see below.

Most, but not all, features of this module work with CouchDB version < 2.0.

Installation

The CouchDB2 module is available at PyPi. It can be installed using pip:

$ pip install couchdb2

The module relies on requests: http://docs.python-requests.org/en/master/

News

• 1.9.3
  • Handle get_attachment rev/If-Match issue; thanks to https://github.com/seb4itik
• 1.9.2
  • Added retrieve of conflicts; thanks to https://github.com/seb4itik
• 1.9.1
  • Added ca_file parameter for HTTPS; thanks to https://github.com/seb4itik
• 1.9.0
  • Changed put_attachment and delete_attachment to update the input doc by the new _rev value.
• 1.8.5
  • Added ids(): Return an iterator over all document identifiers.
• 1.8.4
  • Added get_bulk(ids): Get several documents in one operation.

Example code

import couchdb2

server = couchdb2.Server()   # Arguments required according to local setup
db = server.create('test')

doc1 = {'_id': 'myid', 'name': 'mydoc', 'level': 4}
db.put(doc1)
doc = db['myid']
assert doc == doc1

doc2 = {'name': 'another', 'level': 0}
db.put(doc2)
print(doc2)
# {'_id': '66b5...', '_rev': '1-f3ac...', 'name': 'another', 'level': 0}

db.put_design('mydesign', 
              {"views":
               {"name": {"map": "function (doc) {emit(doc.name, null);}"}
               }
              })
result = db.view('mydesign', 'name', key='another', include_docs=True)
assert len(result) == 1
print(result[0].doc)         # Same printout as above, using OrderedDict

db.destroy()

Server

server = Server(href='http://localhost:5984/', username=None, password=None,
                use_session=True, ca_file=None)

Connection to the CouchDB server.

If use_session is true, then an authenticated session is used transparently. Otherwise, username and password is sent with each request.

ca_file can point to a file or a directory containing CAs if you need to access databases in HTTPS.

version

server.version

Property attribute providing the version of the CouchDB server software.

user_context

server.user_context

Property attribute providing the user context of the connection.

__str__

str(server)

Return a simple string representation of the server interface.

__len__

len(server)

Return the number of user-defined databases.

__iter__

for db in server: ...

Return an iterator over all user-defined databases on the server.

__getitem__

db = server[name]

Get the named database.

__contains__

if name in server: ...

Does the named database exist?

__call__

data = server()

Return meta information about the server.

up

if server.up(): ...

Is the server up and running, ready to respond to requests?

CouchDB version >= 2.0.

get

db = server.get(name, check=True)

Get the named database. If check is true, then raise NotFoundError if the the database does not exist.

create

db = server.create(name)

Create the named database.

get_config

data = server.get_config(nodename='_local')

Get the named node's configuration.

get_active_tasks

data = server.get_active_tasks()

Return a list of running tasks.

get_cluster_setup

data = server.get_cluster_setup(config)

Return the status of the node or cluster.

CouchDB version >= 2.0.

set_cluster_setup

server.cluster_setup(doc)

Configure a node as a single node, as part of a cluster, or finalize a cluster.

CouchDB version >= 2.0.

get_membership

data = server.get_membership()

Return data about the nodes that are part of the cluster.

CouchDB version >= 2.0.

set_replicate

data = server.set_replicate(doc)

Request, configure, or stop, a replication operation.

get_scheduler_jobs

data = server.get_scheduler_jobs(limit=None, skip=None)

Get a list of replication jobs.

CouchDB version >= 2.0.

get_scheduler_docs

data = server.get_scheduler_docs(limit=None, skip=None,
                                 replicator_db=None, docid=None)

Get information about replication document(s).

CouchDB version >= 2.0.

get_node_stats

data = server.get_node_stats(nodename='_local')

Return statistics for the running server.

CouchDB version >= 2.0.

get_node_system

data = server.get_node_system(nodename='_local')

Return various system-level statistics for the running server.

CouchDB version >= 2.0.

Database

db = Database(server, name, check=True)

Interface to a named CouchDB database.

If check is true, then raise NotFoundError if the the database does not exist.

__str__

str(db)

Return the name of the CouchDB database.

__len__

len(db)

Return the number of documents in the database.

__contains__

if id in db: ...

Does a document with the given id exist in the database?

__iter__

for doc in db: ...

Return an iterator over all documents in the database.

__getitem__

doc = db[id]

Return the document with the given id.

exists

if db.exists(): ...

Does the database exist?

check

db.check()

Raises NotFoundError if the database does not exist.

create

db.create()

Create the database.

destroy

db.destroy()

Delete the database and all its contents.

get_info

data = db.get_info()

Return a dictionary with information about the database.

get_security

data = db.get_security()

Return a dictionary with security information for the database.

set_security

db.set_security(doc)

Set the security information for the database.

compact

db.compact(finish=False, callback=None)

Compact the CouchDB database by rewriting the disk database file and removing old revisions of documents.

If finish is True, then return only when compaction is done. In addition, if defined, the function callback(seconds) is called every second until compaction is done.

compact_design

db.compact_design(designname)

Compact the view indexes associated with the named design document.

view_cleanup

db.view_cleanup()

Remove unnecessary view index files due to changed views in design documents of the database.

get

doc = db.get(id, rev=None, revs_info=False, default=None, conflicts=False)

Return the document with the given id, or the default value if not found.

If conflicts is True, includes information about conflicts in document (in _conflicts attribute).

get_bulk

doc = db.get_bulk(ids)

Get several documents in one operation, given a list of document ids, each of which is a string (the document id), or a tuple of the document id and revision.

Returns a list of documents. If no document is found for a specified id or (id, rev), None is returned in that slot of the list.

ids

for id in db.ids(): ...

Return an iterator over all document identifiers.

put

db.put(doc)

Insert or update the document.

If the document is already in the database, the _rev item must be present in the document; its value will be updated.

If the document does not contain an item _id, one will be added having a UUID4 value. The _rev item will also be added.

update

db.update(docs)

Perform a bulk update or insertion of the given documents using a single HTTP request.

The return value of this method is a list containing a tuple for every element in the docs sequence. Each tuple is of the form (success, docid, rev_or_exc), where success is a boolean indicating whether the update succeeded, docid is the ID of the document, and rev_or_exc is either the new document revision, or an exception instance (e.g. ResourceConflict) if the update failed.

If an object in the documents list is not a dictionary, this method looks for an items() method that can be used to convert the object to a dictionary. Effectively this means you can also use this method with mapping.Document objects.

docs : a sequence of dictionaries or Document objects, or objects providing a items() method that can be used to convert them to a dictionary.

Returns an iterable (list) over the resulting documents.

delete

db.delete(doc)

Delete the document.

purge

db.purge(docs)

Perform purging (complete removing) of the given documents.

Uses a single HTTP request to purge all given documents. Purged documents do not leave any meta-data in the storage and are not replicated.

get_designs

data = db.get_designs()

Return the design documents for the database.

CouchDB version >= 2.2.

get_design

data = db.get_design(designname)

Get the named design document.

put_design

db.put_design(designname, doc, rebuild=True)

Insert or update the design document under the given name.

If the existing design document is identical, no action is taken and False is returned, else the document is updated and True is returned.

If rebuild is True, force view indexes to be rebuilt after update. This may take some time.

Example of doc:

  {"views":
    {"name":
      {"map": "function (doc) {emit(doc.name, null);}"},
     "name_sum":
      {"map": "function (doc) {emit(doc.name, 1);}",
       "reduce": "_sum"},
     "name_count":
      {"map": "function (doc) {emit(doc.name, null);}",
       "reduce": "_count"}
  }}

More info: http://docs.couchdb.org/en/latest/api/ddoc/common.html

view

result = db.view(designname, viewname, key=None, keys=None,
                 startkey=None, endkey=None, skip=None, limit=None,
                 sorted=True, descending=False,
                 group=False, group_level=None, reduce=None,
                 include_docs=False)

Return a ViewResult object, containing Row objects in the attribute rows (a list).

If include_docs is True, then reduce is forced to False.

get_indexes

data = db.get_indexes()

Return a list of all indexes in the database.

CouchDB version >= 2.0.

put_index

db.put_index(fields, ddoc=None, name=None, selector=None)

Store a Mango index specification. CouchDB v2.x only.

• fields is a list of fields to index.
• ddoc is the design document name. Generated if none given.
• name is the name of the index. Generated if none given.
• selector is a partial filter selector, which may be omitted.

Returns a dictionary with items id (design document name; sic!), name (index name) and result (created or exists).

CouchDB version >= 2.0.

find

data = db.find(selector, use_index=None, limit=None, skip=None, sort=None,
               fields=None, bookmark=None, update=None, conflicts=None)

Select documents according to the Mango index selector.

Returns a dictionary with items docs, warning, execution_stats and bookmark.

If conflicts is True, includes information about conflicts in documents (in _conflicts attribute).

CouchDB version >= 2.0.

explain

data = db.explain(selector, use_index=None, limit=None, skip=None, sort=None,
                  fields=None, bookmark=None, update=None)

Return info on which index is being used by the query.

CouchDB version >= 2.0.

get_attachment

fileobj = db.get_attachment(doc, filename)

Return a file-like object containing the content of the attachment.

put_attachment

rev = db.put_attachment(doc, content, filename=None, content_type=None)

content is a string or a file-like object. Return the new revision of the document.

Note: Since version 1.9.0, the _rev item in the input doc is updated.

If filename is not provided, then an attempt is made to get it from the content object.

delete_attachment

rev = db.delete_attachment(doc, filename)

Delete the attachment. Return the new revision of the document.

Note: Since version 1.9.0, the _rev item in the input doc is updated.

dump

(ndocs, nfiles) = db.dump(filepath, callback=None)

Dump the entire database to a tar file.

If defined, the function callback(ndocs, nfiles) is called every 100 documents.

If the filepath ends with .gz, then the tar file is gzip compressed. The _rev item of each document is kept.

A tuple (ndocs, nfiles) is returned.

undump

(ndocs, nfiles) = db.undump(filepath, callback=None)

Load the tar file, which must have been produced by dump.

If defined, the function callback(ndocs, nfiles) is called every 100 documents.

NOTE: The documents are just added to the database, ignoring any _rev items.

A tuple (ndocs, nfiles) is returned.

CouchDB2Exception

CouchDB2Exception()

Base CouchDB2 exception.

NotFoundError

NotFoundError()

No such entity exists.

BadRequestError

BadRequestError()

Invalid request; bad name, body or headers.

CreationError

CreationError()

Could not create the entity; it exists already.

RevisionError

RevisionError()

Wrong or missing _rev item in the document to save.

AuthorizationError

AuthorizationError()

Current user not authorized to perform the operation.

ContentTypeError

ContentTypeError()

Bad Content-Type value in the request.

ServerError

ServerError()

Internal server error.

ViewResult

Object returned as result from db.view().

ViewResult(rows, offset, total_rows)

Attributes:

• rows: the list of Row objects.
• offset: the offset used for the set of rows.
• total_rows: the total number of rows selected.

__len__

len(viewresult)

Return the number of rows in the view result.

__iter__

for row in viewresult: ...

Return an iterator over all rows in the view result.

__getitem__

row = viewresult[i]

Return the indexed view result row.

json

data = viewresult.json()

Return view result data in a JSON-like representation.

Row

Named-tuple object returned in ViewResult list attribute rows.

Row(id, key, value, doc)

• id: the identifier of the document, if any.
• key: the key for the index row.
• value: the value for the index row.
• doc: the document, if any.

id

Alias for field number 0

key

Alias for field number 1

value

Alias for field number 2

doc

Alias for field number 3

Utility functions

read_settings

read_settings(filepath, settings=None)

Read the settings lookup from a JSON format file. If settings is given, then return an updated copy of it, else copy the default settings, update, and return.

Command line tool

The module is also a command line tool for interacting with the CouchDB server. Installing it using pip will set up the command couchdb2.

Settings for the command line tool are updated from the following sources, in the order given and if existing:

1. Default values are

   {
     "SERVER": "http://localhost:5984",
     "DATABASE": null,
     "USERNAME": null,
     "PASSWORD": null
   }
   

2. Read from the JSON file ~/.couchdb2 (in your home directory).
3. Read from the JSON file settings.json (in the current working directory).
4. Read from the JSON file given by command line option --settings FILEPATH.

Options

To print available command options:

$ couchdb2 -h
usage: couchdb2 [options]

CouchDB v2.x command line tool, leveraging Python module CouchDB2.

optional arguments:
  -h, --help            show this help message and exit
  --settings FILEPATH   settings file in JSON format
  -S SERVER, --server SERVER
                        CouchDB server URL, including port number
  -d DATABASE, --database DATABASE
                        database to operate on
  -u USERNAME, --username USERNAME
                        CouchDB user account name
  -p PASSWORD, --password PASSWORD
                        CouchDB user account password
  -q, --password_question
                        ask for the password by interactive input
  --ca_file FILEORDIRPATH
                        file or directory containing CAs
  -o FILEPATH, --output FILEPATH
                        write output to the given file (JSON format)
  --indent INT          indentation level for JSON format output file
  -y, --yes             do not ask for confirmation (delete, destroy)
  -v, --verbose         print more information
  -s, --silent          print no information

server operations:
  -V, --version         output CouchDB server version
  --list                output a list of the databases on the server

database operations:
  --create              create the database
  --destroy             delete the database and all its contents
  --compact             compact the database; may take some time
  --compact_design DDOC
                        compact the view indexes for the named design doc
  --view_cleanup        remove view index files no longer required
  --info                output information about the database
  --security            output security information for the database
  --set_security FILEPATH
                        set security information for the database from the
                        JSON file
  --list_designs        list design documents for the database
  --design DDOC         output the named design document
  --put_design DDOC FILEPATH
                        store the named design document from the file
  --delete_design DDOC  delete the named design document
  --dump FILEPATH       create a dump file of the database
  --undump FILEPATH     load a dump file into the database

document operations:
  -G DOCID, --get DOCID
                        output the document with the given identifier
  -P FILEPATH, --put FILEPATH
                        store the document; arg is literal doc or filepath
  --delete DOCID        delete the document with the given identifier

attachments to document:
  --attach DOCID FILEPATH
                        attach the specified file to the given document
  --detach DOCID FILENAME
                        remove the attached file from the given document
  --get_attach DOCID FILENAME
                        get the attached file from the given document; write
                        to same filepath or that given by '-o'

query a design view, returning rows:
  --view SPEC           design view '{design}/{view}' to query
  --key KEY             key value selecting view rows
  --startkey KEY        start key value selecting range of view rows
  --endkey KEY          end key value selecting range of view rows
  --startkey_docid DOCID
                        return rows starting with the specified document
  --endkey_docid DOCID  stop returning rows when specified document reached
  --group               group the results using the 'reduce' function
  --group_level INT     specify the group level to use
  --noreduce            do not use the 'reduce' function of the view
  --limit INT           limit the number of returned rows
  --skip INT            skip this number of rows before returning result
  --descending          sort rows in descending order (swap start/end keys!)
  --include_docs        include documents in result