Array values are preserved (#1300) #3095

normanj-bitquill · 2024-10-22T22:50:18Z

Description

Preserve array values so that they are represented correctly in the result set with all nested values.

Related Issues

Resolves #1300

Check List

New functionality includes testing.
New functionality has been documented.
New functionality has javadoc added.
New functionality has a user manual doc added.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Norman Jordan <[email protected]>

normanj-bitquill · 2024-10-22T22:52:02Z

I am still working on the code for making this configurable. The idea is to have a query parameter named arrays that is optional. If it is included, the only valid value is preserve.

If arrays=preserve, then arrays returned from the OpenSearch engine can flow to the result set and include all of the nested values.

penghuo

could u add setting plugins.query.field_type_tolerance. If the plugins.query.field_type_tolerance setting is set to true, the backend will return scalar data types with array datasets, allowing basic queries like SELECT * FROM tbl WHERE condition; however, using multi-value fields in aggregations, ORDER BY clauses, or expressions will result in exceptions. If the setting is false or does not exist, only the first element of an array is returned, maintaining the current behavior.
could u add exception if operator/expression does not support array value, for instance groupby.

penghuo · 2024-10-22T23:54:07Z

integ-test/src/test/java/org/opensearch/sql/legacy/ObjectFieldSelectIT.java

@@ -81,7 +81,7 @@ public void testSelectObjectFieldOfArrayValuesItself() {
    JSONObject response = new JSONObject(query("SELECT accounts FROM %s"));

    // Only the first element of the list of is returned.


remove comments

Since the default behaviour is to only use the first element of an array, this comment is still valid.

Removed the comment.

Signed-off-by: Norman Jordan <[email protected]>

penghuo

Please update doc also https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst

opensearch/src/main/java/org/opensearch/sql/opensearch/setting/OpenSearchSettings.java

opensearch/src/main/java/org/opensearch/sql/opensearch/response/OpenSearchResponse.java

opensearch/src/main/java/org/opensearch/sql/opensearch/request/OpenSearchQueryRequest.java

integ-test/src/test/resources/expectedOutput/ppl/explain_filter_agg_push.json

…ctory Signed-off-by: Norman Jordan <[email protected]>

codecov · 2024-10-24T08:54:25Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.49%. Comparing base (e838e46) to head (bd462c7).
Report is 7 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##               main    #3095   +/-   ##
=========================================
  Coverage     94.48%   94.49%           
- Complexity     5416     5420    +4     
=========================================
  Files           528      528           
  Lines         15430    15449   +19     
  Branches       1023     1025    +2     
=========================================
+ Hits          14579    14598   +19     
  Misses          804      804           
  Partials         47       47

Flag	Coverage Δ
sql-engine	`94.49% <100.00%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

penghuo · 2024-10-24T15:10:38Z

opensearch/src/main/java/org/opensearch/sql/opensearch/request/OpenSearchQueryRequest.java

@@ -151,7 +153,8 @@ public OpenSearchQueryRequest(StreamInput in, OpenSearchStorageEngine engine) th
    }

    OpenSearchIndex index = (OpenSearchIndex) engine.getTable(null, indexName.toString());
-    exprValueFactory = new OpenSearchExprValueFactory(index.getFieldOpenSearchTypes());
+    exprValueFactory =
+        new OpenSearchExprValueFactory(index.getFieldOpenSearchTypes(), fieldTypeTolerance);


Logic should similar to OpenSearchScrollRequest right? If yes, fieldTypeTolerance should not associate with OpenSearchQueryRequest.

OpenSearchIndex index = (OpenSearchIndex) engine.getTable(null, indexName.toString()); exprValueFactory = new OpenSearchExprValueFactory( index.getFieldOpenSearchTypes(), index.isFieldTypeTolerance());

maybe another option is to create OpenSearchExprValueFactory in request builder and pass it to request? In case factory needs more settings passed in future?

...earch/src/main/java/org/opensearch/sql/opensearch/data/value/OpenSearchExprValueFactory.java

...h/src/test/java/org/opensearch/sql/opensearch/data/value/OpenSearchExprValueFactoryTest.java

penghuo · 2024-10-24T15:23:59Z

opensearch/src/main/java/org/opensearch/sql/opensearch/storage/scan/OpenSearchIndexScan.java

+      OpenSearchClient client,
+      boolean fieldTypeTolerance,
+      int maxResponseSize,
+      OpenSearchRequest request) {


nit: we could keep original constructor which means fieldTypeTolerance=true, it could avoid unnecessary UT chagne.

+1. I'm also curious if it even needs to be a parameter since nearly every refactor hardcodes it to true and the false case isn't even tested. What's the use case where we don't want this?

Changed back, since this change is not actually needed.

opensearch/src/test/java/org/opensearch/sql/opensearch/response/OpenSearchResponseTest.java

integ-test/src/test/java/org/opensearch/sql/legacy/ObjectFieldSelectIT.java

dai-chen

Please update documentation: https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst

dai-chen · 2024-10-24T18:09:16Z

opensearch/src/main/java/org/opensearch/sql/opensearch/request/OpenSearchQueryRequest.java

@@ -151,7 +153,8 @@ public OpenSearchQueryRequest(StreamInput in, OpenSearchStorageEngine engine) th
    }

    OpenSearchIndex index = (OpenSearchIndex) engine.getTable(null, indexName.toString());
-    exprValueFactory = new OpenSearchExprValueFactory(index.getFieldOpenSearchTypes());
+    exprValueFactory =
+        new OpenSearchExprValueFactory(index.getFieldOpenSearchTypes(), fieldTypeTolerance);


maybe another option is to create OpenSearchExprValueFactory in request builder and pass it to request? In case factory needs more settings passed in future?

integ-test/src/test/java/org/opensearch/sql/ppl/StandaloneIT.java

dai-chen · 2024-10-24T18:20:40Z

...earch/src/main/java/org/opensearch/sql/opensearch/data/value/OpenSearchExprValueFactory.java

@@ -164,7 +168,7 @@ public ExprValue construct(String jsonString, boolean supportArrays) {
          new OpenSearchJsonContent(OBJECT_MAPPER.readTree(jsonString)),
          TOP_PATH,
          Optional.of(STRUCT),
-          supportArrays);
+          fieldTypeTolerance || supportArrays);


I'm thinking should we use fieldTypeTolerance directly in parseArray (not sure parseGeopoint)? Because I think supportArrays has its own meaning? Unless we change it and rename the argument?

This also applies to geopoints and anything else that could be in an array. If fieldTypeTolerance is not also applied to parseGeopoint, then an array of geopoints would get reduced to only the first element.

* Cleaned up how the fieldTypeTolerance setting is accessed * Added an integration test for when fieldTypeTolerance is disabled Signed-off-by: Norman Jordan <[email protected]>

penghuo · 2024-10-24T20:14:37Z

opensearch/src/main/java/org/opensearch/sql/opensearch/request/OpenSearchRequestBuilder.java

@@ -110,6 +110,7 @@ private OpenSearchRequest buildRequestWithPit(
    int size = requestedTotalSize;
    FetchSourceContext fetchSource = this.sourceBuilder.fetchSource();
    List<String> includes = fetchSource != null ? Arrays.asList(fetchSource.includes()) : List.of();
+    boolean fieldTypeTolerance = settings.getSettingValue(Settings.Key.FIELD_TYPE_TOLERANCE);


unused field, remove it.

Signed-off-by: Norman Jordan <[email protected]>

penghuo

Thanks for the change!
Please update doc in following PR. https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst

opensearch-trigger-bot · 2024-10-24T22:22:05Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/sql/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/sql/backport-2.x
# Create a new branch
git switch --create backport/backport-3095-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 e109417bb3ce770fb54cfd7b231b8219a22ed46f
# Push it to GitHub
git push --set-upstream origin backport/backport-3095-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/sql/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-3095-to-2.x.

…ect#3095) Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417)

Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417) Co-authored-by: normanj-bitquill <[email protected]>

…ect#3095) (opensearch-project#3120) Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417) Co-authored-by: normanj-bitquill <[email protected]>

…ect#3095) (opensearch-project#3120) Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417) Co-authored-by: normanj-bitquill <[email protected]> Signed-off-by: Louis Chu <[email protected]>

Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417) Co-authored-by: normanj-bitquill <[email protected]> (cherry picked from commit 81577df) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

(cherry picked from commit e109417) (cherry picked from commit 81577df) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: normanj-bitquill <[email protected]>

Array values are preserved

32e7e73

Signed-off-by: Norman Jordan <[email protected]>

penghuo reviewed Oct 23, 2024

View reviewed changes

normanj-bitquill added 2 commits October 23, 2024 15:00

Added a setting to control array handling

e93cc5f

Signed-off-by: Norman Jordan <[email protected]>

Fixed some more tests

1fba9ec

Signed-off-by: Norman Jordan <[email protected]>

penghuo requested changes Oct 23, 2024

View reviewed changes

Reworked to move pass the configuration through OpenSearchExprValueFa…

bd462c7

…ctory Signed-off-by: Norman Jordan <[email protected]>

normanj-bitquill force-pushed the issue-1300-array-passthrough branch from ab02d1d to bd462c7 Compare October 24, 2024 05:44

penghuo reviewed Oct 24, 2024

View reviewed changes

dai-chen reviewed Oct 24, 2024

View reviewed changes

Code cleanup and adding more tests

d58b6dc

* Cleaned up how the fieldTypeTolerance setting is accessed * Added an integration test for when fieldTypeTolerance is disabled Signed-off-by: Norman Jordan <[email protected]>

penghuo reviewed Oct 24, 2024

View reviewed changes

Removed some unused code

69226c8

Signed-off-by: Norman Jordan <[email protected]>

penghuo approved these changes Oct 24, 2024

View reviewed changes

dai-chen approved these changes Oct 24, 2024

View reviewed changes

penghuo merged commit e109417 into opensearch-project:main Oct 24, 2024
14 of 15 checks passed

penghuo added the backport 2.x label Oct 24, 2024

opensearch-trigger-bot bot added the backport-failed label Oct 24, 2024

penghuo changed the title ~~WIP: Array values are preserved (#1300)~~ Array values are preserved (#1300) Oct 24, 2024

penghuo pushed a commit to penghuo/os-sql that referenced this pull request Oct 25, 2024

Array values are preserved (opensearch-project#1300) (opensearch-proj…

b101b6a

…ect#3095) Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417)

penghuo mentioned this pull request Oct 25, 2024

[Backport 2.x] Array values are preserved (#1300) (#3095) #3120

Merged

7 tasks

penghuo pushed a commit to penghuo/os-sql that referenced this pull request Oct 25, 2024

Array values are preserved (opensearch-project#1300) (opensearch-proj…

7ef1071

…ect#3095) Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417)

penghuo added a commit that referenced this pull request Oct 25, 2024

Array values are preserved (#1300) (#3095) (#3120)

81577df

Signed-off-by: Norman Jordan <[email protected]> (cherry picked from commit e109417) Co-authored-by: normanj-bitquill <[email protected]>

Swiddis removed the backport-failed label Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Array values are preserved (#1300) #3095

Array values are preserved (#1300) #3095

normanj-bitquill commented Oct 22, 2024

normanj-bitquill commented Oct 22, 2024

penghuo left a comment

penghuo Oct 22, 2024

normanj-bitquill Oct 23, 2024

normanj-bitquill Oct 24, 2024

penghuo left a comment

codecov bot commented Oct 24, 2024

penghuo Oct 24, 2024

dai-chen Oct 24, 2024

normanj-bitquill Oct 24, 2024

penghuo Oct 24, 2024

Swiddis Oct 24, 2024 •

edited

Loading

normanj-bitquill Oct 24, 2024

dai-chen left a comment

dai-chen Oct 24, 2024

dai-chen Oct 24, 2024

normanj-bitquill Oct 24, 2024

penghuo Oct 24, 2024

normanj-bitquill Oct 24, 2024

penghuo left a comment

opensearch-trigger-bot bot commented Oct 24, 2024

		@@ -81,7 +81,7 @@ public void testSelectObjectFieldOfArrayValuesItself() {
		JSONObject response = new JSONObject(query("SELECT accounts FROM %s"));

		// Only the first element of the list of is returned.

Array values are preserved (#1300) #3095

Array values are preserved (#1300) #3095

Conversation

normanj-bitquill commented Oct 22, 2024

Description

Related Issues

Check List

normanj-bitquill commented Oct 22, 2024

penghuo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

penghuo left a comment

Choose a reason for hiding this comment

codecov bot commented Oct 24, 2024

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swiddis Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dai-chen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

penghuo left a comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Oct 24, 2024

Swiddis Oct 24, 2024 •

edited

Loading