Docs: CONSOLEify multi-get.asciidoc (#23122)

* Docs: CONSOLEify multi-get.asciidoc

relates #23001

* incorporate feedback
This commit is contained in:
Areek Zillur 2017-02-15 13:36:07 -05:00 committed by GitHub
parent 0a5917d182
commit 2a38f155de
2 changed files with 37 additions and 19 deletions

View File

@ -96,7 +96,6 @@ buildRestTests.expectedUnconvertedCandidates = [
'reference/docs/delete-by-query.asciidoc',
'reference/docs/delete.asciidoc',
'reference/docs/index_.asciidoc',
'reference/docs/multi-get.asciidoc',
'reference/docs/reindex.asciidoc',
'reference/docs/update-by-query.asciidoc',
'reference/docs/update.asciidoc',

View File

@ -9,7 +9,8 @@ API. Here is an example:
[source,js]
--------------------------------------------------
curl 'localhost:9200/_mget' -d '{
GET /_mget
{
"docs" : [
{
"_index" : "test",
@ -22,15 +23,17 @@ curl 'localhost:9200/_mget' -d '{
"_id" : "2"
}
]
}'
}
--------------------------------------------------
// CONSOLE
The `mget` endpoint can also be used against an index (in which case it
is not required in the body):
[source,js]
--------------------------------------------------
curl 'localhost:9200/test/_mget' -d '{
GET /test/_mget
{
"docs" : [
{
"_type" : "type",
@ -41,14 +44,16 @@ curl 'localhost:9200/test/_mget' -d '{
"_id" : "2"
}
]
}'
}
--------------------------------------------------
// CONSOLE
And type:
[source,js]
--------------------------------------------------
curl 'localhost:9200/test/type/_mget' -d '{
GET /test/type/_mget
{
"docs" : [
{
"_id" : "1"
@ -57,18 +62,21 @@ curl 'localhost:9200/test/type/_mget' -d '{
"_id" : "2"
}
]
}'
}
--------------------------------------------------
//CONSOLE
In which case, the `ids` element can directly be used to simplify the
request:
[source,js]
--------------------------------------------------
curl 'localhost:9200/test/type/_mget' -d '{
GET /test/type/_mget
{
"ids" : ["1", "2"]
}'
}
--------------------------------------------------
// CONSOLE
[float]
[[mget-type]]
@ -85,10 +93,12 @@ will give you back only the same document twice:
[source,js]
--------------------------------------------------
curl 'localhost:9200/test/_mget' -d '{
GET /test/_mget
{
"ids" : ["1", "1"]
}'
}
--------------------------------------------------
// CONSOLE
You need in that case to explicitly set the `_type`:
@ -108,6 +118,7 @@ GET /test/_mget/
]
}
--------------------------------------------------
// CONSOLE
[float]
[[mget-source-filtering]]
@ -123,7 +134,8 @@ For example:
[source,js]
--------------------------------------------------
curl 'localhost:9200/_mget' -d '{
GET /_mget
{
"docs" : [
{
"_index" : "test",
@ -147,8 +159,9 @@ curl 'localhost:9200/_mget' -d '{
}
}
]
}'
}
--------------------------------------------------
// CONSOLE
[float]
@ -160,7 +173,8 @@ For example:
[source,js]
--------------------------------------------------
curl 'localhost:9200/_mget' -d '{
GET /_mget
{
"docs" : [
{
"_index" : "test",
@ -175,15 +189,17 @@ curl 'localhost:9200/_mget' -d '{
"stored_fields" : ["field3", "field4"]
}
]
}'
}
--------------------------------------------------
// CONSOLE
Alternatively, you can specify the `stored_fields` parameter in the query string
as a default to be applied to all documents.
[source,js]
--------------------------------------------------
curl 'localhost:9200/test/type/_mget?stored_fields=field1,field2' -d '{
GET /test/type/_mget?stored_fields=field1,field2
{
"docs" : [
{
"_id" : "1" <1>
@ -193,8 +209,9 @@ curl 'localhost:9200/test/type/_mget?stored_fields=field1,field2' -d '{
"stored_fields" : ["field3", "field4"] <2>
}
]
}'
}
--------------------------------------------------
// CONSOLE
<1> Returns `field1` and `field2`
<2> Returns `field3` and `field4`
@ -211,7 +228,8 @@ You can also specify routing value as a parameter:
[source,js]
--------------------------------------------------
curl 'localhost:9200/_mget?routing=key1' -d '{
GET /_mget?routing=key1
{
"docs" : [
{
"_index" : "test",
@ -225,8 +243,9 @@ curl 'localhost:9200/_mget?routing=key1' -d '{
"_id" : "2"
}
]
}'
}
--------------------------------------------------
// CONSOLE
In this example, document `test/type/2` will be fetch from shard corresponding to routing key `key1` but
document `test/type/1` will be fetch from shard corresponding to routing key `key2`.