com.databricks.sdk.service.catalog

Interface CatalogsService

@Generated
public interface CatalogsService

A catalog is the first layer of Unity Catalog’s three-level namespace. It’s used to organize your data assets. Users can see all catalogs on which they have been assigned the USE_CATALOG data permission.

In Unity Catalog, admins and data stewards manage users and their access to data centrally across all of the workspaces in a Databricks account. Users in different workspaces can share access to the same data, depending on privileges granted centrally in Unity Catalog.

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
CatalogInfo	create(CreateCatalog createCatalog) Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege.
void	delete(DeleteCatalogRequest deleteCatalogRequest) Deletes the catalog that matches the supplied name.
CatalogInfo	get(GetCatalogRequest getCatalogRequest) Gets the specified catalog in a metastore.
ListCatalogsResponse	list(ListCatalogsRequest listCatalogsRequest) Gets an array of catalogs in the metastore.
CatalogInfo	update(UpdateCatalog updateCatalog) Updates the catalog that matches the supplied name.

Method Detail

create

CatalogInfo create(CreateCatalog createCatalog)

Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the **CREATE_CATALOG** privilege.

delete

void delete(DeleteCatalogRequest deleteCatalogRequest)

Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog.

get

CatalogInfo get(GetCatalogRequest getCatalogRequest)

Gets the specified catalog in a metastore. The caller must be a metastore admin, the owner of the catalog, or a user that has the **USE_CATALOG** privilege set for their account.

list

ListCatalogsResponse list(ListCatalogsRequest listCatalogsRequest)

Gets an array of catalogs in the metastore. If the caller is the metastore admin, all catalogs will be retrieved. Otherwise, only catalogs owned by the caller (or for which the caller has the **USE_CATALOG** 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

CatalogInfo update(UpdateCatalog updateCatalog)

Updates the catalog that matches the supplied name. The caller must be either the owner of the catalog, or a metastore admin (when changing the owner field of the catalog).