Skip to content

Commit b440e8d

Browse files
committed
Cleanup vale comments
Signed-off-by: Andre Kurait <akurait@amazon.com>
1 parent e1944b1 commit b440e8d

File tree

3 files changed

+29
-35
lines changed

3 files changed

+29
-35
lines changed

_migration-assistant/migration-phases/migrate-metadata/transform-dense-vector-knn-vector.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,15 +57,13 @@ Transformations:
5757
Convert field data type dense_vector to OpenSearch knn_vector
5858
```
5959

60-
## Example transformations
61-
62-
### Basic dense_vector transformation
60+
## Transformation Behavior
6361

6462
<table style="border-collapse: collapse; border: 1px solid #ddd;">
6563
<thead>
6664
<tr>
67-
<th style="border: 1px solid #ddd; padding: 8px;">Source Field Type</th>
68-
<th style="border: 1px solid #ddd; padding: 8px;">Target Field Type</th>
65+
<th style="border: 1px solid #ddd; padding: 8px;">Source field type</th>
66+
<th style="border: 1px solid #ddd; padding: 8px;">Target field type</th>
6967
</tr>
7068
</thead>
7169
<tbody>
@@ -105,8 +103,6 @@ Transformations:
105103
</tbody>
106104
</table>
107105

108-
## Configuration details
109-
110106
### HNSW algorithm parameters
111107

112108
The transformation automatically configures the HNSW (Hierarchical Navigable Small World) algorithm with:
@@ -132,9 +128,7 @@ When any `dense_vector` fields are converted, the following index setting is aut
132128
}
133129
```
134130

135-
## Migration scenarios
136-
137-
### Migrating from Elasticsearch 7.x
131+
## Behavior differences
138132

139133
The Migration Assistant automatically transforms all `dense_vector` fields during metadata migration. The k-NN plugin must be installed and enabled on the target OpenSearch cluster.
140134

_migration-assistant/migration-phases/migrate-metadata/transform-flattened-flat-object.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ Transformations:
4040
<table style="border-collapse: collapse; border: 1px solid #ddd;">
4141
<thead>
4242
<tr>
43-
<th style="border: 1px solid #ddd; padding: 8px;">Source Field Type</th>
44-
<th style="border: 1px solid #ddd; padding: 8px;">Target Field Type</th>
43+
<th style="border: 1px solid #ddd; padding: 8px;">Source field type</th>
44+
<th style="border: 1px solid #ddd; padding: 8px;">Target field type</th>
4545
</tr>
4646
</thead>
4747
<tbody>

_migration-assistant/migration-phases/migrate-metadata/transform-string-text-keyword.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -71,15 +71,13 @@ Transformations:
7171
Convert field type string to text/keyword based on field data mappings
7272
```
7373

74-
## Example transformations
75-
76-
### String to keyword conversion
74+
## Transformation Behavior
7775

7876
<table style="border-collapse: collapse; border: 1px solid #ddd;">
7977
<thead>
8078
<tr>
81-
<th style="border: 1px solid #ddd; padding: 8px;">Source Field Type</th>
82-
<th style="border: 1px solid #ddd; padding: 8px;">Target Field Type</th>
79+
<th style="border: 1px solid #ddd; padding: 8px;">Source field type</th>
80+
<th style="border: 1px solid #ddd; padding: 8px;">Target field type</th>
8381
</tr>
8482
</thead>
8583
<tbody>
@@ -114,20 +112,6 @@ Transformations:
114112
}</code></pre>
115113
</td>
116114
</tr>
117-
</tbody>
118-
</table>
119-
120-
121-
### String to text conversion
122-
123-
<table style="border-collapse: collapse; border: 1px solid #ddd;">
124-
<thead>
125-
<tr>
126-
<th style="border: 1px solid #ddd; padding: 8px;">Source Field Type</th>
127-
<th style="border: 1px solid #ddd; padding: 8px;">Target Field Type</th>
128-
</tr>
129-
</thead>
130-
<tbody>
131115
<tr>
132116
<td style="border: 1px solid #ddd; padding: 8px;">
133117
<pre><code>{
@@ -164,15 +148,31 @@ Transformations:
164148
</tbody>
165149
</table>
166150

167-
## Migration scenarios
168-
169-
### Migrating from Elasticsearch 1.x-5.x
151+
## Behavior differences
170152

171153
The Migration Assistant automatically converts all `string` fields during metadata migration. No additional configuration is required.
172154

173155
### Mixed field types
174156

175-
If your source cluster already contains a mix of `string`, `text`, and `keyword` fields (common in Elasticsearch 5.x during the transition period), only the `string` fields will be converted. Existing `text` and `keyword` fields remain unchanged.
157+
If your source cluster already contains a mix of `string`, `text`, and `keyword` fields (common in Elasticsearch 5.x with restored Elasticsearch 2.x indices), only the `string` fields will be converted. Existing `text` and `keyword` fields remain unchanged.
158+
159+
### Query and aggregation impacts
160+
161+
After migration, be aware of these key differences:
162+
163+
- **Term queries**: Work differently on `text` (analyzed) vs `keyword` (exact match) fields
164+
- **Aggregations**: `text` fields cannot be used for aggregations unless fielddata is enabled; `keyword` fields are aggregation-ready
165+
- **Sorting**: `text` fields cannot be used for sorting by default; `keyword` fields support sorting
166+
- **Case sensitivity**: `keyword` fields are case-sensitive; `text` fields depend on the analyzer
167+
168+
### Application compatibility
169+
170+
Review your application code for:
171+
- Queries that expect the old `string` field behavior
172+
- Aggregations or sorting on fields now converted to `text`
173+
- Case-sensitive searches on fields now using `keyword`
174+
175+
For fields requiring both analyzed and exact-match capabilities, consider using multi-fields with both `text` and `keyword` mappings after migration.
176176

177177
## Troubleshooting
178178

0 commit comments

Comments
 (0)