Adding Connections
Prerequisites
To add a connection, you need:
- A Collibra DQ account with ROLE_ADMIN permissions.
- Access to the account credentials of your connection, for example, PostgreSQL.
Adding a JDBC connection
This section shows you how to connect to a JDBC connection from the Connections Management page.
- Sign into Collibra DQ.
- Hover your cursor over the icon and click Admin Console.
The Admin Console opens. - Click Connections.
The Connections Management page opens. - Click Add next to a JDBC connection.
The New JDBC Connection template appears. - Enter the required information.
- Click Save.
Required | Connection Property | Type | Value | ||||||
---|---|---|---|---|---|---|---|---|---|
Yes |
Name | String | The unique name used for your connection. | ||||||
Yes |
Connection URL | String |
The connection string value of your connection. The Connection URL uses the following format: jdbc:<datasource>://$host:<port>/<AdditionalProperties> Replace the Connection URL to point to the database server to run DQ Jobs against. |
||||||
Yes |
Driver Name | String |
The driver class name. For example, a Google BigQuery JDBC driver may use the following convention: com.simba.googlebigquery.jdbc42.Driver |
||||||
Yes |
Port | Integer | The port for the connection to the data source host. | ||||||
No |
Source Name | String |
The alias name of your connection. While this is optional, you can use this to make it easier to identify your connection on the Catalog page and in API payloads. Tip There are no character restrictions for the Source Name field, but it is best practice to use only alphanumeric characters, hyphens, and underscores. |
||||||
No |
Target Agent | String | The Agent used to submit your DQ Job. | ||||||
No |
Pushdown | Option |
Enables Pushdown processing. This option is required for Pushdown Job submission. Note This option is currently only available for Snowflake and Databricks (beta) connections. |
||||||
Yes |
Auth Type | Option |
The method to authenticate your connection. Note The configuration requirements differ depending on the Auth Type you select. |
||||||
Yes |
Driver Location | File path |
The location where your driver file is saved. Click Upload to specify the Directory Name and select a Driver File. |
||||||
No |
Driver Properties | String | The configurable driver properties of your connection. | ||||||
No |
Sensitive Properties | String |
Define sensitive properties to hide in the Connection URL. Click Add Sensitive Property, then enter your information in the following format:
Tip If you need to redefine the value of a sensitive property, click the next to a saved sensitive property, then re-add it with the updated property value. |
PostgreSQL connection template example
Note This example uses a connection named metastore
that connects to a local PostgreSQL server (localhost:5432/postgres
)
Link Connection to Agent
Note Make sure to link a DB connection to a DQ Agent, if required.
Known Limitations
- When you update the name of a connection, a separate connection with the updated name is created in addition to the old connection. Because Collibra DQ treats this as a new connection, the Jobs and details from the old connection do not persist to the new one.
- When you edit an existing connection and its details, another connection is created and any sensitive properties from the old connection do not persist to the new connection.
- A possible workaround is to recreate the sensitive properties from the old connection in the new connection.