sql-database
Manage SQL databases (Fabric-native transactional databases)
Authentication scope: fabric
List SQL databases in a workspace
fabio sql-database list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a SQL database
fabio sql-database show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Read-only · Returns object
create
Section titled “create”Create a new SQL database
fabio sql-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 |
--creation-mode |
string |
No | Creation mode: New, Restore, or RestoreDeletedDatabase |
--backup-retention-days |
string |
No | Backup retention period in days (1-35, for mode=New) |
--collation |
string |
No | Database collation (for mode=New) |
--source-workspace |
string |
No | Source database workspace ID (for mode=Restore) |
--source-database |
string |
No | Source database item ID (for mode=Restore) |
--restore-point |
string |
No | Point-in-time to restore (ISO 8601, for mode=Restore or RestoreDeletedDatabase) |
--restorable-deleted-database-name |
string |
No | Name of the restorable deleted database (for mode=RestoreDeletedDatabase) |
--sensitivity-label |
string |
No | Sensitivity label ID to apply on creation |
Examples
fabio sql-database create --workspace $WS --name "OrdersDB"Mutates state · Returns object
update
Section titled “update”Update SQL database properties
fabio sql-database update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a SQL database
fabio sql-database delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL 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 SQL database (dacpac or sqlproj format)
fabio sql-database get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--format |
string |
No | Definition format: dacpac or sqlproj (default: dacpac) |
--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 SQL database
fabio sql-database update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--file |
string |
No | Definition file path (.dacpac or .sqlproj) |
--content |
string |
No | Definition as inline base64 content |
--format |
string |
No | Definition format: dacpac or sqlproj (default: dacpac) |
--update-metadata |
bool |
No | Also update item metadata from the definition |
Mutates state · Long-running operation · Returns void
start-mirroring
Section titled “start-mirroring”Start mirroring for the SQL database
fabio sql-database start-mirroring --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Mutates state · Returns void
stop-mirroring
Section titled “stop-mirroring”Stop mirroring for the SQL database
fabio sql-database stop-mirroring --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Mutates state · Returns void
revalidate-cmk
Section titled “revalidate-cmk”Revalidate Customer-Managed Key (CMK) for the SQL database
fabio sql-database revalidate-cmk --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Mutates state · Long-running operation · Returns void
get-audit-settings
Section titled “get-audit-settings”Get SQL audit settings for the database
fabio sql-database get-audit-settings --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Read-only · Returns object
update-audit-settings
Section titled “update-audit-settings”Update SQL audit settings for the database
fabio sql-database update-audit-settings --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--state |
string |
No | Audit state: Enabled or Disabled |
--retention-days |
string |
No | Retention days (0 = indefinite) |
--audit-actions |
string |
No | Audit actions and groups (comma-separated) |
--predicate-expression |
string |
No | Predicate expression for filtering audit logs |
Mutates state · Returns object
list-deleted
Section titled “list-deleted”List restorable deleted SQL databases in a workspace
fabio sql-database list-deleted --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Execute a SQL query against a SQL database via TDS
fabio sql-database query --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--sql |
string |
No | SQL query to execute (prefix with @ to read from file, omit to read from stdin) |
Examples
fabio sql-database query --workspace $WS --id $DB --sql "SELECT status, COUNT(*) as cnt FROM orders GROUP BY status"Mutates state · Returns object
Capture the estimated execution plan (SHOWPLAN_XML) without executing the query
fabio sql-database plan --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--sql |
string |
No | SQL query to plan (prefix with @ to read from file, omit to read from stdin) |
Read-only · Returns object
connection-string
Section titled “connection-string”Show the TDS connection string for a SQL database
fabio sql-database connection-string --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Examples
fabio sql-database connection-string --workspace $WS --id $DBRead-only · Returns object
import
Section titled “import”Import data from a CSV or JSON file into a SQL database table
fabio sql-database import --workspace <value> --id <value> --file <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--file |
string |
Yes | Path to the CSV or JSON file to import |
--table |
string |
No | Target table name (default: inferred from filename) |
--no-create-table |
bool |
No | Skip automatic CREATE TABLE (table must already exist) |
--drop-if-exists |
bool |
No | Drop and recreate the table if it already exists |
--batch-size |
integer |
No | Batch size for INSERT statements (default: 100) Default: 100. |
Examples
fabio sql-database import --workspace $WS --id $DB --file orders.csv --table orders --drop-if-existsfabio sql-database import --workspace $WS --id $DB --file events.json --table events --batch-size 500Mutates state · Returns object
queries-running
Section titled “queries-running”List currently running queries on a SQL database
fabio sql-database queries-running --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
Read-only · Returns object
queries-history
Section titled “queries-history”List completed query history
fabio sql-database queries-history --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--top |
string |
No | Number of rows to return |
--label |
string |
No | Filter to queries tagged with this OPTION (LABEL = ‘…’) value |
Read-only · Returns object
queries-kill
Section titled “queries-kill”Kill a running query session by session ID
fabio sql-database queries-kill --workspace <value> --id <value> --session-id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--session-id |
string |
Yes | Session ID to kill |
Mutates state · Destructive · Returns object
statistics-list
Section titled “statistics-list”List statistics on a SQL database
fabio sql-database statistics-list --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--table |
string |
No | Filter by table (schema.table or just table name) |
Read-only · Returns object
statistics-show
Section titled “statistics-show”Show details of a statistic
fabio sql-database statistics-show --workspace <value> --id <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--name |
string |
Yes | Statistic name |
Read-only · Returns object
statistics-create
Section titled “statistics-create”Create a user-defined statistic on a column
fabio sql-database statistics-create --workspace <value> --id <value> --table <value> --column <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--table |
string |
Yes | Table name (schema.table or just table name) |
--column |
string |
Yes | Column name |
--name |
string |
Yes | Statistic name |
Mutates state · Returns object
statistics-update
Section titled “statistics-update”Update (refresh) an existing statistic
fabio sql-database statistics-update --workspace <value> --id <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--name |
string |
Yes | Statistic name |
Mutates state · Returns object
statistics-delete
Section titled “statistics-delete”Delete a user-defined statistic
fabio sql-database statistics-delete --workspace <value> --id <value> --name <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | SQL database ID |
--name |
string |
Yes | Statistic name |
Mutates state · Returns object