You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by an...@apache.org on 2014/02/03 13:09:08 UTC
[1/2] couchdb commit: updated refs/heads/master to 9185631
Updated Branches:
refs/heads/master b68eb1746 -> 918563154
added documentation fixes
made the deletion of a document clearer and
fixed some wording in the JSON structure tables
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/be483fd4
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/be483fd4
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/be483fd4
Branch: refs/heads/master
Commit: be483fd4141ea2c8cbb91f9ca8b490797d49eedf
Parents: 6fd3840
Author: Andy Wenk <an...@apache.org>
Authored: Fri Jan 24 00:20:41 2014 +0100
Committer: Andy Wenk <an...@nms.de>
Committed: Mon Feb 3 13:05:36 2014 +0100
----------------------------------------------------------------------
share/doc/src/api/document/common.rst | 19 ++++---
share/doc/src/json-structure.rst | 84 +++++++++++++++---------------
2 files changed, 54 insertions(+), 49 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/be483fd4/share/doc/src/api/document/common.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/document/common.rst b/share/doc/src/api/document/common.rst
index f21c8df..bdd6702 100644
--- a/share/doc/src/api/document/common.rst
+++ b/share/doc/src/api/document/common.rst
@@ -238,18 +238,22 @@
"rev": "1-917fa2381192822767f010b95b45325b"
}
-
.. http:delete:: /{db}/{docid}
:synopsis: Deletes the document
- Deletes the specified document from the database. You must supply the
- current (latest) revision, either by using the ``rev`` parameter to
- specify the revision.
+ Marks the specified document as deleted by adding a field ``_deleted`` with
+ the value ``true``. Documents with this field will not be returned within
+ requests anymore, but stay in the database. You must supply the current
+ (latest) revision, either by using the ``rev`` parameter or by using the
+ :header:`If-Match` header to specify the revision.
+
+ .. seealso::
+ :ref:`Retrieving Deleted Documents <api/doc/retrieving-deleted-documents>`
.. note::
- Note that deletion of a record increments the revision number.
- The use of a revision for deletion of the record allows replication of
- the database to correctly track the deletion in synchronized copies.
+ CouchDB doesn't actually delete documents. The reason is the need to track
+ them correctly during the replication process between databases to prevent
+ accidental document recovery for any previous state.
:param db: Database name
:param docid: Document ID
@@ -489,6 +493,7 @@ Basic Attachments Info
"name": "Spaghetti with meatballs"
}
+.. _api/doc/retrieving-deleted-documents:
Retrieving Attachments Content
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
http://git-wip-us.apache.org/repos/asf/couchdb/blob/be483fd4/share/doc/src/json-structure.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/json-structure.rst b/share/doc/src/json-structure.rst
index 7d22f1e..4ab2f65 100644
--- a/share/doc/src/json-structure.rst
+++ b/share/doc/src/json-structure.rst
@@ -119,30 +119,30 @@ CouchDB database information object
+================================+=============================================+
| db_name | The name of the database. |
+--------------------------------+---------------------------------------------+
-| committed_update_seq | The number of committed update. |
+| committed_update_seq | The number of committed updates. |
+--------------------------------+---------------------------------------------+
-| doc_count | A count of the documents in the specified |
-| | database. |
+| doc_count | The number of documents in the database. |
+--------------------------------+---------------------------------------------+
-| doc_del_count | Number of deleted documents |
+| doc_del_count | The number of deleted documents. |
+--------------------------------+---------------------------------------------+
| compact_running | Set to true if the database compaction |
| | routine is operating on this database. |
+--------------------------------+---------------------------------------------+
| disk_format_version | The version of the physical format used for |
-| | the data when it is stored on disk. |
+| | the data when it is stored on hard disk. |
+--------------------------------+---------------------------------------------+
-| disk_size | Size in bytes of the data as stored on the |
-| | disk. Views indexes are not included in the |
+| disk_size | Size in bytes of the data as stored on disk.|
+| | View indexes are not included in the |
| | calculation. |
+--------------------------------+---------------------------------------------+
-| instance_start_time | Timestamp of when the database was opened, |
-| | expressed in microseconds since the epoch. |
+| instance_start_time | Timestamp indicating when the database was |
+| | opened, expressed in microseconds since the |
+| | epoch. |
+--------------------------------+---------------------------------------------+
| purge_seq | The number of purge operations on the |
| | database. |
+--------------------------------+---------------------------------------------+
-| update_seq | The current number of updates to the |
+| update_seq | The current number of updates made in the |
| | database. |
+--------------------------------+---------------------------------------------+
@@ -227,7 +227,7 @@ List of Active Tasks
+--------------------------------+---------------------------------------------+
| Field | Description |
+================================+=============================================+
-| tasks [array] | Active Task |
+| tasks [array] | Active Tasks |
+--------------------------------+---------------------------------------------+
| pid | Process ID |
+--------------------------------+---------------------------------------------+
@@ -265,16 +265,16 @@ Replication Settings
| | start |
+--------------------------------+---------------------------------------------+
| filter (optional) | name of the filter function in the form of |
-| | ddoc/myfilter |
+| | ``ddoc/myfilter`` |
+--------------------------------+---------------------------------------------+
-| query_params (optional) | query parameter that are passed to the |
-| | filter function; value should be a document |
-| | containing parameters as members |
+| query_params (optional) | Query parameter that are passed to the |
+| | filter function; the value should be a |
+| | document containing parameters as members |
+--------------------------------+---------------------------------------------+
| use_checkpoints (optional) | Whether to use replication checkpoints |
| | or not |
+--------------------------------+---------------------------------------------+
-| checkpoint_interval (optional) | Specifies checkpoint interval in ms. |
+| checkpoint_interval (optional) | Specifies the checkpoint interval in ms. |
+--------------------------------+---------------------------------------------+
.. _replication-status:
@@ -289,7 +289,7 @@ Replication Status
+--------------------------------+---------------------------------------------+
| session_id | Unique session ID |
+--------------------------------+---------------------------------------------+
-| source_last_seq | Last sequence number read from source |
+| source_last_seq | Last sequence number read from the source |
| | database |
+--------------------------------+---------------------------------------------+
| history [array] | Replication History |
@@ -326,16 +326,16 @@ Request object
| Field | Description |
+================================+=============================================+
| body | Request body data as `string`. |
-| | If request method is `GET` method contains |
-| | this field contains ``"undefined"`` value, |
-| | while if `DELETE` or `HEAD` value is ``""`` |
-| | (empty string) |
+| | If the request method is `GET` this field |
+| | contains the value ``"undefined"``. If the |
+| | method is `DELETE` or `HEAD` the value is |
+| | ``""`` (empty string). |
+--------------------------------+---------------------------------------------+
| cookie | Cookies `object`. |
+--------------------------------+---------------------------------------------+
| form | Form data `object`. |
-| | Contains decoded body as key-value pairs if |
-| | `Content-Type` header was |
+| | Contains the decoded body as key-value |
+| | pairs if the `Content-Type` header was |
| | ``application/x-www-form-urlencoded``. |
+--------------------------------+---------------------------------------------+
| headers | Request headers `object`. |
@@ -346,18 +346,18 @@ Request object
| info | :ref:`Database information <dbinfo_object>` |
+--------------------------------+---------------------------------------------+
| method | Request method as `string` or `array`. |
-| | String value is method is one of: `HEAD`, |
+| | String value is a method as one of: `HEAD`, |
| | `GET`, `POST`, `PUT`, `DELETE`, `OPTIONS`, |
-| | and `TRACE`, otherwise it will be |
-| | represented as array of char codes. |
+| | and `TRACE`. Otherwise it will be |
+| | represented as an array of char codes. |
+--------------------------------+---------------------------------------------+
| path | List of requested path sections. |
+--------------------------------+---------------------------------------------+
| peer | Request source IP address. |
+--------------------------------+---------------------------------------------+
| query | URL query parameters `object`. |
-| | Note that multiple keys not supported and |
-| | last key value suppress others. |
+| | Note that multiple keys are not supported |
+| | and teh last key value suppresses others. |
+--------------------------------+---------------------------------------------+
| requested_path | List of actual requested path section. |
+--------------------------------+---------------------------------------------+
@@ -367,8 +367,8 @@ Request object
+--------------------------------+---------------------------------------------+
| userCtx | :ref:`userctx_object`. |
+--------------------------------+---------------------------------------------+
-| uuid | Generated UUID by specified algorithm in |
-| | config file. |
+| uuid | Generated UUID by a specified algorithm in |
+| | the config file. |
+--------------------------------+---------------------------------------------+
.. code-block:: javascript
@@ -481,15 +481,15 @@ Response object
+--------------------------------+---------------------------------------------+
.. warning::
- ``body``, ``base64`` and ``json`` object keys are overlaps each other and
- the last wins. Since most realizations of key-value objects doesn't preserve
- key order mixing them may create confusing situation. Try to use only one of
- them.
+ The ``body``, ``base64`` and ``json`` object keys are overlapping each other
+ where the last one wins. Since most realizations of key-value objects do
+ not preserve the key order or if they are mixed, confusing situations can
+ occure. Try to use only one of them.
.. note::
- Any custom property makes CouchDB raise internal exception.
- Also `Response object` could be a simple string value which would be
- implicitly wrapped into ``{"body": ...}`` object.
+ Any custom property makes CouchDB raise an internal exception.
+ Furthermore, the `Response object` could be a simple string value which would
+ be implicitly wrapped into a ``{"body": ...}`` object.
Returned CouchDB Document with Detailed Revision Info
@@ -503,7 +503,7 @@ Returned CouchDB Document with Detailed Revision Info
| _rev (optional) | Revision ID (when updating an existing |
| | document) |
+--------------------------------+---------------------------------------------+
-| _revs_info [array] | CouchDB Document Extended Revision Info |
+| _revs_info [array] | CouchDB document extended revision info |
+--------------------------------+---------------------------------------------+
| rev | Full revision string |
+--------------------------------+---------------------------------------------+
@@ -521,7 +521,7 @@ Returned CouchDB Document with Revision Info
| _rev (optional) | Revision ID (when updating an existing |
| | document) |
+--------------------------------+---------------------------------------------+
-| _revisions | CouchDB Document Revisions |
+| _revisions | CouchDB document revisions |
+--------------------------------+---------------------------------------------+
| ids [array] | Array of valid revision IDs, in reverse |
| | order (latest first) |
@@ -540,7 +540,7 @@ Returned Document with Attachments
| _rev (optional) | Revision ID (when updating an existing |
| | document) |
+--------------------------------+---------------------------------------------+
-| _attachments (optional) | Document Attachment |
+| _attachments (optional) | Document attachment |
+--------------------------------+---------------------------------------------+
| filename | Attachment |
+--------------------------------+---------------------------------------------+
@@ -601,8 +601,8 @@ User Context Object
+--------------------------------+---------------------------------------------+
| Field | Description |
+================================+=============================================+
-| db | Database name in context of provided |
-| | operation. |
+| db | Database name in the context of the |
+| | provided operation. |
+--------------------------------+---------------------------------------------+
| name | User name. |
+--------------------------------+---------------------------------------------+
[2/2] couchdb commit: updated refs/heads/master to 9185631
Posted by an...@apache.org.
Merge branch 'added-documentation-fixes' of https://github.com/andywenk/couchdb
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/91856315
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/91856315
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/91856315
Branch: refs/heads/master
Commit: 918563154d5f93a7f979b0b344c031be761a89b2
Parents: b68eb17 be483fd
Author: Andy Wenk <an...@apache.org>
Authored: Mon Feb 3 13:08:46 2014 +0100
Committer: Andy Wenk <an...@apache.org>
Committed: Mon Feb 3 13:08:46 2014 +0100
----------------------------------------------------------------------
share/doc/src/api/document/common.rst | 19 ++++---
share/doc/src/json-structure.rst | 84 +++++++++++++++---------------
2 files changed, 54 insertions(+), 49 deletions(-)
----------------------------------------------------------------------