cosmos-db-database
Manage Cosmos DB databases (mirrored from Azure Cosmos DB)
Authentication scope: fabric
List Cosmos DB databases in a workspace
fabio cosmos-db-database list --workspace <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
Read-only · Returns list
Show details of a Cosmos DB database
fabio cosmos-db-database show --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
Read-only · Returns object
create
Section titled “create”Create a new Cosmos DB database
fabio cosmos-db-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 |
Examples
fabio cosmos-db-database create --workspace $WS --name "CosmosOrders"Mutates state · Returns object
update
Section titled “update”Update Cosmos DB database properties
fabio cosmos-db-database update --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--name |
string |
No | New display name |
--description |
string |
No | New description |
Mutates state · Returns object
delete
Section titled “delete”Delete a Cosmos DB database
fabio cosmos-db-database delete --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB 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 Cosmos DB database
fabio cosmos-db-database get-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB 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 Cosmos DB database
fabio cosmos-db-database update-definition --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--file |
string |
No | Path to definition file |
--content |
string |
No | Inline definition content |
Mutates state · Long-running operation · Returns void
list-containers
Section titled “list-containers”List containers in a Cosmos DB database (data-plane)
fabio cosmos-db-database list-containers --workspace <value> --id <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Read-only · Returns list
create-container
Section titled “create-container”Create a container in a Cosmos DB database (data-plane)
fabio cosmos-db-database create-container --workspace <value> --id <value> --container <value> --partition-key <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--partition-key |
string |
Yes | Partition key path (e.g. /categoryId). A leading slash is added if omitted |
--autoscale-max |
integer |
No | Autoscale maximum throughput (RU/s). Fabric Cosmos is autoscale-only |
--ttl |
integer |
No | Default time-to-live for documents, in seconds (-1 = on, no expiry) |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Mutates state · Returns object
delete-container
Section titled “delete-container”Delete a container and all its documents (data-plane, irreversible)
fabio cosmos-db-database delete-container --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Mutates state · Destructive · Returns void
Run a query against a container (Cosmos DB data-plane)
fabio cosmos-db-database query --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--query-text |
string |
No | Query text (inline, @file, or piped via stdin) |
--parameter |
array |
No | Bind a query parameter as name=value (repeatable). Values are typed when numeric/boolean, else string |
--partition-key |
string |
No | Scope the query to a single partition-key value (else cross-partition) |
--max-item-count |
integer |
No | Max documents per page request (x-ms-max-item-count) |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Read-only · Returns list
import
Section titled “import”Bulk import documents from JSONL/JSON into a container (data-plane, upsert by default)
fabio cosmos-db-database import --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Target container name |
--source |
string |
No | Source file path (JSONL or JSON array). Reads stdin when omitted |
--format |
string |
No | Input format: jsonl, json-array, or auto |
--mode |
string |
No | Write mode: upsert (default, idempotent) or insert |
--concurrency |
integer |
No | Max concurrent writes (default: auto) |
--continue-on-error |
bool |
No | Skip invalid documents instead of aborting the import |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Mutates state · Returns object
show-container
Section titled “show-container”Show a container’s definition (partition key, indexing policy) (data-plane)
fabio cosmos-db-database show-container --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Read-only · Returns object
get-document
Section titled “get-document”Read a single document by id (data-plane)
fabio cosmos-db-database get-document --workspace <value> --id <value> --container <value> --document-id <value> --partition-key <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--document-id |
string |
Yes | Document id |
--partition-key |
string |
Yes | Partition-key value of the document (typed when numeric/boolean) |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Read-only · Returns object
create-document
Section titled “create-document”Create or upsert a single document (data-plane, upsert by default)
fabio cosmos-db-database create-document --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--file |
string |
No | Path to a JSON document file |
--content |
string |
No | Inline JSON document content |
--partition-key |
string |
No | Partition-key value (default: derived from the document’s partition-key field) |
--mode |
string |
No | Write mode: upsert (default, idempotent) or insert |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Mutates state · Returns object
delete-document
Section titled “delete-document”Delete a single document by id (data-plane, irreversible)
fabio cosmos-db-database delete-document --workspace <value> --id <value> --container <value> --document-id <value> --partition-key <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--document-id |
string |
Yes | Document id |
--partition-key |
string |
Yes | Partition-key value of the document (typed when numeric/boolean) |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Mutates state · Destructive · Returns void
export
Section titled “export”Export all documents from a container as JSONL to a file or stdout (data-plane)
fabio cosmos-db-database export --workspace <value> --id <value> --container <value>| Flag | Type | Required | Description |
|---|---|---|---|
--workspace |
string |
Yes | Workspace ID |
--id |
string |
Yes | Cosmos DB database ID |
--container |
string |
Yes | Container name |
--query-text |
string |
No | Optional filter query (default: SELECT * FROM c) |
--output-file |
string |
No | Write JSONL to this file (default: stdout) |
--endpoint |
string |
No | Override the Cosmos DB data-plane endpoint (default: resolved from item properties) |
Read-only · Returns object