Skip to content

Unity Catalog

Browse and manage Unity Catalog objects, permissions, volumes, and governance policies.

“List all tables in my_catalog.my_schema”

“Grant SELECT on this table to the data-analysts group”

“Upload this CSV to /Volumes/catalog/schema/landing/data.csv”


Description: Manage UC metric views (reusable business metrics). Requires DBR 17.2+.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
full_namestrYes
sourcestrNo
dimensionsList[Dict[str, str]]No
measuresList[Dict[str, str]]No
versionstrNo
commentstrNo
filter_exprstrNo
joinsList[Dict[str, Any]]No
materializationDict[str, Any]No
or_replaceboolNo
query_measuresList[str]No
query_dimensionsList[str]No
wherestrNo
order_bystrNo
limitintNo
principalstrNo
privilegesList[str]No
warehouse_idstrNo

Description: Manage Lakehouse Federation foreign connections.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
namestrNo
connection_typestrNo
optionsDict[str, str]No
commentstrNo
ownerstrNo
new_namestrNo
connection_namestrNo
catalog_namestrNo
catalog_optionsDict[str, str]No
warehouse_idstrNo

Description: Manage UC permissions: grant/revoke/get/get_effective.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
securable_typestrYes
full_namestrYes
principalstrNo
privilegesList[str]No

Description: Manage Lakehouse quality monitors for data quality tracking.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
table_namestrYes
output_schema_namestrNo
schedule_cronstrNo
schedule_timezonestrNo
assets_dirstrNo

Description: Manage UC namespace objects: catalog/schema/volume/function.

Parameters:

ParameterTypeRequiredDescription
object_typestrYes
actionstrYes
namestrNo
full_namestrNo
catalog_namestrNo
schema_namestrNo
commentstrNo
ownerstrNo
storage_rootstrNo
volume_typestrNo
storage_locationstrNo
new_namestrNo
propertiesDict[str, str]No
isolation_modestrNo
forceboolNo

Description: Manage row-level security and column masking.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
table_namestrNo
column_namestrNo
filter_functionstrNo
filter_columnsList[str]No
mask_functionstrNo
function_namestrNo
function_bodystrNo
parameter_namestrNo
parameter_typestrNo
return_typestrNo
function_commentstrNo
warehouse_idstrNo

Description: Manage Delta Sharing: shares, recipients, and providers.

Parameters:

ParameterTypeRequiredDescription
resource_typestrYes
actionstrYes
namestrNo
commentstrNo
table_namestrNo
shared_asstrNo
partition_specstrNo
authentication_typestrNo
sharing_idstrNo
ip_access_listList[str]No
share_namestrNo
recipient_namestrNo
include_shared_databoolNo

Description: Manage storage credentials and external locations.

Parameters:

ParameterTypeRequiredDescription
resource_typestrYes
actionstrYes
namestrNo
aws_iam_role_arnstrNo
azure_access_connector_idstrNo
urlstrNo
credential_namestrNo
read_onlyboolNo
commentstrNo
ownerstrNo
new_namestrNo
forceboolNo

Description: Manage UC tags and comments.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
object_typestrNo
full_namestrNo
column_namestrNo
tagsDict[str, str]No
tag_namesList[str]No
comment_textstrNo
catalog_filterstrNo
tag_name_filterstrNo
tag_value_filterstrNo
table_name_filterstrNo
limitintNo
warehouse_idstrNo

Description: Manage Unity Catalog Volume files: list, upload, download, delete, mkdir, get_info.

Parameters:

ParameterTypeRequiredDescription
actionstrYes
volume_pathstrYes
local_pathOptional[str]No
local_destinationOptional[str]No
max_resultsintNo
recursiveboolNo
max_workersintNo
overwriteboolNo