Class CatalogsClient

Index

Constructors

Methods

createCatalog deleteCatalog getCatalog listCatalogs listCatalogsIter updateCatalog

Constructors

constructor

new CatalogsClient(options: ClientOptions): CatalogsClient
Parameters
- options: ClientOptions
Returns CatalogsClient
- Defined in client.ts:55

Methods

createCatalog

createCatalog(
req: CreateCatalogRequest,
options?: CallOptions,
): Promise<CatalogInfo>
Creates a new catalog instance in the parent metastore if the caller is a metastore admin or has the CREATE_CATALOG privilege.
Parameters
- req: CreateCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<CatalogInfo>
- Defined in client.ts:71

deleteCatalog

deleteCatalog(
req: DeleteCatalogRequest,
options?: CallOptions,
): Promise<DeleteCatalogResponse>
Deletes the catalog that matches the supplied name. The caller must be a metastore admin or the owner of the catalog.
Parameters
- req: DeleteCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteCatalogResponse>
- Defined in client.ts:101

getCatalog

getCatalog(req: GetCatalogRequest, options?: CallOptions): Promise<CatalogInfo>
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.
Parameters
- req: GetCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<CatalogInfo>
- Defined in client.ts:139

listCatalogs

listCatalogs(
req: ListCatalogsRequest,
options?: CallOptions,
): Promise<ListCatalogsResponse>
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.
Parameters
- req: ListCatalogsRequest
- Optionaloptions: CallOptions
Returns Promise<ListCatalogsResponse>
- Defined in client.ts:184

listCatalogsIter

listCatalogsIter(
req: ListCatalogsRequest,
options?: CallOptions,
): AsyncGenerator<CatalogInfo>
Parameters
- req: ListCatalogsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<CatalogInfo>
- Defined in client.ts:227

updateCatalog

updateCatalog(
req: UpdateCatalogRequest,
options?: CallOptions,
): Promise<CatalogInfo>
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).
Parameters
- req: UpdateCatalogRequest
- Optionaloptions: CallOptions
Returns Promise<CatalogInfo>
- Defined in client.ts:248