com.databricks.sdk.service.catalog

Interface MetastoresService

@Generated
public interface MetastoresService

A metastore is the top-level container of objects in Unity Catalog. It stores data assets (tables and views) and the permissions that govern access to them. Databricks account admins can create metastores and assign them to Databricks workspaces to control which workloads use each metastore. For a workspace to use Unity Catalog, it must have a Unity Catalog metastore attached.

Each metastore is configured with a root storage location in a cloud storage account. This storage location is used for metadata and managed tables data.

NOTE: This metastore is distinct from the metastore included in Databricks workspaces created before Unity Catalog was released. If your workspace includes a legacy Hive metastore, the data in that metastore is available in a catalog named hive_metastore.

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
void	assign(CreateMetastoreAssignment createMetastoreAssignment) Creates a new metastore assignment.
MetastoreInfo	create(CreateMetastore createMetastore) Creates a new metastore based on a provided name and optional storage root path.
MetastoreAssignment	current() Gets the metastore assignment for the workspace being accessed.
void	delete(DeleteMetastoreRequest deleteMetastoreRequest) Deletes a metastore.
MetastoreInfo	get(GetMetastoreRequest getMetastoreRequest) Gets a metastore that matches the supplied ID.
ListMetastoresResponse	list(ListMetastoresRequest listMetastoresRequest) Gets an array of the available metastores (as __MetastoreInfo__ objects).
GetMetastoreSummaryResponse	summary() Gets information about a metastore.
void	unassign(UnassignRequest unassignRequest) Deletes a metastore assignment.
MetastoreInfo	update(UpdateMetastore updateMetastore) Updates information for a specific metastore.
void	updateAssignment(UpdateMetastoreAssignment updateMetastoreAssignment) Updates a metastore assignment.

Method Detail

assign

void assign(CreateMetastoreAssignment createMetastoreAssignment)

Creates a new metastore assignment. If an assignment for the same __workspace_id__ exists, it will be overwritten by the new __metastore_id__ and __default_catalog_name__. The caller must be an account admin.

create

MetastoreInfo create(CreateMetastore createMetastore)

Creates a new metastore based on a provided name and optional storage root path. By default (if the __owner__ field is not set), the owner of the new metastore is the user calling the __createMetastore__ API. If the __owner__ field is set to the empty string (**""**), the ownership is assigned to the System User instead.

current

MetastoreAssignment current()

Gets the metastore assignment for the workspace being accessed.

delete

void delete(DeleteMetastoreRequest deleteMetastoreRequest)

Deletes a metastore. The caller must be a metastore admin.

get

MetastoreInfo get(GetMetastoreRequest getMetastoreRequest)

Gets a metastore that matches the supplied ID. The caller must be a metastore admin to retrieve this info.

list

ListMetastoresResponse list(ListMetastoresRequest listMetastoresRequest)

Gets an array of the available metastores (as __MetastoreInfo__ objects). The caller must be an admin to retrieve this info. 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.

summary

GetMetastoreSummaryResponse summary()

Gets information about a metastore. This summary includes the storage credential, the cloud vendor, the cloud region, and the global metastore ID.

unassign

void unassign(UnassignRequest unassignRequest)

Deletes a metastore assignment. The caller must be an account administrator.

update

MetastoreInfo update(UpdateMetastore updateMetastore)

Updates information for a specific metastore. The caller must be a metastore admin. If the __owner__ field is set to the empty string (**""**), the ownership is updated to the System User.

updateAssignment

void updateAssignment(UpdateMetastoreAssignment updateMetastoreAssignment)

Updates a metastore assignment. This operation can be used to update __metastore_id__ or __default_catalog_name__ for a specified Workspace, if the Workspace is already assigned a metastore. The caller must be an account admin to update __metastore_id__; otherwise, the caller can be a Workspace admin.