system_schemas

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

Overview

Name	system_schemas
Type	Resource
Id	databricks_workspace.unitycatalog.system_schemas

Fields

The following fields are returned by SELECT queries:

list

The schemas list was successfully retrieved.

Name	Datatype	Description
schema	string
state	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name		Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin.
disable	exec	deployment_name		Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.
enable	exec	deployment_name		Enables the system schema and adds it to the system catalog. The caller must be an account admin or 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

list

Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin.

SELECT
schema,
state
FROM databricks_workspace.unitycatalog.system_schemas
WHERE deployment_name = '{{ deployment_name }}' -- required;

Lifecycle Methods

disable

Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.

EXEC databricks_workspace.unitycatalog.system_schemas.disable 
@deployment_name='{{ deployment_name }}' --required;

enable

Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin.

EXEC databricks_workspace.unitycatalog.system_schemas.enable 
@deployment_name='{{ deployment_name }}' --required;