Class MetastoresClient

Creates a Unity Catalog metastore.

Creates an assignment to a metastore for a workspace

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.

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.

Deletes a Unity Catalog metastore for an account, both specified by ID.

Deletes a metastore assignment to a workspace, leaving the workspace with no metastore.

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

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

Gets a Unity Catalog metastore from an account, both specified by ID.

Gets the metastore assignment for the workspace being accessed.

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

Gets the metastore assignment, if any, for the workspace specified by ID. If the workspace is assigned a metastore, the mapping will be returned. If no metastore is assigned to the workspace, the assignment will not be found and a 404 returned.

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

Gets all Unity Catalog metastores associated with an account specified by ID.

Gets a list of all workspace IDs that have been assigned to given metastore.

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.

Updates an existing Unity Catalog metastore.

Updates an assignment to a metastore for a workspace. Currently, only the default catalog may be updated.

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.

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.