Edit a JDBC connection

Copy the URL of this page.

You can edit a JDBC connection, for example if you want to change one of its connection properties.

If you created a Generic JDBC Connection, you can edit your connection to use a different authentication method. However, if you initially use the Username/Password JDBC connection type and want to change to another authentication method, you must create a new connection by using the Generic JDBC Connection.

You can then register the data source via Edge.

Important 

In Collibra 2024.05, we launched a new user interface (UI) for Collibra Platform! You can learn more about this latest UI in the UI overview.

Use the following options to see the documentation in the latest UI or in the previous, classic UI:

Note If you're using a Collibra Cloud site, go the Collibra Cloud documentation to check if your data source is supported.

Prerequisites

Steps

  1. Open a site.
    1. On the main toolbar, click Products icon → Cogwheel icon Settings.
      The Collibra settings page opens.
    2. In the tab pane, click Edge.
      The Sites tab opens and shows a table with an overview of your sites.
    3. In the site overview, click the name of a site.
      The site page appears.
  2. In the JDBC Connections section, click the name of a JDBC connection.
    The Connection settings page appears.
    The Edit Connection dialog box appears.
  3. At the bottom of the page dialog box, click Edit.
    The fields become editable.
  4. Enter the required information.

    Field

    Description

    Connection settings

    This section contains the settings to connect to your data source.

    Name

    The name of the JDBC connection.

    Note We recommend not to use the special character > in the JDBC connection name. This character is part of the full name of assets created via Edge. If you use this character, features such as sampling or classification can be impacted.

    Description

    The description of the JDBC connection. This field is also visible when you register content.

    Vault

    The vault whose secrets you want to use to fill out fields.

    This field is only available if one or more vaults have been configured for your Edge site.

    Connection provider

    The connection provider, which determines the available connection parameters.

    Connection parameters

    This section contains general settings to connect to your data source.

    Driver class name

    The driver class name of the connection.

    Driver jar

    The JAR file contains the JDBC driver.

    Click Upload to upload a JAR file.

    Additional classpath files

    Any additional classpath files that you want to upload. Use this field if you want to upload more than one driver file.

    Connection string

    The JDBC connection string.

    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the query value to identify the secret in your vault.
      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Secret Engine Type

      Select one of the following:

      • Key Value
      • Database
      Engine PathThe engine path to your vault where the value is stored.
      Secret PathThe secret path to your vault where the value is stored.
      Field

      The name of the field to your vault where the value is stored.

      Note Only available if you selected Key Value in the Secret Engine Type field.

      Role

      The role specified in the Database engine.

      Note Only available if you selected Database in the Secret Engine Type field.

      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Vault NameThe name of your Azure Key Vault in your Azure Key Vault service where the value is stored.
      Secret NameThe name of the secret in your vault where the value is stored.
      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Secret NameThe name of the secret in your vault where the value is stored.
      Field

      If the secret stored in your AWS Secrets Manager is a JSON value, for example {"pass1": "my-password", "pass2": "my-password2"}, then you need to specify the Field to point to the exact JSON value that should be used. For example, Secret Name: edge-db-customer; Field: pass.

      Note If the secret stored in your AWS Secrets Manager is a plain string value, for example my-password, then you do not need to specify the Field.

      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the name of the secret in your vault where the value is stored.
      Example 

    Warning Some connection properties can be added to the URL as name-value pairs separated by semicolons. However, most properties in the URL are ignored. Therefore, we recommend you not to use this mechanism unless we explicitly ask you to. We recommend you to specify all connection properties in the Connection properties section.

    Connection properties

    Property

    This section contains the connection properties.

    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the query value to identify the secret in your vault.
      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Secret Engine Type

      Select one of the following:

      • Key Value
      • Database
      Engine PathThe engine path to your vault where the value is stored.
      Secret PathThe secret path to your vault where the value is stored.
      Field

      The name of the field to your vault where the value is stored.

      Note Only available if you selected Key Value in the Secret Engine Type field.

      Role

      The role specified in the Database engine.

      Note Only available if you selected Database in the Secret Engine Type field.

      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Vault NameThe name of your Azure Key Vault in your Azure Key Vault service where the value is stored.
      Secret NameThe name of the secret in your vault where the value is stored.
      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the required information:
      NameDescription
      Secret NameThe name of the secret in your vault where the value is stored.
      Field

      If the secret stored in your AWS Secrets Manager is a JSON value, for example {"pass1": "my-password", "pass2": "my-password2"}, then you need to specify the Field to point to the exact JSON value that should be used. For example, Secret Name: edge-db-customer; Field: pass.

      Note If the secret stored in your AWS Secrets Manager is a plain string value, for example my-password, then you do not need to specify the Field.

      Example 
    To use your vault, do the following:
    1. In the Value Type field, select Vault Key.
    2. Enter the name of the secret in your vault where the value is stored.
      Example 
  5. Click Save.
  6. If required, you can now test the connection.
    1. At the bottom of the page, click Test connection.
      The Connection test dialog box appears.
    2. When the test is finished,click OK.
      Tip  If the connection failed, you can click View Stacktrace to identify the problem.