docs: Add end-to-end registry deletion lifecycle example and unit test (#5360)#6504
Open
obielin wants to merge 1 commit into
Open
docs: Add end-to-end registry deletion lifecycle example and unit test (#5360)#6504obielin wants to merge 1 commit into
obielin wants to merge 1 commit into
Conversation
b939040 to
5723ed6
Compare
) The existing registry deletion docs cover the CLI and individual Python SDK delete methods, but lack a single copy-pasteable example showing the full create -> verify -> delete -> confirm flow. - Add an 'End-to-end example' snippet to registry.md that lists a feature view, deletes it with delete_feature_view(), and lists again to confirm. - Add a unit test for FeatureView deletion via apply(objects_to_delete=..., partial=False) to guard the programmatic deletion path. Signed-off-by: Linda Oraegbunam <obielinda@gmail.com>
5723ed6 to
25d077d
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What this PR does
Closes #5360.
The existing registry docs already cover the
feast applydeletion warning, the CLI command, the individual Python SDKdelete_*methods, and thepartial=Falsenote. The one remaining gap, as agreed in the issue discussion, is that there is no single, self-contained example showing the complete deletion lifecycle in one place.This PR addresses that gap with a minimal, copy-pasteable addition.
Changes
docs/getting-started/components/registry.md: Adds an "End-to-end example" section demonstrating the full feature view deletion lifecycle — list/verify the object exists, delete it, then list again to confirm removal — and notes that the same pattern applies to other registry objects via their correspondingdelete_*methods.sdk/python/tests/unit/local_feast_tests/test_local_feature_store.py: Addstest_apply_delete_feature_view, which registers an entity and feature view, deletes it usingapply(objects_to_delete=[...], partial=False), and asserts the feature view is gone and thatget_feature_viewraisesFeatureViewNotFoundException.Notes
This keeps the change intentionally small and documentation-focused, per the consensus reached in the issue thread between the maintainer and contributors. Thanks to @Henildiyora for the original snippet draft and review, and to @jyejare for the guidance.