Package com.databricks.sdk.service.catalog

Interface Summary

Interface	Description
AccountMetastoreAssignmentsService	These APIs manage metastore assignments to a workspace.
AccountMetastoresService	These APIs manage Unity Catalog metastores for an account.
AccountStorageCredentialsService	These APIs manage storage credentials for a particular metastore.
ArtifactAllowlistsService	In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist` in UC so that users can leverage these artifacts on compute configured with shared access mode.
CatalogsService	A catalog is the first layer of Unity Catalog’s three-level namespace.
ConnectionsService	Connections allow for creating a connection to an external data source.
ExternalLocationsService	An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path.
FunctionsService	Functions implement User-Defined Functions (UDFs) in Unity Catalog.
GrantsService	In Unity Catalog, data is secure by default.
MetastoresService	A metastore is the top-level container of objects in Unity Catalog.
SchemasService	A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
SecurableTagsService	Tags are attributes containing keys and values that can be applied to different entities in Unity Catalog.
StorageCredentialsService	A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
SubentityTagsService	Tags are attributes containing keys and values that can be applied to different entities in Unity Catalog.
SystemSchemasService	A system schema is a schema that lives within the system catalog.
TableConstraintsService	Primary key and foreign key constraints encode relationships between fields in tables.
TablesService	A table resides in the third layer of Unity Catalog’s three-level namespace.
VolumesService	Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files.
WorkspaceBindingsService	A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.

Class Summary

Class	Description
AccountMetastoreAssignmentsAPI	These APIs manage metastore assignments to a workspace.
AccountMetastoresAPI	These APIs manage Unity Catalog metastores for an account.
AccountsCreateMetastore
AccountsCreateMetastoreAssignment
AccountsCreateStorageCredential
AccountsMetastoreAssignment
AccountsMetastoreInfo
AccountsStorageCredentialInfo
AccountStorageCredentialsAPI	These APIs manage storage credentials for a particular metastore.
AccountsUpdateMetastore
AccountsUpdateMetastoreAssignment
AccountsUpdateStorageCredential
ArtifactAllowlistInfo
ArtifactAllowlistsAPI	In Databricks Runtime 13.3 and above, you can add libraries and init scripts to the `allowlist` in UC so that users can leverage these artifacts on compute configured with shared access mode.
ArtifactMatcher
AwsIamRole
AzureManagedIdentity
AzureServicePrincipal
CatalogInfo
CatalogsAPI	A catalog is the first layer of Unity Catalog’s three-level namespace.
ColumnInfo
ColumnMask
ConnectionInfo
ConnectionsAPI	Connections allow for creating a connection to an external data source.
CreateCatalog
CreateConnection
CreateExternalLocation
CreateFunction
CreateMetastore
CreateMetastoreAssignment
CreateMetastoreAssignmentsResponseItem
CreateSchema
CreateStorageCredential
CreateTableConstraint
CreateVolumeRequestContent
CurrentWorkspaceBindings	Currently assigned workspaces
DatabricksGcpServiceAccountResponse
DeleteAccountMetastoreAssignmentRequest	Delete a metastore assignment
DeleteAccountMetastoreRequest	Delete a metastore
DeleteAccountStorageCredentialRequest	Delete a storage credential
DeleteCatalogRequest	Delete a catalog
DeleteConnectionRequest	Delete a connection
DeleteExternalLocationRequest	Delete an external location
DeleteFunctionRequest	Delete a function
DeleteMetastoreRequest	Delete a metastore
DeleteSchemaRequest	Delete a schema
DeleteStorageCredentialRequest	Delete a credential
DeleteTableConstraintRequest	Delete a table constraint
DeleteTableRequest	Delete a table
DeleteVolumeRequest	Delete a Volume
DeltaRuntimePropertiesKvPairs	Properties pertaining to the current state of the delta table as given by the commit server.
Dependency	A dependency of a SQL object.
DisableRequest	Disable a system schema
EffectiveAutoMaintenanceFlag
EffectivePermissionsList
EffectivePredictiveOptimizationFlag
EffectivePrivilege
EffectivePrivilegeAssignment
EnableRequest	Enable a system schema
EncryptionDetails	Encryption options that apply to clients connecting to cloud storage.
ExternalLocationInfo
ExternalLocationsAPI	An external location is an object that combines a cloud storage path with a storage credential that authorizes access to the cloud storage path.
ForeignKeyConstraint
FunctionDependency	A function that is dependent on a SQL object.
FunctionInfo
FunctionParameterInfo
FunctionsAPI	Functions implement User-Defined Functions (UDFs) in Unity Catalog.
GetAccountMetastoreAssignmentRequest	Gets the metastore assignment for a workspace
GetAccountMetastoreRequest	Get a metastore
GetAccountStorageCredentialRequest	Gets the named storage credential
GetArtifactAllowlistRequest	Get an artifact allowlist
GetCatalogRequest	Get a catalog
GetConnectionRequest	Get a connection
GetEffectiveRequest	Get effective permissions
GetExternalLocationRequest	Get an external location
GetFunctionRequest	Get a function
GetGrantRequest	Get permissions
GetMetastoreRequest	Get a metastore
GetMetastoreSummaryResponse
GetSchemaRequest	Get a schema
GetStorageCredentialRequest	Get a credential
GetTableRequest	Get a table
GetWorkspaceBindingRequest	Get catalog workspace bindings
GrantsAPI	In Unity Catalog, data is secure by default.
ListAccountMetastoreAssignmentsRequest	Get all workspaces assigned to a metastore
ListAccountStorageCredentialsRequest	Get all storage credentials assigned to a metastore
ListCatalogsResponse
ListConnectionsResponse
ListExternalLocationsResponse
ListFunctionsRequest	List functions
ListFunctionsResponse
ListMetastoresResponse
ListSchemasRequest	List schemas
ListSchemasResponse
ListSecurableTagsRequest	Get tags for a securable
ListStorageCredentialsResponse
ListSubentityTagsRequest	Get tags for a subentity
ListSummariesRequest	List table summaries
ListSystemSchemasRequest	List system schemas
ListSystemSchemasResponse
ListTablesRequest	List tables
ListTablesResponse
ListTableSummariesResponse
ListVolumesRequest	List Volumes
ListVolumesResponseContent
MetastoreAssignment
MetastoreInfo
MetastoresAPI	A metastore is the top-level container of objects in Unity Catalog.
NamedTableConstraint
PermissionsChange
PermissionsList
PrimaryKeyConstraint
PrivilegeAssignment
ReadVolumeRequest	Get a Volume
SchemaInfo
SchemasAPI	A schema (also called a database) is the second layer of Unity Catalog’s three-level namespace.
SecurableTagsAPI	Tags are attributes containing keys and values that can be applied to different entities in Unity Catalog.
SetArtifactAllowlist
SseEncryptionDetails	Server-Side Encryption properties for clients communicating with AWS s3.
StorageCredentialInfo
StorageCredentialsAPI	A storage credential represents an authentication and authorization mechanism for accessing data stored on your cloud tenant.
SubentityTagsAPI	Tags are attributes containing keys and values that can be applied to different entities in Unity Catalog.
SystemSchemaInfo
SystemSchemasAPI	A system schema is a schema that lives within the system catalog.
TableConstraint	A table constraint, as defined by *one* of the following fields being set: __primary_key_constraint__, __foreign_key_constraint__, __named_table_constraint__.
TableConstraintList
TableConstraintsAPI	Primary key and foreign key constraints encode relationships between fields in tables.
TableDependency	A table that is dependent on a SQL object.
TableInfo
TableRowFilter
TablesAPI	A table resides in the third layer of Unity Catalog’s three-level namespace.
TableSummary
TagChanges
TagKeyValuePair
TagSecurable
TagSecurableAssignment
TagSecurableAssignmentsList
TagsSubentityAssignment
TagSubentity
TagSubentityAssignmentsList
UnassignRequest	Delete an assignment
UpdateAutoMaintenance
UpdateAutoMaintenanceResponse
UpdateCatalog
UpdateConnection
UpdateExternalLocation
UpdateFunction
UpdateMetastore
UpdateMetastoreAssignment
UpdatePermissions
UpdatePredictiveOptimization
UpdatePredictiveOptimizationResponse
UpdateSchema
UpdateStorageCredential
UpdateTableRequest	Update a table owner.
UpdateTags
UpdateVolumeRequestContent
UpdateWorkspaceBindings
ValidateStorageCredential
ValidateStorageCredentialResponse
ValidationResult
VolumeInfo
VolumesAPI	Volumes are a Unity Catalog (UC) capability for accessing, storing, governing, organizing and processing files.
WorkspaceBindingsAPI	A catalog in Databricks can be configured as __OPEN__ or __ISOLATED__.

Enum Summary

Enum	Description
ArtifactType	The artifact type
CatalogType	The type of the catalog.
ColumnTypeName	Name of type (INT, STRUCT, MAP, etc.).
ConnectionInfoSecurableKind	Kind of connection securable.
ConnectionType	The type of connection.
CreateFunctionParameterStyle	Function parameter style.
CreateFunctionRoutineBody	Function language.
CreateFunctionSecurityType	Function security type.
CreateFunctionSqlDataAccess	Function SQL data access.
CredentialType	The type of credential.
DataSourceFormat	Data source format
DisableSchemaName
EffectiveAutoMaintenanceFlagInheritedFromType	The type of the object from which the flag was inherited.
EffectivePredictiveOptimizationFlagInheritedFromType	The type of the object from which the flag was inherited.
EnableAutoMaintenance	Whether auto maintenance should be enabled for this object and objects under it.
EnablePredictiveOptimization	Whether predictive optimization should be enabled for this object and objects under it.
EnableSchemaName
FunctionInfoParameterStyle	Function parameter style.
FunctionInfoRoutineBody	Function language.
FunctionInfoSecurityType	Function security type.
FunctionInfoSqlDataAccess	Function SQL data access.
FunctionParameterMode	The mode of the function parameter.
FunctionParameterType	The type of function parameter.
GetMetastoreSummaryResponseDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
IsolationMode	Whether the current securable is accessible from all workspaces or a specific set of workspaces.
ListSecurableType
MatchType	The artifact pattern matching type
MetastoreInfoDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
Privilege
ProvisioningState	Status of an asynchronously provisioned resource.
SecurableType	The type of Unity Catalog securable
SseEncryptionDetailsAlgorithm	The type of key encryption to use (affects headers from s3 client).
SystemSchemaInfoState	The current state of enablement for the system schema.
TableType
UpdateMetastoreDeltaSharingScope	The scope of Delta Sharing enabled for the metastore.
UpdateSecurableType
ValidationResultOperation	The operation tested.
ValidationResultResult	The results of the tested operation.
VolumeType