diff options
| author | Andy Wenk <andywenk@apache.org> | 2014-01-24 00:20:41 +0100 |
|---|---|---|
| committer | Andy Wenk <andywenk@apache.org> | 2014-01-24 00:20:41 +0100 |
| commit | b38f1007be3609ae25003bfb310d5a96db77ea06 (patch) | |
| tree | 3ddc6a47877c32d2b20f05d36575ee36f981acd0 | |
| parent | 37c8459693dbf55cd4683c7e288dcc9ca8899e97 (diff) | |
| download | couchdb-b38f1007be3609ae25003bfb310d5a96db77ea06.tar.gz | |
added documentation fixes
made the deletion of a document clearer and
fixed some wording in the JSON structure tables
| -rw-r--r-- | share/doc/src/api/document/common.rst | 11 | ||||
| -rw-r--r-- | share/doc/src/json-structure.rst | 20 |
2 files changed, 18 insertions, 13 deletions
diff --git a/share/doc/src/api/document/common.rst b/share/doc/src/api/document/common.rst index f21c8df5e..f6e4b2af0 100644 --- a/share/doc/src/api/document/common.rst +++ b/share/doc/src/api/document/common.rst @@ -242,9 +242,14 @@ .. 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 + ``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. diff --git a/share/doc/src/json-structure.rst b/share/doc/src/json-structure.rst index 7d22f1e9d..0a6de0d65 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.| +| | Views 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. | +--------------------------------+---------------------------------------------+ |