docs: Update the docstring for ExactValueFilter #620
Closed
Conversation
This file contains hidden or 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
It derives from ValueRegexFilter, so it still expects a regular expression. The name itself was a misnomer, it was mostly to handle int values rather than exact values. For filtering on matching str/byte values, we can use the ValueRangeFilter.
product-auto-label
bot
added
size: xs
Mariatta
added
the
kokoro:force-run
yoshi-kokoro
removed
the
kokoro:force-run
igorbernstein2
requested changes
Aug 5, 2022
Comment on lines
+471
to
+474
| When passing non-integer ``value``, it must be valid RE2 patterns. See Google's | ||
| `RE2 reference`_ for the accepted syntax. | ||
| .. _RE2 reference: https://github.com/google/re2/wiki/Syntax |
There was a problem hiding this comment.
This seems wrong. I think the value needs to be properly escaped. ie if I pass the number 46 (ascii for .), it will match every single byte value
There was a problem hiding this comment.
Spoke offline, the current behavior is very surprising and not very useful. In case users using the current behavior, we can't change it.
Instead I propose that we add a new LiteralValueFilter that
- for ints converts them into bytestrings using the current logic
- for strs converts them to bytestrings
- accepts bytestrings as is
- once everything is normalized to a bytestring, iterate over the bytes and properly escape the bytes to encure they don't get interpreted as control characters. Example: https://github.com/googleapis/java-bigtable/blob/main/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/data/v2/internal/RegexUtil.java#L53-L81
- Deprecate ExactValueFilter and encourage people to migrate to the new filter
- Next major version drop ExactValueFilter
There was a problem hiding this comment.
I added a LiteralValueFilter implementation PR for the v3 branch: #767 (review)
Mariatta
added
the
type: feature request
meredithslota
changed the title
|
Closing in favor of #767 |
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.
It derives from ValueRegexFilter, so it still expects a regular expression.
The name itself was a misnomer, it was mostly to handle int values rather than exact values.
For filtering on matching str/byte values, we can use the ValueRangeFilter.
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #567 🦕