com.databricks.sdk.service.catalog

Class TablesAPI

java.lang.Object

com.databricks.sdk.service.catalog.TablesAPI

@Generated
public class TablesAPI
extends Object

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).

Constructor Summary

Constructors

Constructor and Description
TablesAPI(ApiClient apiClient) Regular-use constructor
TablesAPI(TablesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
TableInfo	create(CreateTableRequest request) Creates a new table in the specified catalog and schema.
void	delete(DeleteTableRequest request) Deletes a table from the specified parent catalog and schema.
void	delete(String fullName)
TableExistsResponse	exists(ExistsRequest request) Gets if a table exists in the metastore for a specific catalog and schema.
TableExistsResponse	exists(String fullName)
TableInfo	get(GetTableRequest request) Gets a table from the metastore for a specific catalog and schema.
TableInfo	get(String fullName)
TablesService	impl()
Iterable<TableInfo>	list(ListTablesRequest request) Gets an array of all tables for the current metastore under the parent catalog and schema.
Iterable<TableInfo>	list(String catalogName, String schemaName)
Iterable<TableSummary>	listSummaries(ListSummariesRequest request) Gets an array of summaries for tables for a schema and catalog within the metastore.
Iterable<TableSummary>	listSummaries(String catalogName)
void	update(UpdateTableRequest request) Change the owner of the table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TablesAPI

public TablesAPI(ApiClient apiClient)

Regular-use constructor

TablesAPI

public TablesAPI(TablesService mock)

Constructor for mocks

Method Detail

create

public TableInfo create(CreateTableRequest request)

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.

delete

public void delete(String fullName)

delete

public void delete(DeleteTableRequest request)

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.

exists

public TableExistsResponse exists(String fullName)

exists

public TableExistsResponse exists(ExistsRequest request)

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

get

public TableInfo get(String fullName)

get

public TableInfo get(GetTableRequest request)

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.

list

public Iterable<TableInfo> list(String catalogName,
                                String schemaName)

list

public Iterable<TableInfo> list(ListTablesRequest request)

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.

listSummaries

public Iterable<TableSummary> listSummaries(String catalogName)

listSummaries

public Iterable<TableSummary> listSummaries(ListSummariesRequest request)

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.

update

public void update(UpdateTableRequest request)

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.

impl

public TablesService impl()