更新连接配置¶

要求¶

在原生应用程序安装过程中，连接配置至少需要执行以下 sql 文件：

• core.sql

• configuration/app_config.sql

• configuration/connection_configuration.sql

• configuration/update_connection_configuration.sql

如果使用此功能，则根据 SDK 用户的不同还有其他要求：

• PUBLIC.TEST_DRAFT_CONNECTION() 和 PUBLIC.TEST_CONNECTION() 过程的自定义实现

状态验证¶

要执行连接配置更新，连接器的内部状态必须为 PAUSED。

不能通过使用 UpdateConnectionConfigurationHandlerBuilder 或覆盖存储过程来覆盖此验证。但是，也可以实现一个自定义处理程序，它不会进行这种验证。

输入验证¶

输入必须是包含属性映射的 variant，但有时这还不够。因此，SDK 提供了名为 PUBLIC.UPDATE_CONNECTION_CONFIG_VALIDATE(config VARIANT) 的内部存储过程。默认情况下，此过程仅返回 'response_code': 'OK'，但在覆盖此过程时，可以在验证期间更新提供的配置。此功能启用自定义逻辑，例如修剪输入、转换为大写/小写等。要返回以任何方式转换的配置，响应需要在响应 Variant 中包含一个额外的 "config" 属性，此属性应将更新的配置作为 Variant 包含在内。通过覆盖 SQL 或使用 UpdateConnectionConfigurationHandlerBuilder 并提供 ConnectionConfigurationInputValidator 接口的自定义实现来对该过程进行自定义。

使用转换的自定义实现的有效响应如下所示：

{
    "response_code" : "OK",
    "config": {
        "key1": "value1",
        "key2": "value2"
    }
}

配置更新¶

成功通过验证后，配置将保存到内部 APP_CONFIG 表中。负责此阶段的服务将提供的 Variant 保存在 connection_configuration 键下。此配置必须通过内部草稿回调和草稿连接验证成功验证才能更新，提供的属性集完全由用户决定。

内部草稿回调¶

内部回调是另一个可自定义的步骤。默认情况下，它会调用 PUBLIC.DRAFT_CONNECTION_CONFIGURATION_INTERNAL(connection_configuration VARIANT)，返回 'response_code': 'OK'。例如，它可用于通过授予其他过程外部访问集成来更改其他过程。可以通过 sql 脚本或使用 ConnectionConfigurationHandlerBuilder 提供 ConnectionConfigurationCallback 接口的自定义实现来将其覆盖。

草稿连接验证¶

此步骤将触发 PUBLIC.TEST_DRAFT_CONNECTION(connection_configuration VARIANT) 过程。此过程尝试使用输入参数中的数据作为连接配置来查询源系统中的数据。默认情况下，此过程未实现，需要由 SDK 用户提供。此外，可以向 UpdateConnectionConfigurationHandlerBuilder 提供 ConnectionValidator 接口实现以自定义此阶段。在这种情况下，无需实现存储过程。建议在此过程中仅执行最少的连接检查，以确保正确配置了 Snowflake 的外部访问功能，并且连接器具有使用这些功能所需的所有权限。

内部回调¶

内部回调是另一个可自定义的步骤。默认情况下，它会调用 PUBLIC.SET_CONNECTION_CONFIGURATION_INTERNAL(connection_configuration VARIANT)，返回 'response_code': 'OK'。例如，它可用于通过授予其他过程外部访问集成来更改其他过程。可以通过 sql 脚本或使用 ConnectionConfigurationHandlerBuilder 提供 ConnectionConfigurationCallback 接口的自定义实现来将其覆盖。

连接验证¶

此步骤将触发 PUBLIC.TEST_CONNECTION 过程。此过程对 PUBLIC.TEST_DRAFT_CONNECTION(connection_configuration VARIANT) 具有双重操作，但没有输入参数，并且应该用于通过保存在数据库中的配置来测试官方连接。

查看配置¶

ADMIN 和 VIEWER 用户可以使用 PUBLIC.GET_CONNECTION_CONFIGURATION() 过程，该过程从内部表返回当前连接配置。

响应¶

{
  "response_code": "OK"
}

{
  "response_code": "<ERROR_CODE>",
  "message": "<error message>"
}