Unity Catalog¶

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.catalog module.

class databricks.sdk.service.catalog.AccountsCreateMetastore¶

metastore_info: CreateMetastore | None = None¶

as_dict() → dict¶: Serializes the AccountsCreateMetastore into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsCreateMetastore¶: Deserializes the AccountsCreateMetastore from a dictionary.

class databricks.sdk.service.catalog.AccountsCreateMetastoreAssignment¶

metastore_assignment: CreateMetastoreAssignment | None = None¶

metastore_id: str | None = None¶: Unity Catalog metastore ID

workspace_id: int | None = None¶: Workspace ID.

as_dict() → dict¶: Serializes the AccountsCreateMetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsCreateMetastoreAssignment¶: Deserializes the AccountsCreateMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.AccountsCreateStorageCredential¶

credential_info: CreateStorageCredential | None = None¶

metastore_id: str | None = None¶: Unity Catalog metastore ID

as_dict() → dict¶: Serializes the AccountsCreateStorageCredential into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsCreateStorageCredential¶: Deserializes the AccountsCreateStorageCredential from a dictionary.

class databricks.sdk.service.catalog.AccountsMetastoreAssignment¶

metastore_assignment: MetastoreAssignment | None = None¶

as_dict() → dict¶: Serializes the AccountsMetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsMetastoreAssignment¶: Deserializes the AccountsMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.AccountsMetastoreInfo¶

metastore_info: MetastoreInfo | None = None¶

as_dict() → dict¶: Serializes the AccountsMetastoreInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsMetastoreInfo¶: Deserializes the AccountsMetastoreInfo from a dictionary.

class databricks.sdk.service.catalog.AccountsStorageCredentialInfo¶

credential_info: StorageCredentialInfo | None = None¶

as_dict() → dict¶: Serializes the AccountsStorageCredentialInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsStorageCredentialInfo¶: Deserializes the AccountsStorageCredentialInfo from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateMetastore¶

metastore_id: str | None = None¶: Unity Catalog metastore ID

metastore_info: UpdateMetastore | None = None¶

as_dict() → dict¶: Serializes the AccountsUpdateMetastore into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsUpdateMetastore¶: Deserializes the AccountsUpdateMetastore from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateMetastoreAssignment¶

metastore_assignment: UpdateMetastoreAssignment | None = None¶

metastore_id: str | None = None¶: Unity Catalog metastore ID

workspace_id: int | None = None¶: Workspace ID.

as_dict() → dict¶: Serializes the AccountsUpdateMetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsUpdateMetastoreAssignment¶: Deserializes the AccountsUpdateMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.AccountsUpdateStorageCredential¶

credential_info: UpdateStorageCredential | None = None¶

metastore_id: str | None = None¶: Unity Catalog metastore ID

storage_credential_name: str | None = None¶: Name of the storage credential.

as_dict() → dict¶: Serializes the AccountsUpdateStorageCredential into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AccountsUpdateStorageCredential¶: Deserializes the AccountsUpdateStorageCredential from a dictionary.

class databricks.sdk.service.catalog.ArtifactAllowlistInfo¶

artifact_matchers: List[ArtifactMatcher] | None = None¶: A list of allowed artifact match patterns.

created_at: int | None = None¶: Time at which this artifact allowlist was set, in epoch milliseconds.

created_by: str | None = None¶: Username of the user who set the artifact allowlist.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

as_dict() → dict¶: Serializes the ArtifactAllowlistInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ArtifactAllowlistInfo¶: Deserializes the ArtifactAllowlistInfo from a dictionary.

class databricks.sdk.service.catalog.ArtifactMatcher¶

artifact: str¶: The artifact path or maven coordinate

match_type: MatchType¶: The pattern matching type of the artifact

as_dict() → dict¶: Serializes the ArtifactMatcher into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ArtifactMatcher¶: Deserializes the ArtifactMatcher from a dictionary.

class databricks.sdk.service.catalog.ArtifactType¶

The artifact type

INIT_SCRIPT = "INIT_SCRIPT"¶

LIBRARY_JAR = "LIBRARY_JAR"¶

LIBRARY_MAVEN = "LIBRARY_MAVEN"¶

class databricks.sdk.service.catalog.AssignResponse¶

as_dict() → dict¶: Serializes the AssignResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AssignResponse¶: Deserializes the AssignResponse from a dictionary.

class databricks.sdk.service.catalog.AwsIamRoleRequest¶

role_arn: str¶: The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access.

as_dict() → dict¶: Serializes the AwsIamRoleRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AwsIamRoleRequest¶: Deserializes the AwsIamRoleRequest from a dictionary.

class databricks.sdk.service.catalog.AwsIamRoleResponse¶

role_arn: str¶: The Amazon Resource Name (ARN) of the AWS IAM role for S3 data access.

external_id: str | None = None¶: The external ID used in role assumption to prevent confused deputy problem..

unity_catalog_iam_arn: str | None = None¶: The Amazon Resource Name (ARN) of the AWS IAM user managed by Databricks. This is the identity that is going to assume the AWS IAM role.

as_dict() → dict¶: Serializes the AwsIamRoleResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AwsIamRoleResponse¶: Deserializes the AwsIamRoleResponse from a dictionary.

class databricks.sdk.service.catalog.AzureManagedIdentityRequest¶

access_connector_id: str¶: The Azure resource ID of the Azure Databricks Access Connector. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}.

managed_identity_id: str | None = None¶: The Azure resource ID of the managed identity. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}. This is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity. If this field is not provided, then we assume the AzureManagedIdentity is for a system-assigned identity.

as_dict() → dict¶: Serializes the AzureManagedIdentityRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AzureManagedIdentityRequest¶: Deserializes the AzureManagedIdentityRequest from a dictionary.

class databricks.sdk.service.catalog.AzureManagedIdentityResponse¶

access_connector_id: str¶: The Azure resource ID of the Azure Databricks Access Connector. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.Databricks/accessConnectors/{connector-name}.

credential_id: str | None = None¶: The Databricks internal ID that represents this managed identity.

managed_identity_id: str | None = None¶: The Azure resource ID of the managed identity. Use the format /subscriptions/{guid}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}. This is only available for user-assgined identities. For system-assigned identities, the access_connector_id is used to identify the identity. If this field is not provided, then we assume the AzureManagedIdentity is for a system-assigned identity.

as_dict() → dict¶: Serializes the AzureManagedIdentityResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AzureManagedIdentityResponse¶: Deserializes the AzureManagedIdentityResponse from a dictionary.

class databricks.sdk.service.catalog.AzureServicePrincipal¶

directory_id: str¶: The directory ID corresponding to the Azure Active Directory (AAD) tenant of the application.

application_id: str¶: The application ID of the application registration within the referenced AAD tenant.

client_secret: str¶: The client secret generated for the above app ID in AAD.

as_dict() → dict¶: Serializes the AzureServicePrincipal into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → AzureServicePrincipal¶: Deserializes the AzureServicePrincipal from a dictionary.

class databricks.sdk.service.catalog.CancelRefreshResponse¶

as_dict() → dict¶: Serializes the CancelRefreshResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CancelRefreshResponse¶: Deserializes the CancelRefreshResponse from a dictionary.

class databricks.sdk.service.catalog.CatalogInfo¶

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_type: CatalogType | None = None¶: The type of the catalog.

comment: str | None = None¶: User-provided free-form text description.

connection_name: str | None = None¶: The name of the connection to an external data source.

created_at: int | None = None¶: Time at which this catalog was created, in epoch milliseconds.

created_by: str | None = None¶: Username of catalog creator.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None¶

enable_predictive_optimization: EnablePredictiveOptimization | None = None¶: Whether predictive optimization should be enabled for this object and objects under it.

full_name: str | None = None¶: The full name of the catalog. Corresponds with the name field.

isolation_mode: CatalogIsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: Name of catalog.

options: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

owner: str | None = None¶: Username of current owner of catalog.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

provider_name: str | None = None¶

The name of delta sharing provider.

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.

provisioning_info: ProvisioningInfo | None = None¶: Status of an asynchronously provisioned resource.

securable_kind: CatalogInfoSecurableKind | None = None¶: Kind of catalog securable.

securable_type: str | None = None¶

share_name: str | None = None¶: The name of the share under the share provider.

storage_location: str | None = None¶: Storage Location URL (full path) for managed tables within catalog.

storage_root: str | None = None¶: Storage root URL for managed tables within catalog.

updated_at: int | None = None¶: Time at which this catalog was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified catalog.

as_dict() → dict¶: Serializes the CatalogInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CatalogInfo¶: Deserializes the CatalogInfo from a dictionary.

class databricks.sdk.service.catalog.CatalogInfoSecurableKind¶

Kind of catalog securable.

CATALOG_DELTASHARING = "CATALOG_DELTASHARING"¶

CATALOG_FOREIGN_BIGQUERY = "CATALOG_FOREIGN_BIGQUERY"¶

CATALOG_FOREIGN_DATABRICKS = "CATALOG_FOREIGN_DATABRICKS"¶

CATALOG_FOREIGN_MYSQL = "CATALOG_FOREIGN_MYSQL"¶

CATALOG_FOREIGN_POSTGRESQL = "CATALOG_FOREIGN_POSTGRESQL"¶

CATALOG_FOREIGN_REDSHIFT = "CATALOG_FOREIGN_REDSHIFT"¶

CATALOG_FOREIGN_SNOWFLAKE = "CATALOG_FOREIGN_SNOWFLAKE"¶

CATALOG_FOREIGN_SQLDW = "CATALOG_FOREIGN_SQLDW"¶

CATALOG_FOREIGN_SQLSERVER = "CATALOG_FOREIGN_SQLSERVER"¶

CATALOG_INTERNAL = "CATALOG_INTERNAL"¶

CATALOG_STANDARD = "CATALOG_STANDARD"¶

CATALOG_SYSTEM = "CATALOG_SYSTEM"¶

CATALOG_SYSTEM_DELTASHARING = "CATALOG_SYSTEM_DELTASHARING"¶

class databricks.sdk.service.catalog.CatalogIsolationMode¶

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

ISOLATED = "ISOLATED"¶

OPEN = "OPEN"¶

class databricks.sdk.service.catalog.CatalogType¶

The type of the catalog.

DELTASHARING_CATALOG = "DELTASHARING_CATALOG"¶

MANAGED_CATALOG = "MANAGED_CATALOG"¶

SYSTEM_CATALOG = "SYSTEM_CATALOG"¶

class databricks.sdk.service.catalog.CloudflareApiToken¶

access_key_id: str¶: The Cloudflare access key id of the token.

secret_access_key: str¶: The secret access token generated for the access key id

account_id: str¶: The account id associated with the API token.

as_dict() → dict¶: Serializes the CloudflareApiToken into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CloudflareApiToken¶: Deserializes the CloudflareApiToken from a dictionary.

class databricks.sdk.service.catalog.ColumnInfo¶

comment: str | None = None¶: User-provided free-form text description.

mask: ColumnMask | None = None¶

name: str | None = None¶: Name of Column.

nullable: bool | None = None¶: Whether field may be Null (default: true).

partition_index: int | None = None¶: Partition index for column.

position: int | None = None¶: Ordinal position of column (starting at position 0).

type_interval_type: str | None = None¶: Format of IntervalType.

type_json: str | None = None¶: Full data type specification, JSON-serialized.

type_name: ColumnTypeName | None = None¶: Name of type (INT, STRUCT, MAP, etc.).

type_precision: int | None = None¶: Digits of precision; required for DecimalTypes.

type_scale: int | None = None¶: Digits to right of decimal; Required for DecimalTypes.

type_text: str | None = None¶: Full data type specification as SQL/catalogString text.

as_dict() → dict¶: Serializes the ColumnInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ColumnInfo¶: Deserializes the ColumnInfo from a dictionary.

class databricks.sdk.service.catalog.ColumnMask¶

function_name: str | None = None¶: The full name of the column mask SQL UDF.

using_column_names: List[str] | None = None¶: The list of additional table columns to be passed as input to the column mask function. The first arg of the mask function should be of the type of the column being masked and the types of the rest of the args should match the types of columns in ‘using_column_names’.

as_dict() → dict¶: Serializes the ColumnMask into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ColumnMask¶: Deserializes the ColumnMask from a dictionary.

class databricks.sdk.service.catalog.ColumnTypeName¶

Name of type (INT, STRUCT, MAP, etc.).

ARRAY = "ARRAY"¶

BINARY = "BINARY"¶

BOOLEAN = "BOOLEAN"¶

BYTE = "BYTE"¶

CHAR = "CHAR"¶

DATE = "DATE"¶

DECIMAL = "DECIMAL"¶

DOUBLE = "DOUBLE"¶

FLOAT = "FLOAT"¶

INT = "INT"¶

INTERVAL = "INTERVAL"¶

LONG = "LONG"¶

MAP = "MAP"¶

NULL = "NULL"¶

SHORT = "SHORT"¶

STRING = "STRING"¶

STRUCT = "STRUCT"¶

TABLE_TYPE = "TABLE_TYPE"¶

TIMESTAMP = "TIMESTAMP"¶

TIMESTAMP_NTZ = "TIMESTAMP_NTZ"¶

USER_DEFINED_TYPE = "USER_DEFINED_TYPE"¶

class databricks.sdk.service.catalog.ConnectionInfo¶

comment: str | None = None¶: User-provided free-form text description.

connection_id: str | None = None¶: Unique identifier of the Connection.

connection_type: ConnectionType | None = None¶: The type of connection.

created_at: int | None = None¶: Time at which this connection was created, in epoch milliseconds.

created_by: str | None = None¶: Username of connection creator.

credential_type: CredentialType | None = None¶: The type of credential.

full_name: str | None = None¶: Full name of connection.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: Name of the connection.

options: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

owner: str | None = None¶: Username of current owner of the connection.

properties: Dict[str, str] | None = None¶: An object containing map of key-value properties attached to the connection.

provisioning_info: ProvisioningInfo | None = None¶: Status of an asynchronously provisioned resource.

read_only: bool | None = None¶: If the connection is read only.

securable_kind: ConnectionInfoSecurableKind | None = None¶: Kind of connection securable.

securable_type: str | None = None¶

updated_at: int | None = None¶: Time at which this connection was updated, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified connection.

url: str | None = None¶: URL of the remote data source, extracted from options.

as_dict() → dict¶: Serializes the ConnectionInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ConnectionInfo¶: Deserializes the ConnectionInfo from a dictionary.

class databricks.sdk.service.catalog.ConnectionInfoSecurableKind¶

Kind of connection securable.

CONNECTION_BIGQUERY = "CONNECTION_BIGQUERY"¶

CONNECTION_BUILTIN_HIVE_METASTORE = "CONNECTION_BUILTIN_HIVE_METASTORE"¶

CONNECTION_DATABRICKS = "CONNECTION_DATABRICKS"¶

CONNECTION_EXTERNAL_HIVE_METASTORE = "CONNECTION_EXTERNAL_HIVE_METASTORE"¶

CONNECTION_GLUE = "CONNECTION_GLUE"¶

CONNECTION_MYSQL = "CONNECTION_MYSQL"¶

CONNECTION_ONLINE_CATALOG = "CONNECTION_ONLINE_CATALOG"¶

CONNECTION_POSTGRESQL = "CONNECTION_POSTGRESQL"¶

CONNECTION_REDSHIFT = "CONNECTION_REDSHIFT"¶

CONNECTION_SNOWFLAKE = "CONNECTION_SNOWFLAKE"¶

CONNECTION_SQLDW = "CONNECTION_SQLDW"¶

CONNECTION_SQLSERVER = "CONNECTION_SQLSERVER"¶

class databricks.sdk.service.catalog.ConnectionType¶

The type of connection.

BIGQUERY = "BIGQUERY"¶

DATABRICKS = "DATABRICKS"¶

GLUE = "GLUE"¶

HIVE_METASTORE = "HIVE_METASTORE"¶

MYSQL = "MYSQL"¶

POSTGRESQL = "POSTGRESQL"¶

REDSHIFT = "REDSHIFT"¶

SNOWFLAKE = "SNOWFLAKE"¶

SQLDW = "SQLDW"¶

SQLSERVER = "SQLSERVER"¶

class databricks.sdk.service.catalog.ContinuousUpdateStatus¶

Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE or the ONLINE_UPDATING_PIPELINE_RESOURCES state.

initial_pipeline_sync_progress: PipelineProgress | None = None¶: Progress of the initial data synchronization.

last_processed_commit_version: int | None = None¶: The last source table Delta version that was synced to the online table. Note that this Delta version may not be completely synced to the online table yet.

timestamp: str | None = None¶: The timestamp of the last time any data was synchronized from the source table to the online table.

as_dict() → dict¶: Serializes the ContinuousUpdateStatus into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ContinuousUpdateStatus¶: Deserializes the ContinuousUpdateStatus from a dictionary.

class databricks.sdk.service.catalog.CreateCatalog¶

name: str¶: Name of catalog.

comment: str | None = None¶: User-provided free-form text description.

connection_name: str | None = None¶: The name of the connection to an external data source.

options: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

provider_name: str | None = None¶

The name of delta sharing provider.

A Delta Sharing catalog is a catalog that is based on a Delta share on a remote sharing server.

share_name: str | None = None¶: The name of the share under the share provider.

storage_root: str | None = None¶: Storage root URL for managed tables within catalog.

as_dict() → dict¶: Serializes the CreateCatalog into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateCatalog¶: Deserializes the CreateCatalog from a dictionary.

class databricks.sdk.service.catalog.CreateConnection¶

name: str¶: Name of the connection.

connection_type: ConnectionType¶: The type of connection.

options: Dict[str, str]¶: A map of key-value properties attached to the securable.

comment: str | None = None¶: User-provided free-form text description.

properties: Dict[str, str] | None = None¶: An object containing map of key-value properties attached to the connection.

read_only: bool | None = None¶: If the connection is read only.

as_dict() → dict¶: Serializes the CreateConnection into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateConnection¶: Deserializes the CreateConnection from a dictionary.

class databricks.sdk.service.catalog.CreateExternalLocation¶

name: str¶: Name of the external location.

url: str¶: Path URL of the external location.

credential_name: str¶: Name of the storage credential used with this location.

access_point: str | None = None¶: The AWS access point to use when accesing s3 for this external location.

comment: str | None = None¶: User-provided free-form text description.

encryption_details: EncryptionDetails | None = None¶: Encryption options that apply to clients connecting to cloud storage.

fallback: bool | None = None¶: Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.

read_only: bool | None = None¶: Indicates whether the external location is read-only.

skip_validation: bool | None = None¶: Skips validation of the storage credential associated with the external location.

as_dict() → dict¶: Serializes the CreateExternalLocation into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateExternalLocation¶: Deserializes the CreateExternalLocation from a dictionary.

class databricks.sdk.service.catalog.CreateFunction¶

name: str¶: Name of function, relative to parent schema.

catalog_name: str¶: Name of parent catalog.

schema_name: str¶: Name of parent schema relative to its parent catalog.

input_params: FunctionParameterInfos¶

data_type: ColumnTypeName¶: Scalar function return data type.

full_data_type: str¶: Pretty printed function data type.

routine_body: CreateFunctionRoutineBody¶: Function language. When EXTERNAL is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as TABLE return type is not supported), and the __sql_data_access__ field must be NO_SQL.

routine_definition: str¶: Function body.

parameter_style: CreateFunctionParameterStyle¶: Function parameter style. S is the value for SQL.

is_deterministic: bool¶: Whether the function is deterministic.

sql_data_access: CreateFunctionSqlDataAccess¶: Function SQL data access.

is_null_call: bool¶: Function null call.

security_type: CreateFunctionSecurityType¶: Function security type.

specific_name: str¶: Specific name of the function; Reserved for future use.

comment: str | None = None¶: User-provided free-form text description.

external_language: str | None = None¶: External function language.

external_name: str | None = None¶: External function name.

properties: str | None = None¶: JSON-serialized key-value pair map, encoded (escaped) as a string.

return_params: FunctionParameterInfos | None = None¶: Table function return parameters.

routine_dependencies: DependencyList | None = None¶: Function dependencies.

sql_path: str | None = None¶: List of schemes whose objects can be referenced without qualification.

as_dict() → dict¶: Serializes the CreateFunction into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateFunction¶: Deserializes the CreateFunction from a dictionary.

class databricks.sdk.service.catalog.CreateFunctionParameterStyle¶

Function parameter style. S is the value for SQL.

S = "S"¶

class databricks.sdk.service.catalog.CreateFunctionRequest¶

function_info: CreateFunction¶: Partial __FunctionInfo__ specifying the function to be created.

as_dict() → dict¶: Serializes the CreateFunctionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateFunctionRequest¶: Deserializes the CreateFunctionRequest from a dictionary.

class databricks.sdk.service.catalog.CreateFunctionRoutineBody¶

Function language. When EXTERNAL is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as TABLE return type is not supported), and the __sql_data_access__ field must be NO_SQL.

EXTERNAL = "EXTERNAL"¶

SQL = "SQL"¶

class databricks.sdk.service.catalog.CreateFunctionSecurityType¶

Function security type.

DEFINER = "DEFINER"¶

class databricks.sdk.service.catalog.CreateFunctionSqlDataAccess¶

Function SQL data access.

CONTAINS_SQL = "CONTAINS_SQL"¶

NO_SQL = "NO_SQL"¶

READS_SQL_DATA = "READS_SQL_DATA"¶

class databricks.sdk.service.catalog.CreateMetastore¶

name: str¶: The user-specified name of the metastore.

region: str | None = None¶: Cloud region which the metastore serves (e.g., us-west-2, westus). The field can be omitted in the __workspace-level__ __API__ but not in the __account-level__ __API__. If this field is omitted, the region of the workspace receiving the request will be used.

storage_root: str | None = None¶: The storage root URL for metastore

as_dict() → dict¶: Serializes the CreateMetastore into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateMetastore¶: Deserializes the CreateMetastore from a dictionary.

class databricks.sdk.service.catalog.CreateMetastoreAssignment¶

metastore_id: str¶: The unique ID of the metastore.

default_catalog_name: str¶: The name of the default catalog in the metastore. This field is depracted. Please use “Default Namespace API” to configure the default catalog for a Databricks workspace.

workspace_id: int | None = None¶: A workspace ID.

as_dict() → dict¶: Serializes the CreateMetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateMetastoreAssignment¶: Deserializes the CreateMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.CreateMonitor¶

assets_dir: str¶: The directory to store monitoring assets (e.g. dashboard, metric tables).

output_schema_name: str¶: Schema where output metric tables are created.

baseline_table_name: str | None = None¶: Name of the baseline table from which drift metrics are computed from. Columns in the monitored table should also be present in the baseline table.

custom_metrics: List[MonitorMetric] | None = None¶: Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).

data_classification_config: MonitorDataClassificationConfig | None = None¶: The data classification config for the monitor.

inference_log: MonitorInferenceLog | None = None¶: Configuration for monitoring inference logs.

notifications: MonitorNotifications | None = None¶: The notification settings for the monitor.

schedule: MonitorCronSchedule | None = None¶: The schedule for automatically updating and refreshing metric tables.

skip_builtin_dashboard: bool | None = None¶: Whether to skip creating a default dashboard summarizing data quality metrics.

slicing_exprs: List[str] | None = None¶: List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.

snapshot: MonitorSnapshot | None = None¶: Configuration for monitoring snapshot tables.

table_name: str | None = None¶: Full name of the table.

time_series: MonitorTimeSeries | None = None¶: Configuration for monitoring time series tables.

warehouse_id: str | None = None¶: Optional argument to specify the warehouse for dashboard creation. If not specified, the first running warehouse will be used.

as_dict() → dict¶: Serializes the CreateMonitor into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateMonitor¶: Deserializes the CreateMonitor from a dictionary.

class databricks.sdk.service.catalog.CreateOnlineTableRequest¶

Online Table information.

name: str | None = None¶: Full three-part (catalog, schema, table) name of the table.

spec: OnlineTableSpec | None = None¶: Specification of the online table.

as_dict() → dict¶: Serializes the CreateOnlineTableRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateOnlineTableRequest¶: Deserializes the CreateOnlineTableRequest from a dictionary.

class databricks.sdk.service.catalog.CreateRegisteredModelRequest¶

catalog_name: str¶: The name of the catalog where the schema and the registered model reside

schema_name: str¶: The name of the schema where the registered model resides

name: str¶: The name of the registered model

comment: str | None = None¶: The comment attached to the registered model

storage_location: str | None = None¶: The storage location on the cloud under which model version data files are stored

as_dict() → dict¶: Serializes the CreateRegisteredModelRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateRegisteredModelRequest¶: Deserializes the CreateRegisteredModelRequest from a dictionary.

class databricks.sdk.service.catalog.CreateResponse¶

as_dict() → dict¶: Serializes the CreateResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateResponse¶: Deserializes the CreateResponse from a dictionary.

class databricks.sdk.service.catalog.CreateSchema¶

name: str¶: Name of schema, relative to parent catalog.

catalog_name: str¶: Name of parent catalog.

comment: str | None = None¶: User-provided free-form text description.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

storage_root: str | None = None¶: Storage root URL for managed tables within schema.

as_dict() → dict¶: Serializes the CreateSchema into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateSchema¶: Deserializes the CreateSchema from a dictionary.

class databricks.sdk.service.catalog.CreateStorageCredential¶

name: str¶: The credential name. The name must be unique within the metastore.

aws_iam_role: AwsIamRoleRequest | None = None¶: The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityRequest | None = None¶: The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None¶: The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None¶: The Cloudflare API token configuration.

comment: str | None = None¶: Comment associated with the credential.

databricks_gcp_service_account: DatabricksGcpServiceAccountRequest | None = None¶: The Databricks managed GCP service account configuration.

read_only: bool | None = None¶: Whether the storage credential is only usable for read operations.

skip_validation: bool | None = None¶: Supplying true to this argument skips validation of the created credential.

as_dict() → dict¶: Serializes the CreateStorageCredential into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateStorageCredential¶: Deserializes the CreateStorageCredential from a dictionary.

class databricks.sdk.service.catalog.CreateTableConstraint¶

full_name_arg: str¶: The full name of the table referenced by the constraint.

constraint: TableConstraint¶: A table constraint, as defined by one of the following fields being set: __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.

as_dict() → dict¶: Serializes the CreateTableConstraint into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateTableConstraint¶: Deserializes the CreateTableConstraint from a dictionary.

class databricks.sdk.service.catalog.CreateVolumeRequestContent¶

catalog_name: str¶: The name of the catalog where the schema and the volume are

schema_name: str¶: The name of the schema where the volume is

name: str¶: The name of the volume

volume_type: VolumeType¶

comment: str | None = None¶: The comment attached to the volume

storage_location: str | None = None¶: The storage location on the cloud

as_dict() → dict¶: Serializes the CreateVolumeRequestContent into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateVolumeRequestContent¶: Deserializes the CreateVolumeRequestContent from a dictionary.

class databricks.sdk.service.catalog.CredentialType¶

The type of credential.

USERNAME_PASSWORD = "USERNAME_PASSWORD"¶

class databricks.sdk.service.catalog.CurrentWorkspaceBindings¶

Currently assigned workspaces

workspaces: List[int] | None = None¶: A list of workspace IDs.

as_dict() → dict¶: Serializes the CurrentWorkspaceBindings into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CurrentWorkspaceBindings¶: Deserializes the CurrentWorkspaceBindings from a dictionary.

class databricks.sdk.service.catalog.DataSourceFormat¶

Data source format

AVRO = "AVRO"¶

BIGQUERY_FORMAT = "BIGQUERY_FORMAT"¶

CSV = "CSV"¶

DATABRICKS_FORMAT = "DATABRICKS_FORMAT"¶

DELTA = "DELTA"¶

DELTASHARING = "DELTASHARING"¶

HIVE_CUSTOM = "HIVE_CUSTOM"¶

HIVE_SERDE = "HIVE_SERDE"¶

JSON = "JSON"¶

MYSQL_FORMAT = "MYSQL_FORMAT"¶

NETSUITE_FORMAT = "NETSUITE_FORMAT"¶

ORC = "ORC"¶

PARQUET = "PARQUET"¶

POSTGRESQL_FORMAT = "POSTGRESQL_FORMAT"¶

REDSHIFT_FORMAT = "REDSHIFT_FORMAT"¶

SALESFORCE_FORMAT = "SALESFORCE_FORMAT"¶

SNOWFLAKE_FORMAT = "SNOWFLAKE_FORMAT"¶

SQLDW_FORMAT = "SQLDW_FORMAT"¶

SQLSERVER_FORMAT = "SQLSERVER_FORMAT"¶

TEXT = "TEXT"¶

UNITY_CATALOG = "UNITY_CATALOG"¶

VECTOR_INDEX_FORMAT = "VECTOR_INDEX_FORMAT"¶

WORKDAY_RAAS_FORMAT = "WORKDAY_RAAS_FORMAT"¶

class databricks.sdk.service.catalog.DatabricksGcpServiceAccountRequest¶

as_dict() → dict¶: Serializes the DatabricksGcpServiceAccountRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DatabricksGcpServiceAccountRequest¶: Deserializes the DatabricksGcpServiceAccountRequest from a dictionary.

class databricks.sdk.service.catalog.DatabricksGcpServiceAccountResponse¶

credential_id: str | None = None¶: The Databricks internal ID that represents this service account. This is an output-only field.

email: str | None = None¶: The email of the service account. This is an output-only field.

as_dict() → dict¶: Serializes the DatabricksGcpServiceAccountResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DatabricksGcpServiceAccountResponse¶: Deserializes the DatabricksGcpServiceAccountResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteAliasResponse¶

as_dict() → dict¶: Serializes the DeleteAliasResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteAliasResponse¶: Deserializes the DeleteAliasResponse from a dictionary.

class databricks.sdk.service.catalog.DeleteResponse¶

as_dict() → dict¶: Serializes the DeleteResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeleteResponse¶: Deserializes the DeleteResponse from a dictionary.

class databricks.sdk.service.catalog.DeltaRuntimePropertiesKvPairs¶

Properties pertaining to the current state of the delta table as given by the commit server. This does not contain delta.* (input) properties in __TableInfo.properties__.

delta_runtime_properties: Dict[str, str]¶: A map of key-value properties attached to the securable.

as_dict() → dict¶: Serializes the DeltaRuntimePropertiesKvPairs into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DeltaRuntimePropertiesKvPairs¶: Deserializes the DeltaRuntimePropertiesKvPairs from a dictionary.

class databricks.sdk.service.catalog.Dependency¶

A dependency of a SQL object. Either the __table__ field or the __function__ field must be defined.

function: FunctionDependency | None = None¶: A function that is dependent on a SQL object.

table: TableDependency | None = None¶: A table that is dependent on a SQL object.

as_dict() → dict¶: Serializes the Dependency into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Dependency¶: Deserializes the Dependency from a dictionary.

class databricks.sdk.service.catalog.DependencyList¶

A list of dependencies.

dependencies: List[Dependency] | None = None¶: Array of dependencies.

as_dict() → dict¶: Serializes the DependencyList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DependencyList¶: Deserializes the DependencyList from a dictionary.

class databricks.sdk.service.catalog.DisableResponse¶

as_dict() → dict¶: Serializes the DisableResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → DisableResponse¶: Deserializes the DisableResponse from a dictionary.

class databricks.sdk.service.catalog.EffectivePermissionsList¶

privilege_assignments: List[EffectivePrivilegeAssignment] | None = None¶: The privileges conveyed to each principal (either directly or via inheritance)

as_dict() → dict¶: Serializes the EffectivePermissionsList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EffectivePermissionsList¶: Deserializes the EffectivePermissionsList from a dictionary.

class databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlag¶

value: EnablePredictiveOptimization¶: Whether predictive optimization should be enabled for this object and objects under it.

inherited_from_name: str | None = None¶: The name of the object from which the flag was inherited. If there was no inheritance, this field is left blank.

inherited_from_type: EffectivePredictiveOptimizationFlagInheritedFromType | None = None¶: The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank.

as_dict() → dict¶: Serializes the EffectivePredictiveOptimizationFlag into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EffectivePredictiveOptimizationFlag¶: Deserializes the EffectivePredictiveOptimizationFlag from a dictionary.

class databricks.sdk.service.catalog.EffectivePredictiveOptimizationFlagInheritedFromType¶

The type of the object from which the flag was inherited. If there was no inheritance, this field is left blank.

CATALOG = "CATALOG"¶

SCHEMA = "SCHEMA"¶

class databricks.sdk.service.catalog.EffectivePrivilege¶

inherited_from_name: str | None = None¶: The full name of the object that conveys this privilege via inheritance. This field is omitted when privilege is not inherited (it’s assigned to the securable itself).

inherited_from_type: SecurableType | None = None¶: The type of the object that conveys this privilege via inheritance. This field is omitted when privilege is not inherited (it’s assigned to the securable itself).

privilege: Privilege | None = None¶: The privilege assigned to the principal.

as_dict() → dict¶: Serializes the EffectivePrivilege into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EffectivePrivilege¶: Deserializes the EffectivePrivilege from a dictionary.

class databricks.sdk.service.catalog.EffectivePrivilegeAssignment¶

principal: str | None = None¶: The principal (user email address or group name).

privileges: List[EffectivePrivilege] | None = None¶: The privileges conveyed to the principal (either directly or via inheritance).

as_dict() → dict¶: Serializes the EffectivePrivilegeAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EffectivePrivilegeAssignment¶: Deserializes the EffectivePrivilegeAssignment from a dictionary.

class databricks.sdk.service.catalog.EnablePredictiveOptimization¶

Whether predictive optimization should be enabled for this object and objects under it.

DISABLE = "DISABLE"¶

ENABLE = "ENABLE"¶

INHERIT = "INHERIT"¶

class databricks.sdk.service.catalog.EnableResponse¶

as_dict() → dict¶: Serializes the EnableResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EnableResponse¶: Deserializes the EnableResponse from a dictionary.

class databricks.sdk.service.catalog.EncryptionDetails¶

Encryption options that apply to clients connecting to cloud storage.

sse_encryption_details: SseEncryptionDetails | None = None¶: Server-Side Encryption properties for clients communicating with AWS s3.

as_dict() → dict¶: Serializes the EncryptionDetails into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → EncryptionDetails¶: Deserializes the EncryptionDetails from a dictionary.

class databricks.sdk.service.catalog.ExternalLocationInfo¶

access_point: str | None = None¶: The AWS access point to use when accesing s3 for this external location.

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

comment: str | None = None¶: User-provided free-form text description.

created_at: int | None = None¶: Time at which this external location was created, in epoch milliseconds.

created_by: str | None = None¶: Username of external location creator.

credential_id: str | None = None¶: Unique ID of the location’s storage credential.

credential_name: str | None = None¶: Name of the storage credential used with this location.

encryption_details: EncryptionDetails | None = None¶: Encryption options that apply to clients connecting to cloud storage.

fallback: bool | None = None¶: Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.

isolation_mode: IsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

metastore_id: str | None = None¶: Unique identifier of metastore hosting the external location.

name: str | None = None¶: Name of the external location.

owner: str | None = None¶: The owner of the external location.

read_only: bool | None = None¶: Indicates whether the external location is read-only.

updated_at: int | None = None¶: Time at which external location this was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified the external location.

url: str | None = None¶: Path URL of the external location.

as_dict() → dict¶: Serializes the ExternalLocationInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ExternalLocationInfo¶: Deserializes the ExternalLocationInfo from a dictionary.

class databricks.sdk.service.catalog.FailedStatus¶

Detailed status of an online table. Shown if the online table is in the OFFLINE_FAILED or the ONLINE_PIPELINE_FAILED state.

last_processed_commit_version: int | None = None¶: The last source table Delta version that was synced to the online table. Note that this Delta version may only be partially synced to the online table. Only populated if the table is still online and available for serving.

timestamp: str | None = None¶: The timestamp of the last time any data was synchronized from the source table to the online table. Only populated if the table is still online and available for serving.

as_dict() → dict¶: Serializes the FailedStatus into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FailedStatus¶: Deserializes the FailedStatus from a dictionary.

class databricks.sdk.service.catalog.ForeignKeyConstraint¶

name: str¶: The name of the constraint.

child_columns: List[str]¶: Column names for this constraint.

parent_table: str¶: The full name of the parent constraint.

parent_columns: List[str]¶: Column names for this constraint.

as_dict() → dict¶: Serializes the ForeignKeyConstraint into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ForeignKeyConstraint¶: Deserializes the ForeignKeyConstraint from a dictionary.

class databricks.sdk.service.catalog.FunctionDependency¶

A function that is dependent on a SQL object.

function_full_name: str¶: Full name of the dependent function, in the form of __catalog_name__.__schema_name__.__function_name__.

as_dict() → dict¶: Serializes the FunctionDependency into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FunctionDependency¶: Deserializes the FunctionDependency from a dictionary.

class databricks.sdk.service.catalog.FunctionInfo¶

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None¶: Name of parent catalog.

comment: str | None = None¶: User-provided free-form text description.

created_at: int | None = None¶: Time at which this function was created, in epoch milliseconds.

created_by: str | None = None¶: Username of function creator.

data_type: ColumnTypeName | None = None¶: Scalar function return data type.

external_language: str | None = None¶: External function language.

external_name: str | None = None¶: External function name.

full_data_type: str | None = None¶: Pretty printed function data type.

full_name: str | None = None¶: Full name of function, in form of __catalog_name__.__schema_name__.__function__name__

function_id: str | None = None¶: Id of Function, relative to parent schema.

input_params: FunctionParameterInfos | None = None¶

is_deterministic: bool | None = None¶: Whether the function is deterministic.

is_null_call: bool | None = None¶: Function null call.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: Name of function, relative to parent schema.

owner: str | None = None¶: Username of current owner of function.

parameter_style: FunctionInfoParameterStyle | None = None¶: Function parameter style. S is the value for SQL.

properties: str | None = None¶: JSON-serialized key-value pair map, encoded (escaped) as a string.

return_params: FunctionParameterInfos | None = None¶: Table function return parameters.

routine_body: FunctionInfoRoutineBody | None = None¶: Function language. When EXTERNAL is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as TABLE return type is not supported), and the __sql_data_access__ field must be NO_SQL.

routine_definition: str | None = None¶: Function body.

routine_dependencies: DependencyList | None = None¶: Function dependencies.

schema_name: str | None = None¶: Name of parent schema relative to its parent catalog.

security_type: FunctionInfoSecurityType | None = None¶: Function security type.

specific_name: str | None = None¶: Specific name of the function; Reserved for future use.

sql_data_access: FunctionInfoSqlDataAccess | None = None¶: Function SQL data access.

sql_path: str | None = None¶: List of schemes whose objects can be referenced without qualification.

updated_at: int | None = None¶: Time at which this function was created, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified function.

as_dict() → dict¶: Serializes the FunctionInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FunctionInfo¶: Deserializes the FunctionInfo from a dictionary.

class databricks.sdk.service.catalog.FunctionInfoParameterStyle¶

Function parameter style. S is the value for SQL.

S = "S"¶

class databricks.sdk.service.catalog.FunctionInfoRoutineBody¶

Function language. When EXTERNAL is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as TABLE return type is not supported), and the __sql_data_access__ field must be NO_SQL.

EXTERNAL = "EXTERNAL"¶

SQL = "SQL"¶

class databricks.sdk.service.catalog.FunctionInfoSecurityType¶

Function security type.

DEFINER = "DEFINER"¶

class databricks.sdk.service.catalog.FunctionInfoSqlDataAccess¶

Function SQL data access.

CONTAINS_SQL = "CONTAINS_SQL"¶

NO_SQL = "NO_SQL"¶

READS_SQL_DATA = "READS_SQL_DATA"¶

class databricks.sdk.service.catalog.FunctionParameterInfo¶

name: str¶: Name of parameter.

type_text: str¶: Full data type spec, SQL/catalogString text.

type_name: ColumnTypeName¶: Name of type (INT, STRUCT, MAP, etc.).

position: int¶: Ordinal position of column (starting at position 0).

comment: str | None = None¶: User-provided free-form text description.

parameter_default: str | None = None¶: Default value of the parameter.

parameter_mode: FunctionParameterMode | None = None¶: The mode of the function parameter.

parameter_type: FunctionParameterType | None = None¶: The type of function parameter.

type_interval_type: str | None = None¶: Format of IntervalType.

type_json: str | None = None¶: Full data type spec, JSON-serialized.

type_precision: int | None = None¶: Digits of precision; required on Create for DecimalTypes.

type_scale: int | None = None¶: Digits to right of decimal; Required on Create for DecimalTypes.

as_dict() → dict¶: Serializes the FunctionParameterInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FunctionParameterInfo¶: Deserializes the FunctionParameterInfo from a dictionary.

class databricks.sdk.service.catalog.FunctionParameterInfos¶

parameters: List[FunctionParameterInfo] | None = None¶: The array of __FunctionParameterInfo__ definitions of the function’s parameters.

as_dict() → dict¶: Serializes the FunctionParameterInfos into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → FunctionParameterInfos¶: Deserializes the FunctionParameterInfos from a dictionary.

class databricks.sdk.service.catalog.FunctionParameterMode¶

The mode of the function parameter.

IN = "IN"¶

class databricks.sdk.service.catalog.FunctionParameterType¶

The type of function parameter.

COLUMN = "COLUMN"¶

PARAM = "PARAM"¶

class databricks.sdk.service.catalog.GetBindingsSecurableType¶

CATALOG = "CATALOG"¶

EXTERNAL_LOCATION = "EXTERNAL_LOCATION"¶

STORAGE_CREDENTIAL = "STORAGE_CREDENTIAL"¶

class databricks.sdk.service.catalog.GetMetastoreSummaryResponse¶

cloud: str | None = None¶: Cloud vendor of the metastore home shard (e.g., aws, azure, gcp).

created_at: int | None = None¶: Time at which this metastore was created, in epoch milliseconds.

created_by: str | None = None¶: Username of metastore creator.

default_data_access_config_id: str | None = None¶: Unique identifier of the metastore’s (Default) Data Access Configuration.

delta_sharing_organization_name: str | None = None¶: The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None¶: The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: GetMetastoreSummaryResponseDeltaSharingScope | None = None¶: The scope of Delta Sharing enabled for the metastore.

external_access_enabled: bool | None = None¶: Whether to allow non-DBR clients to directly access entities under the metastore.

global_metastore_id: str | None = None¶: Globally unique metastore ID across clouds and regions, of the form cloud:region:metastore_id.

metastore_id: str | None = None¶: Unique identifier of metastore.

name: str | None = None¶: The user-specified name of the metastore.

owner: str | None = None¶: The owner of the metastore.

privilege_model_version: str | None = None¶: Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

region: str | None = None¶: Cloud region which the metastore serves (e.g., us-west-2, westus).

storage_root: str | None = None¶: The storage root URL for metastore

storage_root_credential_id: str | None = None¶: UUID of storage credential to access the metastore storage_root.

storage_root_credential_name: str | None = None¶: Name of the storage credential to access the metastore storage_root.

updated_at: int | None = None¶: Time at which the metastore was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified the metastore.

as_dict() → dict¶: Serializes the GetMetastoreSummaryResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetMetastoreSummaryResponse¶: Deserializes the GetMetastoreSummaryResponse from a dictionary.

class databricks.sdk.service.catalog.GetMetastoreSummaryResponseDeltaSharingScope¶

The scope of Delta Sharing enabled for the metastore.

INTERNAL = "INTERNAL"¶

INTERNAL_AND_EXTERNAL = "INTERNAL_AND_EXTERNAL"¶

class databricks.sdk.service.catalog.GetQuotaResponse¶

quota_info: QuotaInfo | None = None¶: The returned QuotaInfo.

as_dict() → dict¶: Serializes the GetQuotaResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → GetQuotaResponse¶: Deserializes the GetQuotaResponse from a dictionary.

class databricks.sdk.service.catalog.IsolationMode¶

Whether the current securable is accessible from all workspaces or a specific set of workspaces.

ISOLATION_MODE_ISOLATED = "ISOLATION_MODE_ISOLATED"¶

ISOLATION_MODE_OPEN = "ISOLATION_MODE_OPEN"¶

class databricks.sdk.service.catalog.ListAccountMetastoreAssignmentsResponse¶

The list of workspaces to which the given metastore is assigned.

workspace_ids: List[int] | None = None¶

as_dict() → dict¶: Serializes the ListAccountMetastoreAssignmentsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListAccountMetastoreAssignmentsResponse¶: Deserializes the ListAccountMetastoreAssignmentsResponse from a dictionary.

class databricks.sdk.service.catalog.ListAccountStorageCredentialsResponse¶

storage_credentials: List[StorageCredentialInfo] | None = None¶: An array of metastore storage credentials.

as_dict() → dict¶: Serializes the ListAccountStorageCredentialsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListAccountStorageCredentialsResponse¶: Deserializes the ListAccountStorageCredentialsResponse from a dictionary.

class databricks.sdk.service.catalog.ListCatalogsResponse¶

catalogs: List[CatalogInfo] | None = None¶: An array of catalog information objects.

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

as_dict() → dict¶: Serializes the ListCatalogsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListCatalogsResponse¶: Deserializes the ListCatalogsResponse from a dictionary.

class databricks.sdk.service.catalog.ListConnectionsResponse¶

connections: List[ConnectionInfo] | None = None¶: An array of connection information objects.

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

as_dict() → dict¶: Serializes the ListConnectionsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListConnectionsResponse¶: Deserializes the ListConnectionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListExternalLocationsResponse¶

external_locations: List[ExternalLocationInfo] | None = None¶: An array of external locations.

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

as_dict() → dict¶: Serializes the ListExternalLocationsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListExternalLocationsResponse¶: Deserializes the ListExternalLocationsResponse from a dictionary.

class databricks.sdk.service.catalog.ListFunctionsResponse¶

functions: List[FunctionInfo] | None = None¶: An array of function information objects.

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

as_dict() → dict¶: Serializes the ListFunctionsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListFunctionsResponse¶: Deserializes the ListFunctionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListMetastoresResponse¶

metastores: List[MetastoreInfo] | None = None¶: An array of metastore information objects.

as_dict() → dict¶: Serializes the ListMetastoresResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListMetastoresResponse¶: Deserializes the ListMetastoresResponse from a dictionary.

class databricks.sdk.service.catalog.ListModelVersionsResponse¶

model_versions: List[ModelVersionInfo] | None = None¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

as_dict() → dict¶: Serializes the ListModelVersionsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListModelVersionsResponse¶: Deserializes the ListModelVersionsResponse from a dictionary.

class databricks.sdk.service.catalog.ListQuotasResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request.

quotas: List[QuotaInfo] | None = None¶: An array of returned QuotaInfos.

as_dict() → dict¶: Serializes the ListQuotasResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListQuotasResponse¶: Deserializes the ListQuotasResponse from a dictionary.

class databricks.sdk.service.catalog.ListRegisteredModelsResponse¶

next_page_token: str | None = None¶: Opaque token for pagination. Omitted if there are no more results. page_token should be set to this value for fetching the next page.

registered_models: List[RegisteredModelInfo] | None = None¶

as_dict() → dict¶: Serializes the ListRegisteredModelsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListRegisteredModelsResponse¶: Deserializes the ListRegisteredModelsResponse from a dictionary.

class databricks.sdk.service.catalog.ListSchemasResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

schemas: List[SchemaInfo] | None = None¶: An array of schema information objects.

as_dict() → dict¶: Serializes the ListSchemasResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListSchemasResponse¶: Deserializes the ListSchemasResponse from a dictionary.

class databricks.sdk.service.catalog.ListStorageCredentialsResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

storage_credentials: List[StorageCredentialInfo] | None = None¶

as_dict() → dict¶: Serializes the ListStorageCredentialsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListStorageCredentialsResponse¶: Deserializes the ListStorageCredentialsResponse from a dictionary.

class databricks.sdk.service.catalog.ListSystemSchemasResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

schemas: List[SystemSchemaInfo] | None = None¶: An array of system schema information objects.

as_dict() → dict¶: Serializes the ListSystemSchemasResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListSystemSchemasResponse¶: Deserializes the ListSystemSchemasResponse from a dictionary.

class databricks.sdk.service.catalog.ListTableSummariesResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

tables: List[TableSummary] | None = None¶: List of table summaries.

as_dict() → dict¶: Serializes the ListTableSummariesResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListTableSummariesResponse¶: Deserializes the ListTableSummariesResponse from a dictionary.

class databricks.sdk.service.catalog.ListTablesResponse¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request (for the next page of results).

tables: List[TableInfo] | None = None¶: An array of table information objects.

as_dict() → dict¶: Serializes the ListTablesResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListTablesResponse¶: Deserializes the ListTablesResponse from a dictionary.

class databricks.sdk.service.catalog.ListVolumesResponseContent¶

next_page_token: str | None = None¶: Opaque token to retrieve the next page of results. Absent if there are no more pages. __page_token__ should be set to this value for the next request to retrieve the next page of results.

volumes: List[VolumeInfo] | None = None¶

as_dict() → dict¶: Serializes the ListVolumesResponseContent into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ListVolumesResponseContent¶: Deserializes the ListVolumesResponseContent from a dictionary.

class databricks.sdk.service.catalog.MatchType¶

The artifact pattern matching type

PREFIX_MATCH = "PREFIX_MATCH"¶

class databricks.sdk.service.catalog.MetastoreAssignment¶

metastore_id: str¶: The unique ID of the metastore.

workspace_id: int¶: The unique ID of the Databricks workspace.

default_catalog_name: str | None = None¶: The name of the default catalog in the metastore.

as_dict() → dict¶: Serializes the MetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MetastoreAssignment¶: Deserializes the MetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.MetastoreInfo¶

cloud: str | None = None¶: Cloud vendor of the metastore home shard (e.g., aws, azure, gcp).

created_at: int | None = None¶: Time at which this metastore was created, in epoch milliseconds.

created_by: str | None = None¶: Username of metastore creator.

default_data_access_config_id: str | None = None¶: Unique identifier of the metastore’s (Default) Data Access Configuration.

delta_sharing_organization_name: str | None = None¶: The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None¶: The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: MetastoreInfoDeltaSharingScope | None = None¶: The scope of Delta Sharing enabled for the metastore.

external_access_enabled: bool | None = None¶: Whether to allow non-DBR clients to directly access entities under the metastore.

global_metastore_id: str | None = None¶: Globally unique metastore ID across clouds and regions, of the form cloud:region:metastore_id.

metastore_id: str | None = None¶: Unique identifier of metastore.

name: str | None = None¶: The user-specified name of the metastore.

owner: str | None = None¶: The owner of the metastore.

privilege_model_version: str | None = None¶: Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

region: str | None = None¶: Cloud region which the metastore serves (e.g., us-west-2, westus).

storage_root: str | None = None¶: The storage root URL for metastore

storage_root_credential_id: str | None = None¶: UUID of storage credential to access the metastore storage_root.

storage_root_credential_name: str | None = None¶: Name of the storage credential to access the metastore storage_root.

updated_at: int | None = None¶: Time at which the metastore was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified the metastore.

as_dict() → dict¶: Serializes the MetastoreInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MetastoreInfo¶: Deserializes the MetastoreInfo from a dictionary.

class databricks.sdk.service.catalog.MetastoreInfoDeltaSharingScope¶

The scope of Delta Sharing enabled for the metastore.

INTERNAL = "INTERNAL"¶

INTERNAL_AND_EXTERNAL = "INTERNAL_AND_EXTERNAL"¶

class databricks.sdk.service.catalog.ModelVersionInfo¶

aliases: List[RegisteredModelAlias] | None = None¶: List of aliases associated with the model version

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None¶: The name of the catalog containing the model version

comment: str | None = None¶: The comment attached to the model version

created_at: int | None = None¶

created_by: str | None = None¶: The identifier of the user who created the model version

id: str | None = None¶: The unique identifier of the model version

metastore_id: str | None = None¶: The unique identifier of the metastore containing the model version

model_name: str | None = None¶: The name of the parent registered model of the model version, relative to parent schema

model_version_dependencies: DependencyList | None = None¶: Model version dependencies, for feature-store packaged models

run_id: str | None = None¶: MLflow run ID used when creating the model version, if source was generated by an experiment run stored in an MLflow tracking server

run_workspace_id: int | None = None¶: ID of the Databricks workspace containing the MLflow run that generated this model version, if applicable

schema_name: str | None = None¶: The name of the schema containing the model version, relative to parent catalog

source: str | None = None¶: URI indicating the location of the source artifacts (files) for the model version

status: ModelVersionInfoStatus | None = None¶: Current status of the model version. Newly created model versions start in PENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and the model version is finalized. Only model versions in READY status can be loaded for inference or served.

storage_location: str | None = None¶: The storage location on the cloud under which model version data files are stored

updated_at: int | None = None¶

updated_by: str | None = None¶: The identifier of the user who updated the model version last time

version: int | None = None¶: Integer model version number, used to reference the model version in API requests.

as_dict() → dict¶: Serializes the ModelVersionInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ModelVersionInfo¶: Deserializes the ModelVersionInfo from a dictionary.

class databricks.sdk.service.catalog.ModelVersionInfoStatus¶

Current status of the model version. Newly created model versions start in PENDING_REGISTRATION status, then move to READY status once the model version files are uploaded and the model version is finalized. Only model versions in READY status can be loaded for inference or served.

FAILED_REGISTRATION = "FAILED_REGISTRATION"¶

PENDING_REGISTRATION = "PENDING_REGISTRATION"¶

READY = "READY"¶

class databricks.sdk.service.catalog.MonitorCronSchedule¶

quartz_cron_expression: str¶

The expression that determines when to run the monitor. See [examples].

[examples]: https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html

timezone_id: str¶: The timezone id (e.g., "PST") in which to evaluate the quartz expression.

pause_status: MonitorCronSchedulePauseStatus | None = None¶: Read only field that indicates whether a schedule is paused or not.

as_dict() → dict¶: Serializes the MonitorCronSchedule into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorCronSchedule¶: Deserializes the MonitorCronSchedule from a dictionary.

class databricks.sdk.service.catalog.MonitorCronSchedulePauseStatus¶

Read only field that indicates whether a schedule is paused or not.

PAUSED = "PAUSED"¶

UNPAUSED = "UNPAUSED"¶

class databricks.sdk.service.catalog.MonitorDataClassificationConfig¶

enabled: bool | None = None¶: Whether data classification is enabled.

as_dict() → dict¶: Serializes the MonitorDataClassificationConfig into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorDataClassificationConfig¶: Deserializes the MonitorDataClassificationConfig from a dictionary.

class databricks.sdk.service.catalog.MonitorDestination¶

email_addresses: List[str] | None = None¶: The list of email addresses to send the notification to. A maximum of 5 email addresses is supported.

as_dict() → dict¶: Serializes the MonitorDestination into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorDestination¶: Deserializes the MonitorDestination from a dictionary.

class databricks.sdk.service.catalog.MonitorInferenceLog¶

timestamp_col: str¶

Column that contains the timestamps of requests. The column must be one of the following: - A TimestampType column - A column whose values can be converted to timestamps through the pyspark to_timestamp [function].

[function]: https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html

granularities: List[str]¶: Granularities for aggregating data into time windows based on their timestamp. Currently the following static granularities are supported: {"5 minutes", "30 minutes", "1 hour", "1 day", "<n> week(s)", "1 month", "1 year"}.

model_id_col: str¶: Column that contains the id of the model generating the predictions. Metrics will be computed per model id by default, and also across all model ids.

problem_type: MonitorInferenceLogProblemType¶: Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed.

prediction_col: str¶: Column that contains the output/prediction from the model.

label_col: str | None = None¶: Optional column that contains the ground truth for the prediction.

prediction_proba_col: str | None = None¶: Optional column that contains the prediction probabilities for each class in a classification problem type. The values in this column should be a map, mapping each class label to the prediction probability for a given sample. The map should be of PySpark MapType().

as_dict() → dict¶: Serializes the MonitorInferenceLog into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorInferenceLog¶: Deserializes the MonitorInferenceLog from a dictionary.

class databricks.sdk.service.catalog.MonitorInferenceLogProblemType¶

Problem type the model aims to solve. Determines the type of model-quality metrics that will be computed.

PROBLEM_TYPE_CLASSIFICATION = "PROBLEM_TYPE_CLASSIFICATION"¶

PROBLEM_TYPE_REGRESSION = "PROBLEM_TYPE_REGRESSION"¶

class databricks.sdk.service.catalog.MonitorInfo¶

table_name: str¶: The full name of the table to monitor. Format: __catalog_name__.__schema_name__.__table_name__.

status: MonitorInfoStatus¶: The status of the monitor.

monitor_version: str¶: The version of the monitor config (e.g. 1,2,3). If negative, the monitor may be corrupted.

profile_metrics_table_name: str¶: The full name of the profile metrics table. Format: __catalog_name__.__schema_name__.__table_name__.

drift_metrics_table_name: str¶: The full name of the drift metrics table. Format: __catalog_name__.__schema_name__.__table_name__.

assets_dir: str | None = None¶: The directory to store monitoring assets (e.g. dashboard, metric tables).

baseline_table_name: str | None = None¶: Name of the baseline table from which drift metrics are computed from. Columns in the monitored table should also be present in the baseline table.

custom_metrics: List[MonitorMetric] | None = None¶: Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).

dashboard_id: str | None = None¶: Id of dashboard that visualizes the computed metrics. This can be empty if the monitor is in PENDING state.

data_classification_config: MonitorDataClassificationConfig | None = None¶: The data classification config for the monitor.

inference_log: MonitorInferenceLog | None = None¶: Configuration for monitoring inference logs.

latest_monitor_failure_msg: str | None = None¶: The latest failure message of the monitor (if any).

notifications: MonitorNotifications | None = None¶: The notification settings for the monitor.

output_schema_name: str | None = None¶: Schema where output metric tables are created.

schedule: MonitorCronSchedule | None = None¶: The schedule for automatically updating and refreshing metric tables.

slicing_exprs: List[str] | None = None¶: List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.

snapshot: MonitorSnapshot | None = None¶: Configuration for monitoring snapshot tables.

time_series: MonitorTimeSeries | None = None¶: Configuration for monitoring time series tables.

as_dict() → dict¶: Serializes the MonitorInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorInfo¶: Deserializes the MonitorInfo from a dictionary.

class databricks.sdk.service.catalog.MonitorInfoStatus¶

The status of the monitor.

MONITOR_STATUS_ACTIVE = "MONITOR_STATUS_ACTIVE"¶

MONITOR_STATUS_DELETE_PENDING = "MONITOR_STATUS_DELETE_PENDING"¶

MONITOR_STATUS_ERROR = "MONITOR_STATUS_ERROR"¶

MONITOR_STATUS_FAILED = "MONITOR_STATUS_FAILED"¶

MONITOR_STATUS_PENDING = "MONITOR_STATUS_PENDING"¶

class databricks.sdk.service.catalog.MonitorMetric¶

name: str¶: Name of the metric in the output tables.

definition: str¶

Jinja template for a SQL expression that specifies how to compute the metric. See [create metric definition].

[create metric definition]: https://docs.databricks.com/en/lakehouse-monitoring/custom-metrics.html#create-definition

input_columns: List[str]¶: A list of column names in the input table the metric should be computed for. Can use ":table" to indicate that the metric needs information from multiple columns.

output_data_type: str¶: The output type of the custom metric.

type: MonitorMetricType¶: Can only be one of "CUSTOM_METRIC_TYPE_AGGREGATE", "CUSTOM_METRIC_TYPE_DERIVED", or "CUSTOM_METRIC_TYPE_DRIFT". The "CUSTOM_METRIC_TYPE_AGGREGATE" and "CUSTOM_METRIC_TYPE_DERIVED" metrics are computed on a single table, whereas the "CUSTOM_METRIC_TYPE_DRIFT" compare metrics across baseline and input table, or across the two consecutive time windows. - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics

as_dict() → dict¶: Serializes the MonitorMetric into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorMetric¶: Deserializes the MonitorMetric from a dictionary.

class databricks.sdk.service.catalog.MonitorMetricType¶

Can only be one of "CUSTOM_METRIC_TYPE_AGGREGATE", "CUSTOM_METRIC_TYPE_DERIVED", or "CUSTOM_METRIC_TYPE_DRIFT". The "CUSTOM_METRIC_TYPE_AGGREGATE" and "CUSTOM_METRIC_TYPE_DERIVED" metrics are computed on a single table, whereas the "CUSTOM_METRIC_TYPE_DRIFT" compare metrics across baseline and input table, or across the two consecutive time windows. - CUSTOM_METRIC_TYPE_AGGREGATE: only depend on the existing columns in your table - CUSTOM_METRIC_TYPE_DERIVED: depend on previously computed aggregate metrics - CUSTOM_METRIC_TYPE_DRIFT: depend on previously computed aggregate or derived metrics

CUSTOM_METRIC_TYPE_AGGREGATE = "CUSTOM_METRIC_TYPE_AGGREGATE"¶

CUSTOM_METRIC_TYPE_DERIVED = "CUSTOM_METRIC_TYPE_DERIVED"¶

CUSTOM_METRIC_TYPE_DRIFT = "CUSTOM_METRIC_TYPE_DRIFT"¶

class databricks.sdk.service.catalog.MonitorNotifications¶

on_failure: MonitorDestination | None = None¶: Who to send notifications to on monitor failure.

on_new_classification_tag_detected: MonitorDestination | None = None¶: Who to send notifications to when new data classification tags are detected.

as_dict() → dict¶: Serializes the MonitorNotifications into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorNotifications¶: Deserializes the MonitorNotifications from a dictionary.

class databricks.sdk.service.catalog.MonitorRefreshInfo¶

refresh_id: int¶: Unique id of the refresh operation.

state: MonitorRefreshInfoState¶: The current state of the refresh.

start_time_ms: int¶: Time at which refresh operation was initiated (milliseconds since 1/1/1970 UTC).

end_time_ms: int | None = None¶: Time at which refresh operation completed (milliseconds since 1/1/1970 UTC).

message: str | None = None¶: An optional message to give insight into the current state of the job (e.g. FAILURE messages).

trigger: MonitorRefreshInfoTrigger | None = None¶: The method by which the refresh was triggered.

as_dict() → dict¶: Serializes the MonitorRefreshInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorRefreshInfo¶: Deserializes the MonitorRefreshInfo from a dictionary.

class databricks.sdk.service.catalog.MonitorRefreshInfoState¶

The current state of the refresh.

CANCELED = "CANCELED"¶

FAILED = "FAILED"¶

PENDING = "PENDING"¶

RUNNING = "RUNNING"¶

SUCCESS = "SUCCESS"¶

class databricks.sdk.service.catalog.MonitorRefreshInfoTrigger¶

The method by which the refresh was triggered.

MANUAL = "MANUAL"¶

SCHEDULE = "SCHEDULE"¶

class databricks.sdk.service.catalog.MonitorRefreshListResponse¶

refreshes: List[MonitorRefreshInfo] | None = None¶: List of refreshes.

as_dict() → dict¶: Serializes the MonitorRefreshListResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorRefreshListResponse¶: Deserializes the MonitorRefreshListResponse from a dictionary.

class databricks.sdk.service.catalog.MonitorSnapshot¶

as_dict() → dict¶: Serializes the MonitorSnapshot into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorSnapshot¶: Deserializes the MonitorSnapshot from a dictionary.

class databricks.sdk.service.catalog.MonitorTimeSeries¶

timestamp_col: str¶

Column that contains the timestamps of requests. The column must be one of the following: - A TimestampType column - A column whose values can be converted to timestamps through the pyspark to_timestamp [function].

[function]: https://spark.apache.org/docs/latest/api/python/reference/pyspark.sql/api/pyspark.sql.functions.to_timestamp.html

granularities: List[str]¶: Granularities for aggregating data into time windows based on their timestamp. Currently the following static granularities are supported: {"5 minutes", "30 minutes", "1 hour", "1 day", "<n> week(s)", "1 month", "1 year"}.

as_dict() → dict¶: Serializes the MonitorTimeSeries into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MonitorTimeSeries¶: Deserializes the MonitorTimeSeries from a dictionary.

class databricks.sdk.service.catalog.NamedTableConstraint¶

name: str¶: The name of the constraint.

as_dict() → dict¶: Serializes the NamedTableConstraint into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → NamedTableConstraint¶: Deserializes the NamedTableConstraint from a dictionary.

class databricks.sdk.service.catalog.OnlineTable¶

Online Table information.

name: str | None = None¶: Full three-part (catalog, schema, table) name of the table.

spec: OnlineTableSpec | None = None¶: Specification of the online table.

status: OnlineTableStatus | None = None¶: Online Table status

table_serving_url: str | None = None¶: Data serving REST API URL for this table

as_dict() → dict¶: Serializes the OnlineTable into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → OnlineTable¶: Deserializes the OnlineTable from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpec¶

Specification of an online table.

perform_full_copy: bool | None = None¶: Whether to create a full-copy pipeline – a pipeline that stops after creates a full copy of the source table upon initialization and does not process any change data feeds (CDFs) afterwards. The pipeline can still be manually triggered afterwards, but it always perform a full copy of the source table and there are no incremental updates. This mode is useful for syncing views or tables without CDFs to online tables. Note that the full-copy pipeline only supports “triggered” scheduling policy.

pipeline_id: str | None = None¶: ID of the associated pipeline. Generated by the server - cannot be set by the caller.

primary_key_columns: List[str] | None = None¶: Primary Key columns to be used for data insert/update in the destination.

run_continuously: OnlineTableSpecContinuousSchedulingPolicy | None = None¶: Pipeline runs continuously after generating the initial data.

run_triggered: OnlineTableSpecTriggeredSchedulingPolicy | None = None¶: Pipeline stops after generating the initial data and can be triggered later (manually, through a cron job or through data triggers)

source_table_full_name: str | None = None¶: Three-part (catalog, schema, table) name of the source Delta table.

timeseries_key: str | None = None¶: Time series key to deduplicate (tie-break) rows with the same primary key.

as_dict() → dict¶: Serializes the OnlineTableSpec into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → OnlineTableSpec¶: Deserializes the OnlineTableSpec from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpecContinuousSchedulingPolicy¶

as_dict() → dict¶: Serializes the OnlineTableSpecContinuousSchedulingPolicy into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → OnlineTableSpecContinuousSchedulingPolicy¶: Deserializes the OnlineTableSpecContinuousSchedulingPolicy from a dictionary.

class databricks.sdk.service.catalog.OnlineTableSpecTriggeredSchedulingPolicy¶

as_dict() → dict¶: Serializes the OnlineTableSpecTriggeredSchedulingPolicy into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → OnlineTableSpecTriggeredSchedulingPolicy¶: Deserializes the OnlineTableSpecTriggeredSchedulingPolicy from a dictionary.

class databricks.sdk.service.catalog.OnlineTableState¶

The state of an online table.

OFFLINE = "OFFLINE"¶

OFFLINE_FAILED = "OFFLINE_FAILED"¶

ONLINE = "ONLINE"¶

ONLINE_CONTINUOUS_UPDATE = "ONLINE_CONTINUOUS_UPDATE"¶

ONLINE_NO_PENDING_UPDATE = "ONLINE_NO_PENDING_UPDATE"¶

ONLINE_PIPELINE_FAILED = "ONLINE_PIPELINE_FAILED"¶

ONLINE_TRIGGERED_UPDATE = "ONLINE_TRIGGERED_UPDATE"¶

ONLINE_UPDATING_PIPELINE_RESOURCES = "ONLINE_UPDATING_PIPELINE_RESOURCES"¶

PROVISIONING = "PROVISIONING"¶

PROVISIONING_INITIAL_SNAPSHOT = "PROVISIONING_INITIAL_SNAPSHOT"¶

PROVISIONING_PIPELINE_RESOURCES = "PROVISIONING_PIPELINE_RESOURCES"¶

class databricks.sdk.service.catalog.OnlineTableStatus¶

Status of an online table.

continuous_update_status: ContinuousUpdateStatus | None = None¶: Detailed status of an online table. Shown if the online table is in the ONLINE_CONTINUOUS_UPDATE or the ONLINE_UPDATING_PIPELINE_RESOURCES state.

detailed_state: OnlineTableState | None = None¶: The state of the online table.

failed_status: FailedStatus | None = None¶: Detailed status of an online table. Shown if the online table is in the OFFLINE_FAILED or the ONLINE_PIPELINE_FAILED state.

message: str | None = None¶: A text description of the current state of the online table.

provisioning_status: ProvisioningStatus | None = None¶: Detailed status of an online table. Shown if the online table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.

triggered_update_status: TriggeredUpdateStatus | None = None¶: Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE or the ONLINE_NO_PENDING_UPDATE state.

as_dict() → dict¶: Serializes the OnlineTableStatus into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → OnlineTableStatus¶: Deserializes the OnlineTableStatus from a dictionary.

class databricks.sdk.service.catalog.PermissionsChange¶

add: List[Privilege] | None = None¶: The set of privileges to add.

principal: str | None = None¶: The principal whose privileges we are changing.

remove: List[Privilege] | None = None¶: The set of privileges to remove.

as_dict() → dict¶: Serializes the PermissionsChange into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PermissionsChange¶: Deserializes the PermissionsChange from a dictionary.

class databricks.sdk.service.catalog.PermissionsList¶

privilege_assignments: List[PrivilegeAssignment] | None = None¶: The privileges assigned to each principal

as_dict() → dict¶: Serializes the PermissionsList into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PermissionsList¶: Deserializes the PermissionsList from a dictionary.

class databricks.sdk.service.catalog.PipelineProgress¶

Progress information of the Online Table data synchronization pipeline.

estimated_completion_time_seconds: float | None = None¶: The estimated time remaining to complete this update in seconds.

latest_version_currently_processing: int | None = None¶: The source table Delta version that was last processed by the pipeline. The pipeline may not have completely processed this version yet.

sync_progress_completion: float | None = None¶: The completion ratio of this update. This is a number between 0 and 1.

synced_row_count: int | None = None¶: The number of rows that have been synced in this update.

total_row_count: int | None = None¶: The total number of rows that need to be synced in this update. This number may be an estimate.

as_dict() → dict¶: Serializes the PipelineProgress into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PipelineProgress¶: Deserializes the PipelineProgress from a dictionary.

class databricks.sdk.service.catalog.PrimaryKeyConstraint¶

name: str¶: The name of the constraint.

child_columns: List[str]¶: Column names for this constraint.

as_dict() → dict¶: Serializes the PrimaryKeyConstraint into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PrimaryKeyConstraint¶: Deserializes the PrimaryKeyConstraint from a dictionary.

class databricks.sdk.service.catalog.Privilege¶

ACCESS = "ACCESS"¶

ALL_PRIVILEGES = "ALL_PRIVILEGES"¶

APPLY_TAG = "APPLY_TAG"¶

CREATE = "CREATE"¶

CREATE_CATALOG = "CREATE_CATALOG"¶

CREATE_CONNECTION = "CREATE_CONNECTION"¶

CREATE_EXTERNAL_LOCATION = "CREATE_EXTERNAL_LOCATION"¶

CREATE_EXTERNAL_TABLE = "CREATE_EXTERNAL_TABLE"¶

CREATE_EXTERNAL_VOLUME = "CREATE_EXTERNAL_VOLUME"¶

CREATE_FOREIGN_CATALOG = "CREATE_FOREIGN_CATALOG"¶

CREATE_FUNCTION = "CREATE_FUNCTION"¶

CREATE_MANAGED_STORAGE = "CREATE_MANAGED_STORAGE"¶

CREATE_MATERIALIZED_VIEW = "CREATE_MATERIALIZED_VIEW"¶

CREATE_MODEL = "CREATE_MODEL"¶

CREATE_PROVIDER = "CREATE_PROVIDER"¶

CREATE_RECIPIENT = "CREATE_RECIPIENT"¶

CREATE_SCHEMA = "CREATE_SCHEMA"¶

CREATE_SERVICE_CREDENTIAL = "CREATE_SERVICE_CREDENTIAL"¶

CREATE_SHARE = "CREATE_SHARE"¶

CREATE_STORAGE_CREDENTIAL = "CREATE_STORAGE_CREDENTIAL"¶

CREATE_TABLE = "CREATE_TABLE"¶

CREATE_VIEW = "CREATE_VIEW"¶

CREATE_VOLUME = "CREATE_VOLUME"¶

EXECUTE = "EXECUTE"¶

MANAGE = "MANAGE"¶

MANAGE_ALLOWLIST = "MANAGE_ALLOWLIST"¶

MODIFY = "MODIFY"¶

READ_FILES = "READ_FILES"¶

READ_PRIVATE_FILES = "READ_PRIVATE_FILES"¶

READ_VOLUME = "READ_VOLUME"¶

REFRESH = "REFRESH"¶

SELECT = "SELECT"¶

SET_SHARE_PERMISSION = "SET_SHARE_PERMISSION"¶

USAGE = "USAGE"¶

USE_CATALOG = "USE_CATALOG"¶

USE_CONNECTION = "USE_CONNECTION"¶

USE_MARKETPLACE_ASSETS = "USE_MARKETPLACE_ASSETS"¶

USE_PROVIDER = "USE_PROVIDER"¶

USE_RECIPIENT = "USE_RECIPIENT"¶

USE_SCHEMA = "USE_SCHEMA"¶

USE_SHARE = "USE_SHARE"¶

WRITE_FILES = "WRITE_FILES"¶

WRITE_PRIVATE_FILES = "WRITE_PRIVATE_FILES"¶

WRITE_VOLUME = "WRITE_VOLUME"¶

class databricks.sdk.service.catalog.PrivilegeAssignment¶

principal: str | None = None¶: The principal (user email address or group name).

privileges: List[Privilege] | None = None¶: The privileges assigned to the principal.

as_dict() → dict¶: Serializes the PrivilegeAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PrivilegeAssignment¶: Deserializes the PrivilegeAssignment from a dictionary.

class databricks.sdk.service.catalog.ProvisioningInfo¶

Status of an asynchronously provisioned resource.

state: ProvisioningInfoState | None = None¶

as_dict() → dict¶: Serializes the ProvisioningInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ProvisioningInfo¶: Deserializes the ProvisioningInfo from a dictionary.

class databricks.sdk.service.catalog.ProvisioningInfoState¶

ACTIVE = "ACTIVE"¶

DELETING = "DELETING"¶

FAILED = "FAILED"¶

PROVISIONING = "PROVISIONING"¶

STATE_UNSPECIFIED = "STATE_UNSPECIFIED"¶

class databricks.sdk.service.catalog.ProvisioningStatus¶

Detailed status of an online table. Shown if the online table is in the PROVISIONING_PIPELINE_RESOURCES or the PROVISIONING_INITIAL_SNAPSHOT state.

initial_pipeline_sync_progress: PipelineProgress | None = None¶: Details about initial data synchronization. Only populated when in the PROVISIONING_INITIAL_SNAPSHOT state.

as_dict() → dict¶: Serializes the ProvisioningStatus into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → ProvisioningStatus¶: Deserializes the ProvisioningStatus from a dictionary.

class databricks.sdk.service.catalog.QuotaInfo¶

last_refreshed_at: int | None = None¶: The timestamp that indicates when the quota count was last updated.

parent_full_name: str | None = None¶: Name of the parent resource. Returns metastore ID if the parent is a metastore.

parent_securable_type: SecurableType | None = None¶: The quota parent securable type.

quota_count: int | None = None¶: The current usage of the resource quota.

quota_limit: int | None = None¶: The current limit of the resource quota.

quota_name: str | None = None¶: The name of the quota.

as_dict() → dict¶: Serializes the QuotaInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → QuotaInfo¶: Deserializes the QuotaInfo from a dictionary.

class databricks.sdk.service.catalog.RegenerateDashboardRequest¶

table_name: str | None = None¶: Full name of the table.

warehouse_id: str | None = None¶: Optional argument to specify the warehouse for dashboard regeneration. If not specified, the first running warehouse will be used.

as_dict() → dict¶: Serializes the RegenerateDashboardRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegenerateDashboardRequest¶: Deserializes the RegenerateDashboardRequest from a dictionary.

class databricks.sdk.service.catalog.RegenerateDashboardResponse¶

dashboard_id: str | None = None¶: Id of the regenerated monitoring dashboard.

parent_folder: str | None = None¶: The directory where the regenerated dashboard is stored.

as_dict() → dict¶: Serializes the RegenerateDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegenerateDashboardResponse¶: Deserializes the RegenerateDashboardResponse from a dictionary.

class databricks.sdk.service.catalog.RegisteredModelAlias¶

Registered model alias.

alias_name: str | None = None¶: Name of the alias, e.g. ‘champion’ or ‘latest_stable’

version_num: int | None = None¶: Integer version number of the model version to which this alias points.

as_dict() → dict¶: Serializes the RegisteredModelAlias into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelAlias¶: Deserializes the RegisteredModelAlias from a dictionary.

class databricks.sdk.service.catalog.RegisteredModelInfo¶

aliases: List[RegisteredModelAlias] | None = None¶: List of aliases associated with the registered model

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None¶: The name of the catalog where the schema and the registered model reside

comment: str | None = None¶: The comment attached to the registered model

created_at: int | None = None¶: Creation timestamp of the registered model in milliseconds since the Unix epoch

created_by: str | None = None¶: The identifier of the user who created the registered model

full_name: str | None = None¶: The three-level (fully qualified) name of the registered model

metastore_id: str | None = None¶: The unique identifier of the metastore

name: str | None = None¶: The name of the registered model

owner: str | None = None¶: The identifier of the user who owns the registered model

schema_name: str | None = None¶: The name of the schema where the registered model resides

storage_location: str | None = None¶: The storage location on the cloud under which model version data files are stored

updated_at: int | None = None¶: Last-update timestamp of the registered model in milliseconds since the Unix epoch

updated_by: str | None = None¶: The identifier of the user who updated the registered model last time

as_dict() → dict¶: Serializes the RegisteredModelInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → RegisteredModelInfo¶: Deserializes the RegisteredModelInfo from a dictionary.

class databricks.sdk.service.catalog.SchemaInfo¶

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None¶: Name of parent catalog.

catalog_type: str | None = None¶: The type of the parent catalog.

comment: str | None = None¶: User-provided free-form text description.

created_at: int | None = None¶: Time at which this schema was created, in epoch milliseconds.

created_by: str | None = None¶: Username of schema creator.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None¶

enable_predictive_optimization: EnablePredictiveOptimization | None = None¶: Whether predictive optimization should be enabled for this object and objects under it.

full_name: str | None = None¶: Full name of schema, in form of __catalog_name__.__schema_name__.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: Name of schema, relative to parent catalog.

owner: str | None = None¶: Username of current owner of schema.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

schema_id: str | None = None¶: The unique identifier of the schema.

storage_location: str | None = None¶: Storage location for managed tables within schema.

storage_root: str | None = None¶: Storage root URL for managed tables within schema.

updated_at: int | None = None¶: Time at which this schema was created, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified schema.

as_dict() → dict¶: Serializes the SchemaInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SchemaInfo¶: Deserializes the SchemaInfo from a dictionary.

class databricks.sdk.service.catalog.SecurableType¶

The type of Unity Catalog securable

CATALOG = "CATALOG"¶

CONNECTION = "CONNECTION"¶

EXTERNAL_LOCATION = "EXTERNAL_LOCATION"¶

FUNCTION = "FUNCTION"¶

METASTORE = "METASTORE"¶

PIPELINE = "PIPELINE"¶

PROVIDER = "PROVIDER"¶

RECIPIENT = "RECIPIENT"¶

SCHEMA = "SCHEMA"¶

SHARE = "SHARE"¶

STORAGE_CREDENTIAL = "STORAGE_CREDENTIAL"¶

TABLE = "TABLE"¶

VOLUME = "VOLUME"¶

class databricks.sdk.service.catalog.SetArtifactAllowlist¶

artifact_matchers: List[ArtifactMatcher]¶: A list of allowed artifact match patterns.

artifact_type: ArtifactType | None = None¶: The artifact type of the allowlist.

as_dict() → dict¶: Serializes the SetArtifactAllowlist into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetArtifactAllowlist¶: Deserializes the SetArtifactAllowlist from a dictionary.

class databricks.sdk.service.catalog.SetRegisteredModelAliasRequest¶

full_name: str¶: Full name of the registered model

alias: str¶: The name of the alias

version_num: int¶: The version number of the model version to which the alias points

as_dict() → dict¶: Serializes the SetRegisteredModelAliasRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SetRegisteredModelAliasRequest¶: Deserializes the SetRegisteredModelAliasRequest from a dictionary.

class databricks.sdk.service.catalog.SseEncryptionDetails¶

Server-Side Encryption properties for clients communicating with AWS s3.

algorithm: SseEncryptionDetailsAlgorithm | None = None¶: The type of key encryption to use (affects headers from s3 client).

aws_kms_key_arn: str | None = None¶: When algorithm is AWS_SSE_KMS this field specifies the ARN of the SSE key to use.

as_dict() → dict¶: Serializes the SseEncryptionDetails into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SseEncryptionDetails¶: Deserializes the SseEncryptionDetails from a dictionary.

class databricks.sdk.service.catalog.SseEncryptionDetailsAlgorithm¶

The type of key encryption to use (affects headers from s3 client).

AWS_SSE_KMS = "AWS_SSE_KMS"¶

AWS_SSE_S3 = "AWS_SSE_S3"¶

class databricks.sdk.service.catalog.StorageCredentialInfo¶

aws_iam_role: AwsIamRoleResponse | None = None¶: The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityResponse | None = None¶: The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None¶: The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None¶: The Cloudflare API token configuration.

comment: str | None = None¶: Comment associated with the credential.

created_at: int | None = None¶: Time at which this Credential was created, in epoch milliseconds.

created_by: str | None = None¶: Username of credential creator.

databricks_gcp_service_account: DatabricksGcpServiceAccountResponse | None = None¶: The Databricks managed GCP service account configuration.

id: str | None = None¶: The unique identifier of the credential.

isolation_mode: IsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: The credential name. The name must be unique within the metastore.

owner: str | None = None¶: Username of current owner of credential.

read_only: bool | None = None¶: Whether the storage credential is only usable for read operations.

updated_at: int | None = None¶: Time at which this credential was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified the credential.

used_for_managed_storage: bool | None = None¶: Whether this credential is the current metastore’s root storage credential.

as_dict() → dict¶: Serializes the StorageCredentialInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → StorageCredentialInfo¶: Deserializes the StorageCredentialInfo from a dictionary.

class databricks.sdk.service.catalog.SystemSchemaInfo¶

schema: str | None = None¶: Name of the system schema.

state: SystemSchemaInfoState | None = None¶: The current state of enablement for the system schema. An empty string means the system schema is available and ready for opt-in.

as_dict() → dict¶: Serializes the SystemSchemaInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → SystemSchemaInfo¶: Deserializes the SystemSchemaInfo from a dictionary.

class databricks.sdk.service.catalog.SystemSchemaInfoState¶

The current state of enablement for the system schema. An empty string means the system schema is available and ready for opt-in.

AVAILABLE = "AVAILABLE"¶

DISABLE_INITIALIZED = "DISABLE_INITIALIZED"¶

ENABLE_COMPLETED = "ENABLE_COMPLETED"¶

ENABLE_INITIALIZED = "ENABLE_INITIALIZED"¶

UNAVAILABLE = "UNAVAILABLE"¶

class databricks.sdk.service.catalog.TableConstraint¶

A table constraint, as defined by one of the following fields being set: __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.

foreign_key_constraint: ForeignKeyConstraint | None = None¶

named_table_constraint: NamedTableConstraint | None = None¶

primary_key_constraint: PrimaryKeyConstraint | None = None¶

as_dict() → dict¶: Serializes the TableConstraint into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableConstraint¶: Deserializes the TableConstraint from a dictionary.

class databricks.sdk.service.catalog.TableDependency¶

A table that is dependent on a SQL object.

table_full_name: str¶: Full name of the dependent table, in the form of __catalog_name__.__schema_name__.__table_name__.

as_dict() → dict¶: Serializes the TableDependency into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableDependency¶: Deserializes the TableDependency from a dictionary.

class databricks.sdk.service.catalog.TableExistsResponse¶

table_exists: bool | None = None¶: Whether the table exists or not.

as_dict() → dict¶: Serializes the TableExistsResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableExistsResponse¶: Deserializes the TableExistsResponse from a dictionary.

class databricks.sdk.service.catalog.TableInfo¶

access_point: str | None = None¶: The AWS access point to use when accesing s3 for this external location.

browse_only: bool | None = None¶: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

catalog_name: str | None = None¶: Name of parent catalog.

columns: List[ColumnInfo] | None = None¶: The array of __ColumnInfo__ definitions of the table’s columns.

comment: str | None = None¶: User-provided free-form text description.

created_at: int | None = None¶: Time at which this table was created, in epoch milliseconds.

created_by: str | None = None¶: Username of table creator.

data_access_configuration_id: str | None = None¶: Unique ID of the Data Access Configuration to use with the table data.

data_source_format: DataSourceFormat | None = None¶: Data source format

deleted_at: int | None = None¶: Time at which this table was deleted, in epoch milliseconds. Field is omitted if table is not deleted.

delta_runtime_properties_kvpairs: DeltaRuntimePropertiesKvPairs | None = None¶: Information pertaining to current state of the delta table.

effective_predictive_optimization_flag: EffectivePredictiveOptimizationFlag | None = None¶

enable_predictive_optimization: EnablePredictiveOptimization | None = None¶: Whether predictive optimization should be enabled for this object and objects under it.

encryption_details: EncryptionDetails | None = None¶: Encryption options that apply to clients connecting to cloud storage.

full_name: str | None = None¶: Full name of table, in form of __catalog_name__.__schema_name__.__table_name__

metastore_id: str | None = None¶: Unique identifier of parent metastore.

name: str | None = None¶: Name of table, relative to parent schema.

owner: str | None = None¶: Username of current owner of table.

pipeline_id: str | None = None¶: The pipeline ID of the table. Applicable for tables created by pipelines (Materialized View, Streaming Table, etc.).

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

row_filter: TableRowFilter | None = None¶

schema_name: str | None = None¶: Name of parent schema relative to its parent catalog.

sql_path: str | None = None¶: List of schemes whose objects can be referenced without qualification.

storage_credential_name: str | None = None¶: Name of the storage credential, when a storage credential is configured for use with this table.

storage_location: str | None = None¶: Storage root URL for table (for MANAGED, EXTERNAL tables)

table_constraints: List[TableConstraint] | None = None¶: List of table constraints. Note: this field is not set in the output of the __listTables__ API.

table_id: str | None = None¶: The unique identifier of the table.

table_type: TableType | None = None¶

updated_at: int | None = None¶: Time at which this table was last modified, in epoch milliseconds.

updated_by: str | None = None¶: Username of user who last modified the table.

view_definition: str | None = None¶: View definition SQL (when __table_type__ is VIEW, MATERIALIZED_VIEW, or STREAMING_TABLE)

view_dependencies: DependencyList | None = None¶: View dependencies (when table_type == VIEW or MATERIALIZED_VIEW, STREAMING_TABLE) - when DependencyList is None, the dependency is not provided; - when DependencyList is an empty list, the dependency is provided but is empty; - when DependencyList is not an empty list, dependencies are provided and recorded.

as_dict() → dict¶: Serializes the TableInfo into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableInfo¶: Deserializes the TableInfo from a dictionary.

class databricks.sdk.service.catalog.TableRowFilter¶

function_name: str¶: The full name of the row filter SQL UDF.

input_column_names: List[str]¶: The list of table columns to be passed as input to the row filter function. The column types should match the types of the filter function arguments.

as_dict() → dict¶: Serializes the TableRowFilter into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableRowFilter¶: Deserializes the TableRowFilter from a dictionary.

class databricks.sdk.service.catalog.TableSummary¶

full_name: str | None = None¶: The full name of the table.

table_type: TableType | None = None¶

as_dict() → dict¶: Serializes the TableSummary into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TableSummary¶: Deserializes the TableSummary from a dictionary.

class databricks.sdk.service.catalog.TableType¶

EXTERNAL = "EXTERNAL"¶

EXTERNAL_SHALLOW_CLONE = "EXTERNAL_SHALLOW_CLONE"¶

FOREIGN = "FOREIGN"¶

MANAGED = "MANAGED"¶

MANAGED_SHALLOW_CLONE = "MANAGED_SHALLOW_CLONE"¶

MATERIALIZED_VIEW = "MATERIALIZED_VIEW"¶

STREAMING_TABLE = "STREAMING_TABLE"¶

VIEW = "VIEW"¶

class databricks.sdk.service.catalog.TriggeredUpdateStatus¶

Detailed status of an online table. Shown if the online table is in the ONLINE_TRIGGERED_UPDATE or the ONLINE_NO_PENDING_UPDATE state.

last_processed_commit_version: int | None = None¶: The last source table Delta version that was synced to the online table. Note that this Delta version may not be completely synced to the online table yet.

timestamp: str | None = None¶: The timestamp of the last time any data was synchronized from the source table to the online table.

triggered_update_progress: PipelineProgress | None = None¶: Progress of the active data synchronization pipeline.

as_dict() → dict¶: Serializes the TriggeredUpdateStatus into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TriggeredUpdateStatus¶: Deserializes the TriggeredUpdateStatus from a dictionary.

class databricks.sdk.service.catalog.UnassignResponse¶

as_dict() → dict¶: Serializes the UnassignResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UnassignResponse¶: Deserializes the UnassignResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateAssignmentResponse¶

as_dict() → dict¶: Serializes the UpdateAssignmentResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateAssignmentResponse¶: Deserializes the UpdateAssignmentResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateBindingsSecurableType¶

CATALOG = "CATALOG"¶

EXTERNAL_LOCATION = "EXTERNAL_LOCATION"¶

STORAGE_CREDENTIAL = "STORAGE_CREDENTIAL"¶

class databricks.sdk.service.catalog.UpdateCatalog¶

comment: str | None = None¶: User-provided free-form text description.

enable_predictive_optimization: EnablePredictiveOptimization | None = None¶: Whether predictive optimization should be enabled for this object and objects under it.

isolation_mode: CatalogIsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

name: str | None = None¶: The name of the catalog.

new_name: str | None = None¶: New name for the catalog.

owner: str | None = None¶: Username of current owner of catalog.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

as_dict() → dict¶: Serializes the UpdateCatalog into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateCatalog¶: Deserializes the UpdateCatalog from a dictionary.

class databricks.sdk.service.catalog.UpdateConnection¶

options: Dict[str, str]¶: A map of key-value properties attached to the securable.

name: str | None = None¶: Name of the connection.

new_name: str | None = None¶: New name for the connection.

owner: str | None = None¶: Username of current owner of the connection.

as_dict() → dict¶: Serializes the UpdateConnection into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateConnection¶: Deserializes the UpdateConnection from a dictionary.

class databricks.sdk.service.catalog.UpdateExternalLocation¶

access_point: str | None = None¶: The AWS access point to use when accesing s3 for this external location.

comment: str | None = None¶: User-provided free-form text description.

credential_name: str | None = None¶: Name of the storage credential used with this location.

encryption_details: EncryptionDetails | None = None¶: Encryption options that apply to clients connecting to cloud storage.

fallback: bool | None = None¶: Indicates whether fallback mode is enabled for this external location. When fallback mode is enabled, the access to the location falls back to cluster credentials if UC credentials are not sufficient.

force: bool | None = None¶: Force update even if changing url invalidates dependent external tables or mounts.

isolation_mode: IsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

name: str | None = None¶: Name of the external location.

new_name: str | None = None¶: New name for the external location.

owner: str | None = None¶: The owner of the external location.

read_only: bool | None = None¶: Indicates whether the external location is read-only.

skip_validation: bool | None = None¶: Skips validation of the storage credential associated with the external location.

url: str | None = None¶: Path URL of the external location.

as_dict() → dict¶: Serializes the UpdateExternalLocation into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateExternalLocation¶: Deserializes the UpdateExternalLocation from a dictionary.

class databricks.sdk.service.catalog.UpdateFunction¶

name: str | None = None¶: The fully-qualified name of the function (of the form __catalog_name__.__schema_name__.__function__name__).

owner: str | None = None¶: Username of current owner of function.

as_dict() → dict¶: Serializes the UpdateFunction into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateFunction¶: Deserializes the UpdateFunction from a dictionary.

class databricks.sdk.service.catalog.UpdateMetastore¶

delta_sharing_organization_name: str | None = None¶: The organization name of a Delta Sharing entity, to be used in Databricks-to-Databricks Delta Sharing as the official name.

delta_sharing_recipient_token_lifetime_in_seconds: int | None = None¶: The lifetime of delta sharing recipient token in seconds.

delta_sharing_scope: UpdateMetastoreDeltaSharingScope | None = None¶: The scope of Delta Sharing enabled for the metastore.

id: str | None = None¶: Unique ID of the metastore.

new_name: str | None = None¶: New name for the metastore.

owner: str | None = None¶: The owner of the metastore.

privilege_model_version: str | None = None¶: Privilege model version of the metastore, of the form major.minor (e.g., 1.0).

storage_root_credential_id: str | None = None¶: UUID of storage credential to access the metastore storage_root.

as_dict() → dict¶: Serializes the UpdateMetastore into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateMetastore¶: Deserializes the UpdateMetastore from a dictionary.

class databricks.sdk.service.catalog.UpdateMetastoreAssignment¶

default_catalog_name: str | None = None¶: The name of the default catalog in the metastore. This field is depracted. Please use “Default Namespace API” to configure the default catalog for a Databricks workspace.

metastore_id: str | None = None¶: The unique ID of the metastore.

workspace_id: int | None = None¶: A workspace ID.

as_dict() → dict¶: Serializes the UpdateMetastoreAssignment into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateMetastoreAssignment¶: Deserializes the UpdateMetastoreAssignment from a dictionary.

class databricks.sdk.service.catalog.UpdateMetastoreDeltaSharingScope¶

The scope of Delta Sharing enabled for the metastore.

INTERNAL = "INTERNAL"¶

INTERNAL_AND_EXTERNAL = "INTERNAL_AND_EXTERNAL"¶

class databricks.sdk.service.catalog.UpdateModelVersionRequest¶

comment: str | None = None¶: The comment attached to the model version

full_name: str | None = None¶: The three-level (fully qualified) name of the model version

version: int | None = None¶: The integer version number of the model version

as_dict() → dict¶: Serializes the UpdateModelVersionRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateModelVersionRequest¶: Deserializes the UpdateModelVersionRequest from a dictionary.

class databricks.sdk.service.catalog.UpdateMonitor¶

output_schema_name: str¶: Schema where output metric tables are created.

baseline_table_name: str | None = None¶: Name of the baseline table from which drift metrics are computed from. Columns in the monitored table should also be present in the baseline table.

custom_metrics: List[MonitorMetric] | None = None¶: Custom metrics to compute on the monitored table. These can be aggregate metrics, derived metrics (from already computed aggregate metrics), or drift metrics (comparing metrics across time windows).

dashboard_id: str | None = None¶: Id of dashboard that visualizes the computed metrics. This can be empty if the monitor is in PENDING state.

data_classification_config: MonitorDataClassificationConfig | None = None¶: The data classification config for the monitor.

inference_log: MonitorInferenceLog | None = None¶: Configuration for monitoring inference logs.

notifications: MonitorNotifications | None = None¶: The notification settings for the monitor.

schedule: MonitorCronSchedule | None = None¶: The schedule for automatically updating and refreshing metric tables.

slicing_exprs: List[str] | None = None¶: List of column expressions to slice data with for targeted analysis. The data is grouped by each expression independently, resulting in a separate slice for each predicate and its complements. For high-cardinality columns, only the top 100 unique values by frequency will generate slices.

snapshot: MonitorSnapshot | None = None¶: Configuration for monitoring snapshot tables.

table_name: str | None = None¶: Full name of the table.

time_series: MonitorTimeSeries | None = None¶: Configuration for monitoring time series tables.

as_dict() → dict¶: Serializes the UpdateMonitor into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateMonitor¶: Deserializes the UpdateMonitor from a dictionary.

class databricks.sdk.service.catalog.UpdatePermissions¶

changes: List[PermissionsChange] | None = None¶: Array of permissions change objects.

full_name: str | None = None¶: Full name of securable.

securable_type: SecurableType | None = None¶: Type of securable.

as_dict() → dict¶: Serializes the UpdatePermissions into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdatePermissions¶: Deserializes the UpdatePermissions from a dictionary.

class databricks.sdk.service.catalog.UpdateRegisteredModelRequest¶

comment: str | None = None¶: The comment attached to the registered model

full_name: str | None = None¶: The three-level (fully qualified) name of the registered model

new_name: str | None = None¶: New name for the registered model.

owner: str | None = None¶: The identifier of the user who owns the registered model

as_dict() → dict¶: Serializes the UpdateRegisteredModelRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateRegisteredModelRequest¶: Deserializes the UpdateRegisteredModelRequest from a dictionary.

class databricks.sdk.service.catalog.UpdateResponse¶

as_dict() → dict¶: Serializes the UpdateResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateResponse¶: Deserializes the UpdateResponse from a dictionary.

class databricks.sdk.service.catalog.UpdateSchema¶

comment: str | None = None¶: User-provided free-form text description.

enable_predictive_optimization: EnablePredictiveOptimization | None = None¶: Whether predictive optimization should be enabled for this object and objects under it.

full_name: str | None = None¶: Full name of the schema.

new_name: str | None = None¶: New name for the schema.

owner: str | None = None¶: Username of current owner of schema.

properties: Dict[str, str] | None = None¶: A map of key-value properties attached to the securable.

as_dict() → dict¶: Serializes the UpdateSchema into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateSchema¶: Deserializes the UpdateSchema from a dictionary.

class databricks.sdk.service.catalog.UpdateStorageCredential¶

aws_iam_role: AwsIamRoleRequest | None = None¶: The AWS IAM role configuration.

azure_managed_identity: AzureManagedIdentityResponse | None = None¶: The Azure managed identity configuration.

azure_service_principal: AzureServicePrincipal | None = None¶: The Azure service principal configuration.

cloudflare_api_token: CloudflareApiToken | None = None¶: The Cloudflare API token configuration.

comment: str | None = None¶: Comment associated with the credential.

databricks_gcp_service_account: DatabricksGcpServiceAccountRequest | None = None¶: The Databricks managed GCP service account configuration.

force: bool | None = None¶: Force update even if there are dependent external locations or external tables.

isolation_mode: IsolationMode | None = None¶: Whether the current securable is accessible from all workspaces or a specific set of workspaces.

name: str | None = None¶: Name of the storage credential.

new_name: str | None = None¶: New name for the storage credential.

Navigation

Related Topics

Unity Catalog¶