Skip to content

Database Connections ​

Manage connections to your application databases. These are the databases your services use — not the internal Ops Atlas database.

Access ​

Navigate to Database in the sidebar or go to /database.

Key Features ​

  • Store connection details for databases across all environments
  • Test connectivity before saving
  • Organize connections by environment (QA, Stage, Prod)
  • Connections are used by Schema Comparison and Migration Wizard

Usage ​

Adding a Connection ​

  1. Navigate to /database and click Add Connection
  2. Fill in the connection details:
FieldDescriptionExample
NameA descriptive labelOrders DB - QA
EnvironmentWhich environment this belongs toqa
HostDatabase server hostnamedb-qa-01.internal
PortDatabase port5432
DatabaseDatabase nameorders
UsernameDatabase userapp_readonly
PasswordDatabase password••••••
  1. Click Test Connection to verify connectivity
  2. Save the connection

Managing Connections ​

The connection list shows all saved connections grouped by environment. From here you can:

  • Edit — update connection details
  • Test — re-verify connectivity
  • Delete — remove a connection

TIP

Use read-only database credentials for connections used only in schema comparison. Write access is only needed for migrations.

Using Connections ​

Saved connections are referenced by the schema comparison and migration tools. Select source and target connections from your saved list when running comparisons or migrations.

API ​

GET    /api/database/connections           # List all connections
POST   /api/database/connections           # Create a connection
PUT    /api/database/connections/{id}      # Update a connection
DELETE /api/database/connections/{id}      # Delete a connection
POST   /api/database/connections/{id}/test # Test connectivity

Managed by DatabaseConnectionController.

Released under the MIT License.