com.databricks.sdk.service.catalog

Class SystemSchemasAPI

java.lang.Object

com.databricks.sdk.service.catalog.SystemSchemasAPI

@Generated
public class SystemSchemasAPI
extends Object

A system schema is a schema that lives within the system catalog. A system schema may contain information about customer usage of Unity Catalog such as audit-logs, billing-logs, lineage information, etc.

Constructor Summary

Constructors

Constructor and Description
SystemSchemasAPI(ApiClient apiClient) Regular-use constructor
SystemSchemasAPI(SystemSchemasService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	disable(DisableRequest request) Disables the system schema and removes it from the system catalog.
void	disable(String metastoreId, String schemaName)
void	enable(EnableRequest request) Enables the system schema and adds it to the system catalog.
SystemSchemasService	impl()
Iterable<SystemSchemaInfo>	list(ListSystemSchemasRequest request) Gets an array of system schemas for a metastore.
Iterable<SystemSchemaInfo>	list(String metastoreId)

Methods inherited from class java.lang.Object

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

Constructor Detail

SystemSchemasAPI

public SystemSchemasAPI(ApiClient apiClient)

Regular-use constructor

SystemSchemasAPI

public SystemSchemasAPI(SystemSchemasService mock)

Constructor for mocks

Method Detail

disable

public void disable(String metastoreId,
                    String schemaName)

disable

public void disable(DisableRequest request)

Disables the system schema and removes it from the system catalog. The caller must be an account admin or a metastore admin.

enable

public void enable(EnableRequest request)

Enables the system schema and adds it to the system catalog. The caller must be an account admin or a metastore admin.

list

public Iterable<SystemSchemaInfo> list(String metastoreId)

list

public Iterable<SystemSchemaInfo> list(ListSystemSchemasRequest request)

Gets an array of system schemas for a metastore. The caller must be an account admin or a metastore admin.

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.

impl

public SystemSchemasService impl()