From 2aba05aa0d3eee8fb2b6e8f79e9e08d63711eec3 Mon Sep 17 00:00:00 2001 From: alicejw Date: Tue, 12 Apr 2022 14:09:46 -0700 Subject: [PATCH] for review comments Signed-off-by: alicejw --- _opensearch/rest-api/index-apis/update-mapping.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/_opensearch/rest-api/index-apis/update-mapping.md b/_opensearch/rest-api/index-apis/update-mapping.md index 50ec1342..0a1ea8e0 100644 --- a/_opensearch/rest-api/index-apis/update-mapping.md +++ b/_opensearch/rest-api/index-apis/update-mapping.md @@ -10,9 +10,9 @@ nav_order: 220 Introduced 1.0 {: .label .label-purple } -If you want to update an index's mappings to add or update field types after index creation, you can do so with the update mapping API operation. +If you want to add or update field types to an existing index, you can use the update mapping API operation. -**Note:** You can't use this operation to update mappings that already map to existing data in the index. You must first create a new index with your desired mappings, and then use the [reindex API operation]({{site.url}}{{site.baseurl}}/opensearch/reindex-data) to map all the documents from your old index to the new index. If you don't want any downtime while you re-index your indices, you can use [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias). +You can't use this operation to update mappings that already map to existing data in the index. You must first create a new index with your desired mappings, and then use the [reindex API operation]({{site.url}}{{site.baseurl}}/opensearch/reindex-data) to map all the documents from your old index to the new index. If you don't want any downtime while you re-index your indexes, you can use [aliases]({{site.url}}{{site.baseurl}}/opensearch/index-alias). ## Example @@ -51,10 +51,10 @@ All update mapping parameters are optional. Parameter | Data Type | Description :--- | :--- | :--- -<target-index> | Data Type | The index to add the mapping to. If you do not specify this parameter, OpenSearch adds the mapping to all indices within the cluster. -allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indices. Default is `true`. -expand_wildcards | String | Expands wildcard expressions to different indices. Combine multiple values with commas. Available values are `all` (match all indices), `open` (match open indices), `closed` (match closed indices), `hidden` (match hidden indices), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`. -ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indices in the response. +<target-index> | N/A | The index to add the mapping to. If you do not specify this parameter, OpenSearch adds the mapping to all indexes within the cluster. +allow_no_indices | Boolean | Whether to ignore wildcards that don’t match any indexes. Default is `true`. +expand_wildcards | String | Expands wildcard expressions to different indexes. Combine multiple values with commas. Available values are `all` (match all indexes), `open` (match open indexes), `closed` (match closed indexes), `hidden` (match hidden indexes), and `none` (do not accept wildcard expressions), which must be used with `open`, `closed`, or both. Default is `open`. +ignore_unavailable | Boolean | If true, OpenSearch does not include missing or closed indexes in the response. master_timeout | Time | How long to wait for a connection to the master node. Default is `30s`. timeout | Time | How long to wait for the response to return. Default is `30s`. write_index_only | Boolean | Whether OpenSearch should apply mapping updates only to the write index.