Skip to content
User Guide

Resource → Database Shell

For database resources (PostgreSQL, MySQL, MariaDB, SQL Server, ClickHouse), the Connect terminal icon in the location tree opens an interactive SQL shell pre-authenticated against the resource. The worker connects on your behalf using the credentials supplied for the connection; you then type SQL and see results.

The terminal experience mirrors the SSH terminal; only the connect step and the SQL-aware behaviour differ.

Each connection opens its own pin. You can open up to three shell sessions per user/resource by default, across all shell modes; administrators can change this limit. Select an existing connection pin to return to it without opening another shell. This limit is shared with native SSH connections.

What you can do

  • Open a SQL prompt against any database discovered on the resource.
  • Open another database in its own connection pin.
  • Enable AI assistance for help writing or understanding queries.
  • Share the session with teammates or external guests, with in-session chat.

Common tasks

Start a session

  1. Pick a database in the connection-options dialog after clicking the Connect terminal icon in the location tree, or keep the pre-selected one.
  2. Click Connect. The shell opens once the connection is authenticated.

The database list is discovered by the resource’s connectivity check. If it is empty, collect a fresh snapshot first (see Conditions and blockers).

If Authentication required appears, enter credentials or choose a compatible personal/team credential with Use vault, then click Connect. Saved credentials for templates are used automatically. See providing credentials when connecting.

Switch database

Click Connect beside the resource in the location tree and choose the other database. Disconnect an existing shell first if you have reached the resource limit.

Share and AI-assist

Identical to an SSH session — see Resource → SSH Terminal for the detailed workflow.

Database Actions (read-only diagnostics)

The Actions tab on a database resource offers a catalog of ready-made, read-only diagnostic queries grouped by category (for example connection, performance, and schema checks). Pick a category and a command, fill any parameters it offers, and click Execute; results appear as a table or structured tree and can be exported to CSV. These actions are read-only — they inspect the database without changing it. See the Actions tab for how it works in general.

Conditions and blockers

  • You do not have permission to open sessions — you lack the app.resources.execute permission.
  • No databases discovered — collect a fresh snapshot from the page header (the collect button next to the snapshot picker, tooltip Collect new snapshot); collection re-runs the connectivity check, which populates the list of databases you can open.
  • Authentication required — enter credentials or choose a compatible personal/team entry with Use vault. To avoid the prompt for future connections, save your credential for the template in Account → Personal Vault.

Permissions

  • Open an interactive session: app.resources.execute.
  • Run database diagnostic actions: app.resources.read (the shipped diagnostics are all read-mode commands).
  • Share a session and invite participants: app.session.execute.
  • Attach AI assistance: app.ai.execute and a configured Session Assist agent with an available model.