Database Connection
Database Connection allows Qubase to communicate with an existing database. Once connected, you can inspect database objects, import schemas, reverse engineer structures, and synchronize changes between your database and visual models.
A successful connection is the first step before using advanced Database Engineering features.
Before you begin
Before connecting a database, ensure that you have:
- Access to a supported database system
- Database connection credentials
- Network access to the database server
- Permission to read the database schema
[!NOTE] Connecting to a development or staging database is recommended instead of connecting directly to a production environment.
Supported database systems
Qubase supports connecting to supported relational database systems.
Depending on your project configuration, available systems may include:
- PostgreSQL
- MySQL
- Microsoft SQL Server
Additional database systems may be supported in future releases.
Connection information
When creating a new connection, provide the required database information.
| Field | Description |
|---|---|
| Connection Name | Friendly name used inside Qubase |
| Database Type | Target database system |
| Host | Database server address |
| Port | Database server port |
| Database Name | Database to connect to |
| Username | Database login username |
| Password | Database login password |
Create a connection
To create a database connection:
- Open the Database Engineering module.
- Select Database Connections.
- Click New Connection.
- Enter the required connection information.
- Test the connection.
- Save the configuration.
If the connection is successful, the database becomes available for engineering tasks.
Test connection
Before saving the configuration, Qubase validates the connection.
The validation may include:
- Server availability
- Authentication
- Database existence
- Network accessibility
- User permissions
If validation fails, Qubase displays the detected issue.
Connection status
Each saved connection displays its current status.
| Status | Meaning |
|---|---|
| Connected | Database is available |
| Disconnected | Database is currently unavailable |
| Invalid | Connection configuration is incorrect |
| Error | An unexpected connection error occurred |
Security recommendations
To help protect your database:
- Use strong database credentials.
- Connect using secure network configurations.
- Limit database permissions to only what is required.
- Avoid sharing database credentials.
- Review saved connections regularly.
[!IMPORTANT] Never use highly privileged database accounts unless they are required for your engineering workflow.
What you can do after connecting
Once connected, you can:
- Reverse engineer an existing database
- Inspect database objects
- Compare schema changes
- Generate ERD diagrams
- Synchronize database structures
- Export SQL scripts
Troubleshooting
Unable to connect
Verify that:
- The database server is running.
- The host and port are correct.
- Your username and password are valid.
- Firewall rules allow access.
- Your account has permission to access the database.
Authentication failed
Double-check your credentials and verify that your database user has the necessary permissions.