Skip to content

Commit f5c3d3f

Browse files
Add skip_list details to date, scaled float (#11181)
* Add skip_list details to date, scaled float * resolves #11166 Signed-off-by: Asim Mahmood <[email protected]> * Apply suggestions from code review Signed-off-by: kolchfa-aws <[email protected]> --------- Signed-off-by: Asim Mahmood <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: kolchfa-aws <[email protected]>
1 parent 626bad6 commit f5c3d3f

File tree

2 files changed

+6
-3
lines changed

2 files changed

+6
-3
lines changed

_field-types/supported-field-types/date.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ Parameter | Description
5656
`locale` | A region- and language-specific way of representing the date. Default is [`ROOT`](https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html#ROOT) (a region- and language-neutral locale).
5757
`meta` | Accepts metadata for this field.
5858
[`null_value`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/index#null-value) | A value to be used in place of `null`. Must be of the same type as the field. If this parameter is not specified, the field is treated as missing when its value is `null`. Default is `null`.
59+
`skip_list` | A Boolean value that specifies whether to enable skip list indexing for doc values. When enabled, OpenSearch creates indexed doc values that can improve performance for `range` queries by allowing the query engine to skip irrelevant document ranges. Skip list indexing is automatically enabled for the `@timestamp` field and fields used for index sorting. For all other fields, the default is `false`.
5960
`store` | A Boolean value that specifies whether the field value should be stored and can be retrieved separately from the _source field. Default is `false`.
6061

6162
## Formats

_field-types/supported-field-types/numeric.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ PUT testindex/_doc/1
6161

6262
## Example: Skip list
6363

64-
Use the `skip_list` parameter for better query performance. The `skip_list` parameter is particularly beneficial for fields that are frequently used in `range` queries or aggregations because it allows the query engine to skip over document ranges that don't match the query criteria.
64+
Use the `skip_list` parameter for better query performance. The `skip_list` parameter is particularly beneficial for fields that are frequently used in `range` queries because it allows the query engine to skip over document ranges that don't match the query criteria.
6565

6666
Create a mapping with skip list indexing enabled:
6767

@@ -114,6 +114,7 @@ PUT testindex
114114
}
115115
}
116116
}
117+
117118
```
118119
{% include copy-curl.html %}
119120

@@ -142,11 +143,12 @@ Parameter | Description
142143
`index` | A Boolean value that specifies whether the field should be searchable. Default is `true`.
143144
`meta` | Accepts metadata for this field.
144145
[`null_value`]({{site.url}}{{site.baseurl}}/opensearch/supported-field-types/index#null-value) | A value to be used in place of `null`. Must be of the same type as the field. If this parameter is not specified, the field is treated as missing when its value is `null`. Default is `null`.
145-
`skip_list` | A Boolean value that specifies whether to enable skip list indexing for doc values. When enabled, this creates indexed doc values that can improve performance for `range` queries and aggregations by allowing the query engine to skip over irrelevant document ranges. Default is `false`.
146+
`skip_list` | A Boolean value that specifies whether to enable skip list indexing for doc values. When enabled, this creates indexed doc values that can improve performance for `range` queries by allowing the query engine to skip over irrelevant document ranges. Default is `false`.
146147
`store` | A Boolean value that specifies whether the field value should be stored and can be retrieved separately from the _source field. Default is `false`.
147148

148149
Scaled float has an additional required parameter: `scaling_factor`.
149150

150151
Parameter | Description
151152
:--- | :---
152-
`scaling_factor` | A double value that is multiplied by the field value and rounded to the nearest long. Required.
153+
`scaling_factor` | A double value that is multiplied by the field value and rounded to the nearest long. Required.
154+
`skip_list` | A Boolean value that specifies whether to enable skip list indexing for doc values. When enabled, OpenSearch creates indexed doc values that can improve performance for `range` queries by allowing the query engine to skip irrelevant document ranges. Default is `false`.

0 commit comments

Comments
 (0)