metastore_assignments

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

Overview

Name	metastore_assignments
Type	Resource
Id	databricks_workspace.unitycatalog.metastore_assignments

Fields

The following fields are returned by SELECT queries:

current

The metastore assignment was successfully retrieved.

Name	Datatype	Description
metastore_id	string
workspace_id	integer
default_catalog_name	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
current	select	deployment_name		Gets the metastore assignment for the workspace being accessed.
assign	insert	deployment_name		Creates a new metastore assignment. If an assignment for the same
updateassignment	update	deployment_name		Updates a metastore assignment. This operation can be used to update
unassign	delete	deployment_name		Deletes a metastore assignment. The caller must be an account administrator.

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

current

Gets the metastore assignment for the workspace being accessed.

SELECT
metastore_id,
workspace_id,
default_catalog_name
FROM databricks_workspace.unitycatalog.metastore_assignments
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

assign

Creates a new metastore assignment. If an assignment for the same

INSERT INTO databricks_workspace.unitycatalog.metastore_assignments (
data__metastore_id,
data__default_catalog_name,
deployment_name
)
SELECT 
'{{ metastore_id }}',
'{{ default_catalog_name }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: metastore_assignments
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the metastore_assignments resource.
    - name: metastore_id
      value: required
    - name: default_catalog_name
      value: string

UPDATE examples

updateassignment

Updates a metastore assignment. This operation can be used to update

UPDATE databricks_workspace.unitycatalog.metastore_assignments
SET 
data__metastore_id = '{{ metastore_id }}',
data__default_catalog_name = '{{ default_catalog_name }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

unassign

Deletes a metastore assignment. The caller must be an account administrator.

DELETE FROM databricks_workspace.unitycatalog.metastore_assignments
WHERE deployment_name = '{{ deployment_name }}' --required;