com.databricks.sdk.service.catalog

Class CatalogsAPI

java.lang.Object

com.databricks.sdk.service.catalog.CatalogsAPI

@Generated
public class CatalogsAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
CatalogsAPI(ApiClient apiClient) Regular-use constructor
CatalogsAPI(CatalogsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
CatalogInfo	create(CreateCatalog request) 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 request) Deletes the catalog that matches the supplied name.
void	delete(String name)
CatalogInfo	get(GetCatalogRequest request) Gets the specified catalog in a metastore.
CatalogInfo	get(String name)
CatalogsService	impl()
Iterable<CatalogInfo>	list(ListCatalogsRequest request) Gets an array of catalogs in the metastore.
CatalogInfo	update(UpdateCatalog request) Updates the catalog that matches the supplied name.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogsAPI

public CatalogsAPI(ApiClient apiClient)

Regular-use constructor

CatalogsAPI

public CatalogsAPI(CatalogsService mock)

Constructor for mocks

Method Detail

create

public CatalogInfo create(CreateCatalog request)

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

delete

public void delete(String name)

delete

public void delete(DeleteCatalogRequest request)

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

get

public CatalogInfo get(String name)

get

public CatalogInfo get(GetCatalogRequest request)

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

public Iterable<CatalogInfo> list(ListCatalogsRequest request)

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

public CatalogInfo update(UpdateCatalog request)

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

impl

public CatalogsService impl()