w.system_schemas: SystemSchemas

class databricks.sdk.service.catalog.SystemSchemasAPI

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.

disable(metastore_id: str, schema_name: str)

Disable a system schema.

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

Parameters:

  • metastore_id – str The metastore ID under which the system schema lives.

  • schema_name – str Full name of the system schema.

enable(metastore_id: str, schema_name: str)

Enable a system schema.

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

Parameters:

  • metastore_id – str The metastore ID under which the system schema lives.

  • schema_name – str Full name of the system schema.

list(metastore_id: str [, max_results: Optional[int], page_token: Optional[str]]) → Iterator[SystemSchemaInfo]

List system schemas.

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

Parameters:

  • metastore_id – str The ID for the metastore in which the system schema resides.

  • max_results – int (optional) Maximum number of schemas to return. - When set to 0, the page length is set to a server configured value (recommended); - When set to a value greater than 0, the page length is the minimum of this value and a server configured value; - When set to a value less than 0, an invalid parameter error is returned; - If not set, all the schemas are returned (not recommended).

  • page_token – str (optional) Opaque pagination token to go to next page based on previous query.

Returns:

Iterator over SystemSchemaInfo