document arrayContainsElement filter #15455
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/querying/filters.md
Outdated
| @@ -450,6 +450,43 @@ Note that it is often more optimal to use a like filter instead of a regex for s | |||
| { "type": "regex", "dimension": "someColumn", "pattern": ^50.* } | |||
| ``` | |||
|
|
|||
| ## Array contains element filter | |||
|
|
|||
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can match against any type of column with scalar columns being treated as single element arrays. | |||
There was a problem hiding this comment.
Suggested change
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can match against any type of column with scalar columns being treated as single element arrays. | |
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can also match against any type of column. When matching against scalar columns, scalar columns are treated as single-element arrays. |
There was a problem hiding this comment.
Includes Abhishek's suggestions:
Suggested change
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can match against any type of column with scalar columns being treated as single element arrays. | |
| The `arrayContainsElement` filter checks if an `ARRAY` contains a specific element but can also match against any type of column. When matching against scalar columns, scalar columns are treated as single-element arrays. |
docs/querying/filters.md
Outdated
| | Property | Description | Required | | ||
| | -------- | ----------- | -------- | | ||
| | `type` | Must be "arrayContainsElement".| Yes | | ||
| | `column` | Input column or virtual column name to filter. | Yes | |
There was a problem hiding this comment.
Suggested change
| | `column` | Input column or virtual column name to filter. | Yes | | |
| | `column` | Input column or virtual column name to filter on. | Yes | |
There was a problem hiding this comment.
this matches all of the other tables in the page.. i guess i can update all of the tables... again :p
There was a problem hiding this comment.
its ok even if we make an exception here :)
docs/querying/filters.md
Outdated
| | `type` | Must be "arrayContainsElement".| Yes | | ||
| | `column` | Input column or virtual column name to filter. | Yes | | ||
| | `elementMatchValueType` | String specifying the type of element value to match. For example `STRING`, `LONG`, `DOUBLE`, `FLOAT`, `ARRAY<STRING>`, `ARRAY<LONG>`, or any other Druid type. The `elementMatchValueType` determines how Druid interprets the `elementMatchValue` to assist in converting to the type of elements contained in the matched `column`. | Yes | | ||
| | `elementMatchValue` | Array element value to match, including null. | Yes | |
There was a problem hiding this comment.
Suggested change
| | `elementMatchValue` | Array element value to match, including null. | Yes | | |
| | `elementMatchValue` | The value to is matched against the elements of `column`. This value can be null. | Yes | |
my phrasing might not be best here.
There was a problem hiding this comment.
The original wording is mostly ok imo, but the explicit can be null is helpful.
Suggested change
| | `elementMatchValue` | Array element value to match, including null. | Yes | | |
| | `elementMatchValue` | Array element value to match. This value can be null. | Yes | |
| | `elementMatchValueType` | String specifying the type of element value to match. For example `STRING`, `LONG`, `DOUBLE`, `FLOAT`, `ARRAY<STRING>`, `ARRAY<LONG>`, or any other Druid type. The `elementMatchValueType` determines how Druid interprets the `elementMatchValue` to assist in converting to the type of elements contained in the matched `column`. | Yes | | ||
| | `elementMatchValue` | Array element value to match, including null. | Yes | | ||
|
|
||
| ### Example: equivalent of `WHERE ARRAY_CONTAINS(someArrayColumn, 'hello')` |
There was a problem hiding this comment.
I feel a language like below is better
Suggested change
| ### Example: equivalent of `WHERE ARRAY_CONTAINS(someArrayColumn, 'hello')` | |
| ### Example: to filter rows where someArrayColumn has any element that is equal to 'hello' |
There was a problem hiding this comment.
all of the other examples on this page are framed in terms of equivalent SQL queries, am going to leave it as is
There was a problem hiding this comment.
hehe. that's what I thought but was too lazy to look beyond the surrounding functions.
317brian
approved these changes
Nov 30, 2023
docs/querying/filters.md
Outdated
| @@ -450,6 +450,43 @@ Note that it is often more optimal to use a like filter instead of a regex for s | |||
| { "type": "regex", "dimension": "someColumn", "pattern": ^50.* } | |||
| ``` | |||
|
|
|||
| ## Array contains element filter | |||
|
|
|||
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can match against any type of column with scalar columns being treated as single element arrays. | |||
There was a problem hiding this comment.
Includes Abhishek's suggestions:
Suggested change
| The `arrayContainsElement` filter is for checking if an `ARRAY` contains a specific element, but can match against any type of column with scalar columns being treated as single element arrays. | |
| The `arrayContainsElement` filter checks if an `ARRAY` contains a specific element but can also match against any type of column. When matching against scalar columns, scalar columns are treated as single-element arrays. |
docs/querying/filters.md
Outdated
| | `type` | Must be "arrayContainsElement".| Yes | | ||
| | `column` | Input column or virtual column name to filter. | Yes | | ||
| | `elementMatchValueType` | String specifying the type of element value to match. For example `STRING`, `LONG`, `DOUBLE`, `FLOAT`, `ARRAY<STRING>`, `ARRAY<LONG>`, or any other Druid type. The `elementMatchValueType` determines how Druid interprets the `elementMatchValue` to assist in converting to the type of elements contained in the matched `column`. | Yes | | ||
| | `elementMatchValue` | Array element value to match, including null. | Yes | |
There was a problem hiding this comment.
The original wording is mostly ok imo, but the explicit can be null is helpful.
Suggested change
| | `elementMatchValue` | Array element value to match, including null. | Yes | | |
| | `elementMatchValue` | Array element value to match. This value can be null. | Yes | |
abhishekagarwal87
approved these changes
Dec 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds docs for new native filter added in #15366