metastore_summary
Creates, updates, deletes, gets or lists a metastore_summary resource.
Overview
| Name | metastore_summary |
| Type | Resource |
| Id | databricks_workspace.catalog.metastore_summary |
Fields
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
name | string | The user-specified name of the metastore. |
default_data_access_config_id | string | Unique identifier of the metastore's (Default) Data Access Configuration. |
global_metastore_id | string | Globally unique metastore ID across clouds and regions, of the form `cloud:region:metastore_id`. |
metastore_id | string | Unique identifier of metastore. |
storage_root_credential_id | string | UUID of storage credential to access the metastore storage_root. |
delta_sharing_organization_name | string | The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name. |
storage_root_credential_name | string | Name of the storage credential to access the metastore storage_root. |
cloud | string | |
created_at | integer | Time at which this metastore was created, in epoch milliseconds. |
created_by | string | Username of metastore creator. |
delta_sharing_recipient_token_lifetime_in_seconds | integer | The lifetime of delta sharing recipient token in seconds. |
delta_sharing_scope | string | The scope of Delta Sharing enabled for the metastore. (INTERNAL, INTERNAL_AND_EXTERNAL) |
external_access_enabled | boolean | Whether to allow non-DBR clients to directly access entities under the metastore. |
owner | string | The owner of the metastore. |
privilege_model_version | string | Privilege model version of the metastore, of the form `major.minor` (e.g., `1.0`). |
region | string | Cloud region which the metastore serves (e.g., `us-west-2`, `westus`). |
storage_root | string | The storage root URL for metastore |
updated_at | integer | Time at which the metastore was last modified, in epoch milliseconds. |
updated_by | string | Username of user who last modified the metastore. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | deployment_name | Gets information about a metastore. This summary includes the storage credential, the cloud vendor, |
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 information about a metastore. This summary includes the storage credential, the cloud vendor,
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.catalog.metastore_summary
WHERE deployment_name = '{{ deployment_name }}' -- required
;