Skip to content

Managing Connections

Managing Connections

DBeagle keeps connection management lightweight and VS Code-native:

  • Connection definitions live in the dbeagle.connections setting.
  • Passwords live in VS Code SecretStorage.
  • Trino headers also live in SecretStorage.
  • The active connection controls tree browsing, query execution, autocomplete context, and SQL dialect resolution for generic sql files.

Adding a connection

You can open the connection form from either place:

  • The Add Connection button in the Connections view
  • The DBeagle: Add Connection command in the Command Palette

Common fields

FieldDescription
NameFriendly label shown in the tree and picker UIs
DriverTrino, PostgreSQL, MySQL, SQL Server, or Vertica
HostDatabase host or endpoint
PortDriver-specific default port, editable when needed
Catalog / DatabaseThe default catalog or database for the session
SchemaThe default schema when the driver supports it
UserDatabase username
PasswordStored securely in VS Code
SSL / TLSToggle encrypted transport when your endpoint requires it
TimeoutPer-connection timeout override in seconds

Advanced fields

FieldDriverDescription
HeadersTrinoCustom HTTP headers such as bearer tokens or proxy headers
Session propertiesTrinoKey/value session properties sent with queries
Verify server certificateTrino, PostgreSQL, MySQL, VerticaTurn off only for trusted development endpoints
Trust server certificateSQL ServerAccept an otherwise untrusted SQL Server TLS certificate
Max pooled connectionsPostgreSQL, MySQL, SQL Server, VerticaOptional connection pool cap

Connection management in DBeagle

The connection form used for adding, testing, and saving connections.

Testing before save

Use Test Connection before saving. DBeagle verifies:

  • Network connectivity
  • Authentication credentials
  • Basic server reachability through the selected driver

If the test passes, choose either:

  • Save to keep the connection without activating it
  • Save and Connect to make it active immediately

Editing, duplicating, and removing

  • Edit Connection opens the saved settings back in the form.
  • Duplicate Connection creates a copy you can tweak for another environment.
  • Remove Connection deletes the saved definition and any stored secret entries for it.

Connecting and disconnecting

  • Click a saved connection in the tree to connect.
  • Use the inline Connect and Disconnect actions from the tree item context.
  • Use the connection picker from the editor toolbar when you are working in a SQL file.

The active connection is also reflected in the status bar and in the editor title toolbar for SQL files.

Schema selection

When a driver exposes schemas, use Select Active Schemas to scope what DBeagle shows.

This scope affects:

  • The Connections tree
  • SQL autocomplete metadata
  • Other metadata-driven surfaces that use the shared schema snapshot

It is a usability filter, not a security boundary. For sensitive environments, still use scoped or read-only database credentials.

Refreshing metadata

Use Refresh Schema when:

  • New tables or columns were added recently
  • Autocomplete looks stale
  • You changed schema scope and want a fresh metadata snapshot

Previewing tables and views

Click any table or view in the tree to run a bounded preview query. This is the fastest way to inspect data without writing SQL first.

Read-only and write mode

The Connections view header includes the safety toggle:

  • When read-only is enabled, DBeagle blocks mutating SQL before execution.
  • When write mode is enabled, DBeagle allows those statements through.

Read-only protection applies globally in the current release.

Driver-specific guides