Skip to content
DBeagle

Quick Start

Quick Start

This walkthrough takes you from install to your first result grid.

Step 1: Install DBeagle

Follow the Installation guide if you have not installed the extension yet.

Step 2: Add a connection

  1. Open the DBeagle Activity Bar icon.
  2. In the Connections view, click Add Connection.
  3. Choose your driver.
  4. Fill in the connection form.
  5. Click Test Connection.
  6. Click Save and Connect when the test succeeds.
FieldDescription
NameA friendly label such as Prod Warehouse or Local Postgres
HostThe database hostname
PortThe database port for that driver
Catalog / DatabaseThe default catalog or database for the session
SchemaThe default schema when that driver supports one
UserThe database user name
PasswordThe database password, stored in VS Code SecretStorage

DBeagle connection form

The DBeagle connection form for adding and testing a database connection.

Step 3: Explore your database

After DBeagle connects, the Connections tree populates with the objects it can browse for that driver.

Connection
  -> Catalog or database
  -> Schema
  -> Table or view
  -> Column

Click any table or view to run a bounded preview query. This is a fast way to validate that the connection works and that you are looking at the right schema.

Step 4: Run a query

  1. Open a .sql file, or create one.
  2. Write a query such as:
select *
from orders
limit 100;
  1. Press Cmd+Enter on macOS or Ctrl+Enter on Windows and Linux.
  2. The result opens in the DBeagle Results panel.

If you select part of the SQL first, DBeagle runs only the selected text by default.

Step 5: Use parameters when you need reusable SQL

Named $parameters let you keep one query template and swap values before execution:

select *
from orders
where order_date >= $start_date
  and order_date < $end_date;

When DBeagle detects parameters, the Parameters view shows inputs for the current file or selection.

Step 6: Work with the result grid

ActionHow
Search rowsUse the search box in the results toolbar
Sort a columnClick the sort control in a header
Filter a columnType into that column’s filter input
Resize columnsDrag the header resize handle
Reorder columnsDrag a column header
Copy a selectionSelect cells, rows, or columns and copy them
Export dataUse the export menu for CSV or JSON
Open chart viewSwitch from Grid to Chart when the result supports it
Detach resultsOpen the result in its own editor tab

DBeagle result grid

A completed result set in the DBeagle Results panel.

Step 7: Keep the right safety mode on

DBeagle starts with read-only protection enabled. That is the recommended mode for production and shared environments.

If you intentionally need to run writes, use the button in the Connections view header to switch into write mode first. DBeagle will then allow mutating SQL instead of blocking it.

Next steps