From 99c18d1c86a079b78879703fdb366ce0c2d1d76c Mon Sep 17 00:00:00 2001 From: Asim Mahmood Date: Thu, 2 Oct 2025 14:55:32 -0700 Subject: [PATCH 1/2] Add skip_list details to date, scaled float * resolves https://github.com/opensearch-project/documentation-website/issues/11166 Signed-off-by: Asim Mahmood --- _field-types/supported-field-types/date.md | 1 + _field-types/supported-field-types/numeric.md | 8 +++++--- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/_field-types/supported-field-types/date.md b/_field-types/supported-field-types/date.md index 0d5a49c99f..c78d6347d4 100644 --- a/_field-types/supported-field-types/date.md +++ b/_field-types/supported-field-types/date.md @@ -56,6 +56,7 @@ Parameter | Description `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). `meta` | Accepts metadata for this field. [`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`. +`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`, but skip list indexing is automatically enabled for the `@timestamp` field and fields used for index sorting. `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`. ## Formats diff --git a/_field-types/supported-field-types/numeric.md b/_field-types/supported-field-types/numeric.md index 5d902f9660..2eac29c239 100644 --- a/_field-types/supported-field-types/numeric.md +++ b/_field-types/supported-field-types/numeric.md @@ -61,7 +61,7 @@ PUT testindex/_doc/1 ## Example: Skip list -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. +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. Create a mapping with skip list indexing enabled: @@ -114,6 +114,7 @@ PUT testindex } } } + ``` {% include copy-curl.html %} @@ -142,11 +143,12 @@ Parameter | Description `index` | A Boolean value that specifies whether the field should be searchable. Default is `true`. `meta` | Accepts metadata for this field. [`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`. -`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`. +`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`. `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`. Scaled float has an additional required parameter: `scaling_factor`. Parameter | Description :--- | :--- -`scaling_factor` | A double value that is multiplied by the field value and rounded to the nearest long. Required. +`scaling_factor` | A double value that is multiplied by the field value and rounded to the nearest long. Required. +`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`. From 3f36dc6ade00fa0600d72e8cf97dae99eea4694d Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Fri, 10 Oct 2025 09:59:10 -0400 Subject: [PATCH 2/2] Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --- _field-types/supported-field-types/date.md | 2 +- _field-types/supported-field-types/numeric.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_field-types/supported-field-types/date.md b/_field-types/supported-field-types/date.md index c78d6347d4..939f9eaf9f 100644 --- a/_field-types/supported-field-types/date.md +++ b/_field-types/supported-field-types/date.md @@ -56,7 +56,7 @@ Parameter | Description `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). `meta` | Accepts metadata for this field. [`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`. -`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`, but skip list indexing is automatically enabled for the `@timestamp` field and fields used for index sorting. +`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`. `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`. ## Formats diff --git a/_field-types/supported-field-types/numeric.md b/_field-types/supported-field-types/numeric.md index 2eac29c239..917e8562ec 100644 --- a/_field-types/supported-field-types/numeric.md +++ b/_field-types/supported-field-types/numeric.md @@ -151,4 +151,4 @@ Scaled float has an additional required parameter: `scaling_factor`. Parameter | Description :--- | :--- `scaling_factor` | A double value that is multiplied by the field value and rounded to the nearest long. Required. -`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`. +`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`.