创建自定义 JDBC 连接器

重要提示：4.8IBM Cloud Pak® for Data 版本将于2025年7月31日达到支持终止（EOS）。有关更多信息，请参阅 4.X 版本 IBM Cloud Pak for Data 的服务终止公告。

升级至 IBM Software Hub 版本 5.1 ，在 4.8 版本达到支持 IBM Cloud Pak for Data 终止前完成升级。有关更多信息，请参阅从 IBM Cloud Pak for Data 版本 4.8 升级到 IBM 的说明： Software Hub 版本 5.1。

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

完成此任务需要哪些角色和权限？

要完成此任务，您必须拥有该域的管理员 Platform assets catalog 角色。
有关将JAR文件上传至所需的权限，请参阅《导入 JDBCCloud Pak for Data驱动程序》。
重要提示： 4.8.4 及更高版本默认禁用了 JDBC 驱动程序的上传功能。
4.8.5 或更高版本默认情况下，用户无法在Web客户端中查看新安装的 JDBC 驱动程序列表。

管理员必须允许用户上传或查看 JDBC 驱动程序。

你需要在什么时候完成这项任务？

当您希望用户能够以一致的方式连接到未在 Cloud Pak for Data. 中预定义类型的数据源时，请完成此任务。

若仅需连接单一数据源，且用户无需重复使用连接方法，则可创建通用 JDBC 连接。

限制

从自定义 JDBC 连接器创建的任何连接，在将项目导出后再导入到其他 Cloud Pak for Data 实例时将无法正常工作。您必须删除连接，并在新实例中重新创建连接器和连接。
4.8.24.8.14.8.0 在基于 Git 的项目中，无法从自定义 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文件。然后创建一个用于数据库的 JDBCURL 模板，并输入 JDBC 驱动程序的属性。您可自定义并测试连接属性及连接表单布局。完成所有步骤并创建连接器后，用户即可使用该连接器。

过程

登录到 Cloud Pak for Data Web 客户端。从导航菜单中，选择数据 > 平台连接。
选择连接器 > 自定义 JDBC 连接器，然后单击新建连接器。
创建连接器向导已打开。
显示信息：请为必填的连接器名称和描述字段输入值。
- 在连接器名称字段中，输入用户能够识别的唯一名称。该名称将出现在列出所有连接器的新连接页面中。它还将出现在用户用于创建连接的创建连接表单中。
- 在描述字段中，提供有助于用户识别连接器的信息。该描述将显示在侧边面板的 “详细信息 ”部分，当用户在 “新建连接 ”页面选择连接器时，该面板将展开。它也将在连接表单的连接概述部分中显示。
点击 “下一步 ”后，您可以将连接器保存为草稿，稍后再返回完成设置。
JDBC 驱动程序：上传并选择连接器的 JDBC 驱动程序文件。接下来，输入驱动程序类名称。
定义连接器的连接属性。
属性可以是变量，也可以是固定值。
- 变量：用户在创建连接时为变量提供值。使用语法 ${variable}。变量必须由一个或多个小写单词组成，各单词之间用下划线字符（_）分隔。变量名称中不能包含空格，也不能以下划线字符或数字开头。例如，有效的变量是 ${hostname} 或 ${host_name}。
- 固定值：具有指定值的属性是硬编码的。它们被连接使用，但不会显示在连接表单中。
1. 进入 JDBC URL 模板。 JDBCURL 用于标识数据库。 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 证书。
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
具有固定值的属性不会出现在连接表单中，但会被连接器使用。
连接表单配置 ：定义每个变量属性在连接表单中的显示方式。例如，在此处您可以修改显示名称、输入默认值，并指定属性是必填项还是可选项。
点击预览并测试，查看连接表单将如何显示给用户。您可以输入值并点击 “测试连接 ”来确认连接器是否配置正确。
以下字段会自动包含在所有连接表单中，且无法删除或修改：
- 凭证设置：个人或共享
- 屏蔽通过 API 调用检索的敏感凭证
- 凭证和证书的输入方式。 (此字段决定了输入值时采用纯文本输入还是使用保险库中的密钥进行选择。)
表单配置设置将在您预览连接或点击“下一步 ”时保存。
摘要：检查显示信息、 JDBC 驱动程序、连接属性及连接表单配置，然后执行以下操作之一：
- 取消连接器。该连接器将不会创建。若您正在编辑草稿，您的修改将被丢弃，但草稿仍会保留。
- 点击 “返回 ”可回到连接表单配置步骤，或点击“编辑”()返回任何先前步骤。
- 将连接器保存为草稿。
- 创建连接器。若创建连接器，它将处于活动状态，用户可在新建连接页面的连接列表中选择使用。
  重要说明：
  - 创建连接器后，并非所有字段或属性都能被修改。参见管理自定义 JDBC 连接器。
  - 若在创建连接器后对其进行编辑，可能会中断用户已通过该连接器建立的任何连接、关联数据资产或作业。

下一步操作

测试连接器，确保其在您用于连接数据源的服务和工具中正常运行。