Skip to content

mirrored-databricks-catalog

Manage mirrored Azure Databricks catalogs

Authentication scope: fabric

List mirrored Azure Databricks catalogs in a workspace

Terminal window
fabio mirrored-databricks-catalog list --workspace <value>
Flag Type Required Description
--workspace string Yes Workspace ID

Read-only · Returns list

Show details of a mirrored Azure Databricks catalog

Terminal window
fabio mirrored-databricks-catalog show --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID

Read-only · Returns object

Create a new mirrored Azure Databricks catalog

Terminal window
fabio mirrored-databricks-catalog create --workspace <value> --name <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--name string Yes Display name
--description string No Optional description
--databricks-connection-id string No Azure Databricks workspace connection ID (creationPayload.databricksWorkspaceConnectionId). Required to actually MIRROR a catalog — without it, an empty shell is created
--catalog-name string No Unity Catalog name to mirror (creationPayload.catalogName)
--mirroring-mode enum No Mirroring mode: Full (all tables, auto-sync new ones) or Partial (selected tables) One of: Full, Partial.
--storage-connection-id string No Optional storage connection ID (creationPayload.storageConnectionId)
--sensitivity-label string No Sensitivity label ID to apply on creation

Mutates state · Returns object

Update mirrored Databricks catalog properties (name, description, auto-sync, mirroring mode)

Terminal window
fabio mirrored-databricks-catalog update --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID
--name string No New display name
--description string No New description
--auto-sync enum No Enable/disable auto-sync of newly added Databricks tables. Set to Enabled to start replication — a freshly created mirror defaults to Disabled and never syncs until this is enabled One of: Enabled, Disabled.
--mirroring-mode enum No Change the mirroring mode: Full (all tables), Partial (selected), or Exclude (all except selected) One of: Full, Partial, Exclude.
--storage-connection-id string No Storage connection ID for the mirror

Mutates state · Returns object

Delete a mirrored Azure Databricks catalog

Terminal window
fabio mirrored-databricks-catalog delete --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID
--hard-delete bool No Permanently delete (cannot be recovered)

Mutates state · Destructive · Returns void

Get the definition of a mirrored Databricks catalog

Terminal window
fabio mirrored-databricks-catalog get-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID
--decode bool No Decode base64 payloads inline (adds decodedPayload field)

Read-only · Long-running operation · Returns object

Update the definition of a mirrored Databricks catalog

Terminal window
fabio mirrored-databricks-catalog update-definition --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID
--file string No Path to definition file
--content string No Inline definition content

Mutates state · Long-running operation · Returns void

Refresh catalog metadata

Terminal window
fabio mirrored-databricks-catalog refresh-metadata --workspace <value> --id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--id string Yes Mirrored Databricks catalog ID

Mutates state · Returns object

Discover available Databricks catalogs (workspace-level)

Terminal window
fabio mirrored-databricks-catalog discover-catalogs --workspace <value> --connection-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--connection-id string Yes Databricks workspace connection ID (required)

Read-only · Returns object

Discover schemas in a Databricks catalog

Terminal window
fabio mirrored-databricks-catalog discover-schemas --workspace <value> --catalog-name <value> --connection-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--catalog-name string Yes Catalog name
--connection-id string Yes Databricks workspace connection ID (required)

Read-only · Returns object

Discover tables in a Databricks catalog schema

Terminal window
fabio mirrored-databricks-catalog discover-tables --workspace <value> --catalog-name <value> --schema-name <value> --connection-id <value>
Flag Type Required Description
--workspace string Yes Workspace ID
--catalog-name string Yes Catalog name
--schema-name string Yes Schema name
--connection-id string Yes Databricks workspace connection ID (required)

Read-only · Returns object