89 lines
2.1 KiB
Plaintext
89 lines
2.1 KiB
Plaintext
[[indices-get-mapping]]
|
|
== Get Mapping
|
|
|
|
The get mapping API allows to retrieve mapping definitions for an index or
|
|
index/type.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /twitter/_mapping/_doc
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
[float]
|
|
=== Multiple Indices and Types
|
|
|
|
The get mapping API can be used to get more than one index or type
|
|
mapping with a single call. General usage of the API follows the
|
|
following syntax: `host:port/{index}/_mapping/{type}` where both
|
|
`{index}` and `{type}` can accept a comma-separated list of names. To
|
|
get mappings for all indices you can use `_all` for `{index}`. The
|
|
following are some examples:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_mapping/_doc
|
|
|
|
GET /_all/_mapping/_doc
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
If you want to get mappings of all indices and types then the following
|
|
two examples are equivalent:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_all/_mapping
|
|
|
|
GET /_mapping
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
[float]
|
|
=== Skipping types
|
|
|
|
Types are scheduled to be fully removed in Elasticsearch 8.0 and will not appear
|
|
in requests or responses anymore. You can opt in for this future behaviour by
|
|
setting `include_type_name=false` in the request, which will return mappings
|
|
directly under `mappings` without keying by the type name.
|
|
|
|
Here is an example:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT test?include_type_name=false
|
|
{
|
|
"mappings": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "keyword"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
GET test/_mappings?include_type_name=false
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
which returns
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
{
|
|
"test": {
|
|
"mappings": {
|
|
"properties": {
|
|
"foo": {
|
|
"type": "keyword"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE
|