Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): amend description of use_index on /{db}/_find #4774

Merged
merged 1 commit into from
Oct 4, 2023
Merged

fix(docs): amend description of use_index on /{db}/_find #4774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions src/docs/src/api/database/find.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,14 @@
should be returned. If it is omitted, the entire object is returned.
More information provided in the section on :ref:`filtering fields
<find/filter>`. *Optional*
:<json string|array use_index: Instruct a query to use a specific index.
Specified either as ``"<design_document>"`` or
``["<design_document>", "<index_name>"]``. *Optional*
:<json string|array use_index: Request a query to use a specific
index. Specified either as ``"<design_document>"`` or
``["<design_document>", "<index_name>"]``. It is not
guaranteed that the index will be actually used because if the
index is not valid for the selector, fallback to a valid index
is attempted. Therefore that is more like a hint. When
fallback occurs, the details are given in the ``warning``
field of the response. *Optional*
:<json boolean conflicts: Include conflicted documents if ``true``.
Intended use is to easily find conflicted documents, without an
index or view. Default is ``false``. *Optional*
Expand Down