Class Database

Constructor for Database

Parameters:

• uri - str, Database uri
• create - boolean, False by default, if True try to create the database.
• server - Server instance

Overrides: object.__init__

repr(x)

Overrides: object.__repr__

(inherited documentation)

Get database information

Returns:

dict

compact database

Parameters:

• dname - string, name of design doc. Usefull to compact a view.

Test if document exists in a database

Parameters:

• docid - str, document id

Returns:

boolean, True if document exist

Get document from database

Args:

Parameters:

• docid - str, document id to retrieve
• wrapper - callable. function that takes dict as a param. Used to wrap an object.
• **params - See doc api for parameters to use: http://wiki.apache.org/couchdb/HTTP_Document_API

Returns:

dict, representation of CouchDB document as a dict.

Get document from database

Args:

Parameters:

• docid - str, document id to retrieve
• wrapper - callable. function that takes dict as a param. Used to wrap an object.
• **params - See doc api for parameters to use: http://wiki.apache.org/couchdb/HTTP_Document_API

Returns:

dict, representation of CouchDB document as a dict.

Execute a list function on the server and return the response. If the response is json it will be deserialized, otherwise the string will be returned.

Args:

Parameters:

• list_name - should be 'designname/listname'
• view_name - name of the view to run through the list document
• params - params of the list

Execute a show function on the server and return the response. If the response is json it will be deserialized, otherwise the string will be returned.

Args:

Parameters:

• show_name - should be 'designname/showname'
• doc_id - id of the document to pass into the show document
• params - params of the show

Get all documents from a database

This method has the same behavior as a view.

`all_docs( **params )` is the same as `view('_all_docs', **params)`
 and `all_docs( by_seq=True, **params)` is the same as
`view('_all_docs_by_seq', **params)`

You can use all(), one(), first() just like views

Args:
@param by_seq: bool, if True the "_all_docs_by_seq" is passed to
couchdb. It will return an updated list of all documents.

@return: list, results of the view

Get last revision from docid (the '_rev' member)

Parameters:

• docid - str, undecoded document id.

Save a document. It will use the `_id` member of the document or request a new uuid from CouchDB. IDs are attached to documents on the client side because POST has the curious property of being automatically retried by proxies in the event of network segmentation and lost responses. (Idee from `Couchrest <http://github.com/jchris/couchrest/>`)

Parameters:

• doc - dict. doc is updated with doc '_id' and '_rev' properties returned by CouchDB server when you save.
• force_update - boolean, if there is conlict, try to update with latest revision @param params, list of optionnal params, like batch="ok"

bulk save. Modify Multiple Documents With a Single Request

Parameters:

• docs - list of docs
• use_uuids - add _id in doc who don't have it already set.
• all_or_nothing - In the case of a power failure, when the database restarts either all the changes will have been saved or none of them. However, it does not do conflict checking, so the documents will

  .. seealso:: `HTTP Bulk Document API <http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API>`

bulk save. Modify Multiple Documents With a Single Request

Parameters:

• docs - list of docs
• use_uuids - add _id in doc who don't have it already set.
• all_or_nothing - In the case of a power failure, when the database restarts either all the changes will have been saved or none of them. However, it does not do conflict checking, so the documents will

  .. seealso:: `HTTP Bulk Document API <http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API>`

bulk delete. It adds '_deleted' member to doc then uses bulk_save to save them.

Parameters:

• empty_on_delete - default is False if you want to make sure the doc is emptied and will not be stored as is in Apache CouchDB.
• all_or_nothing - In the case of a power failure, when the database restarts either all the changes will have been saved or none of them. However, it does not do conflict checking, so the documents will

  .. seealso:: `HTTP Bulk Document API <http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API>`

bulk delete. It adds '_deleted' member to doc then uses bulk_save to save them.

Parameters:

• empty_on_delete - default is False if you want to make sure the doc is emptied and will not be stored as is in Apache CouchDB.
• all_or_nothing - In the case of a power failure, when the database restarts either all the changes will have been saved or none of them. However, it does not do conflict checking, so the documents will

  .. seealso:: `HTTP Bulk Document API <http://wiki.apache.org/couchdb/HTTP_Bulk_Document_API>`

delete a document or a list of documents
@param doc: str or dict,  document id or full doc.
@return: dict like:

.. code-block:: python

    {"ok":true,"rev":"2839830636"}

copy an existing document to a new id. If dest is None, a new uuid will be requested

Parameters:

• doc - dict or string, document or document id
• dest - basestring or dict. if _rev is specified in dict it will override the doc

get view results from database. viewname is generally a string like `designname/viewname". It return an ViewResults object on which you could iterate, list, ... . You could wrap results in wrapper function, a wrapper function take a row as argument. Wrapping could be also done by passing an Object in obj arguments. This Object should have a `wrap` method that work like a simple wrapper function.

@param view_name, string could be '_all_docs', '_all_docs_by_seq', 'designname/viewname' if view_name start with a "/" it won't be parsed and beginning slash will be removed. Usefull with c-l for example. @param schema, Object with a wrapper function

Parameters:

• wrapper - function used to wrap results
• params - params of the view

get adhoc view results. Like view it reeturn a ViewResult object.

Search. Return results from search. Use couchdb-lucene with its default settings by default.

return a ViewResults objects containing all documents. This is a shorthand to view function.

return a ViewResults objects containing all documents. This is a shorthand to view function.

Add attachement to a document. All attachments are streamed.

Parameters:

• doc - dict, document object
• content - string or :obj:`File` object.
• name - name or attachment (file name).
• content_type - string, mimetype of attachment. If you don't set it, it will be autodetected.
• content_lenght - int, size of attachment.

Returns:

bool, True if everything was ok.

Example:

>>> from simplecouchdb import server
>>> server = server()
>>> db = server.create_db('couchdbkit_test')
>>> doc = { 'string': 'test', 'number': 4 }
>>> db.save(doc)
>>> text_attachment = u'un texte attaché'
>>> db.put_attachment(doc, text_attachment, "test", "text/plain")
True
>>> file = db.fetch_attachment(doc, 'test')
>>> result = db.delete_attachment(doc, 'test')
>>> result['ok']
True
>>> db.fetch_attachment(doc, 'test')
>>> del server['couchdbkit_test']
{u'ok': True}

delete attachement to the document

Parameters:

• doc - dict, document object in python
• name - name of attachement

Returns:

dict, with member ok set to True if delete was ok.

get attachment in a document

Parameters:

• id_or_doc - str or dict, doc id or document dict
• name - name of attachment default: default result
• stream - boolean, if True return a file object

Returns:

`restkit.httpc.Response` object