-
Notifications
You must be signed in to change notification settings - Fork 172
Deprecate ZetaSQL-based filter_query functionality for v1.18.0 removal
#226
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
ZetaSQL-based filter_query functionality for v1.19.0 removal
ZetaSQL-based filter_query functionality for v1.19.0 removalZetaSQL-based filter_query functionality for v1.18.0 removal
|
@aktech @vkarampudi I have updated the title, description and commit messages as per the plan we discussed (to remove ZetaSQL in 1.18.0 release). We should merge this PR before v1.17.1 release (i.e., the next one). |
b09d217 to
3cc84da
Compare
| filter_query: An optional boolean expression in SQL syntax to specify | ||
| conditions on node attributes and directly connected assets. See | ||
| https://github.com/google/ml-metadata/blob/master/ml_metadata/proto/metadata_store.proto#L705-L783 for the query capabilities and syntax. | ||
| filter_query: DEPRECATED (will be removed in v1.19.0) - An optional boolean |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR description states removal in v1.18.0, but comment here says v1.19.0 and everywhere below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. The plan was changed later. Let me make the updates quickly. I was busy with struct2tensor. My 100% focus and time was allocated there (and finally we did it). Now let me clean this PR.
|
@czgdp1807 I see a bunch of examples here https://github.com/google/ml-metadata/blob/93574251a56d29f3775dd980daf5dbfbd58840cd/docs/index.md which uses |
Deprecate filter_query parameter in ListOperationOptions that depends on ZetaSQL. Add runtime warnings (Python DeprecationWarning, C++ LOG(WARNING)), update documentation, and add test coverage for deprecation warnings. This prepares for removal of ZetaSQL dependency in version 1.18.0.
Add deprecation notes to documentation examples and update version references from 1.19.0 to 1.18.0 across Python, C++, and documentation files.
3cc84da to
45ae7d2
Compare
|
This is ready to merge. The tests will pass. cc: @aktech |
Summary
This PR implements comprehensive deprecation warnings for the
filter_queryparameter inListOperationOptionsthat depends on ZetaSQL. This prepares for the removal of ZetaSQL dependency from ML Metadata in version 1.18.0.Motivation
ZetaSQL dependency is being phased out from ML Metadata. The
filter_queryfeature relies on ZetaSQL for SQL query parsing and analysis. To maintain backward compatibility while communicating the planned removal, this PR adds proper deprecation warnings across the codebase.Changes
Runtime Warnings
metadata_store.py): AddedDeprecationWarningwhenfilter_queryis used inListOptionsLOG(WARNING)messages in:query_config_executor.cc(MySQL)postgresql_query_executor.cc(PostgreSQL)Documentation Updates
filter_queryas deprecated with migration guidancefilter_query_ast_resolver.hand.ccfilter_query_builder.hand.ccTest Updates
test_get_nodes_by_filter_queryto verifyDeprecationWarningis raisedtest_get_nodes_by_filter_query_syntax_errorsto verify warnings even on syntax errorswarnings.catch_warnings()) to lineage subgraph tests that usefilter_queryfor backward compatibility testingTimeline
filter_queryand ZetaSQL dependencyTesting
All tests pass with proper deprecation warning handling:
filter_queryis usedMigration Path
Users relying on
filter_queryshould migrate to alternative filtering approaches before v1.18.0. The deprecation warnings provide clear guidance on the timeline and necessary actions.