table_summaries

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

Overview

Name	table_summaries
Type	Resource
Id	databricks_workspace.catalog.table_summaries

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
full_name	string
▶securable_kind_manifest	object	SecurableKindManifest of table, including capabilities the table has.
table_type	string	Create a collection of name/value pairs.<br /><br />Example enumeration:<br /><br />&gt;&gt;&gt; class Color(Enum):<br />... RED = 1<br />... BLUE = 2<br />... GREEN = 3<br /><br />Access them by:<br /><br />- attribute access::<br /><br />&gt;&gt;&gt; Color.RED<br />&lt;Color.RED: 1&gt;<br /><br />- value lookup:<br /><br />&gt;&gt;&gt; Color(1)<br />&lt;Color.RED: 1&gt;<br /><br />- name lookup:<br /><br />&gt;&gt;&gt; Color['RED']<br />&lt;Color.RED: 1&gt;<br /><br />Enumerations can be iterated over, and know how many members they have:<br /><br />&gt;&gt;&gt; len(Color)<br />3<br /><br />&gt;&gt;&gt; list(Color)<br />[&lt;Color.RED: 1&gt;, &lt;Color.BLUE: 2&gt;, &lt;Color.GREEN: 3&gt;]<br /><br />Methods can be added to enumerations, and members can have their own<br />attributes -- see the documentation for details. (EXTERNAL, EXTERNAL_SHALLOW_CLONE, FOREIGN, MANAGED, MANAGED_SHALLOW_CLONE, MATERIALIZED_VIEW, METRIC_VIEW, STREAMING_TABLE, VIEW)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	catalog_name, deployment_name	include_manifest_capabilities, max_results, page_token, schema_name_pattern, table_name_pattern	Gets an array of summaries for tables for a schema and catalog within the metastore. The table

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
catalog_name	string	Name of parent catalog for tables of interest.
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)
include_manifest_capabilities	boolean	Whether to include a manifest containing table capabilities in the response.
max_results	integer	Maximum number of summaries for tables to return. If not set, the page length is set to a server configured value (10000, as of 1/5/2024). - when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/5/2024); - when set to 0, the page length is set to a server configured value (10000, as of 1/5/2024) (recommended); - when set to a value less than 0, an invalid parameter error is returned;
page_token	string	Opaque pagination token to go to next page based on previous query.
schema_name_pattern	string	A sql LIKE pattern (% and _) for schema names. All schemas will be returned if not set or empty.
table_name_pattern	string	A sql LIKE pattern (% and _) for table names. All tables will be returned if not set or empty.

SELECT examples

list

Gets an array of summaries for tables for a schema and catalog within the metastore. The table

SELECT
full_name,
securable_kind_manifest,
table_type
FROM databricks_workspace.catalog.table_summaries
WHERE catalog_name = '{{ catalog_name }}' -- required
AND deployment_name = '{{ deployment_name }}' -- required
AND include_manifest_capabilities = '{{ include_manifest_capabilities }}'
AND max_results = '{{ max_results }}'
AND page_token = '{{ page_token }}'
AND schema_name_pattern = '{{ schema_name_pattern }}'
AND table_name_pattern = '{{ table_name_pattern }}'
;