Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9D2C2DFC2 for ; Fri, 14 Sep 2012 10:17:41 +0000 (UTC) Received: (qmail 94784 invoked by uid 500); 14 Sep 2012 10:17:22 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 93946 invoked by uid 500); 14 Sep 2012 10:17:17 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 91118 invoked by uid 99); 14 Sep 2012 10:17:01 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 14 Sep 2012 10:17:01 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 7EDD73687D; Fri, 14 Sep 2012 10:17:00 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: dch@apache.org To: commits@couchdb.apache.org X-Mailer: ASF-Git Admin Mailer Subject: [47/49] import CouchBase docs Message-Id: <20120914101700.7EDD73687D@tyr.zones.apache.org> Date: Fri, 14 Sep 2012 10:17:00 +0000 (UTC) http://git-wip-us.apache.org/repos/asf/couchdb/blob/1055ea0e/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-json.xml ---------------------------------------------------------------------- diff --git a/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-json.xml b/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-json.xml new file mode 100644 index 0000000..6e773d4 --- /dev/null +++ b/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-json.xml @@ -0,0 +1,347 @@ + + +%every.entities; +]> + + + JSON Structure Reference + + + The following appendix provides a quick reference to all the JSON + structures that you can supply to CouchDB, or get in return to + requests. + + + + + + +JSON StructuresDescription + All Database Documents + + Bulk Document Response + + Bulk Documents + + Changes information for a database + + CouchDB Document + + CouchDB Error Status + + CouchDB database information object + + Design Document + + Design Document Information + + Design Document spatial index Information + + Document with Attachments + + List of Active Tasks + + Replication Settings + + Replication Status + + Returned CouchDB Document with Detailed Revision Info + + Returned CouchDB Document with Revision Info + + Returned Document with Attachments + + Security Object +
+ + + + + + + All Database Documents + FieldDescriptionoffset + Offset where the document list started + rows [array] + Array of document object + total_rows + Number of documents in the database/view + update_seq (optional) + Current update sequence for the database +
+ Bulk Document Response + FieldDescriptiondocs [array] + Bulk Docs Returned Documents +         error + Error type +         id + Document ID +         reason + Error string with extended reason +
+ Bulk Documents + FieldDescriptionall_or_nothing (optional) + Sets the database commit mode to use all-or-nothing semantics + docs [array] + Bulk Documents Document +         _id (optional) + Document ID +         _rev (optional) + Revision ID (when updating an existing document) +         _deleted (optional) + Whether the document should be deleted +
+ Changes information for a database + FieldDescriptionlast_seq + Last change sequence number + results [array] + Changes made to a database +         changes [array] + List of changes, field-by-field, for this document +         id + Document ID +         seq + Update sequence number +
+ CouchDB Document + FieldDescription_id (optional) + Document ID + _rev (optional) + Revision ID (when updating an existing document) +
+ CouchDB Error Status + FieldDescriptionerror + Error type + id + Document ID + reason + Error string with extended reason +
+ CouchDB database information object + FieldDescriptioncommitted_update_seq + The number of committed update. + compact_running + Set to true if the database compaction routine is operating on + this database. + db_name + The name of the database. + disk_format_version + The version of the physical format used for the data when it is + stored on disk. + disk_size + Size in bytes of the data as stored on the disk. Views indexes + are not included in the calculation. + doc_count + A count of the documents in the specified database. + doc_del_count + Number of deleted documents + instance_start_time + Timestamp of when the database was created, expressed in + milliseconds since the epoch. + purge_seq + The number of purge operations on the database. + update_seq + The current number of updates to the database. +
+ Design Document + FieldDescription_id + Design Document ID + _rev + Design Document Revision + views + View +         viewname + View Definition +                 map + Map Function for View +                 reduce (optional) + Reduce Function for View +
+ Design Document Information + FieldDescriptionname + Name/ID of Design Document + view_index + View Index +         compact_running + Indicates whether a compaction routine is currently running on + the view +         disk_size + Size in bytes of the view as stored on disk +         language + Language for the defined views +         purge_seq + The purge sequence that has been processed +         signature + MD5 signature of the views for the design document +         update_seq + The update sequence of the corresponding database that has been + indexed +         updater_running + Indicates if the view is currently being updated +         waiting_clients + Number of clients waiting on views from this design document +         waiting_commit + Indicates if there are outstanding commits to the underlying + database that need to processed +
+ Design Document spatial index Information + FieldDescriptionname + Name/ID of Design Document + spatial_index + View Index +         compact_running + Indicates whether a compaction routine is currently running on + the view +         disk_size + Size in bytes of the view as stored on disk +         language + Language for the defined views +         purge_seq + The purge sequence that has been processed +         signature + MD5 signature of the views for the design document +         update_seq + The update sequence of the corresponding database that has been + indexed +         updater_running + Indicates if the view is currently being updated +         waiting_clients + Number of clients waiting on views from this design document +         waiting_commit + Indicates if there are outstanding commits to the underlying + database that need to processed +
+ Document with Attachments + FieldDescription_id (optional) + Document ID + _rev (optional) + Revision ID (when updating an existing document) + _attachments (optional) + Document Attachment +         filename + Attachment information +                 content_type + MIME Content type string +                 data + File attachment content, Base64 encoded +
+ List of Active Tasks + FieldDescriptiontasks [array] + Active Task +         pid + Process ID +         status + Task status message +         task + Task name +         type + Operation Type +
+ Replication Settings + FieldDescriptioncancel (optional) + Cancels the replication + continuous (optional) + Configure the replication to be continuous + create_target (optional) + Creates the target database + doc_ids (optional) + Array of document IDs to be synchronized + proxy (optional) + Address of a proxy server through which replication should occur + source + Source database name or URL + target + Target database name or URL +
+ Replication Status + FieldDescriptionhistory [array] + Replication History +         doc_write_failures + Number of document write failures +         docs_read + Number of documents read +         docs_written + Number of documents written to target +         end_last_seq + Last sequence number in changes stream +         end_time + Date/Time replication operation completed +         missing_checked + Number of missing documents checked +         missing_found + Number of missing documents found +         recorded_seq + Last recorded sequence number +         session_id + Session ID for this replication operation +         start_last_seq + First sequence number in changes stream +         start_time + Date/Time replication operation started + ok + Replication status + session_id + Unique session ID + source_last_seq + Last sequence number read from source database +
+ Returned CouchDB Document with Detailed Revision Info + FieldDescription_id (optional) + Document ID + _rev (optional) + Revision ID (when updating an existing document) + _revs_info [array] + CouchDB Document Extended Revision Info +         rev + Full revision string +         status + Status of the revision +
+ Returned CouchDB Document with Revision Info + FieldDescription_id (optional) + Document ID + _rev (optional) + Revision ID (when updating an existing document) + _revisions + CouchDB Document Revisions +         ids [array] + Array of valid revision IDs, in reverse order (latest first) +         start + Prefix number for the latest revision +
+ Returned Document with Attachments + FieldDescription_id (optional) + Document ID + _rev (optional) + Revision ID (when updating an existing document) + _attachments (optional) + Document Attachment +         filename + Attachment +                 content_type + MIME Content type string +                 length + Length (bytes) of the attachment data +                 revpos + Revision where this attachment exists +                 stub + Indicates whether the attachment is a stub +
+ Security Object + FieldDescriptionadmins + Roles/Users with admin privileges +         roles [array] + List of roles with parent privilege +         users [array] + List of users with parent privilege + readers + Roles/Users with reader privileges +         roles [array] + List of roles with parent privilege +         users [array] + List of users with parent privilege +
+ + http://git-wip-us.apache.org/repos/asf/couchdb/blob/1055ea0e/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-localdb.xml ---------------------------------------------------------------------- diff --git a/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-localdb.xml b/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-localdb.xml new file mode 100644 index 0000000..9f7161f --- /dev/null +++ b/share/docs/couchdb-manual-1.1/metadoc-couchdb-api-localdb.xml @@ -0,0 +1,188 @@ + + +%every.entities; +]> + + + CouchDB API Server Local (non-replicating) Document Methods + + + The Local (non-replicating) document interface allows you to create + local documents that are not replicated to other databases. These + documents can be used to hold configuration or other information + that is required specifically on the local CouchDB instance. + + + + Local documents have the following limitations: + + + + + + + Local documents are not replicated to other databases. + + + + + + The ID of the local document must be known for the document to + accessed. You cannot obtain a list of local documents from the + database. + + + + + + Local documents are not output by views, or the + _all_docs view. + + + + + + + Local documents can be used when you want to store configuration or + other information for the curent (local) instance of a given + database. + + + + A list of the available methods and URL paths are provided below: + + + + + + +Local (non-replicating) Document API + CallsMethodPathDescriptionGET/db/_local/local-doc + Returns the latest revision of the non-replicated document + PUT/db/_local/local-doc + Inserts a new version of the non-replicated document + DELETE/db/_local/local-doc + Deletes the non-replicated document + COPY/db/_local/local-doc + Copies the non-replicated document +
+ +
+ + <literal>GET /db/_local/local-doc</literal> + + + + + +URL API GET /db/_local/local-docMethodGET /db/_local/local-docRequest + None + Response + JSON of the returned document + Admin Privileges RequirednoQuery ArgumentsArgumentrevDescription + Specify the revision to return + OptionalyesTypestringSupported ValuestrueIncludes the revisionsArgumentrevsDescription + Return a list of the revisions for the document + OptionalyesTypebooleanArgumentrevs_infoDescription + Return a list of detailed revision information for the + document + OptionalyesTypebooleanSupported ValuestrueIncludes the revisionsReturn Codes400 + The format of the request or revision was invalid + 404 + The specified document or revision cannot be found, or has been + deleted + + + + Gets the specified local document. The semantics are identical to + accessing a standard document in the specified database, except + that the document is not replicated. See + . + + +
+ +
+ + <literal>PUT /db/_local/local-doc</literal> + + + + + +URL API PUT /db/_local/local-docMethodPUT /db/_local/local-docRequest + JSON of the document + Response + JSON with the committed document information + Admin Privileges RequirednoReturn Codes201 + Document has been created successfully + + + + Stores the specified local document. The semantics are identical + to storing a standard document in the specified database, except + that the document is not replicated. See + . + + +
+ +
+ + <literal>DELETE /db/_local/local-doc</literal> + + + + + +URL API DELETE /db/_local/local-docMethodDELETE /db/_local/local-docRequest + None + Response + JSON with the deleted document information + Admin Privileges RequirednoQuery ArgumentsArgumentrevDescription + Current revision of the document for validation + OptionalyesTypestringHTTP HeadersHeaderIf-MatchDescriptionCurrent revision of the document for validationOptionalyesReturn Codes409 + Supplied revision is incorrect or missing + + + + Deletes the specified local document. The semantics are identical + to deleting a standard document in the specified database, except + that the document is not replicated. See + . + + +
+ +
+ + <literal>COPY /db/_local/local-doc</literal> + + + + + +URL API COPY /db/_local/local-docMethodCOPY /db/_local/local-docRequest + None + Response + JSON of the copied document + Admin Privileges RequirednoQuery ArgumentsArgumentrevDescription + Revision to copy from + OptionalyesTypestringHTTP HeadersHeaderDestinationDescriptionDestination document (and optional revision)Optionalno + + + Copies the specified local document. The semantics are identical + to copying a standard document in the specified database, except + that the document is not replicated. See + . + + +
+ +