Skip to content

Commit f1da856

Browse files
committed
Update migration guide
1 parent 8ba8c94 commit f1da856

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

docs/content/reference/migration/migration-0-28.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,30 @@ rotation and scale.
6363
Naturally, if any update to a transform always changes the same components, this does not cause any changes other than
6464
the simplification of not having to clear out all other components that may ever be set, thus reducing memory bloat both
6565
on send and query!
66+
67+
## Python SDK: "partition" renamed to "segment" in catalog APIs
68+
69+
<!-- TODO(ab): as I roll more API updates, I'll keep that section up-to-date -->
70+
71+
In the `rerun.catalog` module, all APIs using "partition" terminology have been renamed to use "segment" instead.
72+
The old APIs are deprecated and will be removed in a future release.
73+
74+
| Old API | New API |
75+
|---------|---------|
76+
| `DatasetEntry.partition_ids()` | `DatasetEntry.segment_ids()` |
77+
| `DatasetEntry.partition_table()` | `DatasetEntry.segment_table()` |
78+
| `DatasetEntry.partition_url()` | `DatasetEntry.segment_url()` |
79+
| `DatasetEntry.download_partition()` | `DatasetEntry.download_segment()` |
80+
| `DatasetEntry.default_blueprint_partition_id()` | `DatasetEntry.default_blueprint_segment_id()` |
81+
| `DatasetEntry.set_default_blueprint_partition_id()` | `DatasetEntry.set_default_blueprint_segment_id()` |
82+
| `DataframeQueryView.filter_partition_id()` | `DataframeQueryView.filter_segment_id()` |
83+
84+
The DataFusion utility functions in `rerun.utilities.datafusion.functions.url_generation` have also been renamed:
85+
86+
| Old API | New API |
87+
|---------|---------|
88+
| `partition_url()` | `segment_url()` |
89+
| `partition_url_udf()` | `segment_url_udf()` |
90+
| `partition_url_with_timeref_udf()` | `segment_url_with_timeref_udf()` |
91+
92+
The partition table columns have also been renamed from `rerun_partition_id` to `rerun_segment_id`.

0 commit comments

Comments
 (0)