w.clean_rooms: Clean Rooms

class databricks.sdk.service.cleanrooms.CleanRoomsAPI

A clean room uses Delta Sharing and serverless compute to provide a secure and privacy-protecting environment where multiple parties can work together on sensitive enterprise data without direct access to each other’s data.

create(clean_room: CleanRoom) → Wait[CleanRoom]

Create a new clean room with the specified collaborators. This method is asynchronous; the returned name field inside the clean_room field can be used to poll the clean room status, using the :method:cleanrooms/get method. When this method returns, the clean room will be in a PROVISIONING state, with only name, owner, comment, created_at and status populated. The clean room will be usable once it enters an ACTIVE state.

The caller must be a metastore admin or have the CREATE_CLEAN_ROOM privilege on the metastore.

Parameters:

clean_room – CleanRoom

Returns:

Long-running operation waiter for CleanRoom. See :method:wait_get_clean_room_active for more details.

create_and_wait(clean_room: CleanRoom, timeout: datetime.timedelta = 0:20:00) → CleanRoom
create_output_catalog(clean_room_name: str, output_catalog: CleanRoomOutputCatalog) → CreateCleanRoomOutputCatalogResponse

Create the output catalog of the clean room.

Parameters:
Returns:

CreateCleanRoomOutputCatalogResponse

delete(name: str)

Delete a clean room. After deletion, the clean room will be removed from the metastore. If the other collaborators have not deleted the clean room, they will still have the clean room in their metastore, but it will be in a DELETED state and no operations other than deletion can be performed on it.

Parameters:

name – str Name of the clean room.

get(name: str) → CleanRoom

Get the details of a clean room given its name.

Parameters:

name – str

Returns:

CleanRoom

list([, page_size: Optional[int], page_token: Optional[str]]) → Iterator[CleanRoom]

Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned.

Parameters:

  • page_size – int (optional) Maximum number of clean rooms to return (i.e., the page length). Defaults to 100.

  • page_token – str (optional) Opaque pagination token to go to next page based on previous query.

Returns:

Iterator over CleanRoom

update(name: str [, clean_room: Optional[CleanRoom]]) → CleanRoom

Update a clean room. The caller must be the owner of the clean room, have MODIFY_CLEAN_ROOM privilege, or be metastore admin.

When the caller is a metastore admin, only the __owner__ field can be updated.

Parameters:

  • name – str Name of the clean room.

  • clean_room – CleanRoom (optional)

Returns:

CleanRoom

wait_get_clean_room_active(name: str, timeout: datetime.timedelta = 0:20:00, callback: Optional[Callable[[CleanRoom], None]]) → CleanRoom