You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by fl...@apache.org on 2017/11/09 13:15:42 UTC
[couchdb-documentation] branch all_docs updated (418219c -> 09853f9)
This is an automated email from the ASF dual-hosted git repository.
flimzy pushed a change to branch all_docs
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git.
omit 418219c Cleanups, clarifications, and better formatting consistency.
new 09853f9 Cleanups, clarifications, and better formatting consistency.
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (418219c)
\
N -- N -- N refs/heads/all_docs (09853f9)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
src/api/ddoc/views.rst | 52 +++++++++++++++++++++++---------------------------
1 file changed, 24 insertions(+), 28 deletions(-)
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].
[couchdb-documentation] 01/01: Cleanups, clarifications,
and better formatting consistency.
Posted by fl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
flimzy pushed a commit to branch all_docs
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit 09853f9bbf0dd7f1c0cb9aba26e6792a3284cd34
Author: Jonathan Hall <fl...@flimzy.com>
AuthorDate: Thu Nov 9 13:55:35 2017 +0100
Cleanups, clarifications, and better formatting consistency.
---
src/api/ddoc/views.rst | 63 ++++++++++++++++++++++++--------------------------
1 file changed, 30 insertions(+), 33 deletions(-)
diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index 7225f4b..0a01442 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -28,20 +28,21 @@
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
- :query boolean conflicts: Includes `conflicts` information in response.
- Ignored if `include_docs` isn't ``true``. Default is ``false``
- :query boolean descending: Return the documents in descending by key order.
- Default is ``false``
+ :query boolean conflicts: Include `conflicts` information in response.
+ Ignored if `include_docs` isn't ``true``. Default is ``false``.
+ :query boolean descending: Return the documents in descending order by key.
+ Default is ``false``.
:query json endkey: Stop returning records when the specified key is
- reached. *Optional*
+ reached.
:query json end_key: Alias for `endkey` param
:query string endkey_docid: Stop returning records when the specified
- document ID is reached. Requires ``endkey`` to be specified for this to
- have any effect. *Optional*
- :query string end_key_doc_id: Alias for `endkey_docid` param
+ document ID is reached. Ignored if `endkey` is not set.
+ :query string end_key_doc_id: Alias for `endkey_docid`.
:query boolean group: Group the results using the reduce function to a
- group or single row. Default is ``false``
- :query number group_level: Specify the group level to be used. *Optional*
+ group or single row. Implies the maximum `group_level`. Default is
+ ``false``.
+ :query number group_level: Specify the group level to be used. Implies
+ `group` is ``true``.
:query boolean include_docs: Include the associated document with each row.
Default is ``false``.
:query boolean attachments: Include the Base64-encoded content of
@@ -53,53 +54,49 @@
attachment is compressed. Ignored if `include_docs` isn't ``true``.
Default is ``false``.
:query boolean inclusive_end: Specifies whether the specified end key
- should be included in the result. Default is ``true``
+ should be included in the result. Default is ``true``.
:query json key: Return only documents that match the specified key.
- *Optional*
:query json-array keys: Return only documents where the key matches one of
- the keys specified in the array. *Optional*
+ the keys specified in the array.
:query number limit: Limit the number of the returned documents to the
- specified number. *Optional*
- :query boolean reduce: Use the reduction function. Default is ``true``
+ specified number.
+ :query boolean reduce: Use the reduction function. Default is ``true`` when
+ a reduce function is defined.
:query number skip: Skip this number of records before starting to return
- the results. Default is ``0``
+ the results. Default is ``0``.
:query boolean sorted: Sort returned rows (see :ref:`Sorting Returned Rows
<api/ddoc/view/sorting>`). Setting this to ``false`` offers a performance
boost. The `total_rows` and `offset` fields are not available when this
- is set to ``false``. Default is ``true``
+ is set to ``false``. Default is ``true``.
:query boolean stable: Whether or not the view results should be returned
- from a stable set of shards. Default is ``false``. *Optional*
+ from a stable set of shards. Default is ``false``.
:query string stale: Allow the results from a stale view to be used.
Supported values: ``ok``, ``update_after`` and ``false``.
``ok`` is equivalent to ``stable=true&update=false``.
``update_after`` is equivalent to ``stable=true&update=lazy``.
``false`` is equivalent to ``stable=false&update=true``.
- *Optional*
:query json startkey: Return records starting with the specified key.
- *Optional*
- :query json start_key: Alias for `startkey` param
+ :query json start_key: Alias for `startkey`.
:query string startkey_docid: Return records starting with the specified
- document ID. Requires ``startkey`` to be specified for this to have any
- effect. *Optional*
+ document ID. Ignored if ``startkey`` is not set.
:query string start_key_doc_id: Alias for `startkey_docid` param
:query string update: Whether or not the view in question should be updated
- prior to responding to the user.
- Supported values: ``true``, ``false``, ``lazy``.
- Default is ``true``. *Optional*
- :query boolean update_seq: Response includes an ``update_seq`` value
- indicating which sequence id of the database the view reflects.
- Default is ``false``.
+ prior to responding to the user. Supported values: ``true``, ``false``,
+ ``lazy``. Default is ``true``.
+ :query boolean update_seq: Whether to include in the response an
+ `update_seq` value indicating the sequence id of the database the view
+ reflects. Default is ``false``.
:>header Content-Type: - :mimetype:`application/json`
- :mimetype:`text/plain; charset=utf-8`
:>header ETag: Response signature
:>header Transfer-Encoding: ``chunked``
- :>json number offset: Offset where the document list started
+ :>json number offset: Offset where the document list started.
:>json array rows: Array of view row objects. By default the information
- returned contains only the document ID and revision
- :>json number total_rows: Number of documents in the database/view
- :>json object update_seq: Current update sequence for the database
+ returned contains only the document ID and revision.
+ :>json number total_rows: Number of documents in the database/view.
+ :>json object update_seq: Current update sequence for the database.
:code 200: Request completed successfully
:code 400: Invalid request
--
To stop receiving notification emails like this one, please contact
"commits@couchdb.apache.org" <co...@couchdb.apache.org>.