`w.tables`: Tables¶

class databricks.sdk.service.catalog.TablesAPI¶

A table resides in the third layer of Unity Catalog’s three-level namespace. It contains rows of data. To create a table, users must have CREATE_TABLE and USE_SCHEMA permissions on the schema, and they must have the USE_CATALOG permission on its parent catalog. To query a table, users must have the SELECT permission on the table, and they must have the USE_CATALOG permission on its parent catalog and the USE_SCHEMA permission on its parent schema.

A table can be managed or external. From an API perspective, a __VIEW__ is a particular kind of table (rather than a managed or external table).

create(name: str, catalog_name: str, schema_name: str, table_type: TableType, data_source_format: DataSourceFormat, storage_location: str [, columns: Optional[List[ColumnInfo]], properties: Optional[Dict[str, str]]]) → TableInfo¶

Creates a new table in the specified catalog and schema.

To create an external delta table, the caller must have the EXTERNAL_USE_SCHEMA privilege on the parent schema and the EXTERNAL_USE_LOCATION privilege on the external location. These privileges must always be granted explicitly, and cannot be inherited through ownership or ALL_PRIVILEGES.

Standard UC permissions needed to create tables still apply: USE_CATALOG on the parent catalog (or ownership of the parent catalog), CREATE_TABLE and USE_SCHEMA on the parent schema (or ownership of the parent schema), and CREATE_EXTERNAL_TABLE on external location.

The columns field needs to be in a Spark compatible format, so we recommend you use Spark to create these tables. The API itself does not validate the correctness of the column spec. If the spec is not Spark compatible, the tables may not be readable by Databricks Runtime.

NOTE: The Create Table API for external clients only supports creating external delta tables. The values shown in the respective enums are all values supported by Databricks, however for this specific Create Table API, only table_type EXTERNAL and data_source_format DELTA are supported. Additionally, column masks are not supported when creating tables through this API.

Parameters:

name – str Name of table, relative to parent schema.
catalog_name – str Name of parent catalog.
schema_name – str Name of parent schema relative to its parent catalog.
table_type – TableType
data_source_format – DataSourceFormat
storage_location – str Storage root URL for table (for MANAGED, EXTERNAL tables).
columns – List[ColumnInfo] (optional) The array of __ColumnInfo__ definitions of the table’s columns.
properties – Dict[str,str] (optional) A map of key-value properties attached to the securable.

Returns:

TableInfo

delete(full_name: str)¶

Deletes a table from the specified parent catalog and schema. The caller must be the owner of the parent catalog, have the USE_CATALOG privilege on the parent catalog and be the owner of the parent schema, or be the owner of the table and have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema.

Parameters:: full_name – str Full name of the table.

exists(full_name: str) → TableExistsResponse¶

Gets if a table exists in the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the owner of the parent schema and have the USE_CATALOG privilege on the parent catalog * Have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema, and either be the table owner or have the SELECT privilege on the table. * Have BROWSE privilege on the parent catalog * Have BROWSE privilege on the parent schema

Parameters:: full_name – str Full name of the table.
Returns:: TableExistsResponse

get(full_name: str [, include_browse: Optional[bool], include_delta_metadata: Optional[bool], include_manifest_capabilities: Optional[bool]]) → TableInfo¶

Usage:

import os
import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

table_name = f"sdk-{time.time_ns()}"

created_catalog = w.catalogs.create(name=f"sdk-{time.time_ns()}")

created_schema = w.schemas.create(name=f"sdk-{time.time_ns()}", catalog_name=created_catalog.name)

_ = w.statement_execution.execute(
    warehouse_id=os.environ["TEST_DEFAULT_WAREHOUSE_ID"],
    catalog=created_catalog.name,
    schema=created_schema.name,
    statement="CREATE TABLE %s AS SELECT 2+2 as four" % (table_name),
).result()

table_full_name = "%s.%s.%s" % (
    created_catalog.name,
    created_schema.name,
    table_name,
)

created_table = w.tables.get(full_name=table_full_name)

# cleanup
w.schemas.delete(full_name=created_schema.full_name)
w.catalogs.delete(name=created_catalog.name, force=True)
w.tables.delete(full_name=table_full_name)

Gets a table from the metastore for a specific catalog and schema. The caller must satisfy one of the following requirements: * Be a metastore admin * Be the owner of the parent catalog * Be the owner of the parent schema and have the USE_CATALOG privilege on the parent catalog * Have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema, and either be the table owner or have the SELECT privilege on the table.

Parameters:

full_name – str Full name of the table.
include_browse – bool (optional) Whether to include tables in the response for which the principal can only access selective metadata for.
include_delta_metadata – bool (optional) Whether delta metadata should be included in the response.
include_manifest_capabilities – bool (optional) Whether to include a manifest containing table capabilities in the response.

Returns:

TableInfo

list(catalog_name: str, schema_name: str [, include_browse: Optional[bool], include_manifest_capabilities: Optional[bool], max_results: Optional[int], omit_columns: Optional[bool], omit_properties: Optional[bool], omit_username: Optional[bool], page_token: Optional[str]]) → Iterator[TableInfo]¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created_catalog = w.catalogs.create(name=f"sdk-{time.time_ns()}")

created_schema = w.schemas.create(name=f"sdk-{time.time_ns()}", catalog_name=created_catalog.name)

summaries = w.tables.list_summaries(catalog_name=created_catalog.name, schema_name_pattern=created_schema.name)

# cleanup
w.schemas.delete(full_name=created_schema.full_name)
w.catalogs.delete(name=created_catalog.name, force=True)

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 privilege on) the table. For the latter case, the caller must also be the owner or have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema. There is no guarantee of a specific ordering of the elements in the array.

NOTE: view_dependencies and table_constraints are not returned by ListTables queries.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

Parameters:

catalog_name – str Name of parent catalog for tables of interest.
schema_name – str Parent schema of tables.
include_browse – bool (optional) Whether to include tables in the response for which the principal can only access selective metadata for.
include_manifest_capabilities – bool (optional) Whether to include a manifest containing table capabilities in the response.
max_results – int (optional) Maximum number of tables to return. If not set, all the tables are returned (not recommended). - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value (recommended); - when set to a value less than 0, an invalid parameter error is returned;
omit_columns – bool (optional) Whether to omit the columns of the table from the response or not.
omit_properties – bool (optional) Whether to omit the properties of the table from the response or not.
omit_username – bool (optional) Whether to omit the username of the table (e.g. owner, updated_by, created_by) from the response or not.
page_token – str (optional) Opaque token to send for the next page of results (pagination).

Returns:

Iterator over TableInfo

list_summaries(catalog_name: str [, include_manifest_capabilities: Optional[bool], max_results: Optional[int], page_token: Optional[str], schema_name_pattern: Optional[str], table_name_pattern: Optional[str]]) → Iterator[TableSummary]¶

Usage:

import time

from databricks.sdk import WorkspaceClient

w = WorkspaceClient()

created_catalog = w.catalogs.create(name=f"sdk-{time.time_ns()}")

created_schema = w.schemas.create(name=f"sdk-{time.time_ns()}", catalog_name=created_catalog.name)

summaries = w.tables.list_summaries(catalog_name=created_catalog.name, schema_name_pattern=created_schema.name)

# cleanup
w.schemas.delete(full_name=created_schema.full_name)
w.catalogs.delete(name=created_catalog.name, force=True)

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

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.

PAGINATION BEHAVIOR: The API is by default paginated, a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

Parameters:

catalog_name – str Name of parent catalog for tables of interest.
include_manifest_capabilities – bool (optional) Whether to include a manifest containing table capabilities in the response.
max_results – int (optional) 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 – str (optional) Opaque pagination token to go to next page based on previous query.
schema_name_pattern – str (optional) A sql LIKE pattern (% and _) for schema names. All schemas will be returned if not set or empty.
table_name_pattern – str (optional) A sql LIKE pattern (% and _) for table names. All tables will be returned if not set or empty.

Returns:

Iterator over TableSummary

update(full_name: str [, owner: Optional[str]])¶

Change the owner of the table. The caller must be the owner of the parent catalog, have the USE_CATALOG privilege on the parent catalog and be the owner of the parent schema, or be the owner of the table and have the USE_CATALOG privilege on the parent catalog and the USE_SCHEMA privilege on the parent schema.

Parameters:

full_name – str Full name of the table.
owner – str (optional) Username of current owner of table.

Navigation

Related Topics

`w.tables`: Tables¶

w.tables: Tables¶

`w.tables`: Tables¶