mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
Allowing `_doc` as a type will enable users to make the transition to 7.0 smoother since the index APIs will be `PUT index/_doc/id` and `POST index/_doc`. This also moves most of the documentation to `_doc` as a type name. Closes #27750 Closes #27751
44 lines
1.2 KiB
Plaintext
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/_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]
|