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.

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

[DOC] Add documentation for new preferences for search requests #4034

Closed
1 of 4 tasks
kotwanikunal opened this issue May 8, 2023 · 0 comments · Fixed by #4099
Closed
1 of 4 tasks

[DOC] Add documentation for new preferences for search requests #4034

kotwanikunal opened this issue May 8, 2023 · 0 comments · Fixed by #4099
Assignees
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started v2.8.0
Milestone

Comments

@kotwanikunal
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.
As a part of opensearch-project/OpenSearch#7375, we added a new options for preferences to search requests - _primary, _replica, _primary_first and _replica_first.

None of the preferences are listed out on https://opensearch.org/docs/2.7/api-reference/search/ (Request parameters -> Preferences) but it would be useful for the clients and users to have a list of available preferences.

_primary - Search will be performed only on the primary shards.
_replica - Search will be performed only on the replica shards. 
_primary_first - Search will be performed preferably on the primary shards, but can failover to other available shards. 
_replica_first - Search will be performed preferably on the replica shards, but can failover to other available shards including primary. 

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog Issue: The issue is unassigned or assigned but not started v2.8.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants