-
Notifications
You must be signed in to change notification settings - Fork 595
Update docs and migration guide for the catalog API updates #12203
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
base: main
Are you sure you want to change the base?
Conversation
|
Latest documentation preview deployed successfully.
Note: This comment is updated whenever you push a commit. |
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.
Pull request overview
This PR updates documentation and the migration guide to reflect recent catalog API changes, primarily the renaming of "partition" terminology to "segment" and a comprehensive overhaul of the catalog module APIs. The changes consolidate the migration guide into a more structured format and update code examples to use the new API patterns.
- Consolidated catalog API migration guide with clearer categorization
- Updated documentation examples to use new method names (
get_dataset(),datasets(), etc.) - Added deprecation decorator for
partition_idproperty in viewer events
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| rerun_py/rerun_sdk/rerun/event.py | Adds deprecated partition_id property to maintain backward compatibility while transitioning to segment_id |
| docs/content/reference/migration/migration-0-28.md | Major restructuring of migration guide with consolidated sections for catalog API changes, clearer categorization, and updated code examples |
| docs/content/getting-started/data-out/query-data.md | Updates code examples to use new API methods and patterns (e.g., get_dataset(), datasets(), DatasetView) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Blueprints | ||
|
|
||
| ## Python SDK: blueprint APIs simplified | ||
| The updated APIs now abstracted from the underlying storage mechanism (blueprint datasets). |
Copilot
AI
Dec 15, 2025
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.
Corrected 'now abstracted' to 'are now abstracted' for grammatical correctness.
| The updated APIs now abstracted from the underlying storage mechanism (blueprint datasets). | |
| The updated APIs are now abstracted from the underlying storage mechanism (blueprint datasets). |
ntjohnson1
left a comment
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.
LGTM. Added copilot review in case there was a typo or something. Looks pretty clear.
Related
What