com.databricks.sdk.service.catalog.MetastoresAPI Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of databricks-sdk-java Show documentation
There is a newer version: 0.35.0
// Code generated from OpenAPI specs by Databricks SDK Generator. DO NOT EDIT.
package com.databricks.sdk.service.catalog;

import com.databricks.sdk.core.ApiClient;
import com.databricks.sdk.support.Generated;
import com.databricks.sdk.support.Paginator;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 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.
 */
@Generated
public class MetastoresAPI {
  private static final Logger LOG = LoggerFactory.getLogger(MetastoresAPI.class);

  private final MetastoresService impl;

  /** Regular-use constructor */
  public MetastoresAPI(ApiClient apiClient) {
    impl = new MetastoresImpl(apiClient);
  }

  /** Constructor for mocks */
  public MetastoresAPI(MetastoresService mock) {
    impl = mock;
  }

  public void assign(long workspaceId, String metastoreId, String defaultCatalogName) {
    assign(
        new CreateMetastoreAssignment()
            .setWorkspaceId(workspaceId)
            .setMetastoreId(metastoreId)
            .setDefaultCatalogName(defaultCatalogName));
  }

  /**
   * Create an assignment.
   *
   * 
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.
   */
  public void assign(CreateMetastoreAssignment request) {
    impl.assign(request);
  }

  public MetastoreInfo create(String name) {
    return create(new CreateMetastore().setName(name));
  }

  /**
   * Create a metastore.
   *
   * 
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.
   */
  public MetastoreInfo create(CreateMetastore request) {
    return impl.create(request);
  }

  /**
   * Get metastore assignment for workspace.
   *
   * 
Gets the metastore assignment for the workspace being accessed.
   */
  public MetastoreAssignment current() {
    return impl.current();
  }

  public void delete(String id) {
    delete(new DeleteMetastoreRequest().setId(id));
  }

  /**
   * Delete a metastore.
   *
   * 
Deletes a metastore. The caller must be a metastore admin.
   */
  public void delete(DeleteMetastoreRequest request) {
    impl.delete(request);
  }

  public MetastoreInfo get(String id) {
    return get(new GetMetastoreRequest().setId(id));
  }

  /**
   * Get a metastore.
   *
   * 
Gets a metastore that matches the supplied ID. The caller must be a metastore admin to
   * retrieve this info.
   */
  public MetastoreInfo get(GetMetastoreRequest request) {
    return impl.get(request);
  }

  /**
   * List metastores.
   *
   * 
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.
   */
  public Iterable list() {
    return new Paginator<>(
        null, (Void v) -> impl.list(), ListMetastoresResponse::getMetastores, response -> null);
  }

  /**
   * Get a metastore summary.
   *
   * 
Gets information about a metastore. This summary includes the storage credential, the cloud
   * vendor, the cloud region, and the global metastore ID.
   */
  public GetMetastoreSummaryResponse summary() {
    return impl.summary();
  }

  public void unassign(long workspaceId, String metastoreId) {
    unassign(new UnassignRequest().setWorkspaceId(workspaceId).setMetastoreId(metastoreId));
  }

  /**
   * Delete an assignment.
   *
   * 
Deletes a metastore assignment. The caller must be an account administrator.
   */
  public void unassign(UnassignRequest request) {
    impl.unassign(request);
  }

  public MetastoreInfo update(String id) {
    return update(new UpdateMetastore().setId(id));
  }

  /**
   * Update a metastore.
   *
   * 
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.
   */
  public MetastoreInfo update(UpdateMetastore request) {
    return impl.update(request);
  }

  public void updateAssignment(long workspaceId) {
    updateAssignment(new UpdateMetastoreAssignment().setWorkspaceId(workspaceId));
  }

  /**
   * Update an assignment.
   *
   * 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.
   */
  public void updateAssignment(UpdateMetastoreAssignment request) {
    impl.updateAssignment(request);
  }

  public MetastoresService impl() {
    return impl;
  }
}