mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-09 14:35:04 +00:00
8819f91d47
This new API allows to get the mapping for a specific set of fields rather than get the whole index mapping and traverse it. The fields to be retrieved can be specified by their full path, index name and field name and will be resolved in this order. In case multiple field match, the first one will be returned. Since we are now generating the output (rather then fall back to the stored mapping), you can specify `include_defaults`=true on the request to have default values returned. Closes #3941
38 lines
1.2 KiB
Plaintext
38 lines
1.2 KiB
Plaintext
[[indices-get-mapping]]
|
|
== Get Mapping
|
|
|
|
The get mapping API allows to retrieve mapping definition of index or
|
|
index/type.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
curl -XGET 'http://localhost:9200/twitter/tweet/_mapping'
|
|
--------------------------------------------------
|
|
|
|
[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}/{type}/_mapping` where both
|
|
`{index}` and `{type}` can stand for comma-separated list of names. To
|
|
get mappings for all indices you can use `_all` for `{index}`. The
|
|
following are some examples:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
curl -XGET 'http://localhost:9200/twitter,kimchy/_mapping'
|
|
|
|
curl -XGET 'http://localhost:9200/_all/tweet,book/_mapping'
|
|
--------------------------------------------------
|
|
|
|
If you want to get mappings of all indices and types then the following
|
|
two examples are equivalent:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
curl -XGET 'http://localhost:9200/_all/_mapping'
|
|
|
|
curl -XGET 'http://localhost:9200/_mapping'
|
|
--------------------------------------------------
|