metastore_summary

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

Overview

Name	metastore_summary
Type	Resource
Id	databricks_workspace.unitycatalog.metastore_summary

Fields

The following fields are returned by SELECT queries:

summary

The metastore summary 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
summary	select	deployment_name		Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.

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

summary

Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.

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.metastore_summary
WHERE deployment_name = '{{ deployment_name }}' -- required;