创建定制 JDBC 连接器

如果 Cloud Pak for Data 没有针对特定数据源的预定义连接器，那么管理员可以为该数据源创建定制 JDBC 连接器。 用户可以使用定制 JDBC 连接器以一致方式连接到数据源的多个实例。

您需要哪些角色和许可权才能完成此任务?
何时需要完成此任务?
当您希望用户能够以一致方式连接到在 Cloud Pak for Data中没有预定义类型的数据源时，请完成此任务。

如果仅连接到一个数据源，并且用户不需要可重复的方法来连接到该数据源，那么用户可以创建 通用 JDBC 连接。

限制
如果您导出项目，然后将项目导入到其他 Cloud Pak for Data 实例中，那么从定制 JDBC 连接器创建的任何连接都将不起作用。 必须删除连接并在新实例中重新创建连接器和连接。

开始之前

重要信息: 确认您打算使用的服务和工具可以使用从定制 JDBC 连接器创建的连接。 请参阅 定制 JDBC 连接器支持的服务和工具。

作为设置的一部分，您将需要一个或多个驱动程序文件 (JDBC JAR 文件)。 请参阅 JDBC 驱动程序供应商提供的文档以获取此信息:

  • 确定并获取数据源所需的一个或多个 JAR 文件。 您可以提前或在创建连接器时 上载 文件。
  • 标识驱动程序类名。 您还可以通过执行以下步骤来检查 JAR 文件来查找驱动程序类:
    1. 将 JAR 文件作为归档文件打开。 如果没有可打开 JAR 归档的程序，请将文件扩展名更改为 zip。
    2. 转至归档中的 META-INF/services/ 目录。
    3. 解压缩名为 java.sql.Driver 的文件，并在文本编辑器中打开该文件。 java.sql.Driver 文件中列出了有效驱动程序类的列表。
    通常，驱动程序具有一个具有一个驱动程序类名的 JAR 文件。 如果驱动程序包含多个 JAR 文件或定义了多个驱动程序类名，请参阅供应商文档以确定以下信息:
    • 主 JAR 文件的名称
    • 主驱动程序类的名称
    驱动程序中的任何其他 JAR 文件通常是主 JAR 文件的第三方依赖关系。
  • 识别 JDBC URL 的格式。
  • 确定连接到数据源所需的属性。 对于每个属性，确定该属性是否:
    • 具有变量或固定值
    • 具有缺省值
    • 必需或可选
    • 用于定义凭证，例如用户名或密码
    • 用于 SSL 支持

观看此视频以了解如何创建定制 JDBC 连接器。

关于本任务

要创建定制 JDBC 连接器，请执行以下步骤来创建用户将用于创建实际连接的可复用连接表单。 上载一个或多个 JDBC 驱动程序 JAR 文件。 然后为数据库创建一个 JDBC URL 模板并输入 JDBC 驱动程序的属性。 您可以定制和测试连接属性和连接表单布局。 在您完成所有步骤并创建连接器后，该连接器可供用户使用。

过程

  1. 登录到 Cloud Pak for Data Web 客户机。 从导航菜单中，选择 数据 > 连接。
  2. 选择 连接器 > 定制 JDBC 连接器，然后单击 新建连接器。
    注: 缺省情况下， 连接器 选项卡不可见。 实例管理员必须 允许用户上载或查看 JDBC 驱动程序。
    此时将打开 " 创建连接器 " 向导。
  3. 显示信息: 输入必需的 连接器名称 和 描述 字段的值。
    • 在 连接器名称 字段中，输入用户将识别的唯一名称。 该名称将显示在列出所有连接器的 " 新建连接 " 页面中。 它还将显示在用户将用于创建连接的 创建连接 表单中。
    • 在 描述 字段中，提供有助于用户识别连接器的信息。 描述将显示在当用户在 " 新建连接 " 页面中选择连接器时打开的侧面板中的 详细信息 下。 它还将位于连接表单的 连接概述 部分中。

    单击 下一步后，可以将连接器另存为草稿并返回以稍后完成。

  4. JDBC 驱动程序: 上载 并为连接器选择 JDBC 驱动程序文件。 接下来，输入驱动程序类名。
  5. 定义连接器 连接属性的属性。

    属性可以是变量或固定值。

    • 变量: 用户在创建连接时提供变量的值。 使用语法 ${variable}。 变量必须是一个或多个用下划线字符 (_) 分隔的小写单词。 变量不能包含空格或以下划线字符或数字开头。 例如，有效变量为 ${hostname} 或 ${host_name}。
    • 固定值: 具有指定值的属性是硬编码的。 它们由连接使用，但不会显示在连接表单中。
    1. 输入 JDBC URL。 JDBC URL 标识数据库。 JDBC URL通常包括主机名、端口号和数据库名称的变量。 URL 必须以 jdbc:。
      JDBC URL 模板示例：
      • jdbc:db2://${hostname}:${port}/${dbname}
      • jdbc:informix-sqli://${hostname}:${port}/${dbname}:informixserver=${informix_server_name}
      • jdbc:oracle:thin:@${hostname}:${port}:SID
      • jdbc:sqlserver://${hostname}:${port};databasename=${database_name}
    2. 选择 预定义属性，例如用户名和密码认证。

      如果服务器已启用SSL，请在 URL中输入属性。 选择连接器支持 SSL复选框以启用使用 SSL 所需的字段。
      注意 ：您需要URL 和附加属性部分输入属性。 例如，您需要输入sslConnection=true。
    3. 在 性能属性 部分中，选择或输入可提高连接效率的属性。
    4. 单击 其他属性，然后输入任何其他属性以连接到数据源。 请查阅驱动程序供应商的文档以了解受支持的属性。 如果数据源不使用用户名和密码认证，请使用这些字段来输入其他认证方法。
      具有固定值的示例属性。 这些属性将对连接表单中的用户不可见。
      • loggerLevel=TRACE
      • encrypt=true
      具有变量的示例属性。 这些属性将对连接表单中的用户可见。 在下一步中指定显示名称，缺省值，悬浮式帮助和占位符文本。
      • charset=${charset}
      • readtimeout=${read_timeout}
    示例
    • URL 模板： jdbc:db2://${hostname}:${port}/${dbname}
    • 预定义属性: 用户名和密码认证。

    用户将在连接表单中输入的示例值:

    • hostname=server1
    • port=50000
    • dbname=my_database
    • username=user_1
    • 密码 = *****

    JDBC URL 将是： jdbc:db2://server1:50000/my_database

    具有固定值的属性将不在连接表单中，而是由连接器使用。
  6. 连接表单配置: 定义每个变量属性在连接表单中的显示方式。 例如，您可以在此处修改显示名称，输入缺省值，并指定属性是必需属性还是可选属性。
    单击 预览和测试 以查看将如何向用户显示连接表单。 您可以输入值，然后单击 测试连接 以确认是否正确配置了连接器。

    以下字段将自动包含在所有连接表单中，并且无法删除或更改:

    • 个人或共享的凭证设置
    • 屏蔽通过 API 调用检索的敏感凭证
    • 凭证和证书的输入方法。 (此字段确定选择以纯文本或使用保险库文件中的私钥输入值。)
    当您预览连接或单击 下一步时，将保存表单配置设置。
  7. 摘要: 查看显示信息， JDBC 驱动程序，连接属性和连接表单配置，然后执行下列其中一项操作:
    • 取消连接器。 将不会创建连接器。 如果您正在编辑草稿，那么您的更改将丢失，但草稿将保留。
    • 点击后退返回连接形式配置步骤或单击编辑 (编辑图标 ）返回任意先前步骤。
    • 将连接器另存为草稿。
    • 创建连接器。 如果创建连接器，那么它将处于活动状态，可供用户在 " 新建连接 " 页面的连接列表中进行选择。
      重要说明：
      • 创建连接器后，并非所有字段或属性都可以更改。 请参阅 管理定制 JDBC 连接器。
      • 如果在创建连接器后对其进行编辑，那么可能会中断用户已使用其创建的任何连接，已连接的数据资产或作业。

下一步操作

测试连接器以确保其在服务中工作，并使用用于连接到数据源的工具。