clean_rooms

Creates, updates, deletes, gets or lists a clean_rooms resource.

Overview

Name	clean_rooms
Type	Resource
Id	databricks_workspace.cleanrooms.clean_rooms

Fields

The following fields are returned by SELECT queries:

get

Request completed successfully.

Name	Datatype	Description
name	string
access_restricted	string
comment	string
created_at	integer
local_collaborator_alias	string
output_catalog	object
owner	string
remote_detailed_info	object
status	string
updated_at	integer

list

Request completed successfully.

Name	Datatype	Description
name	string
access_restricted	string
comment	string
created_at	integer
local_collaborator_alias	string
output_catalog	object
owner	string
remote_detailed_info	object
status	string
updated_at	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Get the details of a clean room given its name.
list	select	deployment_name		Get a list of all clean rooms of the metastore. Only clean rooms the caller has access to are returned.
create	insert	deployment_name		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
update	update	deployment_name		Update a clean room. The caller must be the owner of the clean room, have
delete	delete	deployment_name		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

get

Get the details of a clean room given its name.

SELECT
name,
access_restricted,
comment,
created_at,
local_collaborator_alias,
output_catalog,
owner,
remote_detailed_info,
status,
updated_at
FROM databricks_workspace.cleanrooms.clean_rooms
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

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

SELECT
name,
access_restricted,
comment,
created_at,
local_collaborator_alias,
output_catalog,
owner,
remote_detailed_info,
status,
updated_at
FROM databricks_workspace.cleanrooms.clean_rooms
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

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

INSERT INTO databricks_workspace.cleanrooms.clean_rooms (
data__name,
data__owner,
data__comment,
data__remote_detailed_info,
deployment_name
)
SELECT 
'{{ name }}',
'{{ owner }}',
'{{ comment }}',
'{{ remote_detailed_info }}',
'{{ deployment_name }}'
RETURNING
name,
access_restricted,
comment,
created_at,
local_collaborator_alias,
output_catalog,
owner,
remote_detailed_info,
status,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: clean_rooms
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the clean_rooms resource.
    - name: name
      value: string
    - name: owner
      value: string
    - name: comment
      value: string
    - name: remote_detailed_info
      value: object

UPDATE examples

update

Update a clean room. The caller must be the owner of the clean room, have

UPDATE databricks_workspace.cleanrooms.clean_rooms
SET 
data__clean_room = '{{ clean_room }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
name,
access_restricted,
comment,
created_at,
local_collaborator_alias,
output_catalog,
owner,
remote_detailed_info,
status,
updated_at;

DELETE examples

delete

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.

DELETE FROM databricks_workspace.cleanrooms.clean_rooms
WHERE deployment_name = '{{ deployment_name }}' --required;