DataPad++Download

Document and NoSQL

Cosmos DB

Cosmos DB supports parameterized SQL API reads with a visual NoSQL builder and bounded continuation-token paging, plus a native GraphSON v2 Gremlin WebSocket runtime with Cosmos authentication, bounded graph results, and request-charge metrics.

Available for NoSQL queries; cloud administration is guarded12 minDesktop

Prerequisites

  • Install the current DataPad++ desktop pre-release on Windows, macOS, or Linux.
  • Have the endpoint, database file, or cloud account details for a Cosmos DB datastore you are authorized to use. Start with least-privileged, read-only access.
  • Keep an independent backup before enabling edits, administration, restore, or transfer execution.

Connect and run a safe query

  1. 1

    Create the connection

    Open Library, choose Create connection, and select Cosmos DB and a supported Connection method tab.

  2. 2

    Test and save

    Complete the applicable fields and enable Read-only connection. Test connection when available; new local files and pending secondary credential changes must be saved first. Review runtime limitations and warnings.

    Cosmos DB connection setup. The Cosmos DB connection dialog with supported method tabs and illustrative, non-secret settings. Expand optional sections and review runtime limitations before saving.
    Cosmos DB connection setup. The Cosmos DB connection dialog with supported method tabs and illustrative, non-secret settings. Expand optional sections and review runtime limitations before saving. Open full size
  3. 3

    Open the native explorer

    Use Save Connection, or Create Database and Save Connection for a new local file, then open the Cosmos DB Explorer where supported.

  4. 4

    Select a scope

    Select the database / container scope that should be attached to the new tab.

  5. 5

    Run a bounded read

    Open a query tab, paste the bounded read-only sample below, and choose Run or press Ctrl/Cmd+Enter.

    Cosmos DB native workflow. A representative Cosmos DB explorer and bounded read-only workflow. Replace the example objects with names from your datastore.
    Cosmos DB native workflow. A representative Cosmos DB explorer and bounded read-only workflow. Replace the example objects with names from your datastore. Open full size
  6. 6

    Inspect the result

    Inspect Results, Messages, History, and Details; dock the panel on the bottom or right as needed.

  7. 7

    Export when needed

    Export only the required rows after reviewing format, destination, and redaction options.

  8. 8

    Open diagnostics or transfers

    Open Diagnostics or Transfers from the drawer/status bar and treat disabled reasons as capability boundaries, not transient errors.

Connection fields

FieldRequiredPurposeSafe example
NameYesA clear profile name, without credentials.Cosmos DB development
Connection methodYesChoose a supported tab. The fields below apply only to the selected method and deployment.Cloud / endpoint settings / Connection string
EnvironmentNoAttach the intended variable and safety context.Local development
Read-only connectionNoEnable for initial exploration. This does not make pre-release software safe for production workloads.Enabled
Host / PortNoEndpoint for a fields-based connection. Follow the selected deployment and runtime limitations; MongoDB SRV does not use an explicit port.localhost / engine default
Database / default scopeNoInitial scope for browsing, where supported.catalog
Complete connection stringYesRequired in Connection string mode only. Saved unchanged as one vault secret with Save Connection. Blank keeps an existing stored value.Paste your complete provider string; do not share it
Account key / resource tokenNoRequired only when the chosen authentication needs it. Save Connection stores changes; blank preserves an existing value, and Reveal… explicitly discloses it.Stored in the desktop OS vault
Connection modeNoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.emulator / account-endpoint / resource-token
APINoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.nosql / gremlin
AuthenticationNoAuthentication. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.emulator / account-key / resource-token
Account endpointNoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Database nameNoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Allow emulator certificateNoTLS & certificates. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Page sizeNoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Connect timeout (ms)NoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Request timeout (ms)NoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Maximum retry attemptsNoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default

Run the sample query

Cosmos DB read-only example
SELECT TOP 25 c.id, c.name, c.category
FROM c
WHERE c.active = true

Explore and inspect

  • Browse databases, containers, partition keys, indexing policies, throughput, consistency, regions, access, diagnostics, and API-specific native branches.
  • Inspect document rows or normalized graph nodes and edges, raw JSON, RU/query metrics, opaque continuation state or partial-response signals, partition metadata, and container posture cards.

Diagnose, administer, and transfer

  • Review RU consumption, query metrics, indexing posture, region/failover posture, consistency, partition-key shape, access, and API disabled reasons.
  • Preview throughput changes, indexing policy changes, consistency changes, failover, access checks, exports, imports, and guarded container drops.
  • Import — Live. Cosmos DB NoSQL streams lossless documents with explicit identity and hierarchical partition-routing metadata. Imports use create semantics and never replace an existing id/partition pair. Formats: Cosmos DB JSON Lines (native). Destinations: local file.
  • Export — Live. Cosmos DB NoSQL streams lossless documents with explicit identity and hierarchical partition-routing metadata. Imports use create semantics and never replace an existing id/partition pair. Formats: Cosmos DB JSON Lines (native). Destinations: local file.
  • Backup — Plan only. Cosmos DB exposes platform-managed restore operations. Formats: Native managed backup (native). Destinations: managed restore, cloud uri. Cosmos DB managed restore requires Azure control-plane identity, an eligible backup policy, an isolated destination account, and opt-in real-service validation.
  • Restore — Plan only. Cosmos DB exposes platform-managed restore operations. Formats: Native managed backup (native). Destinations: managed restore, cloud uri. Cosmos DB managed restore requires Azure control-plane identity, an eligible backup policy, an isolated destination account, and opt-in real-service validation.
Transfers Center. Transfers Center shows a failed example transfer with its warning count, failure detail, retry control, and dismiss action.
Transfers Center. Transfers Center shows a failed example transfer with its warning count, failure detail, retry control, and dismiss action. Open full size

Capabilities and availability

CapabilityStatusNotes
Native explorerAvailableBrowse databases, containers, partition keys, indexing policies, throughput, consistency, regions, access, diagnostics, and API-specific native branches.
Read queriesAvailableBuild Cosmos SQL reads visually with fields, typed filters, AND/OR logic, sorting, offset/limit, partition routing, and exact Count, or run live Gremlin traversals. NoSQL paging is cancellable and session-aware; Gremlin responses aggregate partial GraphSON messages into bounded graph, object, table, JSON, profile, and metrics views.
Inline editingUnavailableUse a reviewed statement or the engine-native tool instead.
Diagnostics / administrationGuardedPreview throughput changes, indexing policy changes, consistency changes, failover, access checks, exports, imports, and guarded container drops.
Import / export / transferGuardedAvailability follows the authoritative runtime transfer manifest and shows a disabled reason when execution is not implemented.

Safety and limitations

Troubleshooting

SymptomResolution
Test connection fails or times outVerify endpoint, port, TLS mode, proxy settings, service health, firewall rules, and network access. Keep the profile unsaved until the test explains the failure.
Explorer branches are empty or disabledConfirm the selected database / container, refresh the branch, and grant the minimum metadata permissions described in the connection warning.
Run, edit, admin, or transfer is disabledRead the visible disabled reason. Select a compatible target, turn off read-only only when authorized, or use the documented preview/export fallback.
The sample query fails or returns different columnsReplace the example names with objects from your Cosmos DB datastore, confirm the selected database / container, and keep the query bounded while you validate the result.

Related content

Create and organize connectionsContinue with this DataPad++ guide.Native datastore transfersContinue with this DataPad++ guide.Safety modelContinue with this DataPad++ guide.
PreviousCassandraNextLiteDB