List table summaries. — list_table_summaries • databricks

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

Usage

list_table_summaries(
  client,
  catalog_name,
  max_results = NULL,
  page_token = NULL,
  schema_name_pattern = NULL,
  table_name_pattern = NULL
)

tablesListSummaries(
  client,
  catalog_name,
  max_results = NULL,
  page_token = NULL,
  schema_name_pattern = NULL,
  table_name_pattern = NULL
)

Arguments

client: Required. Instance of DatabricksClient()
catalog_name: Required. Name of parent catalog for tables of interest.
max_results: Maximum number of summaries for tables to return.
page_token: Opaque pagination token to go to next page based on previous query.
schema_name_pattern: A sql LIKE pattern (% and _) for schema names.
table_name_pattern: A sql LIKE pattern (% and _) for table names.

Value

data.frame with all of the response pages.

Details

summaries for tables (within the current metastore and parent catalog and schema), when the user is a metastore admin, or: * summaries for tables and schemas (within the current metastore and parent catalog) for which the user has ownership or the SELECT privilege on the table and ownership or USE_SCHEMA privilege on the schema, provided that the user also has ownership or the USE_CATALOG privilege on the parent catalog.

There is no guarantee of a specific ordering of the elements in the array.