> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kasoftware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Database 端口设置

> 连接知行之桥与 Database，用于数据集成和同步

数据库端口（Database connector）允许连接到多种不同的数据库类型，并可以从这些数据库中推送或拉取数据。

## 核心功能

* **通用数据库连接**：支持主流数据库平台。
* **驱动程序支持**：同时支持 ADO.NET 和 JDBC 驱动程序。
* **全面的事务管理**：具备提交 (Commit) 和回滚 (Rollback) 功能。
* **标准数据库操作**：提供查询 (Select)、查找 (Lookup)、更新/插入 (Upsert) 和存储过程 (Stored Procedure) 用于数据操作。
* **高级查询自定义**：支持查询自定义和参数绑定。

按照以下步骤将知行之桥连接到 Database。

## 建立数据库连接

在将 Database 端口添加到工作流之前，必须在本地计算机上配置与数据库的连接。

> [!NOTE]
>
> Database 端口中引用且需要许可的数据源，应在知行之桥外部的计算机上完成许可授权。

### ADO.NET

知行之桥的 [.NET 版本](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/installation/windows-edition.md)主要使用 ADO.NET 驱动程序。为了让 ADO.NET 提供程序对知行之桥可见，它必须在 machine.config 文件中定义，并在全局程序集缓存 (GAC) 中注册。熟悉相关操作的用户可以手动完成此过程，但 知行软件建议在托管知行之桥的计算机上安装数据库客户端，因为数据库特定的安装向导会处理提供程序的定义和注册。

### JDBC

为了让 JDBC 驱动程序对知行之桥可见，它必须作为 Java 类路径的一部分包含在内。知行之桥包含 H2、MySQL、PostgreSQL 和 SQL Server 的驱动程序；如需将其他驱动程序添加到类路径，请参阅 Java Web servlet 的文档。

> [!NOTE]
>
> 除了默认选项之外，Database 端口还支持其他数据库的 JDBC 驱动程序。但是，自定义驱动程序可能需要覆盖端口发出的查询，以符合数据库预期的语法。可以使用 Input Mapping 或 Output Mapping 的 *Write custom query* 部分覆盖查询。

## 配置 Database 端口

配置数据库连接后，可以将 Database 端口添加到知行之桥工作流中。必须在 Database 端口的每个实例中输入数据库连接凭据。

按照以下步骤建立连接：

1. 将 Database 端口拖入知行之桥工作流，并为其命名。

2. 在 **Settings** 选项卡的 **Database Connection** 部分，从列表中选择 **Driver Name**。**Driver Class** 会自动填充。

3. 选择 **Settings Format**。

   1. 如果选择 **Property List**，请填写驱动程序特定的属性。这些属性因驱动程序而异。
   2. 如果选择 **Connection String** 或 **DatabaseURL**，请向数据库提供完整的连接字符串。

4. 单击 **Test Connection**，确保知行之桥可以连接到 Database。如果发生错误，请检查所有字段并重试。

5. 单击 **Save Changes**。

### 其他数据库连接

**Database Connection** 下拉菜单包含一个 **Other** 选项。选择 **Other** 时，会出现 **Connection Type** 选项，要求选择 **ADO.NET** 或 **ODBC**。

* 如果选择 **ADO.NET**，请输入 **Driver Class**、**Data Source**、**User** 和 **Password** 详细信息。
* 如果选择 **ODBC**，请确保已按照以下说明创建系统 DSN，然后在 **Data Source Name** 中选择它。填写 **Driver**、**User** 和 **Password** 详细信息。

#### ODBC

通过 ODBC 驱动程序连接数据库需要数据源名称 (DSN)。可以使用 Microsoft ODBC 管理器创建 DSN。CData 必须为 ODBC 驱动程序使用系统 DSN 连接。创建 DSN 后，在端口的 **Data Source Name** 下拉列表中选择它。

Database 端口支持默认选项之外的其他数据库 ODBC 驱动程序。但是，自定义驱动程序可能需要覆盖端口发出的查询，以符合数据库预期的语法。有关更多信息，请参阅[预处理和后处理查询](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-ac.md#pre-processing-and-post-processing-queries)。也可以在 [Select](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-select.md) 操作中使用 **Write custom queries** 选项。

## 选择一个操作

与 Database 建立连接后，必须选择 Database 端口将执行的操作。下表概述了每个操作及其在知行之桥工作流中的位置。

| 操作 | 描述 | 工作流中位置 |
| - | - | - |
| [Upsert](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-upsert.md) | 插入或更新 Database 数据。默认情况下，如果 Database 中已存在记录，则会使用输入中提供的值更新 Database 中的现有数据。 | End |
| [Lookup](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-lookup.md) | 从 Database 检索值，并将这些值插入到工作流中已有的知行之桥消息中。 **Lookup 查询**决定端口将从 Database 检索什么值。该查询应格式化为针对 Database 表的 SQL 查询。 | Middle |
| [Lookup 存储过程](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-lsp.md) | 将进入端口的数据视为存储过程的输入，然后将结果插入到工作流中的现有知行之桥消息中。 可以单击 **Test Lookup** 模态框中的 **Show Sample Data** 按钮，为所选存储过程提供示例输入并预览结果。 | Middle |
| [Select](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-select.md) | 从 Database 检索数据并将其带入知行之桥。 可以使用 **Filter** 面板向 Select 添加过滤器。这些过滤器的功能类似于 SQL 中的 *WHERE* 子句。 | Beginning |
| [执行存储过程](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-esp.md) | 将进入端口的数据视为存储过程的输入，然后将结果沿工作流向下传递。 可以单击 **Test Execute Stored Procedure** 模态框中的 **Show Sample Data** 按钮，为所选存储过程提供示例输入并预览结果。 | Middle |

## 高级选项卡

**高级**选项卡上的许多设置都是从正在使用的数据源动态加载的，因此本文档中未介绍这些设置。可以在我们网站的[在线帮助文件](https://www.kasoftware.com/articles.html)页面上找到数据源的详细信息。

下面描述的选项适用于所有数据源。

### 消息

> [!NOTE]
>
> **保存至 Sent 文件夹**和**Sent 文件夹方案**设置已弃用，默认处于隐藏状态。只有先前已启用这些设置或将其配置为非默认值的端口才会显示它们。若要保留成功处理的文件副本，请在工作流中右键单击该端口，选择**显示成功路径**，然后将成功路径连接到[File 端口](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/file.md)。

| 设置 | 描述 |
| - | - |
| **保存至 Sent 文件夹**（已弃用） | 将端口处理的文件复制到 Sent 文件夹。默认禁用。保存到 Sent 文件夹中的文件不受静态加密保护。 |
| **Sent 文件夹方案**（已弃用） | 按所选时间间隔对 Sent 文件夹中的文件进行分组。仅在启用**保存至 Sent 文件夹**时适用。 |

### 高级设置

*高级设置* 是依赖任意数据库驱动程序（例如 Database、CData 和 API 端口）以连接到各种数据源的端口的通用设置。

| 设置 | 描述 |
| - | - |
| **自动截断** | 启用后，端口会自动截断任何超过允许长度限制的字符串或二进制列值。 |
| **命令超时时间** | 命令执行超时时长（以秒为单位）。 |
| **上次插入的 ID 查询** | 提供一个要执行的查询，用于检索最后插入记录的自增 ID。 |
| **日志级别** | 端口生成日志的详细程度。请求支持时，请将其设置为 **Debug**。 |
| **本地文件方案** | 用于为端口输出的消息分配文件名的方案。可以在文件名中动态使用宏，以包含标识符、时间戳等信息。有关更多信息，请参阅[宏](#宏)。 |
| **保留消息副本** | 选中后，端口会在 Logs 目录中将消息副本保存在该消息的日志旁边。如果禁用此功能，可能无法从 **Input** 或 **Output** 选项卡下载文件副本。 |
| **最大失败记录数** | 插入期间允许失败且仍继续处理的最大记录数。默认值 0 表示任何错误都会导致输入消息被标记为 Error，并回滚任何未提交的事务。值 -1 表示忽略所有错误，端口会继续尝试插入后续记录。正值表示端口会继续尝试插入记录，直到达到该阈值。 |
| **输出文件格式** | 输出数据的表示格式。默认值 (XML) 会让端口为处理的每条记录输出一个 XML 文件，同时可根据 **最大记录数** 的值选择将多条记录组合到单个数据结构中。CSV 和 TSV 选项会以相应的文件格式输出数据。此选项不适用于包含子表的复杂表结构。 |
| **处理更改间隔单位** | 仅适用于 Select 操作。当在 **Settings** 选项卡的 **Select Configuration** 部分的 **Advanced** 区域中选中 **Use column *columnname* for processing new or changed records** 时，此设置控制如何解释 **Process Changes Interval** 设置（例如小时、天或周）。有关此设置以及以下两个设置的详细信息，请参阅[只处理新的或更改的记录](https://docs.kasoftware.com/26.3/self-hosted/zh/connectors/database/database-ac.md#only-process-new-or-changed-records)。 |
| **处理更改间隔** | 当在 **Settings** 选项卡的 **Select Configuration** 部分中选中 **Use column *columnname* for processing new or changed records** 时，此设置控制知行之桥首次尝试处理多少历史数据。例如，保留默认值 180 (Days) 表示知行之桥只尝试处理过去 180 天内创建或修改的数据。 |
| **处理更改开始日期** | 当在 **Settings** 选项卡的 **Select Configuration** 部分中选中 **Use column *columnname* for processing new or changed records** 时，此设置控制要检索数据的开始日期。 |
| **重置历史记录** | 重置选中 **Use column *columnname* for processing new or changed records** 时存储的缓存。 |
| **批处理输入大小** | 如果数据源支持批处理，则这是批处理中查询的最大数量。 |
| **批处理大小** | 批处理组中批处理消息的最大数量。 |
| **最大记录数** | 单个输出消息中包含的最大记录数。使用 -1 表示所有输出记录应放入单个文件，使用 0 表示端口可以根据配置的 **输出文件格式** 决定。默认情况下，XML 每个文件输出一条记录，而平面文件格式会将所有记录包含在一个文件中。 |
| **事务大小** | 事务中的最大查询数量。 |
| **处理延迟** | 放入 Input 文件夹的文件延迟处理的时间（以秒为单位）。这是一个旧版设置。最佳实践是[使用 File 端口](https://docs.kasoftware.com/26.3/self-hosted/zh/flows/designing-a-flow.md#interacting-with-the-local-file-system)管理本地文件系统，而不是使用此设置。 |
| **插入空值** | 如果未选中（默认），端口在构建 INSERT 和 UPDATE 语句时会跳过空的 XML 元素。这会使数据库在 INSERT 语句中使用默认列值，并在 UPDATE 语句中保持列值不变。选中后，端口会在 INSERT 和 UPDATE 语句中包含空的 XML 元素，并将空字符串用作该列的值。 |
| **插入 Null** | 如果未选中（默认），端口在构建 INSERT 和 UPDATE 语句时会跳过 null XML 元素（由 `xsi:nil="true"` 属性指示）。这会使数据库在 INSERT 语句中使用默认列值，并在 UPDATE 语句中保持列值不变。选中后，端口会在 INSERT 和 UPDATE 语句中包含 null XML 元素，并将 null 用作该列的值。被视为 null 的情况包括：`Not exist`、`<element/>`、`<element xsi:nil="true"/>`、`<element xsi:nil="true"></element>`、`<element null="true"/>` 和 `<element null="true"></element>`。 |
| **Lookup 缓存** | 选中 **Enable lookup cache** 后，在直接对数据源执行查询之前（当缓存未返回任何记录时），会先对本地缓存执行查询。如果未选中（默认），查询会直接对数据源执行。以下 Lookup 缓存选项仅在选中 **Enable lookup cache** 时可用。 |
| **Lookup 缓存提供程序** | 指定使用哪个驱动程序来辅助连接缓存数据库。 |
| **Lookup 缓存连接字符串** | 设置后，端口会使用此处指定的数据库进行缓存。 |
| **Lookup 缓存容差** | 指定端口查询数据源以刷新缓存的频率。与 **容差单位** 选项结合使用。 |
| **Lookup 缓存容差单位** | 选择 **Minute**、**Hour** 或 **Day**。 |
| **日志子文件夹方案** | 指示端口根据所选时间间隔对 `Logs` 文件夹中的文件进行分组。例如，**Weekly** 选项指示端口每周创建一个新的子文件夹，并将该周的所有日志存储在该文件夹中。空白设置会让端口将所有日志直接保存到 `Logs` 文件夹。对于处理大量事务的端口，使用子文件夹有助于保持日志有序并提高性能。 |

### 其它

*其它设置* 适用于特定用例。

| 设置 | 描述 |
| - | - |
| **其他设置** | 允许以分号分隔的列表配置隐藏的端口设置（例如 `setting1=value1;setting2=value2`）。正常的端口用例和功能不应需要使用这些设置。 |

## 自动化选项卡

### 自动化设置

*与端口自动处理文件相关的设置。*

| 设置 | 描述 |
| - | - |
| **发送** | 到达端口的文件是否会自动发送。 |
| **重试间隔** | 失败发送在重试前等待的分钟数。 |
| **最大次数** | 端口处理文件的最大次数。成功与否根据服务器成功确认来衡量。如果将此设置为 0，端口会无限期重试该文件。 |
| **接收** | 端口是否应自动查询数据源。 |
| **间隔** | 自动查询尝试之间的时间间隔。 |
| **整点后的分钟数** | 小时计划的分钟偏移量。仅当上面的间隔设置为 *Hourly* 时适用。例如，如果此值设置为 5，自动化服务会在 1:05、2:05、3:05 等时间下载。 |
| **时间** | 尝试发生的当天时间。仅当上面的间隔设置为 *Daily*、*Weekly* 或 *Monthly* 时适用。 |
| **天** | 尝试发生的日期。仅当上面的间隔设置为 *Weekly* 或 *Monthly* 时适用。 |
| **分钟** | 尝试下载前等待的分钟数。仅当上面的间隔设置为 *Minute* 时适用。 |
| **Cron 表达式** | 表示 cron 表达式的五段字符串，用于确定尝试发生的时间。仅当上面的间隔设置为 *Advanced* 时适用。 |

### 性能

*与分配给端口的资源相关的设置。*

| 设置 | 描述 |
| - | - |
| **最大工作线程数** | 处理此端口上的文件时从线程池消耗的最大工作线程数。如果设置，将覆盖[高级设置](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/advanced-settings.md)页面中[性能设置](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/performance-settings.md)部分的默认设置。 |
| **最大文件数** | 分配给端口的每个线程发送的最大文件数。如果设置，将覆盖[高级设置](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/advanced-settings.md)页面中[性能设置](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/performance-settings.md)部分的默认设置。 |

## 通知选项卡

*与配置通知相关的设置。*

在执行服务等级协议 (SLA) 之前，需要设置电子邮件通知。默认情况下，知行之桥使用[通知](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/alerts.md)选项卡上的全局设置。要为此端口使用其他设置，请启用 **覆盖全局设置**。

默认情况下，错误通知已启用，这意味着每当发生错误时都会发送电子邮件。要关闭它们，请取消选中 **启用** 复选框。

输入 **主题**（必填），然后可选地输入以逗号分隔的 **收件人** 电子邮件列表。

## SLA 选项卡

*与配置服务等级协议 (SLA) 相关的设置。*

SLA 允许配置期望工作流中的端口发送或接收的数据量，并设置期望达到该数据量的时间范围。当 SLA 未满足时，知行之桥会发送电子邮件警告用户，并将 SLA 标记为 *有风险*，这意味着如果 SLA 很快仍未满足，则会被标记为 *已违反*。这使用户有机会介入并确定 SLA 未满足的原因，并采取适当措施。如果在风险时间段结束时仍未满足 SLA，SLA 会被标记为已违反，并再次通知用户。

要定义 SLA，请启用 **预期数据量**，然后单击 **设置** 选项卡。

![空 SLA 配置](https://mintcdn.com/qiao/ImYlxBRjlKh9pKya/26.3/images/sla_empty.png?fit=max\&auto=format\&n=ImYlxBRjlKh9pKya\&q=85\&s=a3e02838303e09f3ddfc5d7b06db2987)

* 如果端口具有单独的发送和接收操作，请使用单选按钮指定 SLA 适用的方向。
* 在窗口的 **预计至少** 部分：
  * 设置期望处理的最小事务数（数量）
  * 使用 **每** 字段指定时间范围
  * 指定 SLA 应何时生效。如果选择 **开始于**，请填写日期和时间字段。
  * 勾选希望 SLA 生效的星期几。如有需要，使用下拉菜单选择 **每天**。
* 在窗口的 **将状态设置为“有风险”** 部分，指定何时应将 SLA 标记为有风险。
  * 默认情况下，只有违反 SLA 后才会发送通知。若要更改此设置，请选中 **发送“有风险”通知**。

以下示例显示了为预计周一至周五每天接收 1000 个文件的端口配置的 SLA。如果尚未收到 1000 个文件，则会在时间段结束前 1 小时发送风险通知。

![SLA 配置示例](https://mintcdn.com/qiao/ImYlxBRjlKh9pKya/26.3/images/sla_defined.png?fit=max\&auto=format\&n=ImYlxBRjlKh9pKya\&q=85\&s=d8c67592769e76409cb1fba2c86c4805)

> [!NOTE]
>
> 如有必要，可以关闭 SLA 通知。这在维护窗口期间非常有用。单击导航栏上的 **Settings**，然后导航到 **Alerts > General Alerts**。单击平板和铅笔图标进行编辑，并取消选中 **SLA Alerts** 设置。

## 宏

在文件命名策略中使用宏可以提高组织效率和对数据的上下文理解。通过将宏合并到文件名中，可以动态包含标识符、时间戳和消息头信息等相关信息，为每个文件提供有价值的上下文。这有助于确保文件名反映对组织重要的详细信息。

知行之桥支持这些宏，它们都使用以下语法：`%Macro%`。

| 宏 | 描述 |
| - | - |
| ConnectionName | 替换为端口使用的连接名称。 |
| ConnectorID | 替换为端口的 ConnectorID。 |
| Ext | 替换为端口当前正在处理的文件的文件扩展名。 |
| Filename | 替换为端口当前正在处理的文件的文件名（包括扩展名）。 |
| FilenameNoExt | 替换为端口当前正在处理的文件的文件名（不带扩展名）。 |
| MessageId | 替换为端口输出消息的 MessageId。 |
| RegexFilename:*pattern* | 将正则表达式模式应用于端口当前正在处理的文件名。 |
| Header:*headername* | 替换为当前正在处理消息上的目标消息头（`headername`）的值。 |
| LongDate | 替换为系统当前日期时间的长格式（例如，2024 年 1 月 24 日星期三）。 |
| ShortDate | 替换为系统当前日期时间的 yyyy-MM-dd 格式（例如 2024-01-24）。 |
| DateFormat:*format* | 替换为指定格式（`format`）的系统当前日期时间。有关可用日期时间格式，请参阅[示例日期格式](https://docs.kasoftware.com/26.3/self-hosted/zh/scripting/value-formatters/date-formatters.md#date-formats-with-literal-characters)。 |
| Vault:*vaultitem* | 替换为指定保管库项目的值。 |
| Table | 替换为端口选择数据所在的表名。 |
| PK | 替换为从表中接收的记录的主键值。 |
| Sequence | 根据端口接收的记录总数替换为四位数字（例如，对于返回的第五条记录，%Sequence% 替换为 0005）。 |
| FileFormat | 替换为端口 **高级** 选项卡上指定的输出文件格式（XML、CSV 或 TSV）。 |

### 示例

某些宏（例如 %Ext% 和 %ShortDate%）不需要参数，但其他宏需要。所有带参数的宏都使用以下语法：`%Macro:argument%`

以下是一些带参数宏的示例：

* %Header:headername%：其中 `headername` 是消息上消息头的名称。
* %Header:mycustomheader% 替换为输入消息上设置的 `mycustomheader` 消息头的值。
* %Header:ponum% 替换为输入消息上设置的 `ponum` 消息头的值。
* %RegexFilename:pattern%：其中 `pattern` 是正则表达式模式。例如，`%RegexFilename:^([\w][A-Za-z]+)%` 会匹配并替换为文件名中的第一个单词，且不区分大小写（`test_file.xml` 替换为 `test`）。
* %Vault:vaultitem%：其中 `vaultitem` 是[保管库](https://docs.kasoftware.com/26.3/self-hosted/zh/getting-started/administration/settings/global-settings-vault.md)中项目的名称。例如，`%Vault:companyname%` 替换为保管库中存储的 `companyname` 项的值。
* %DateFormat:format%：其中 `format` 是可接受的日期格式（详见[示例日期格式](https://docs.kasoftware.com/26.3/self-hosted/zh/scripting/value-formatters/date-formatters.md#sample-date-formats)）。例如，`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%` 替换为文件上的日期和时间戳。

还可以创建更复杂的宏，如以下示例所示：

* 在一个文件名中组合多个宏：`%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%%EXT%`
* 包含宏之外的文本：`MyFile_%DateFormat:yyyy-MM-dd-HH-mm-ss-fff%`
* 在宏中包含文本：`%DateFormat:'DateProcessed-'yyyy-MM-dd_'TimeProcessed-'HH-mm-ss%`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.