Skip to content

Add APIs to Dataset to query and update the associated blueprint#10156

Merged
abey79 merged 2 commits intomainfrom
antoine/sdk-update-blueprint
Jun 6, 2025
Merged

Add APIs to Dataset to query and update the associated blueprint#10156
abey79 merged 2 commits intomainfrom
antoine/sdk-update-blueprint

Conversation

@abey79
Copy link
Member

@abey79 abey79 commented Jun 6, 2025

Related

What

This PR introduces the following APIs to the Python SDK, related to the querying and updating of the associated blueprint dataset and default blueprint partition ID:

class Dataset:
    # …
    
    def blueprint_dataset_id(self) -> EntryId | None:
        """The ID of the associated blueprint dataset, if any."""

    def blueprint_dataset(self) -> Dataset | None:
        """The associated blueprint dataset, if any."""

    def default_blueprint_partition_id(self) -> str | None:
        """The default blueprint partition ID for this dataset, if any."""

    def set_default_blueprint_partition_id(self, partition_id: str) -> None:
        """
        Set the default blueprint partition ID for this dataset.
        This fails if the change cannot be made to the remote server.
        """

    def partition_ids(self) -> list[str]:
        """Returns a list of partitions IDs for the dataset."""

The partition_ids() helper comes as a bonus, it proved useful for the dataset loader script.

DNM: chained

@abey79 abey79 added sdk-python Python logging API do-not-merge Do not merge this PR include in changelog dataplatform Rerun Data Platform integration labels Jun 6, 2025
@github-actions
Copy link

github-actions bot commented Jun 6, 2025

Web viewer built successfully. If applicable, you should also test it:

  • I have tested the web viewer
Result Commit Link Manifest
cc1b386 https://rerun.io/viewer/pr/10156 +nightly +main

Note: This comment is updated whenever you push a commit.

@jleibs jleibs self-requested a review June 6, 2025 14:45
@abey79 abey79 force-pushed the antoine/sdk-update-blueprint branch from 0bfcdee to e468ef5 Compare June 6, 2025 15:50
Base automatically changed from antoine/update-dataset to main June 6, 2025 16:20
@abey79 abey79 removed the do-not-merge Do not merge this PR label Jun 6, 2025
@abey79 abey79 force-pushed the antoine/sdk-update-blueprint branch from e468ef5 to cc1b386 Compare June 6, 2025 16:24
@abey79 abey79 merged commit 4897437 into main Jun 6, 2025
41 checks passed
@abey79 abey79 deleted the antoine/sdk-update-blueprint branch June 6, 2025 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dataplatform Rerun Data Platform integration include in changelog sdk-python Python logging API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants