Queries endpoint support by jiangphcn · Pull Request #241 · apache/couchdb-documentation

jiangphcn · 2018-01-25T06:26:52Z

Overview

Document new feature for multiple queries against POST /{db}/_all_docs/queries. This allows to execute multiple specified built-in view queries of all documents in specified database. This enables you to request multiple documents in a single request, in place of multiple POST /{db}/_all_docs requests.

The multiple queries are also supported in /db/_local_docs/queries and /db/_design_docs/queries (similar to /db/_all_docs/queries).

In addition, the multiple queries against view are supported in newly introduced endpoint /{db}/_design/{ddoc}/_view/{view}/querie

Testing recommendations

see apache/couchdb#1032

GitHub issue number

Issue #820

Related Pull Requests

apache/couchdb#820
apache/couchdb#1222

Checklist

Documentation is written and is accurate;
make check passes with no errors
[] Update rebar.config.script with the commit hash once this PR is rebased and merged

flimzy

Should the queries parameter not be added to the existing POST /{db}/_all_docs documentation? Having a separate example like this is probably still useful, but since the new functionality is added to an existing endpoint, I would hate not to have complete documentation in one canonical place, as well.

flimzy · 2018-01-25T07:44:51Z

+    :synopsis: Returns results for the specified queries
+
+    Executes multiple specified built-in view queries of all documents in this
+    database. This enables you to request multiple documents in a single


I wonder if it would be worth explaining in more detail that (as I understand) this allows combining the results of multiple queries, not just multiple documents (_all_docs already returns multiple documents, so I can see room for confusion, upon a cursory read of this statement). Perhaps something like:

This enables you to request the results of multiple queries in a single request, in place of ...

jiangphcn · 2018-01-25T08:18:49Z

Thanks Jonathan @flimzy. I just added commit to change documents to queries to make it clearer.

Regarding comment below

Should the queries parameter not be added to the existing POST /{db}/_all_docs documentation? Having a separate example like this is probably still useful, but since the new functionality is added to an existing endpoint, I would hate not to have complete documentation in one canonical place, as well.

I think that I need to mention that this is newly added feature. Making separate section can help explain the difference between previous feature and new feature. In addition, reader can easily find the newly added section because it is just near to POST /{db}/_all_docs documentation. In addition, current organization is same as page in http://docs.couchdb.org/en/latest/api/ddoc/views.html

flimzy · 2018-01-25T17:13:19Z

I think that I need to mention that this is newly added feature. Making separate section can help explain the difference between previous feature and new feature.

Sure. I didn't mean to suggest there shouldn't also be a new section to highlight the added functionality, just that it might be nice to ensure that the existing endpoint documentation also contains the full documentation for that endpoint.

jiangphcn · 2018-01-26T07:02:49Z

Cool, thanks @flimzy for your clarification and review.

wohali · 2018-03-09T18:46:56Z

@jiangphcn please mesh this with apache/couchdb#820 and #244 so that we get the right documentation in the upcoming 2.2.0 release, please. Thanks!

jiangphcn · 2018-03-10T04:47:58Z

Okay Joan. Will do soon.

jiangphcn · 2018-03-16T07:14:17Z

@flimzy，Hey Jonathan, could you please review this PR? This is because we adjust endpoints to

/{db}/_all_docs/queries
/db/_local_docs/queries
/db/_design_docs/queries
/{db}/_design/{ddoc}/_view/{view}/queries

flimzy

Just a few minor changes.

flimzy · 2018-03-16T12:43:18Z

+    :code 200: Request completed successfully
+    :code 400: Invalid request
+    :code 401: Read permission required
+    :code 404: Specified database is missed


s/missed/missing/

flimzy · 2018-03-16T12:43:59Z

+    :code 200: Request completed successfully
+    :code 400: Invalid request
+    :code 401: Read permission required
+    :code 404: Specified database, design document or view is missed


s/missed/missing/

flimzy · 2018-03-16T12:47:06Z

+
+.. warning::
+    Using POST to /{db}/_design/{ddoc}/_view/{view} is still supported and
+    allows to get multiple query result to a view. This is described below.


s/allows/allows you/

wohali · 2018-03-18T04:07:18Z

Looks like there is a conflict that needs to be resolved in src/api/database/bulk-api.rst.

jiangphcn · 2018-03-19T02:47:33Z

Thanks @flimzy for your comments. I already addressed them. Also, thanks @wohali for kind reminder, and I already addressed conflict.

flimzy

Looks good! +1

- POST /{db}/_all_docs/queries Executes multiple specified built-in view queries of all documents in this database. This enables you to request multiple documents in a single request, in place of multiple POST /{db}/_all_docs requests. issue 820

jiangphcn mentioned this pull request Jan 25, 2018

Add support for queries in /{db}/_all_docs POST apache/couchdb#1032

Merged

3 tasks

jiangphcn force-pushed the issue-820-add-queries-for_all_docs branch from 2af6b8d to ddd2980 Compare January 25, 2018 06:53

flimzy reviewed Jan 25, 2018

View reviewed changes

jiangphcn force-pushed the issue-820-add-queries-for_all_docs branch from 886584d to 5a6a6bd Compare January 25, 2018 08:17

jiangphcn mentioned this pull request Jan 25, 2018

Update documentation to describe queries support for /_all_docs #233

Closed

jiangphcn changed the title ~~Add statement for multiple queris for _all_docs~~ Add statement for multiple queries for _all_docs Jan 29, 2018

jiangphcn changed the title ~~Add statement for multiple queries for _all_docs~~ [WIP] Add statement for multiple queries for _all_docs Feb 6, 2018

jiangphcn force-pushed the issue-820-add-queries-for_all_docs branch 3 times, most recently from fd68264 to 1336ca3 Compare March 16, 2018 06:45

jiangphcn mentioned this pull request Mar 16, 2018

Support queries endpoints apache/couchdb#1222

Merged

3 tasks

jiangphcn changed the title ~~[WIP] Add statement for multiple queries for _all_docs~~ Multiple queries support Mar 16, 2018

jiangphcn mentioned this pull request Mar 16, 2018

Add support for queries in /{db}/_all_docs POST apache/couchdb#820

Closed

jiangphcn changed the title ~~Multiple queries support~~ Queries endpoint support Mar 16, 2018

flimzy reviewed Mar 16, 2018

View reviewed changes

wohali mentioned this pull request Mar 18, 2018

Introduce _all_docs_view_query #244

Closed

1 task

jiangphcn force-pushed the issue-820-add-queries-for_all_docs branch 2 times, most recently from 5d5a49e to 9470572 Compare March 19, 2018 02:44

flimzy approved these changes Mar 19, 2018

View reviewed changes

jiangphcn force-pushed the issue-820-add-queries-for_all_docs branch from 9470572 to e4e0fba Compare March 19, 2018 08:46

jiangphcn merged commit ec608bf into apache:master Mar 19, 2018

jiangphcn deleted the issue-820-add-queries-for_all_docs branch March 19, 2018 08:50

Conversation

jiangphcn commented Jan 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Testing recommendations

GitHub issue number

Related Pull Requests

Checklist

Uh oh!

flimzy left a comment

Choose a reason for hiding this comment

Uh oh!

flimzy Jan 25, 2018

Choose a reason for hiding this comment

Uh oh!

jiangphcn commented Jan 25, 2018

Uh oh!

flimzy commented Jan 25, 2018

Uh oh!

jiangphcn commented Jan 26, 2018

Uh oh!

wohali commented Mar 9, 2018

Uh oh!

jiangphcn commented Mar 10, 2018

Uh oh!

jiangphcn commented Mar 16, 2018

Uh oh!

flimzy left a comment

Choose a reason for hiding this comment

Uh oh!

flimzy Mar 16, 2018

Choose a reason for hiding this comment

Uh oh!

flimzy Mar 16, 2018

Choose a reason for hiding this comment

Uh oh!

flimzy Mar 16, 2018

Choose a reason for hiding this comment

Uh oh!

wohali commented Mar 18, 2018

Uh oh!

jiangphcn commented Mar 19, 2018

Uh oh!

flimzy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jiangphcn commented Jan 25, 2018 •

edited

Loading