metastores

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

Overview

Name	metastores
Type	Resource
Id	databricks_workspace.unitycatalog.metastores

Fields

The following fields are returned by SELECT queries:

get

The metastore was successfully retrieved.

Name	Datatype	Description
name	string
default_data_access_config_id	string
global_metastore_id	string
metastore_id	string
storage_root_credential_id	string
delta_sharing_organization_name	string
storage_root_credential_name	string
cloud	string
created_at	integer
created_by	string
delta_sharing_recipient_token_lifetime_in_seconds	integer
delta_sharing_scope	string
external_access_enabled	boolean
owner	string
privilege_model_version	string
region	string
storage_root	string
updated_at	integer
updated_by	string

list

The metastore list was successfully retrieved.

Name	Datatype	Description
name	string
default_data_access_config_id	string
global_metastore_id	string
metastore_id	string
storage_root_credential_id	string
delta_sharing_organization_name	string
storage_root_credential_name	string
cloud	string
created_at	integer
created_by	string
delta_sharing_recipient_token_lifetime_in_seconds	integer
delta_sharing_scope	string
external_access_enabled	boolean
owner	string
privilege_model_version	string
region	string
storage_root	string
updated_at	integer
updated_by	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deployment_name		Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info.
list	select	deployment_name		Gets an array of the available metastores (as
create	insert	deployment_name		Creates a new metastore based on a provided name and optional storage root path. By default (if the
update	update	deployment_name		Updates information for a specific metastore. The caller must be a metastore admin. If the
delete	delete	deployment_name		Deletes a metastore. The caller must be a metastore admin.

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

Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info.

SELECT
name,
default_data_access_config_id,
global_metastore_id,
metastore_id,
storage_root_credential_id,
delta_sharing_organization_name,
storage_root_credential_name,
cloud,
created_at,
created_by,
delta_sharing_recipient_token_lifetime_in_seconds,
delta_sharing_scope,
external_access_enabled,
owner,
privilege_model_version,
region,
storage_root,
updated_at,
updated_by
FROM databricks_workspace.unitycatalog.metastores
WHERE deployment_name = '{{ deployment_name }}' -- required;

list

Gets an array of the available metastores (as

SELECT
name,
default_data_access_config_id,
global_metastore_id,
metastore_id,
storage_root_credential_id,
delta_sharing_organization_name,
storage_root_credential_name,
cloud,
created_at,
created_by,
delta_sharing_recipient_token_lifetime_in_seconds,
delta_sharing_scope,
external_access_enabled,
owner,
privilege_model_version,
region,
storage_root,
updated_at,
updated_by
FROM databricks_workspace.unitycatalog.metastores
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new metastore based on a provided name and optional storage root path. By default (if the

INSERT INTO databricks_workspace.unitycatalog.metastores (
data__name,
data__storage_root,
data__region,
deployment_name
)
SELECT 
'{{ name }}',
'{{ storage_root }}',
'{{ region }}',
'{{ deployment_name }}'
RETURNING
name,
default_data_access_config_id,
global_metastore_id,
metastore_id,
storage_root_credential_id,
delta_sharing_organization_name,
storage_root_credential_name,
cloud,
created_at,
created_by,
delta_sharing_recipient_token_lifetime_in_seconds,
delta_sharing_scope,
external_access_enabled,
owner,
privilege_model_version,
region,
storage_root,
updated_at,
updated_by
;

Manifest

# Description fields are for documentation purposes
- name: metastores
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the metastores resource.
    - name: name
      value: required
    - name: storage_root
      value: string
    - name: region
      value: string

UPDATE examples

update

Updates information for a specific metastore. The caller must be a metastore admin. If the

UPDATE databricks_workspace.unitycatalog.metastores
SET 
data__storage_root_credential_id = '{{ storage_root_credential_id }}',
data__delta_sharing_recipient_token_lifetime_in_seconds = {{ delta_sharing_recipient_token_lifetime_in_seconds }},
data__delta_sharing_organization_name = '{{ delta_sharing_organization_name }}',
data__owner = '{{ owner }}',
data__privilege_model_version = '{{ privilege_model_version }}',
data__new_name = '{{ new_name }}',
data__delta_sharing_scope = '{{ delta_sharing_scope }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required
RETURNING
name,
default_data_access_config_id,
global_metastore_id,
metastore_id,
storage_root_credential_id,
delta_sharing_organization_name,
storage_root_credential_name,
cloud,
created_at,
created_by,
delta_sharing_recipient_token_lifetime_in_seconds,
delta_sharing_scope,
external_access_enabled,
owner,
privilege_model_version,
region,
storage_root,
updated_at,
updated_by;

DELETE examples

delete

Deletes a metastore. The caller must be a metastore admin.

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