> For the complete documentation index, see [llms.txt](https://docs.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.collibra.com/data-quality-self-hosted/connections/connect-to-a-jdbc-or-remote-file-data-source.md).

# Connect to a JDBC or remote file data source

This topic shows you how to create a new data source connection.

{% hint style="success" %}
For more information on the data sources supported by Data Quality & Observability (self-hosted), see [Supported Connections](/data-quality-self-hosted/connections/supported-connections.md).
{% endhint %}

## Prerequisites

To add a connection, you need:

* A Collibra DQ account with ROLE\_ADMIN or ROLE\_CONNECTION\_MANAGER permissions.
* Access to the account credentials of your connection, for example, PostgreSQL.

## Adding a JDBC or remote file connection

This section shows you how to connect to a JDBC or remote file data source from the Connection Management page. Select an option from the tabs below.

{% tabs %}
{% tab title="JDBC Connections" %}
{% stepper %}
{% step %}
Sign in to Collibra DQ.
{% endstep %}

{% step %}
Hover your cursor over the <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-75245abf5c50ddf56f1d2d727ccaacf757d11145%2Fcogwheel-large%402x.png?alt=media" alt="" data-size="line"> icon and click **Admin Console**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The Admin Console opens.
{% endstep %}

{% step %}
Click **Connections**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Connection Management** page opens.
{% endstep %}

{% step %}
Click **Add Connection** in the upper-right corner.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Add New Connection** dialog box opens to the JDBC Connections tab with a list of [supported JDBC data sources](/data-quality-self-hosted/connections/supported-connections/supported-jdbc-data-sources.md).
{% endstep %}

{% step %}
Click a data source.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Add Connection** template appears.
{% endstep %}

{% step %}
Enter the required information.

***

**Details**

<table><thead><tr><th>Required</th><th>Option</th><th>Type</th><th>Value</th></tr></thead><tbody><tr><td colspan="4"><strong>Connection Details</strong></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Name</td><td>String</td><td><p>The unique name used for your connection.</p><p>Do not use single quotes (') or double quotes (") in the connection name. When a job runs, the connection name is passed as a command-line argument. Quote characters cause the argument to be parsed incorrectly, which makes the connection name malformed and causes the job to fail.</p></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Connection URL</td><td>String</td><td><p>The connection string value of your connection. The Connection URL uses the following format:</p><pre><code>jdbc:&#x3C;datasource>://$host:&#x3C;port>/&#x3C;AdditionalProperties>
</code></pre><p>Replace the Connection URL to point to the database server to run DQ Jobs against.</p></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Port</td><td>Integer</td><td>The port for the connection to the data source host.</td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No</td><td>Limit Schemas</td><td>Option</td><td><p>Allows you to manage usage and restrict visibility to only the necessary schemas in the <a href="/data-quality-self-hosted/core-concepts/explorer/create-a-dq-job/connect-to-a-data-source.md">Explorer</a> tree.</p><p>See <a href="/data-quality-self-hosted/admin-configuration/admin-console/connections/limiting-schemas.md">Limiting schemas</a> to learn how to limit schemas from the Connection Management page.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>When you include a restricted schema in the query of a DQ Job, the query scope may be overwritten when the job runs. While only the schemas you selected when you set up the connection are shown in the Explorer menu, users are not restricted from running SQL queries on any schema from the data source.</p></div></td></tr><tr><td colspan="4"><strong>Connection Credentials</strong></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Authentication Type</td><td>Option</td><td><p>The method to authenticate your connection.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The configuration requirements differ depending on the authentication type you select. Additional options on the connection template, such as Username and Password, will appear depending on the authentication type you select.</p></div></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No</td><td>Pushdown</td><td>Option</td><td><p>Enables Pushdown processing. This option is required for Pushdown Job submission.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This option is currently only available for the connections listed on <a href="/data-quality-self-hosted/core-concepts/explorer/processing-methods/pushdown-processing.md">Pushdown processing</a>.</p></div></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No</td><td>Source Name</td><td>String</td><td><p>The alias name of your connection. While this is optional, you can use this to make it easier to identify your connection in API payloads.</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>There are no character restrictions for the Source Name field, but it is best practice to use only alphanumeric characters, hyphens, and underscores.</p></div></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No</td><td>Target Agents</td><td>String</td><td>The <a href="/data-quality-self-hosted/installation/agent.md">Agent</a> used to submit your DQ Job.</td></tr></tbody></table>

***

**Properties**

<table><thead><tr><th>Required</th><th>Property</th><th>Type</th><th>Value</th></tr></thead><tbody><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Driver Location</td><td>File path</td><td><p>The location where your driver file is saved.</p><p>Click <strong>Upload</strong> to specify the Directory Name and select a Driver File.</p></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</td><td>Driver Name</td><td>String</td><td><p>The driver class name.</p><p>For example, a BigQuery JDBC driver may use the following convention:</p><pre><code>com.simba.googlebigquery.jdbc42.Driver
</code></pre></td></tr><tr><td><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No</td><td>Driver Properties</td><td>String</td><td><p>The configurable driver properties of your connection.</p><p>The supported format is <code>[{"name":"prop1","value":"val1"},{"name":"prop2","value":"val2"}]</code></p></td></tr></tbody></table>

***

**Variables**

| Required                                                                                                                                                                                                                                                                  | Property      | Type   | Value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</p><p>(when using)</p> | Variable Name | String | <p>The variable to display in place of sensitive information, such as <code>Password</code>, or a variable that must be URL-encoded because it uses special characters (spaces, ampersands, equals signs, etc.), such as a Snowflake query\_tag.</p><p>In the Connection URL, replace the sensitive information with this value. In the following example, <code>dquser</code> and <code>dqpassword</code> are the property names that replace the sensitive variable values: <code>jdbc:postgresql://localhost:5432/postgres?user=${dquser}\&password=${dqpassword}</code></p> |
| <p><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</p><p>(when using)</p> | Value         | String | <p>The sensitive value to hide in the Connection URL. For example, if the password value of the connection credential is "password123", enter <code>password123</code> in the property value field.</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>Commas and equals signs are supported characters. For example, <strong>val1=,val2</strong> is a valid format.</p></div>                                                                                                                                                      |

***

{% endstep %}

{% step %}
Click **Submit**.
{% endstep %}
{% endstepper %}
{% endtab %}

{% tab title="Remote File Connections" %}
{% stepper %}
{% step %}
Sign in to Collibra DQ.
{% endstep %}

{% step %}
Hover your cursor over the <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-75245abf5c50ddf56f1d2d727ccaacf757d11145%2Fcogwheel-large%402x.png?alt=media" alt="" data-size="line"> icon and click **Admin Console**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The Admin Console opens.
{% endstep %}

{% step %}
Click **Connections**.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Connection Management** page opens.
{% endstep %}

{% step %}
Click **Add Connection** in the upper-right corner.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Add New Connection** dialog box opens to the JDBC Connections tab
{% endstep %}

{% step %}
Click the **Remote File Connections** tab.\ <i class="fa-chevrons-right">:chevrons-right:</i> A list of [supported remote file data sources](/data-quality-self-hosted/connections/supported-connections/supported-remote-files.md).
{% endstep %}

{% step %}
Click a data source.\ <i class="fa-chevrons-right">:chevrons-right:</i> The **Add Connection** template appears.
{% endstep %}

{% step %}
Enter the required information.

***

**Details**

| Required                                                                                                                                                                                                                                          | Connection Detail        | Type   | Value                                                                                                                                                                                                                                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes   | Name                     | String | The unique name used for your connection.                                                                                                                                                                                                                                                                                                                                                                                     |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes   | Connection URL           | String | <p>The connection string value of your connection.</p><p><i class="fa-glasses-round">:glasses-round:</i> Example: <code>s3://dq-datasets-123</code></p><hr>                                                                                                                                                                                                                                                                   |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes   | Authentication Type      | Option | <p>The method to authenticate your connection.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The configuration requirements differ depending on the authentication type you select. Additional options on the connection template, such as Keytab, will appear depending on the authentication type you select.</p></div>                                                          |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No | Target Agents            | String | The [Agent](/data-quality-self-hosted/installation/agent.md) used to submit your DQ Job.                                                                                                                                                                                                                                                                                                                                      |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No | Archive Breaking Records | Option | Select this option to automatically export CSV files containing the breaking records of DQ Job to your remote file data source.                                                                                                                                                                                                                                                                                               |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No | Archive Location         | String | <p>The path along which break records will be archived when the Archive Break Records and HTTPS options are enabled.</p><p>Specify a schema output location in your data source for break records to send. For example, <strong>/write/FolderName</strong></p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>This option is only available when the HTTPS option is enabled.</p></div> |

***

**Properties**

| Required                                                                                                                                                                                                                                          | Property          | Type   | Value                                                                                                                                                                       |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-de45f34193ae06a2b093c2dfb8fb80cfda945166%2Fclose-large%402x.png?alt=media" alt="" data-size="line"> No | Driver Properties | String | <p>The configurable driver properties of your connection.</p><p>The supported format is <code>\[{"name":"prop1","value":"val1"},{"name":"prop2","value":"val2"}]</code></p> |

***

**Variables**

| Required                                                                                                                                                                                                                                                                  | Property      | Type   | Value                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</p><p>(when using)</p> | Variable Name | String | <p>The variable to display in place of the sensitive information. This can be any variable, such as <code>Password</code></p><p>In the Connection URL, replace the sensitive information with this value. In the following example, <code>dquser</code> and <code>dqpassword</code> are the property names that replace the sensitive variable values: <code>jdbc:postgresql://localhost:5432/postgres?user=${dquser}\&password=${dqpassword}</code></p> |
| <p><img src="https://4121921244-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWCrP7Albs8DfJjIQxUxw%2Fuploads%2Fgit-blob-d06dd40622fc7d030e21f7c0303a90eb28d229fc%2Fok-large%402x.png?alt=media" alt="" data-size="line"> Yes</p><p>(when using)</p> | Value         | String | <p>The sensitive value to hide in the Connection URL. For example, if the password value of the connection credential is "password123", enter <code>password123</code> in the property value field.</p><div data-gb-custom-block data-tag="hint" data-style="success" class="hint hint-success"><p>Commas and equals signs are supported characters. For example, <strong>val1=,val2</strong> is a valid format.</p></div>                               |

***

{% endstep %}

{% step %}
Click **Submit**.
{% endstep %}
{% endstepper %}
{% endtab %}
{% endtabs %}

## What's next

[Map data source connections to a DQ agent](/data-quality-self-hosted/installation/agent/map-data-source-connections-to-a-dq-agent.md)

### Known Limitations

* When you update the [name](#connection-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.
* Single quotes (') and double quotes (") are not supported in connection names.
* When you add a connection to a SAS Datasets source using a CData JDBC driver, the Explorer table browser returns empty. This happens because of two issues: the connection string can become corrupted when it is saved, and the CData driver does not accept the lowercase username and password that Collibra DQ sends by default.
  * A possible workaround is to update the connection string directly in the DQ Postgres metastore after you add the connection in the web UI. Run the following SQL statement against the metastore, replacing the placeholder values with your own:

    ```
    UPDATE public.connections
                                SET hostname = 'jdbc:cdata:sasdatasets:ConnectionType="Azure Blob Storage";AuthScheme=AccessKey;AzureStorageAccount=\<your-storage-account\>;AzureAccessKey=\<your-access-key\>;URI=azureblob://\<your-container\>/;'
                            WHERE aliasname = '\<your-connection-alias\>';
    ```
  * After you run this update, refresh Explorer. Tables from the SAS dataset directory appear, and you can generate a report.
* When you edit an existing connection and its details, another connection is created and any [sensitive properties](#Variable) used in variables 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.
