com.databricks.sdk.service.catalog

Class MetastoresAPI

java.lang.Object

com.databricks.sdk.service.catalog.MetastoresAPI

@Generated
public class MetastoresAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
MetastoresAPI(ApiClient apiClient) Regular-use constructor
MetastoresAPI(MetastoresService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	assign(CreateMetastoreAssignment request) Creates a new metastore assignment.
MetastoreInfo	create(CreateMetastore request) 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 request) Deletes a metastore.
void	delete(String id)
MetastoreInfo	get(GetMetastoreRequest request) Gets a metastore that matches the supplied ID.
MetastoreInfo	get(String id)
MetastoresService	impl()
Iterable<MetastoreInfo>	list(ListMetastoresRequest request) Gets an array of the available metastores (as __MetastoreInfo__ objects).
GetMetastoreSummaryResponse	summary() Gets information about a metastore.
void	unassign(long workspaceId)
void	unassign(UnassignRequest request) Deletes a metastore assignment.
MetastoreInfo	update(UpdateMetastore request) Updates information for a specific metastore.
void	updateAssignment(UpdateMetastoreAssignment request) Updates a metastore assignment.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetastoresAPI

public MetastoresAPI(ApiClient apiClient)

Regular-use constructor

MetastoresAPI

public MetastoresAPI(MetastoresService mock)

Constructor for mocks

Method Detail

assign

public void assign(CreateMetastoreAssignment request)

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

public MetastoreInfo create(CreateMetastore request)

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

public MetastoreAssignment current()

Gets the metastore assignment for the workspace being accessed.

delete

public void delete(String id)

delete

public void delete(DeleteMetastoreRequest request)

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

get

public MetastoreInfo get(String id)

get

public MetastoreInfo get(GetMetastoreRequest request)

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

list

public Iterable<MetastoreInfo> list(ListMetastoresRequest request)

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

public 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

public void unassign(long workspaceId)

unassign

public void unassign(UnassignRequest request)

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

update

public MetastoreInfo update(UpdateMetastore request)

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

public void updateAssignment(UpdateMetastoreAssignment request)

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.

impl

public MetastoresService impl()