UnityCatalog

Properties

Property	Type	Attributes	Description
name	string	Required	Name of catalog.
browseOnly	bool	Read-only	Whether the catalog is accessible from all workspaces or a specific set of workspaces.
catalogType	'MANAGED_CATALOG' | 'DELTASHARING_CATALOG' | 'FOREIGN_CATALOG' | 'SYSTEM_CATALOG'	Read-only	The type of the catalog.
comment	string		User-provided free-form text description.
connectionName	string		The name of the connection to an external data source.
createdAt	int	Read-only	Time at which this catalog was created, in epoch milliseconds.
createdBy	string	Read-only	Username of catalog creator.
effectivePredictiveOptimizationFlag	EffectivePredictiveOptimizationFlag	Read-only	The effective predictive optimization flag.
enablePredictiveOptimization	'DISABLE' | 'ENABLE' | 'INHERIT'		Whether predictive optimization should be enabled for this object and objects under it.
forceDestroy	bool		Whether to force destroy the catalog even if it contains schemas and tables.
fullName	string	Read-only	The full name of the catalog.
isolationMode	'OPEN' | 'ISOLATED'		Whether the catalog is accessible from all workspaces or a specific set of workspaces.
metastoreId	string	Read-only	Unique identifier of the metastore for the catalog.
options	Object		A map of key-value properties attached to the securable.
owner	string		Username of current owner of catalog.
providerName	string		For catalogs corresponding to a share: the name of the provider.
provisioningInfo	ProvisioningInfo	Read-only	Provisioning info about the catalog.
securableType	'CATALOG' | 'SCHEMA' | 'TABLE' | 'VOLUME'	Read-only	The type of the securable.
shareName	string		For catalogs corresponding to a share: the name of the share.
storageLocation	string	Read-only	Path to the storage location.
storageRoot	string		Storage root URL for managed tables within catalog.
updatedAt	int	Read-only	Time at which this catalog was last modified, in epoch milliseconds.
updatedBy	string	Read-only	Username of user who last modified catalog.

EffectivePredictiveOptimizationFlag

Property	Type	Attributes	Description
inheritedFromName	string	Read-only	The name of the object from which the flag was inherited.
inheritedFromType	'CATALOG' | 'SCHEMA' | 'TABLE'	Read-only	The type of the object from which the flag was inherited.
value	'DISABLE' | 'ENABLE' | 'INHERIT'	Read-only	The value of the effective predictive optimization flag.

Object

This type has no properties.

ProvisioningInfo

Property	Type	Attributes	Description
state	'PROVISIONING' | 'PROVISIONED' | 'FAILED'	Read-only	The current provisioning state of the catalog.