metastores

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

Overview

Name	metastores
Type	Resource
Id	databricks_account.unity_catalog.metastores

Fields

The following fields are returned by SELECT queries:

get

The metastore was successfully returned.

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

Metastores were returned successfully.

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			Gets a Unity Catalog metastore from an account, both specified by ID.
list	select			Gets all Unity Catalog metastores associated with an account specified by ID.
create	insert			Creates a Unity Catalog metastore.
update	replace			Updates an existing Unity Catalog metastore.
delete	delete			Deletes a Unity Catalog metastore for an account, both specified by 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

SELECT examples

get

Gets a Unity Catalog metastore from an account, both specified by 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_account.unity_catalog.metastores;

list

Gets all Unity Catalog metastores associated with an account specified by 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_account.unity_catalog.metastores;

INSERT examples

create

Creates a Unity Catalog metastore.

INSERT INTO databricks_account.unity_catalog.metastores (
data__metastore_info
)
SELECT 
'{{ metastore_info }}'
;

Manifest

# Description fields are for documentation purposes
- name: metastores
  props:
    - name: metastore_info
      value: object

REPLACE examples

update

Updates an existing Unity Catalog metastore.

REPLACE databricks_account.unity_catalog.metastores
SET 
data__metastore_info = '{{ metastore_info }}'
WHERE 
;

DELETE examples

delete

Deletes a Unity Catalog metastore for an account, both specified by ID.

DELETE FROM databricks_account.unity_catalog.metastores;