From 78b4c414b859340442f88b05b539c50b4f29e0d0 Mon Sep 17 00:00:00 2001 From: Bharathwaj G Date: Wed, 23 Oct 2024 15:42:41 +0530 Subject: [PATCH] addressing comments Signed-off-by: Bharathwaj G --- _field-types/supported-field-types/index.md | 2 +- _field-types/supported-field-types/star-tree.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/_field-types/supported-field-types/index.md b/_field-types/supported-field-types/index.md index 20e13cec7a..d1a498cef2 100644 --- a/_field-types/supported-field-types/index.md +++ b/_field-types/supported-field-types/index.md @@ -30,7 +30,7 @@ IP | [`ip`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/ip/): k-NN vector | [`knn_vector`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/knn-vector/): Allows indexing a k-NN vector into OpenSearch and performing different kinds of k-NN search. Percolator | [`percolator`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/percolator/): Specifies to treat this field as a query. Derived | [`derived`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/derived/): Creates new fields dynamically by executing scripts on existing fields. -Star Tree | [`star_tree`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/star-tree/): Allows creating materialized views by pre-computing aggregations during indexing based on user-provided configuration to accelerate performance of aggregations. +Star Tree | [`star_tree`]({{site.url}}{{site.baseurl}}/field-types/supported-field-types/star-tree/): Creates materialized views by pre-computing aggregations using star-tree index to accelerate performance of aggregations. ## Arrays There is no dedicated array field type in OpenSearch. Instead, you can pass an array of values into any field. All values in the array must have the same field type. diff --git a/_field-types/supported-field-types/star-tree.md b/_field-types/supported-field-types/star-tree.md index 9ee40810c6..47eacc7fc4 100644 --- a/_field-types/supported-field-types/star-tree.md +++ b/_field-types/supported-field-types/star-tree.md @@ -13,8 +13,8 @@ redirect_from: This is an experimental feature and is not recommended for use in a production environment. For updates on the progress the feature or if you want to leave feedback, join the discussion on the [OpenSearch forum](https://forum.opensearch.org/). {: .warning} -Star Tree Index is a multi-field index that improves the performance of aggregations. -Once you configure star-tree index as part of index mapping by specifying the dimensions and metrics, star-tree index gets created and maintained in real-time within segments as data is ingested. +Star Tree Index is a multi-field index that improves the performance of aggregations by pre-computing the aggregations. +Once you configure star-tree index as part of index mapping, it will be created and maintained in real-time within segments as data is ingested. OpenSearch will automatically use the star-tree index to optimize aggregations based on the input query and star-tree configuration. No changes are required in the query syntax or requests. @@ -27,7 +27,7 @@ Before using star-tree field, be sure to satisfy the following prerequisites: - Set the feature flag `opensearch.experimental.feature.composite_index.star_tree.enabled"` to `true`. For more information about enabling and disabling feature flags, see [Enabling experimental features]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/experimental/). - Set the `indices.composite_index.star_tree.enabled` setting to `true`. For instructions on how to configure OpenSearch, see [configuring settings]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index/#static-settings). - Set the `index.composite_index` index setting to `true` during index creation. -- Enable `doc_values` : Ensure that the `doc_values` is enabled for the dimensions and metrics fields used in your star-tree mapping. +- Enable `doc_values` : Ensure that the `doc_values` is enabled for the [dimensions](#ordered-dimensions) and [metrics](#metrics) fields used in your star-tree mapping. ## Examples