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

89 lines
2.1 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]
--------------------------------------------------
Allow `_doc` as a type. (#27816) 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
2017-12-14 11:47:53 -05:00
GET /twitter/_mapping/_doc
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]
--------------------------------------------------
Allow `_doc` as a type. (#27816) 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
2017-12-14 11:47:53 -05:00
GET /_mapping/_doc
Migrated documentation into the main repo
2013-08-28 19:24:34 -04:00
Allow `_doc` as a type. (#27816) 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
2017-12-14 11:47:53 -05:00
GET /_all/_mapping/_doc
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]
Add an `include_type_name` option. (#29453) This adds an `include_type_name` option to the `indices.create`, `indices.get_mapping` and `indices.put_mapping` APIs, which defaults to `true`. When set to `false`, then mappings will be returned directly in the body of the `indices.get_mapping` API, without keying them by the type name, the `indices.create` will expect mappings directly under the `mappings` key, and the `indices.put_mapping` will use `_doc` as a type name and fail if a `type` is provided explicitly. Relates #15613
2018-04-11 09:54:16 -04:00
[float]
=== Skipping types
Types are scheduled to be fully removed in Elasticsearch 8.0 and will not appear
in requests or responses anymore. You can opt in for this future behaviour by
setting `include_type_name=false` in the request, which will return mappings
directly under `mappings` without keying by the type name.
Here is an example:
[source,js]
--------------------------------------------------
PUT test?include_type_name=false
{
"mappings": {
"properties": {
"foo": {
"type": "keyword"
}
}
}
}
GET test/_mappings?include_type_name=false
--------------------------------------------------
// CONSOLE
which returns
[source,js]
--------------------------------------------------
{
"test": {
"mappings": {
"properties": {
"foo": {
"type": "keyword"
}
}
}
}
}
--------------------------------------------------
// TESTRESPONSE