SQL and relational

CockroachDB

CockroachDB uses PostgreSQL-style SQL with distributed database posture, Cockroach Cloud metadata, and preview-first cluster operations.

Available12 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 CockroachDB 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 CockroachDB 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.

    CockroachDB connection setup. The CockroachDB connection dialog with supported method tabs and illustrative, non-secret settings. Expand optional sections and review runtime limitations before saving.
    CockroachDB connection setup. The CockroachDB 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 CockroachDB Explorer where supported.

  4. 4

    Select a scope

    Select the database / schema 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.

    CockroachDB native workflow. A representative CockroachDB explorer and bounded read-only workflow. Replace the example objects with names from your datastore.
    CockroachDB native workflow. A representative CockroachDB 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.CockroachDB development
Connection methodYesChoose a supported tab. The fields below apply only to the selected method and deployment.Connection fields / 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
UsernameNoAuthentication identity for the selected method.catalog_reader
PasswordNoRequired 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
TransportNoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.tcp / unix-socket / cloud-sql-proxy / managed-postgres
Unix socket directoryNoGeneral. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Application nameNoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Search pathNoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Target sessionNoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.any / read-write / read-only
Use TLSNoTLS & certificates. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Verify server certificateNoTLS & certificates. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
CA certificateNoTLS & certificates. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Client certificateNoTLS & certificates. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Client keyNoTLS & certificates. 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
Statement timeout (ms)NoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Lock timeout (ms)NoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default
Idle transaction timeout (ms)NoAdvanced. Optional, depending on the method and server. Review runtime limitations before overriding the driver default.Driver default

Run the sample query

CockroachDB read-only example
SELECT id, name, status
FROM public.customers
ORDER BY id
LIMIT 25;

Explore and inspect

  • Browse databases, schemas, tables, indexes, regions, jobs, ranges, sessions, contention, roles, certificates, and zone configuration surfaces.
  • Inspect SQL result grids, cluster posture payloads, job rows, region/locality details, statement stats, and contention records.
  • Primary-key row edits follow the SQL identity model when a table target and key predicate are complete.

Diagnose, administer, and transfer

  • Review jobs, ranges, regions/localities, sessions, statement stats, transactions, locks, contention, statistics, certificates, and restricted-surface warnings.
  • Preview jobs, ranges, regions, sessions, contention, role/grant/default-privilege changes, zone configuration, backup, restore, import, and export workflows.
  • Import — Live. CockroachDB exports native CSV to server-accessible storage and imports into an existing empty table through a monitored IMPORT job. Destinations must use credential-free external, userfile, or node-local references. Formats: CockroachDB CSV (native). Destinations: cloud uri, server path.
  • Export — Live. CockroachDB exports native CSV to server-accessible storage and imports into an existing empty table through a monitored IMPORT job. Destinations must use credential-free external, userfile, or node-local references. Formats: CockroachDB CSV (native). Destinations: cloud uri, server path.
  • Backup — Live. CockroachDB uses managed BACKUP and RESTORE jobs. Formats: Native managed backup (native). Destinations: cloud uri, server path.
  • Restore — Live. CockroachDB uses managed BACKUP and RESTORE jobs. Formats: Native managed backup (native). Destinations: cloud uri, server path.
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, schemas, tables, indexes, regions, jobs, ranges, sessions, contention, roles, certificates, and zone configuration surfaces.
Read queriesAvailableRun read-oriented SQL, SHOW helpers, crdb_internal diagnostic snippets, distributed explain snippets, and bounded table queries.
Inline editingGuardedRequires key evidence, a writable profile, and environment confirmation.
Diagnostics / administrationGuardedPreview jobs, ranges, regions, sessions, contention, role/grant/default-privilege changes, zone configuration, backup, restore, import, and export workflows.
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 / schema, 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 CockroachDB datastore, confirm the selected database / schema, and keep the query bounded while you validate the result.