honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update preference.asciidoc 

Clarify that `preference` is a query string parameter only
and provide an example.
This commit is contained in:
Clinton Gormley 2014-07-09 11:12:43 +02:00
parent af119dfdd9
commit b6baa4be4a
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/reference/search/request/preference.asciidoc
View File

@ -5,7 +5,7 @@ Controls a `preference` of which shard replicas to execute the search
request on. By default, the operation is randomized between the shard request on. By default, the operation is randomized between the shard
replicas. replicas.
The `preference` can be set to: The `preference` is a query string parameter which can be set to:
[horizontal] [horizontal]
`_primary`:: `_primary`::
@ -40,3 +40,20 @@ Custom (string) value::
states. A sample value can be something like the web session id, or the states. A sample value can be something like the web session id, or the
user name. user name.
For instance, use the user's session ID to ensure consistent ordering of results
for the user:
[source,js]
------------------------------------------------
curl localhost:9200/_search?preference=xyzabc123 -d '
{
"query": {
"match": {
"title": "elasticsearch"
}
}
}
'
------------------------------------------------