[role="xpack"] [[data-streams-change-mappings-and-settings]] == Change mappings and settings for a data stream Each data stream has a <>. Mappings and index settings from this template are applied to new backing indices created for the stream. This includes the stream's first backing index, which is auto-generated when the stream is created. Before creating a data stream, we recommend you carefully consider which mappings and settings to include in this template. If you later need to change the mappings or settings for a data stream, you have a few options: * <> * <> * <> * <> TIP: If your changes include modifications to existing field mappings or <>, a reindex is often required to apply the changes to a data stream's backing indices. If you are already performing a reindex, you can use the same process to add new field mappings and change <>. See <>. //// [source,console] ---- PUT /_ilm/policy/logs_policy { "policy": { "phases": { "hot": { "actions": { "rollover": { "max_size": "25GB" } } }, "delete": { "min_age": "30d", "actions": { "delete": {} } } } } } PUT /_index_template/logs_data_stream { "index_patterns": [ "logs*" ], "data_stream": { } } PUT /_index_template/new_logs_data_stream { "index_patterns": [ "new_logs*" ], "data_stream": { } } PUT /_data_stream/logs POST /logs/_rollover/ PUT /_data_stream/new_logs ---- // TESTSETUP [source,console] ---- DELETE /_data_stream/* DELETE /_index_template/* DELETE /_ilm/policy/logs_policy ---- // TEARDOWN //// [discrete] [[add-new-field-mapping-to-a-data-stream]] === Add a new field mapping to a data stream To add a mapping for a new field to a data stream, following these steps: . Update the index template used by the data stream. This ensures the new field mapping is added to future backing indices created for the stream. + .*Example* [%collapsible] ==== `logs_data_stream` is an existing index template used by the `logs` data stream. The following <> request adds a mapping for a new field, `message`, to the template. [source,console] ---- PUT /_index_template/logs_data_stream { "index_patterns": [ "logs*" ], "data_stream": { }, "template": { "mappings": { "properties": { "message": { <1> "type": "text" } } } } } ---- <1> Adds a mapping for the new `message` field. ==== . Use the <> to add the new field mapping to the data stream. By default, this adds the mapping to the stream's existing backing indices, including the write index. + .*Example* [%collapsible] ==== The following put mapping API request adds the new `message` field mapping to the `logs` data stream. [source,console] ---- PUT /logs/_mapping { "properties": { "message": { "type": "text" } } } ---- ==== [discrete] [[change-existing-field-mapping-in-a-data-stream]] === Change an existing field mapping in a data stream The documentation for each <> indicates whether you can update it for an existing field using the <>. To update these parameters for an existing field, follow these steps: . Update the index template used by the data stream. This ensures the updated field mapping is added to future backing indices created for the stream. + .*Example* [%collapsible] ==== `logs_data_stream` is an existing index template used by the `logs` data stream. The following <> request changes the argument for the `host.ip` field's <> mapping parameter to `true`. [source,console] ---- PUT /_index_template/logs_data_stream { "index_patterns": [ "logs*" ], "data_stream": { }, "template": { "mappings": { "properties": { "host": { "properties": { "ip": { "type": "ip", "ignore_malformed": true <1> } } } } } } } ---- <1> Changes the `host.ip` field's `ignore_malformed` value to `true`. ==== . Use the <> to apply the mapping changes to the data stream. By default, this applies the changes to the stream's existing backing indices, including the write index. + .*Example* [%collapsible] ==== The following <> request targets the `logs` data stream. The request changes the argument for the `host.ip` field's `ignore_malformed` mapping parameter to `true`. [source,console] ---- PUT /logs/_mapping { "properties": { "host": { "properties": { "ip": { "type": "ip", "ignore_malformed": true } } } } } ---- ==== Except for supported mapping parameters, we don't recommend you change the mapping or field data type of existing fields, even in a data stream's matching index template or its backing indices. Changing the mapping of an existing field could invalidate any data that’s already indexed. If you need to change the mapping of an existing field, create a new data stream and reindex your data into it. See <>. [discrete] [[change-dynamic-index-setting-for-a-data-stream]] === Change a dynamic index setting for a data stream To change a <> for a data stream, follow these steps: . Update the index template used by the data stream. This ensures the setting is applied to future backing indices created for the stream. + .*Example* [%collapsible] ==== `logs_data_stream` is an existing index template used by the `logs` data stream. The following <> request changes the template's `index.refresh_interval` index setting to `30s` (30 seconds). [source,console] ---- PUT /_index_template/logs_data_stream { "index_patterns": [ "logs*" ], "data_stream": { }, "template": { "settings": { "index.refresh_interval": "30s" <1> } } } ---- <1> Changes the `index.refresh_interval` setting to `30s` (30 seconds). ==== . Use the <> to update the index setting for the data stream. By default, this applies the setting to the stream's existing backing indices, including the write index. + .*Example* [%collapsible] ==== The following update index settings API request updates the `index.refresh_interval` setting for the `logs` data stream. [source,console] ---- PUT /logs/_settings { "index": { "refresh_interval": "30s" } } ---- ==== [discrete] [[change-static-index-setting-for-a-data-stream]] === Change a static index setting for a data stream <> can only be set when a backing index is created. You cannot update static index settings using the <>. To apply a new static setting to future backing indices, update the index template used by the data stream. The setting is automatically applied to any backing index created after the update. .*Example* [%collapsible] ==== `logs_data_stream` is an existing index template used by the `logs` data stream. The following <> requests adds new `sort.field` and `sort.order index` settings to the template. [source,console] ---- PUT /_index_template/logs_data_stream { "index_patterns": [ "logs*" ], "data_stream": { }, "template": { "settings": { "sort.field": [ "@timestamp"], <1> "sort.order": [ "desc"] <2> } } } ---- <1> Adds the `sort.field` index setting. <2> Adds the `sort.order` index setting. ==== If wanted, you can <> to immediately apply the setting to the data stream’s write index. This affects any new data added to the stream after the rollover. However, it does not affect the data stream's existing backing indices or existing data. To apply static setting changes to existing backing indices, you must create a new data stream and reindex your data into it. See <>. [discrete] [[data-streams-use-reindex-to-change-mappings-settings]] === Use reindex to change mappings or settings You can use a reindex to change the mappings or settings of a data stream. This is often required to change the data type of an existing field or update static index settings for backing indices. To reindex a data stream, first create or update an index template so that it contains the wanted mapping or setting changes. You can then reindex the existing data stream into a new stream matching the template. This applies the mapping and setting changes in the template to each document and backing index added to the new data stream. These changes also affect any future backing index created by the new stream. Follow these steps: . Choose a name or wildcard (`*`) pattern for a new data stream. This new data stream will contain data from your existing stream. + You can use the resolve index API to check if the name or pattern matches any existing indices, index aliases, or data streams. If so, you should consider using another name or pattern. + .*Example* [%collapsible] ==== The following resolve index API request checks for any existing indices, index aliases, or data streams that start with `new_logs`. If not, the `new_logs*` wildcard pattern can be used to create a new data stream. [source,console] ---- GET /_resolve/index/new_logs* ---- The API returns the following response, indicating no existing targets match this pattern. [source,console-result] ---- { "indices": [ ], "aliases": [ ], "data_streams": [ ] } ---- // TESTRESPONSE[s/"data_streams": \[ \]/"data_streams": $body.data_streams/] ==== . Create or update an index template. This template should contain the mappings and settings you'd like to apply to the new data stream's backing indices. + This index template must meet the <>. It should also contain your previously chosen name or wildcard pattern in the `index_patterns` property. + TIP: If you are only adding or changing a few things, we recommend you create a new template by copying an existing one and modifying it as needed. + .*Example* [%collapsible] ==== `logs_data_stream` is an existing index template used by the `logs` data stream. The following <> request creates a new index template, `new_logs_data_stream`. `new_logs_data_stream` uses the `logs_data_stream` template as its basis, with the following changes: * The `index_patterns` wildcard pattern matches any index or data stream starting with `new_logs`. * The `@timestamp` field mapping uses the `date_nanos` field data type rather than the `date` data type. * The template includes `sort.field` and `sort.order` index settings, which were not in the original `logs_data_stream` template. [source,console] ---- PUT /_index_template/new_logs_data_stream { "index_patterns": [ "new_logs*" ], "data_stream": { }, "template": { "mappings": { "properties": { "@timestamp": { "type": "date_nanos" <1> } } }, "settings": { "sort.field": [ "@timestamp"], <2> "sort.order": [ "desc"] <3> } } } ---- <1> Changes the `@timestamp` field mapping to the `date_nanos` field data type. <2> Adds the `sort.field` index setting. <3> Adds the `sort.order` index setting. ==== . Use the <> to manually create the new data stream. The name of the data stream must match the name or wildcard pattern defined in the new template's `index_patterns` property. + We do not recommend <>. Later, you will reindex older data from an existing data stream into this new stream. This could result in one or more backing indices that contains a mix of new and old data. + [[data-stream-mix-new-old-data]] .Mixing new and old data in a data stream [IMPORTANT] ==== While mixing new and old data is safe, it could interfere with data retention. If you delete older indices, you could accidentally delete a backing index that contains both new and old data. To prevent premature data loss, you would need to retain such a backing index until you are ready to delete its newest data. ==== + .*Example* [%collapsible] ==== The following create data stream API request targets `new_logs`, which matches the wildcard pattern for the `new_logs_data_stream` template. Because no existing index or data stream uses this name, this request creates the `new_logs` data stream. [source,console] ---- PUT /_data_stream/new_logs ---- // TEST[s/new_logs/new_logs_two/] ==== . If you do not want to mix new and old data in your new data stream, pause the indexing of new documents. While mixing old and new data is safe, it could interfere with data retention. See <>. . If you use {ilm-init} to <>, reduce the {ilm-init} poll interval. This ensures the current write index doesn’t grow too large while waiting for the rollover check. By default, {ilm-init} checks rollover conditions every 10 minutes. + .*Example* [%collapsible] ==== The following <> request lowers the `indices.lifecycle.poll_interval` setting to `1m` (one minute). [source,console] ---- PUT /_cluster/settings { "transient": { "indices.lifecycle.poll_interval": "1m" } } ---- ==== . Reindex your data to the new data stream using an `op_type` of `create`. + If you want to partition the data in the order in which it was originally indexed, you can run separate reindex requests. These reindex requests can use individual backing indices as the source. You can use the <> to retrieve a list of backing indices. + .*Example* [%collapsible] ==== You plan to reindex data from the `logs` data stream into the newly created `new_logs` data stream. However, you want to submit a separate reindex request for each backing index in the `logs` data stream, starting with the oldest backing index. This preserves the order in which the data was originally indexed. The following get data stream API request retrieves information about the `logs` data stream, including a list of its backing indices. [source,console] ---- GET /_data_stream/logs ---- The API returns the following response. Note the `indices` property contains an array of the stream's current backing indices. The first item in the array contains information about the stream's oldest backing index, `.ds-logs-000001`. [source,console-result] ---- { "data_streams": [ { "name": "logs", "timestamp_field": { "name": "@timestamp" }, "indices": [ { "index_name": ".ds-logs-000001", <1> "index_uuid": "Gpdiyq8sRuK9WuthvAdFbw" }, { "index_name": ".ds-logs-000002", "index_uuid": "_eEfRrFHS9OyhqWntkgHAQ" } ], "generation": 2, "status": "GREEN", "template": "logs_data_stream" } ] } ---- // TESTRESPONSE[s/"index_uuid": "Gpdiyq8sRuK9WuthvAdFbw"/"index_uuid": $body.data_streams.0.indices.0.index_uuid/] // TESTRESPONSE[s/"index_uuid": "_eEfRrFHS9OyhqWntkgHAQ"/"index_uuid": $body.data_streams.0.indices.1.index_uuid/] // TESTRESPONSE[s/"status": "GREEN"/"status": "YELLOW"/] <1> First item in the `indices` array for the `logs` data stream. This item contains information about the stream's oldest backing index, `.ds-logs-000001`. The following <> request copies documents from `.ds-logs-000001` to the `new_logs` data stream. Note the request's `op_type` is `create`. [source,console] ---- POST /_reindex { "source": { "index": ".ds-logs-000001" }, "dest": { "index": "new_logs", "op_type": "create" } } ---- ==== + You can also use a query to reindex only a subset of documents with each request. + .*Example* [%collapsible] ==== The following <> request copies documents from the `logs` data stream to the `new_logs` data stream. The request uses a <> to only reindex documents with a timestamp within the last week. Note the request's `op_type` is `create`. [source,console] ---- POST /_reindex { "source": { "index": "logs", "query": { "range": { "@timestamp": { "gte": "now-7d/d", "lte": "now/d" } } } }, "dest": { "index": "new_logs", "op_type": "create" } } ---- ==== . If you previously changed your {ilm-init} poll interval, change it back to its original value when reindexing is complete. This prevents unnecessary load on the master node. + .*Example* [%collapsible] ==== The following update cluster settings API request resets the `indices.lifecycle.poll_interval` setting to its default value, 10 minutes. [source,console] ---- PUT /_cluster/settings { "transient": { "indices.lifecycle.poll_interval": null } } ---- ==== . Resume indexing using the new data stream. Searches on this stream will now query your new data and the reindexed data. . Once you have verified that all reindexed data is available in the new data stream, you can safely remove the old stream. + .*Example* [%collapsible] ==== The following <> request deletes the `logs` data stream. This request also deletes the stream's backing indices and any data they contain. [source,console] ---- DELETE /_data_stream/logs ---- ====