Docs/Connections

Connection Management Guide

Connections are managed directly in the Data Explorer sidebar. The sidebar lists all configured connections — databases, local files, and S3-compatible storage — with their tree of schemas, tables, and objects.

From the sidebar you can:

  • create connections (click + New Connection)
  • edit credentials and transport settings
  • test access
  • clone reusable configurations
  • browse schemas, tables, and files inline
  • prepare source and target pairs for streams

Connection entries

Each connection in the sidebar shows:

  • connection name and type icon
  • database connections: host and port
  • file connections: base path
  • S3 connections: bucket or endpoint

Hover over a connection to reveal quick actions: Edit (pencil), Clone (copy), and Delete (trash).

Adding a new connection

Typical flow:

  1. Click New connection.
  2. Select the connection type.
  3. Fill in the required parameters.
  4. Configure SSL/TLS if needed.
  5. Test the connection.
  6. Save it once validation succeeds.

Connection types

When you click New connection, you select one of three connection families. Each has its own settings panel.

Database connections

Database connections currently use MySQL or PostgreSQL settings. Snowflake target support is documented separately and is not yet publicly available.

These database connections use:

  • name
  • host and port
  • username and password
  • database or initial scope
  • optional connection-string import

Local file connections

Local file connections point to a directory on the machine running DBConvert Streams.

SettingRequiredDescription
NameYesConnection label
Base pathYesRoot directory for file browsing (e.g. /data/exports)

Once saved, the connection tree in Data Explorer shows folders and files under the base path. Supported formats: CSV, JSON/JSONL, and Parquet. Files can be previewed, queried with SQL, and used as sources or targets in Convert streams.

For format details and SQL workflows, see Local Files.

S3-compatible storage connections

S3 connections let you browse buckets, query objects with SQL, and use S3 as a stream source or target. Built-in presets are available for AWS S3, Google Cloud Storage, Cloudflare R2, DigitalOcean Spaces, Backblaze B2, and MinIO. Use the Custom preset for other S3-compatible providers.

For connection settings, provider presets, and provider-specific setup, see S3-Compatible Storage.

SSL and secure transport

Use SSL/TLS settings when the selected environment requires encrypted transport or certificate validation.

For full guidance, use SSL Configuration.

Common actions

Edit

Use edit when credentials, host details, database scope, or transport settings change.

Clone

Use clone when you need a similar connection with small changes, such as:

  • another environment
  • another database
  • another region or provider

Delete

Delete removes the saved configuration. Use it only after confirming nothing still depends on it.

Best practices

  1. Use descriptive names that encode environment or purpose.
  2. Test every connection before using it in a stream.
  3. Validate visibility in Data Explorer before assuming the stream scope is correct.
  4. Use SSL/TLS in production-relevant environments where appropriate.
  5. Remove unused connections to keep the workspace readable.
PreviousOS CompatibilityNextMySQL Server Setup