tables

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

Overview

Name	tables
Type	Resource
Id	databricks_workspace.unitycatalog.tables

Fields

The following fields are returned by SELECT queries:

list

The tables list was successfully retrieved.

Name	Datatype	Description
name	string
data_access_configuration_id	string
metastore_id	string
pipeline_id	string
table_id	string
catalog_name	string
full_name	string
schema_name	string
storage_credential_name	string
access_point	string
browse_only	boolean
columns	array
comment	string
created_at	integer
created_by	string
data_source_format	string
deleted_at	integer
delta_runtime_properties_kvpairs	object
effective_predictive_optimization_flag	object
enable_predictive_optimization	string
owner	string
properties	object
row_filter	object
sql_path	string
storage_location	string
table_constraints	array
table_type	string
updated_at	integer
updated_by	string
view_definition	string
view_dependencies	object

get

The table was successfully retrieved.

Name	Datatype	Description
name	string
data_access_configuration_id	string
metastore_id	string
pipeline_id	string
table_id	string
catalog_name	string
full_name	string
schema_name	string
storage_credential_name	string
access_point	string
browse_only	boolean
columns	array
comment	string
created_at	integer
created_by	string
data_source_format	string
deleted_at	integer
delta_runtime_properties_kvpairs	object
effective_predictive_optimization_flag	object
enable_predictive_optimization	string
owner	string
properties	object
row_filter	object
sql_path	string
storage_location	string
table_constraints	array
table_type	string
updated_at	integer
updated_by	string
view_definition	string
view_dependencies	object

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 all tables for the current metastore under the parent catalog and schema. The caller must be a metastore admin or an owner of (or have the
get	select	deployment_name		Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements:
delete	delete	deployment_name		Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the

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 all tables for the current metastore under the parent catalog and schema. The caller must be a metastore admin or an owner of (or have the

SELECT
name,
data_access_configuration_id,
metastore_id,
pipeline_id,
table_id,
catalog_name,
full_name,
schema_name,
storage_credential_name,
access_point,
browse_only,
columns,
comment,
created_at,
created_by,
data_source_format,
deleted_at,
delta_runtime_properties_kvpairs,
effective_predictive_optimization_flag,
enable_predictive_optimization,
owner,
properties,
row_filter,
sql_path,
storage_location,
table_constraints,
table_type,
updated_at,
updated_by,
view_definition,
view_dependencies
FROM databricks_workspace.unitycatalog.tables
WHERE deployment_name = '{{ deployment_name }}' -- required;

get

Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements:

SELECT
name,
data_access_configuration_id,
metastore_id,
pipeline_id,
table_id,
catalog_name,
full_name,
schema_name,
storage_credential_name,
access_point,
browse_only,
columns,
comment,
created_at,
created_by,
data_source_format,
deleted_at,
delta_runtime_properties_kvpairs,
effective_predictive_optimization_flag,
enable_predictive_optimization,
owner,
properties,
row_filter,
sql_path,
storage_location,
table_constraints,
table_type,
updated_at,
updated_by,
view_definition,
view_dependencies
FROM databricks_workspace.unitycatalog.tables
WHERE deployment_name = '{{ deployment_name }}' -- required;

DELETE examples

delete

Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the

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