db_uc_tables_summaries: List Table Summaries (Unity Catalog)

In zacdav-db/brickster: R Toolkit for 'Databricks'

List Table Summaries (Unity Catalog)

Description

List Table Summaries (Unity Catalog)

Usage

db_uc_tables_summaries(
  catalog,
  schema_name_pattern = NULL,
  table_name_pattern = NULL,
  max_results = 10000,
  include_manifest_capabilities = FALSE,
  page_token = NULL,
  host = db_host(),
  token = db_token(),
  perform_request = TRUE
)

Arguments

catalog	Name of parent catalog for tables of interest.
schema_name_pattern	A sql LIKE pattern (⁠%⁠ and ⁠_⁠) for schema names. All schemas will be returned if not set or empty.
table_name_pattern	A sql LIKE pattern (⁠%⁠ and ⁠_⁠) for table names. All tables will be returned if not set or empty.
max_results	Maximum number of summaries for tables to return (default: 10000, max: 10000). If not set, the page length is set to a server configured value.
include_manifest_capabilities	Whether to include a manifest containing capabilities the table has.
page_token	Opaque token used to get the next page of results. Optional.
host	Databricks workspace URL, defaults to calling db_host().
token	Databricks workspace token, defaults to calling db_token().
perform_request	If TRUE (default) the request is performed, if FALSE the httr2 request is returned without being performed.

Value

List

See Also

Other Unity Catalog Table Management: db_uc_tables_delete(), db_uc_tables_exists(), db_uc_tables_get(), db_uc_tables_list()

zacdav-db/brickster documentation built on June 13, 2025, 2:39 p.m.