Put mapping API
editPut mapping API
editAdds new fields to an existing data stream or index. You can also use the put mapping API to change the search settings of existing fields.
For data streams, these changes are applied to all backing indices by default.
PUT /my-index-000001/_mapping { "properties": { "email": { "type": "keyword" } } }
Before 7.0.0, the mappings definition used to include a type name.
Although specifying types in requests is now deprecated, a type can still be
provided if the request parameter include_type_name
is set. For more details,
please see Removal of mapping types.
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage
index privilege for the target data stream, index, or index alias.[7.9] Deprecated in 7.9. If the request targets an index or index alias, you can also update its mapping with the
create
,create_doc
,index
, orwrite
index privilege.
Path parameters
edit-
<target>
-
(Optional, string) Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (
*
) are supported.To target all data streams and indices in a cluster, omit this parameter or use
_all
or*
.
Query parameters
edit-
allow_no_indices
-
(Optional, Boolean) If
false
, the request returns an error if any wildcard expression, index alias, or_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
.Defaults to
false
. -
expand_wildcards
-
(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in
open,hidden
. Valid values are:-
all
- Expand to open and closed indices, including hidden indices.
-
open
- Expand only to open indices.
-
closed
- Expand only to closed indices.
-
hidden
-
Expansion of wildcards will include hidden indices.
Must be combined with
open
,closed
, or both. -
none
- Wildcard expressions are not accepted.
Defaults to
open
. -
-
include_type_name
-
[7.0.0]
Deprecated in 7.0.0. Mapping types have been deprecated. See Removal of mapping types.
(Optional, boolean) If
true
, a mapping type is expected in the body of mappings. Defaults tofalse
. -
ignore_unavailable
-
(Optional, Boolean) If
false
, the request returns an error if it targets a missing or closed index. Defaults tofalse
. -
master_timeout
-
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s
. -
timeout
-
(Optional, time units)
Period to wait for a response. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
. -
write_index_only
-
(Optional, Boolean)
If
true
, the mappings are applied only to the current write index for the target. Defaults tofalse
.
Request body
edit-
properties
-
(Required, mapping object) Mapping for a field. For new fields, this mapping can include:
- Field name
- Field data type
- Mapping parameters
For existing fields, see Change the mapping of an existing field.
Examples
editExample with single target
editThe put mapping API requires an existing data stream or index. The following
create index API request creates the publications
index with no mapping.
PUT /publications
The following put mapping API request adds title
, a new text
field,
to the publications
index.
PUT /publications/_mapping { "properties": { "title": { "type": "text"} } }
Multiple targets
editThe PUT mapping API can be applied to multiple data streams or indices with a single request.
For example, you can update mappings for the my-index-000001
and my-index-000002
indices at the same time:
# Create the two indices PUT /my-index-000001 PUT /my-index-000002 # Update both mappings PUT /my-index-000001,my-index-000002/_mapping { "properties": { "user": { "properties": { "name": { "type": "keyword" } } } } }
Add new properties to an existing object field
editYou can use the put mapping API to add new properties to an existing
object
field. To see how this works, try the following example.
Use the create index API to create an index with the
name
object field and an inner first
text field.
PUT /my-index-000001 { "mappings": { "properties": { "name": { "properties": { "first": { "type": "text" } } } } } }
Use the put mapping API to add a new inner last
text field to the name
field.
PUT /my-index-000001/_mapping { "properties": { "name": { "properties": { "last": { "type": "text" } } } } }
Add multi-fields to an existing field
editMulti-fields let you index the same field in different ways.
You can use the put mapping API to update the fields
mapping parameter and
enable multi-fields for an existing field.
To see how this works, try the following example.
Use the create index API to create an index with the
city
text field.
PUT /my-index-000001 { "mappings": { "properties": { "city": { "type": "text" } } } }
While text fields work well for full-text search, keyword fields are not analyzed and may work better for sorting or aggregations.
Use the put mapping API to enable a multi-field for the city
field. This
request adds the city.raw
keyword multi-field, which can be used for sorting.
PUT /my-index-000001/_mapping { "properties": { "city": { "type": "text", "fields": { "raw": { "type": "keyword" } } } } }
Change supported mapping parameters for an existing field
editThe documentation for each mapping parameter indicates
whether you can update it for an existing field using the put mapping API. For
example, you can use the put mapping API to update the
ignore_above
parameter.
To see how this works, try the following example.
Use the create index API to create an index containing
a user_id
keyword field. The user_id
field has an ignore_above
parameter
value of 20
.
PUT /my-index-000001 { "mappings": { "properties": { "user_id": { "type": "keyword", "ignore_above": 20 } } } }
Use the put mapping API to change the ignore_above
parameter value to 100
.
PUT /my-index-000001/_mapping { "properties": { "user_id": { "type": "keyword", "ignore_above": 100 } } }
Change the mapping of an existing field
editExcept for supported mapping parameters, you can’t change the mapping or field type of an existing field. Changing an existing field could invalidate data that’s already indexed.
If you need to change the mapping of a field in a data stream’s backing indices, see Change mappings and settings for a data stream.
If you need to change the mapping of a field in other indices, create a new index with the correct mapping and reindex your data into that index.
To see how you can change the mapping of an existing field in an index, try the following example.
Use the create index API
to create an index
with the user_id
field
with the long
field type.
PUT /my-index-000001 { "mappings" : { "properties": { "user_id": { "type": "long" } } } }
Use the index API
to index several documents
with user_id
field values.
POST /my-index-000001/_doc?refresh=wait_for { "user_id" : 12345 } POST /my-index-000001/_doc?refresh=wait_for { "user_id" : 12346 }
To change the user_id
field
to the keyword
field type,
use the create index API
to create a new index with the correct mapping.
PUT /my-new-index-000001 { "mappings" : { "properties": { "user_id": { "type": "keyword" } } } }
Use the reindex API to copy documents from the old index to the new one.
POST /_reindex { "source": { "index": "my-index-000001" }, "dest": { "index": "my-new-index-000001" } }
Rename a field
editRenaming a field would invalidate data already indexed under the old field name.
Instead, add an alias
field to create an alternate field name.
For example,
use the create index API
to create an index
with the user_identifier
field.
PUT /my-index-000001 { "mappings": { "properties": { "user_identifier": { "type": "keyword" } } } }
Use the put mapping API to add the user_id
field alias
for the existing user_identifier
field.
PUT /my-index-000001/_mapping { "properties": { "user_id": { "type": "alias", "path": "user_identifier" } } }