Add RDBMS Panel
Overview
The Add RDBMS panel allows administrators and data engineers to securely connect Relational Database Management Systems (such as PostgreSQL, MySQL, MS SQL, Oracle, etc.) to the DataFloem platform.
Databases defined through this panel serve as structural operational endpoints within data integration pipelines, acting as logical points for both ingestion (Sources) and delivery (Targets).
Access Requirements
To access this page, the user must either have Administrator privileges or the CREATE permission for the Target module.
The CREATE permission allows users to create new groups. Users without administrator privileges or the required permission cannot access this page.
If you do not have the required permission, ask your administrator to grant it from one of the authorization pages below.
Authorization
Users without the required authorization will receive the following error:
Access Denied
You don't have access to this resource.
Prerequisites
Before establishing an RDBMS connection, ensure that:
- Network line connectivity and firewall pathways are cleared between DataFloem and the target server IP/Port.
- You possess valid database credentials provisioned with sufficient read, write, and query execution permissions.
Form Elements
The fields that need to be configured within the panel are as follows:
| Field | Required? | Description |
|---|---|---|
| Connection Name | Yes | A unique alias identifying this database connection across the platform. |
| Database Type | Yes (Dropdown) | Selects the engine architecture of the target database (e.g., PostgreSQL, MySQL). |
| Database Version | Yes (Dropdown) | Selects the precise version mapping to ensure correct driver dependencies. |
| Is Active | Yes (Toggle) |
Defines whether the connection is active immediately upon
deployment. Enabled (on) by default.
|
| Host | Yes | The IP address or domain endpoint of the database server. |
| Port | Yes |
The service communication port (e.g.,
5432 for PostgreSQL,
3306 for MySQL).
|
| Database Name | Yes | The exact target database instance or schema name to be accessed. |
| Username | Yes | The authorized database user account string. |
| Password | Yes | The credential password (Visibility can be toggled using the eye icon). |
| Test Connection | Button | Simulates an immediate end-to-end handshake with the target server. |
| Optional Parameters (Name / Value) | No |
Dynamic entries used to pass fine-grained connection string
parameters (e.g., sslmode,
timeout).
|
| Is Secret (Optional Parameters) | Yes (Toggle) | Encrypts and masks the specific parameter value within internal stores. |
Test Connection Behavior
-
Clicking the Test Connection button triggers a
real-time verification handshake with the target database using the
provided
Host,Port,Username, andPasswordparameters. - If the handshake succeeds, a green success banner is displayed, confirming network connectivity.
- If the handshake fails, a red error prompt appears detailing network or authorization issues. Validating the connection prior to saving is highly recommended.
RDBMS Connection Deployment Process
- Click the Add RDBMS action button on the workspace dashboard to trigger the side panel.
- Enter a unique Connection Name, then designate the Database Type and Database Version.
- Fill in the server connectivity details including Host, Port, Database Name, Username, and Password.
- If required, add custom key-value arguments under Optional Parameters and toggle Is Secret appropriately.
- Click Test Connection to confirm connectivity to the target database server.
- Once validated, click Save to commit the asset to the platform, or click Cancel to abort the operation.
Validation Rules
- Connection Name, Host, Port, Database Name, Username, and Password fields cannot be left empty.
- The Port field must contain a valid numerical integer within the port range (1-65535).