mirrored-database
Manage mirrored databases (real-time replication)
Authentication scope: fabric
List mirrored databases in a workspace
fabio mirrored-database list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a mirrored database
fabio mirrored-database show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Read-only · Returns object
create
Section titled “create”Create a new mirrored database
fabio mirrored-database 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 |
--open-mirroring |
bool |
No | Configure as an OPEN mirrored database (push-based; source type GenericMirror). Push data files to the landing zone (see mirrored-database landing-zone) — no source connection needed |
--default-schema |
string |
No | Default schema for the mirrored tables (open mirroring; default: dbo) |
Examples
fabio mirrored-database create --workspace $WS --name "MirroredSalesDB"Mutates state · Returns object
landing-zone
Section titled “landing-zone”Print the OneLake landing-zone URL of an OPEN mirrored database (push data files here)
fabio mirrored-database landing-zone --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Read-only · Returns object
update
Section titled “update”Update mirrored database properties (name and/or description)
fabio mirrored-database update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a mirrored database
fabio mirrored-database delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database 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 database
fabio mirrored-database get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database 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 database
fabio mirrored-database update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
--file |
string |
No | Definition as JSON file path |
--content |
string |
No | Definition as inline JSON |
Mutates state · Long-running operation · Returns void
Start mirroring
fabio mirrored-database start --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Examples
fabio mirrored-database start --workspace $WS --id $MDBMutates state · Returns object
Stop mirroring
fabio mirrored-database stop --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Mutates state · Returns object
status
Section titled “status”Get mirroring status
fabio mirrored-database status --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Examples
fabio mirrored-database status --workspace $WS --id $MDBRead-only · Returns object
table-status
Section titled “table-status”Get tables mirroring status
fabio mirrored-database table-status --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Mirrored database ID |
Examples
fabio mirrored-database table-status --workspace $WS --id $MDB -o tableRead-only · Returns object