You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ii...@apache.org on 2020/09/21 13:48:01 UTC
[couchdb-documentation] 02/02: Address problems identified durring
review
This is an automated email from the ASF dual-hosted git repository.
iilyak pushed a commit to branch pagination
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
commit e0eae75fe698148e75c3a50c6e2b245621d7d86e
Author: ILYA Khlopotov <ii...@apache.org>
AuthorDate: Mon Sep 21 06:47:19 2020 -0700
Address problems identified durring review
---
src/api/database/bulk-api.rst | 2 +-
src/api/ddoc/views.rst | 13 ++++++-------
src/ddocs/views/pagination.rst | 24 +++++++++++-------------
3 files changed, 18 insertions(+), 21 deletions(-)
diff --git a/src/api/database/bulk-api.rst b/src/api/database/bulk-api.rst
index 15cc623..4f2af0f 100644
--- a/src/api/database/bulk-api.rst
+++ b/src/api/database/bulk-api.rst
@@ -332,7 +332,7 @@ Sending multiple queries to a database
:param db: Database name
- :query number page_size: Specify the number of queries in the result.
+ :query number page_size: The number of queries in the result.
Enables paginated reply for included queries.
:<header Content-Type: - :mimetype:`application/json`
diff --git a/src/api/ddoc/views.rst b/src/api/ddoc/views.rst
index e438b32..4347962 100644
--- a/src/api/ddoc/views.rst
+++ b/src/api/ddoc/views.rst
@@ -28,7 +28,7 @@
:<header Accept: - :mimetype:`application/json`
- :mimetype:`text/plain`
- :query string bookmark: Specify a bookmark to get sepcific page of the results.
+ :query string bookmark: A bookmark to get sepcific page of the results.
: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.
@@ -61,7 +61,7 @@
the keys specified in the array.
:query number limit: Limit the number of the returned documents to the
specified number.
- :query number page_size: Specify the number of rows in the result.
+ :query number page_size: The number of rows in the result.
Enables paginated reply.
:query boolean reduce: Use the reduction function. Default is ``true`` when
a reduce function is defined.
@@ -927,8 +927,8 @@ Pagination
.. versionadded:: 4.0
-There is a support for token based pagination. The token based pagination is an
-alternative to previously recomended :ref:`pagination recipe <views/pagination>`
+CouchDB supports token-based pagination, which is an alternative to
+:ref:`pagination recipe <views/pagination>`
based on ``offset``, ``limit`` and ``skip``.
The user can request paginated mode by setting ``page_size`` query parameter. When
@@ -946,7 +946,6 @@ section in one of the ``ini`` files.
_view = 2500
_view/queries = 2500
-
Note that ``page_size`` for :ref:`Multiple queries <api/ddoc/view/multiple_queries>`
endpoints limits number of queries the user can submit in the body of the request.
@@ -956,8 +955,8 @@ Compatibility notes
- ``page_size`` is forbidden in the query object passed in ``queries`` array \
submitted via :post:`/{db}/_design/{ddoc}/_view/{view}/queries` request.
-- ``keys`` propery is incompatible with ``page_size``.
+- The ``keys`` propery is incompatible with ``page_size``.
-- value for ``skip`` property has to be in range of ``[0..<request_limit>]``.
+- value for ``skip`` property must be in range of ``[0..<request_limit>]``.
- ``bookmark`` is incompatible with any other query parameters
diff --git a/src/ddocs/views/pagination.rst b/src/ddocs/views/pagination.rst
index 867f66c..bf5a736 100644
--- a/src/ddocs/views/pagination.rst
+++ b/src/ddocs/views/pagination.rst
@@ -123,9 +123,8 @@ Or in a pseudo-JavaScript snippet:
page.display_link('next');
}
-
-Paging (New Way)
-================
+`page_size` based paging (recommended)
+======================================
.. versionadded:: 4.0
@@ -134,7 +133,7 @@ query parameter::
curl -X GET http://127.0.0.1:5984/artists/_design/artists/_view/by-name?page_size=5
-The result:
+The result::
.. code-block:: javascript
@@ -148,13 +147,13 @@ The result:
"next": "an encoded string representing bookmark pointing to next page of results"
}
-By presence of ``next`` property we can determine if there are more pages to display.
+By presence of ``next`` property we can determine if there are more pages to display.
-To get next page from CouchDB we would use::
+To get the next page from CouchDB we would use::
curl -X GET 'http://127.0.0.1:5984/artists/_design/artists/_view/by-name?bookmark=<the next token>'
-The result:
+The result::
.. code-block:: javascript
@@ -170,13 +169,12 @@ The result:
"next": "an encoded string representing bookmark pointing to next page of results",
}
-The ``previous`` property can be used to get the previous page of the results if need to::
+Likewise, the ``previous`` property can be used to get the previous page of the results::
curl -X GET 'http://127.0.0.1:5984/artists/_design/artists/_view/by-name?bookmark=<the previous token>'
-
-Paging (Old Way)
-================
+Skip based paging
+=================
To get the first five rows from the view result, you use the ``?limit=5``
query parameter::
@@ -243,8 +241,8 @@ straightforward:
return page != last_page;
}
-Paging (Alternate Method)
-=========================
+`startkey` based paging
+=======================
The method described above performed poorly with large skip values until
CouchDB 1.2. Additionally, some use cases may call for the following