mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-09 22:45:04 +00:00
a63f60b776
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
46 lines
1.4 KiB
Plaintext
46 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]
|
|
--------------------------------------------------
|
|
GET /twitter/_mapping
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
|
|
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings
|
|
in responses no longer contain a type name by default, you can still request the old format
|
|
through the parameter include_type_name. For more details, please see <<removal-of-types>>.
|
|
|
|
[float]
|
|
==== Multiple Indices
|
|
|
|
The get mapping API can be used to get more than one index with a
|
|
single call. General usage of the API follows the following syntax:
|
|
`host:port/{index}/_mapping` where `{index}` 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 /twitter,kimchy/_mapping
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
// TEST[setup:twitter]
|
|
// TEST[s/^/PUT kimchy\nPUT book\n/]
|
|
|
|
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]
|