OpenSearch/docs/reference/indices/get-mapping.asciidoc
Nik Everett 4b219d15d2 Add CONSOLE to a few snippets in reference docs
This allows them to be run in Console and adds them to the list of
docs that are automatically tested as part of the build.

Relates to #18160
2016-09-01 13:08:36 -04:00

44 lines
1.2 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/tweet
--------------------------------------------------
// 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/tweet,kimchy
GET /_all/_mapping/tweet,book
--------------------------------------------------
// 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]