mirrored-catalog
Manage mirrored catalogs (Unity Catalog mirroring)
Authentication scope: fabric
List mirrored catalogs in a workspace
fabio mirrored-catalog list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a mirrored catalog
fabio mirrored-catalog show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
Read-only · Returns object
create
Section titled “create”Create a new mirrored catalog
fabio mirrored-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 |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Mutates state · Returns object
update
Section titled “update”Update mirrored catalog properties (name and/or description)
fabio mirrored-catalog update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a mirrored catalog
fabio mirrored-catalog delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
--hard-delete |
bool |
No | Permanently delete (cannot be recovered) |
Mutates state · Destructive · Returns void
get-definition
Section titled “get-definition”Get the definition of a mirrored catalog
fabio mirrored-catalog get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
--decode |
bool |
No | Decode base64 payloads inline (adds decodedPayload field) |
Read-only · Long-running operation · Returns object
update-definition
Section titled “update-definition”Update the definition of a mirrored catalog
fabio mirrored-catalog update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
--file |
string |
No | Path to definition file |
--content |
string |
No | Inline definition content |
Mutates state · Long-running operation · Returns void
refresh-metadata
Section titled “refresh-metadata”Refresh catalog metadata
fabio mirrored-catalog refresh-metadata --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
Mutates state · Long-running operation · Returns object
list-scopes
Section titled “list-scopes”List catalog mirroring scopes (workspace-level)
fabio mirrored-catalog list-scopes --workspace <value> --connection-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--connection-id |
string |
Yes | Connection ID of the catalog mirroring source (required) |
--parent |
string |
No | Parent scope to list under (optional) |
--recursive |
bool |
No | Recurse into nested scopes (optional) |
Read-only · Returns list
list-tables
Section titled “list-tables”List catalog mirroring tables (workspace-level)
fabio mirrored-catalog list-tables --workspace <value> --connection-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--connection-id |
string |
Yes | Connection ID of the catalog mirroring source (required) |
--scope |
string |
No | Scope to list tables under (optional) |
Read-only · Returns list
mirroring-status
Section titled “mirroring-status”Get mirroring status
fabio mirrored-catalog mirroring-status --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
Read-only · Returns object
tables-mirroring-status
Section titled “tables-mirroring-status”Get tables mirroring status
fabio mirrored-catalog tables-mirroring-status --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored catalog ID |
Read-only · Returns object