honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/indices/get-mapping.asciidoc

44 lines
1.2 KiB
Plaintext
Raw Normal View History

Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[[indices-get-mapping]]
== Get Mapping
[DOCS] Multiple doc fixes Closes #5047
2014-03-07 08:21:45 -05:00
The get mapping API allows to retrieve mapping definitions for an index or
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
index/type.
[source,js]
--------------------------------------------------
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:05:22 -04:00
GET /twitter/_mapping/tweet
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
--------------------------------------------------
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:05:22 -04:00
// CONSOLE
// TEST[setup:twitter]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
[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
[DOCS] Update to the new {index}/_mapping/{type} format
2014-08-21 13:56:11 -04:00
following syntax: `host:port/{index}/_mapping/{type}` where both
[DOCS] Multiple doc fixes Closes #5047
2014-03-07 08:21:45 -05:00
`{index}` and `{type}` can accept a comma-separated list of names. To
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
get mappings for all indices you can use `_all` for `{index}`. The
following are some examples:
[source,js]
--------------------------------------------------
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:05:22 -04:00
GET /_mapping/tweet,kimchy
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
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:05:22 -04:00
GET /_all/_mapping/tweet,book
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
--------------------------------------------------
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:05:22 -04:00
// CONSOLE
// TEST[setup:twitter]
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
If you want to get mappings of all indices and types then the following
two examples are equivalent:
[source,js]
--------------------------------------------------
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:05:22 -04:00
GET /_all/_mapping
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
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:05:22 -04:00
GET /_mapping
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
--------------------------------------------------
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:05:22 -04:00
// CONSOLE
// TEST[setup:twitter]