Packages
Erlang/Elixir Cloud Framework CouchDB Service
Current section
Files
Jump to
Current section
Files
doc/cloudi_service_db_couchdb.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module cloudi_service_db_couchdb</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module cloudi_service_db_couchdb</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="CloudI_CouchDB_Data_Module">CloudI CouchDB Data Module</a></h3>.
<p>Copyright © 2009-2013 Michael Truog</p>
<p><b>Version:</b> 1.3.0 Sep 30 2014 14:08:45
------------------------------------------------------------------------</p>
<p><b>Behaviours:</b> <a href="deps/cloudi_core/doc/cloudi_service.html"><tt>cloudi_service</tt></a>.</p>
<p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>
<h2><a name="description">Description</a></h2>
<h3><a name="CloudI_CouchDB_Data_Module">CloudI CouchDB Data Module</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-dispatcher">dispatcher()</a></h3>
<p><tt>dispatcher() = <a href="deps/cloudi_core/doc/cloudi_service.html#type-dispatcher">cloudi_service:dispatcher()</a> | <a href="deps/cloudi_core/doc/cloudi.html#type-context">cloudi:context()</a></tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_init-3">cloudi_service_init/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#cloudi_service_terminate-2">cloudi_service_terminate/2</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_attachment-5">create_attachment/5</a></td><td>
<h4><a name="Create_a_document_attachment_from_a_file.">Create a document attachment from a file.</a></h4>
The file is referenced by its filename.</td></tr>
<tr><td valign="top"><a href="#create_attachment-6">create_attachment/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_database-2">create_database/2</a></td><td>
<h4><a name="Create_the_database.">Create the database.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_database-3">create_database/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_document-3">create_document/3</a></td><td>
<h4><a name="Create_a_document_and_allow_the_server_to_create_the_document_id.">Create a document and allow the server to create the document id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_document-4">create_document/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_document_id-4">create_document_id/4</a></td><td>
<h4><a name="Create_a_document_with_a_specific_document_id.">Create a document with a specific document id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_document_id-5">create_document_id/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_documents-3">create_documents/3</a></td><td>
<h4><a name="Create_many_documents.">Create many documents.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_documents-4">create_documents/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_view-5">create_view/5</a></td><td>
<h4><a name="Create_a_view.">Create a view.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_view-6">create_view/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_view_type-6">create_view_type/6</a></td><td>
<h4><a name="Create_a_view_of_a_unique_type.">Create a view of a unique type.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_view_type-7">create_view_type/7</a></td><td></td></tr>
<tr><td valign="top"><a href="#create_views-4">create_views/4</a></td><td>
<h4><a name="Create_many_views.">Create many views.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#create_views-5">create_views/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#database_info-2">database_info/2</a></td><td>
<h4><a name="Get_information_about_the_database.">Get information about the database.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#database_info-3">database_info/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#delete_database-2">delete_database/2</a></td><td>
<h4><a name="Delete_the_database.">Delete the database.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete_database-3">delete_database/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#delete_document-3">delete_document/3</a></td><td>
<h4><a name="Delete_a_document_based_on_its_id.">Delete a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete_document-4">delete_document/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#delete_document_rev-4">delete_document_rev/4</a></td><td>
<h4><a name="Delete_a_specific_revision_of_a_document_based_on_its_id.">Delete a specific revision of a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete_document_rev-5">delete_document_rev/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#delete_documents-3">delete_documents/3</a></td><td>
<h4><a name="Delete_many_documents.">Delete many documents.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#delete_documents-4">delete_documents/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#document_revision-3">document_revision/3</a></td><td>
<h4><a name="Get_the_current_revision_of_a_document.">Get the current revision of a document.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#document_revision-4">document_revision/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#invoke_view-4">invoke_view/4</a></td><td>
<h4><a name="Invoke_a_view.">Invoke a view.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#invoke_view-5">invoke_view/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#invoke_view_keys-5">invoke_view_keys/5</a></td><td>
<h4><a name="Invoke_a_view_with_a_list_of_keys.">Invoke a view with a list of keys.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#invoke_view_keys-6">invoke_view_keys/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#replace_document-4">replace_document/4</a></td><td>
<h4><a name="Replace_a_document_based_on_its_id.">Replace a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#replace_document-5">replace_document/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#replace_document_rev-5">replace_document_rev/5</a></td><td>
<h4><a name="Replace_a_specific_revision_of_a_document_based_on_its_id.">Replace a specific revision of a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#replace_document_rev-6">replace_document_rev/6</a></td><td></td></tr>
<tr><td valign="top"><a href="#retrieve_all_dbs-2">retrieve_all_dbs/2</a></td><td>
<h4><a name="Retrieve_a_list_of_all_the_databases.">Retrieve a list of all the databases.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#retrieve_all_dbs-3">retrieve_all_dbs/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#retrieve_document-3">retrieve_document/3</a></td><td>
<h4><a name="Get_a_document_based_on_its_id.">Get a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#retrieve_document-4">retrieve_document/4</a></td><td></td></tr>
<tr><td valign="top"><a href="#server_info-2">server_info/2</a></td><td>
<h4><a name="Get_information_about_the_server.">Get information about the server.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#server_info-3">server_info/3</a></td><td></td></tr>
<tr><td valign="top"><a href="#update_document-4">update_document/4</a></td><td>
<h4><a name="Update_a_document_based_on_its_id.">Update a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#update_document-5">update_document/5</a></td><td></td></tr>
<tr><td valign="top"><a href="#update_document_rev-5">update_document_rev/5</a></td><td>
<h4><a name="Update_a_specific_revision_of_a_document_based_on_its_id.">Update a specific revision of a document based on its id.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#update_document_rev-6">update_document_rev/6</a></td><td></td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="cloudi_service_handle_info-3">cloudi_service_handle_info/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_handle_info(Request, State, X3) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_handle_request-11">cloudi_service_handle_request/11</a></h3>
<div class="spec">
<p><tt>cloudi_service_handle_request(Type, Name, Pattern, RequestInfo, Request, Timeout, Priority, TransId, Pid, State, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_init-3">cloudi_service_init/3</a></h3>
<div class="spec">
<p><tt>cloudi_service_init(Args, Prefix, Dispatcher) -> any()</tt></p>
</div>
<h3 class="function"><a name="cloudi_service_terminate-2">cloudi_service_terminate/2</a></h3>
<div class="spec">
<p><tt>cloudi_service_terminate(X1, State) -> any()</tt></p>
</div>
<h3 class="function"><a name="create_attachment-5">create_attachment/5</a></h3>
<div class="spec">
<p><tt>create_attachment(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), File::string(), ContentType::string()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_a_document_attachment_from_a_file.">Create a document attachment from a file.</a></h4>
The file is referenced by its filename.</p>
<h3 class="function"><a name="create_attachment-6">create_attachment/6</a></h3>
<div class="spec">
<p><tt>create_attachment(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), File::string(), ContentType::string(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_database-2">create_database/2</a></h3>
<div class="spec">
<p><tt>create_database(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string()) -> {ok, any()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_the_database.">Create the database.</a></h4>
</p>
<h3 class="function"><a name="create_database-3">create_database/3</a></h3>
<div class="spec">
<p><tt>create_database(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Timeout::pos_integer()) -> {ok, any()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_document-3">create_document/3</a></h3>
<div class="spec">
<p><tt>create_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_a_document_and_allow_the_server_to_create_the_document_id.">Create a document and allow the server to create the document id.</a></h4>
</p>
<h3 class="function"><a name="create_document-4">create_document/4</a></h3>
<div class="spec">
<p><tt>create_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_document_id-4">create_document_id/4</a></h3>
<div class="spec">
<p><tt>create_document_id(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_a_document_with_a_specific_document_id.">Create a document with a specific document id.</a></h4>
</p>
<h3 class="function"><a name="create_document_id-5">create_document_id/5</a></h3>
<div class="spec">
<p><tt>create_document_id(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_documents-3">create_documents/3</a></h3>
<div class="spec">
<p><tt>create_documents(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Documents::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_many_documents.">Create many documents.</a></h4>
</p>
<h3 class="function"><a name="create_documents-4">create_documents/4</a></h3>
<div class="spec">
<p><tt>create_documents(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Documents::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_view-5">create_view/5</a></h3>
<div class="spec">
<p><tt>create_view(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string(), Data::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_a_view.">Create a view.</a></h4>
</p>
<h3 class="function"><a name="create_view-6">create_view/6</a></h3>
<div class="spec">
<p><tt>create_view(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string(), Data::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_view_type-6">create_view_type/6</a></h3>
<div class="spec">
<p><tt>create_view_type(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), Type::string(), ViewName::string(), Data::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_a_view_of_a_unique_type.">Create a view of a unique type.</a></h4>
</p>
<h3 class="function"><a name="create_view_type-7">create_view_type/7</a></h3>
<div class="spec">
<p><tt>create_view_type(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), Type::string(), ViewName::string(), Data::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="create_views-4">create_views/4</a></h3>
<div class="spec">
<p><tt>create_views(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewList::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Create_many_views.">Create many views.</a></h4>
</p>
<h3 class="function"><a name="create_views-5">create_views/5</a></h3>
<div class="spec">
<p><tt>create_views(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewList::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="database_info-2">database_info/2</a></h3>
<div class="spec">
<p><tt>database_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string()) -> {ok, any()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Get_information_about_the_database.">Get information about the database.</a></h4>
</p>
<h3 class="function"><a name="database_info-3">database_info/3</a></h3>
<div class="spec">
<p><tt>database_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Timeout::pos_integer()) -> {ok, any()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="delete_database-2">delete_database/2</a></h3>
<div class="spec">
<p><tt>delete_database(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string()) -> {ok, any()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Delete_the_database.">Delete the database.</a></h4>
</p>
<h3 class="function"><a name="delete_database-3">delete_database/3</a></h3>
<div class="spec">
<p><tt>delete_database(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Timeout::pos_integer()) -> {ok, any()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="delete_document-3">delete_document/3</a></h3>
<div class="spec">
<p><tt>delete_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Delete_a_document_based_on_its_id.">Delete a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="delete_document-4">delete_document/4</a></h3>
<div class="spec">
<p><tt>delete_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="delete_document_rev-4">delete_document_rev/4</a></h3>
<div class="spec">
<p><tt>delete_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Delete_a_specific_revision_of_a_document_based_on_its_id.">Delete a specific revision of a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="delete_document_rev-5">delete_document_rev/5</a></h3>
<div class="spec">
<p><tt>delete_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="delete_documents-3">delete_documents/3</a></h3>
<div class="spec">
<p><tt>delete_documents(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Documents::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Delete_many_documents.">Delete many documents.</a></h4>
</p>
<h3 class="function"><a name="delete_documents-4">delete_documents/4</a></h3>
<div class="spec">
<p><tt>delete_documents(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Documents::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="document_revision-3">document_revision/3</a></h3>
<div class="spec">
<p><tt>document_revision(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string()) -> {ok, {any(), any()}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Get_the_current_revision_of_a_document.">Get the current revision of a document.</a></h4>
</p>
<h3 class="function"><a name="document_revision-4">document_revision/4</a></h3>
<div class="spec">
<p><tt>document_revision(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Timeout::pos_integer()) -> {ok, {any(), any()}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="invoke_view-4">invoke_view/4</a></h3>
<div class="spec">
<p><tt>invoke_view(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Invoke_a_view.">Invoke a view.</a></h4>
</p>
<h3 class="function"><a name="invoke_view-5">invoke_view/5</a></h3>
<div class="spec">
<p><tt>invoke_view(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="invoke_view_keys-5">invoke_view_keys/5</a></h3>
<div class="spec">
<p><tt>invoke_view_keys(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string(), Keys::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Invoke_a_view_with_a_list_of_keys.">Invoke a view with a list of keys.</a></h4>
</p>
<h3 class="function"><a name="invoke_view_keys-6">invoke_view_keys/6</a></h3>
<div class="spec">
<p><tt>invoke_view_keys(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocName::string(), ViewName::string(), Keys::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="replace_document-4">replace_document/4</a></h3>
<div class="spec">
<p><tt>replace_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Replace_a_document_based_on_its_id.">Replace a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="replace_document-5">replace_document/5</a></h3>
<div class="spec">
<p><tt>replace_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="replace_document_rev-5">replace_document_rev/5</a></h3>
<div class="spec">
<p><tt>replace_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Replace_a_specific_revision_of_a_document_based_on_its_id.">Replace a specific revision of a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="replace_document_rev-6">replace_document_rev/6</a></h3>
<div class="spec">
<p><tt>replace_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="retrieve_all_dbs-2">retrieve_all_dbs/2</a></h3>
<div class="spec">
<p><tt>retrieve_all_dbs(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string()) -> {ok, any()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Retrieve_a_list_of_all_the_databases.">Retrieve a list of all the databases.</a></h4>
</p>
<h3 class="function"><a name="retrieve_all_dbs-3">retrieve_all_dbs/3</a></h3>
<div class="spec">
<p><tt>retrieve_all_dbs(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Timeout::pos_integer()) -> {ok, any()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="retrieve_document-3">retrieve_document/3</a></h3>
<div class="spec">
<p><tt>retrieve_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Get_a_document_based_on_its_id.">Get a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="retrieve_document-4">retrieve_document/4</a></h3>
<div class="spec">
<p><tt>retrieve_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="server_info-2">server_info/2</a></h3>
<div class="spec">
<p><tt>server_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string()) -> {ok, any()} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Get_information_about_the_server.">Get information about the server.</a></h4>
</p>
<h3 class="function"><a name="server_info-3">server_info/3</a></h3>
<div class="spec">
<p><tt>server_info(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), Timeout::pos_integer()) -> {ok, any()} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="update_document-4">update_document/4</a></h3>
<div class="spec">
<p><tt>update_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Update_a_document_based_on_its_id.">Update a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="update_document-5">update_document/5</a></h3>
<div class="spec">
<p><tt>update_document(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<h3 class="function"><a name="update_document_rev-5">update_document_rev/5</a></h3>
<div class="spec">
<p><tt>update_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string(), Doc::list()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Update_a_specific_revision_of_a_document_based_on_its_id.">Update a specific revision of a document based on its id.</a></h4>
</p>
<h3 class="function"><a name="update_document_rev-6">update_document_rev/6</a></h3>
<div class="spec">
<p><tt>update_document_rev(Dispatcher::<a href="#type-dispatcher">dispatcher()</a>, Name::string(), DocumentID::string(), Rev::string(), Doc::list(), Timeout::pos_integer()) -> {ok, {json, {struct, list()}}} | {error, any()}</tt><br></p>
</div>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Sep 30 2014, 14:08:45.</i></p>
</body>
</html>