com.databricks.sdk.service.catalog

Interface SchemasService

@Generated
public interface SchemasService

A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace. A schema organizes tables, views and functions. To access (or list) a table or view in a schema, users must have the USE_SCHEMA data permission on the schema and its parent catalog, and they must have the SELECT permission on the table or view.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
SchemaInfo	create(CreateSchema createSchema) Creates a new schema for catalog in the Metastore.
void	delete(DeleteSchemaRequest deleteSchemaRequest) Deletes the specified schema from the parent catalog.
SchemaInfo	get(GetSchemaRequest getSchemaRequest) Gets the specified schema within the metastore.
ListSchemasResponse	list(ListSchemasRequest listSchemasRequest) Gets an array of schemas for a catalog in the metastore.
SchemaInfo	update(UpdateSchema updateSchema) Updates a schema for a catalog.

Method Detail

create

SchemaInfo create(CreateSchema createSchema)

Creates a new schema for catalog in the Metastore. The caller must be a metastore admin, or have the **CREATE_SCHEMA** privilege in the parent catalog.

delete

void delete(DeleteSchemaRequest deleteSchemaRequest)

Deletes the specified schema from the parent catalog. The caller must be the owner of the schema or an owner of the parent catalog.

get

SchemaInfo get(GetSchemaRequest getSchemaRequest)

Gets the specified schema within the metastore. The caller must be a metastore admin, the owner of the schema, or a user that has the **USE_SCHEMA** privilege on the schema.

list

ListSchemasResponse list(ListSchemasRequest listSchemasRequest)

Gets an array of schemas for a catalog in the metastore. If the caller is the metastore admin or the owner of the parent catalog, all schemas for the catalog will be retrieved. Otherwise, only schemas owned by the caller (or for which the caller has the **USE_SCHEMA** privilege) will be retrieved. There is no guarantee of a specific ordering of the elements in the array.

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.

update

SchemaInfo update(UpdateSchema updateSchema)

Updates a schema for a catalog. The caller must be the owner of the schema or a metastore admin. If the caller is a metastore admin, only the __owner__ field can be changed in the update. If the __name__ field must be updated, the caller must be a metastore admin or have the **CREATE_SCHEMA** privilege on the parent catalog.