1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
//! The couchdb crate provides low-level access to individual HTTP actions—e.g., //! PUT database, GET document, etc. It handles the menial task of sending //! requests and receiving responses, thereby allowing application programmers //! to focus on their business logic. //! //! This documentation has been written assuming the application programmer is //! familiar with the CouchDB API. Descriptions of types, methods, etc. in the //! couchdb crate should provide just enough information for the programmer to //! map the crate's concepts onto the CouchDB API and then use the CouchDB //! documentation as needed to fill in remaining details. Most names in the //! crate API are identical to the names used in the CouchDB API so as to make //! this mapping straightforward. There's also a table, below, that [shows the //! mapping at a high level](#couchdb-api-overview). //! //! One key difference between the couchdb crate's API and the CouchDB API is //! the crate provides stronger type-safety beyond working with raw strings. For //! example, applications get and put documents using structured types, and //! other types, such as revisions and views, are strongly typed as well. //! //! To deal with JSON, the couchdb crate relies on Serde and its traits //! `serde::Serialize` and `serde::Deserialize`. These traits are fundamental to //! the crate's API—they are not mere implementation details. As such, //! applications must use these traits when working with documents, views, or //! any type that is JSON-encoded in the CouchDB API. //! //! ## Example: Create a document, read a document //! //! This example shows how the couchdb crates thinly wraps the CouchDB API. //! //! The following program (1) constructs a `Client` with which to connect to the //! CouchDB server, (2) creates a database (via the `put_database` method), (3) //! creates a document within that database (via the `post_database` method), //! and (4) reads the new document (via the `get_document` method). //! //! ```no_run //! extern crate couchdb; //! extern crate serde_json; //! //! // The `Client` type is the entry point for sending all HTTP requests to the //! // CouchDB server. //! let client = couchdb::Client::new("http://couchdb-server:5984/").unwrap(); //! //! // PUT http://couchdb-server:5984/baseball //! client.put_database("/baseball").run().unwrap(); //! //! // POST http://couchdb-server:5984/baseball //! let content = serde_json::builder::ObjectBuilder::new() //! .insert("name", "Babe Ruth") //! .insert("career_hr", 714) //! .unwrap(); //! let (id, rev) = client.post_database("/baseball", &content) //! .run() //! .unwrap(); //! //! // GET http://couchdb-server:5984/baseball/<doc_id> //! let doc = client.get_document(("/baseball", id.clone())) //! .run() //! .unwrap() //! .unwrap(); //! assert_eq!(id, doc.id); //! assert_eq!(rev, doc.rev); //! assert_eq!(content, doc.into_content().unwrap()); //! ``` //! //! ## CouchDB API overview //! //! This table shows the mapping from each CouchDB API action to the `Client` //! method that performs that action. //! //! In the couchdb crate, the `Client` type is the principal type for //! communicating with a CouchDB server. All HTTP requests to the CouchDB server //! go through a `Client` instance. //! //! <table> //! //! <thead> //! <tr> //! <th>URI path</th> //! <th>Method</th> //! <th><code>Client</code> method</th> //! <th>Description</th> //! </tr> //! </thead> //! //! <tbody> //! <tr> //! <td> //! <ul><li><code>/</code></li></ul> //! </td> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_root"><code>get_root</code></a></td> //! <td>Get server version and other meta-information.</td> //! </tr> //! //! <tr> //! <td> //! <ul><li><code>/_all_dbs</code></li></ul> //! </td> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_all_databases"><code>get_all_databases</code></a></td> //! <td>Get list of all databases.</td> //! </tr> //! //! <tr> //! <td rowspan="5"> //! <ul><li><code>/db</code></li></ul> //! </td> //! <td>HEAD</td> //! <td><a href="struct.Client.html#method.head_database"><code>head_database</code></a></td> //! <td>Test whether a database exists.</td> //! </tr> //! //! <tr> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_database"><code>get_database</code></a></td> //! <td>Get meta-information about a database.</td> //! </tr> //! //! <tr> //! <td>PUT</td> //! <td><a href="struct.Client.html#method.put_database"><code>put_database</code></a></td> //! <td>Create a database.</td> //! </tr> //! //! <tr> //! <td>DELETE</td> //! <td><a href="struct.Client.html#method.delete_database"><code>delete_database</code></a></td> //! <td>Delete a database.</td> //! </tr> //! //! <tr> //! <td>POST</td> //! <td><a href="struct.Client.html#method.post_database"><code>post_database</code></a></td> //! <td>Create a document.</td> //! </tr> //! //! <tr> //! <td> //! <ul> //! <li><code>/db/_changes</code></li> //! </ul> //! </td> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_changes"><code>get_changes</code></a></td> //! <td>Get changes made to documents in a database.</td> //! </tr> //! //! <tr> //! <td rowspan="4"> //! <ul> //! <li><code>/db/doc</code><br></li> //! <li><code>/db/_design/design-doc</code></li> //! <li><code>/db/_local/id</code></li> //! </ul> //! </td> //! <td>HEAD</td> //! <td><a href="struct.Client.html#method.head_document"><code>head_document</code></a></td> //! <td>Test whether a document exists.</td> //! </tr> //! //! <tr> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_document"><code>get_document</code></a></td> //! <td>Get meta-information and application-defined content for a //! document.</td> //! </tr> //! //! <tr> //! <td>PUT</td> //! <td><a href="struct.Client.html#method.put_document"><code>put_document</code></a></td> //! <td>Create or update a document.</td> //! </tr> //! //! <tr> //! <td>DELETE</td> //! <td><a href="struct.Client.html#method.delete_document"><code>delete_document</code></a></td> //! <td>Delete a document.</td> //! </tr> //! //! <tr> //! <td> //! <ul><li><code>/db/_design/design-doc/_view/view</code></li></ul> //! </td> //! <td>GET</td> //! <td><a href="struct.Client.html#method.get_view"><code>get_view</code></a></td> //! <td>Execute a view.</td> //! </tr> //! //! </tbody> //! </table> extern crate base64; extern crate hyper; extern crate mime; extern crate regex; extern crate serde; extern crate serde_json; extern crate semver; extern crate tempdir; extern crate url; extern crate uuid; pub mod action; pub mod testing; mod client; mod dbtype; mod error; mod path; pub use client::{Client, IntoUrl}; pub use dbtype::{ChangeItem, ChangeItemBuilder, ChangeResult, ChangeResultBuilder, Changes, ChangesBuilder, Database, DatabaseName, Design, DesignBuilder, DesignDocumentName, Document, DocumentId, DocumentName, EmbeddedAttachment, EmbeddedAttachmentBuilder, ErrorResponse, Heartbeat, Revision, Root, Since, Vendor, ViewFunction, ViewFunctionBuilder, ViewFunctionMap, ViewName, ViewResult, ViewRow}; pub use path::{IntoDatabasePath, IntoDesignDocumentPath, IntoDocumentPath, IntoViewPath, DatabasePath, DesignDocumentPath, DocumentPath, ViewPath}; pub use error::Error;