OpenSearch/docs/reference/indices/get-mapping.asciidoc

40 lines
1.4 KiB
Plaintext

[[indices-get-mapping]]
== Get Mapping
The get mapping API allows to retrieve mapping definitions for an index or
index/type.
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/twitter/_mapping/tweet'
--------------------------------------------------
[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]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_mapping/twitter,kimchy'
curl -XGET 'http://localhost:9200/_all/_mapping/tweet,book'
--------------------------------------------------
If you want to get mappings of all indices and types then the following
two examples are equivalent:
coming[1.4.0,The API will always include a `mappings` section, even if there aren't any mappings. Previous versions would not return the `mappings` section]
[source,js]
--------------------------------------------------
curl -XGET 'http://localhost:9200/_all/_mapping'
curl -XGET 'http://localhost:9200/_mapping'
--------------------------------------------------