重置配置参考

有关与重置配置功能相关联的对象和过程的详细信息。

数据库对象和过程

以下数据库对象使用 configuration/reset_configuration.sql 创建。

PUBLIC.RESET_CONFIGURATION()

入口点过程可用于 ADMIN 角色。此过程会调用 Java ResetConfigurationHandler.resetConfiguration 处理程序。

PUBLIC.RESET_CONFIGURATION_VALIDATE()

用于提供额外的连接器特定验证。默认情况下，将返回 'response_code': 'OK'。它由默认 ResetConfigurationValidator 调用。在 SQL 和 Java 中都可以被覆盖。

PUBLIC.RESET_CONFIGURATION_INTERNAL()

用于提供额外的连接器特定逻辑。默认情况下，将返回 'response_code': 'OK'。它由默认 ResetConfigurationCallback 调用。在 SQL 和 Java 中都可以被覆盖。

自定义处理程序

处理程序可以通过使用 SQL 完全替换或通过实施 Java 接口进行自定义。

使用 SQL 替换

可以使用 SQL 替换以下组件。

处理程序

若要提供 ResetConfigurationHandler 的自定义实施，必须替换 PUBLIC.RESET_CONFIGURATION 过程。例如：

CREATE OR REPLACE PROCEDURE PUBLIC.RESET_CONFIGURATION()
RETURNS VARIANT
LANGUAGE JAVA
RUNTIME_VERSION = '11'
PACKAGES = ('com.snowflake:snowpark:1.11.0')
IMPORTS = ('/connectors-native-sdk.jar')
HANDLER = 'com.snowflake.connectors.application.configuration.reset.CustomResetConfigurationHandler.resetConfiguration';

GRANT USAGE ON PROCEDURE PUBLIC.RESET_CONFIGURATION() TO APPLICATION ROLE ADMIN;
Copy

内部过程

也可以通过 SQL 对 INTERNAL 过程进行自定义。

CREATE OR REPLACE PROCEDURE PUBLIC.RESET_CONFIGURATION_INTERNAL()
    RETURNS VARIANT
LANGUAGE SQL
EXECUTE AS OWNER
AS
BEGIN
    -- SOME CUSTOM LOGIC

    RETURN OBJECT_CONSTRUCT('response_code', 'OK');
END;
Copy

它还可以调用另一个 Java 处理程序：

CREATE OR REPLACE PROCEDURE PUBLIC.RESET_CONFIGURATION_INTERNAL()
RETURNS VARIANT
LANGUAGE JAVA
RUNTIME_VERSION = '11'
PACKAGES = ('com.snowflake:snowpark:1.11.0')
IMPORTS = ('/connectors-native-sdk.jar')
HANDLER = 'com.snowflake.connectors.application.configuration.reset.CustomResetConfigurationCallback.resetConfiguration';
Copy

生成器方法

可以使用 ResetConfigurationHandlerBuilder 对 ResetConfigurationHandler 进行自定义。此生成器允许开发者提供以下界面的自定义实施：

  • ResetConfigurationValidator

  • ResetConfigurationCallback

  • ConnectorErrorHelper

并非所有接口都需要实施，在这种情况下，将使用 SDK 提供的默认实施。

以下示例显示了如何自定义 ResetConfigurationValidator。

class CustomResetConfigurationValidator implements ResetConfigurationValidator {

    @Override
    public ConnectorResponse validate() {
        // CUSTOM VALIDATION LOGIC
        return ConnectorResponse.success();
    }
}

class CustomHandler {

    // Path to this method needs to be specified in the SQL definition of the PUBLIC.RESET_CONFIGURATION procedure
    public static Variant resetConfiguration(Session session) {
        // Using the builder
        var handler = ResetConfigurationHandler.builder(session)
            .withValidator(new CustomResetConfigurationValidator())
            .build();
        return handler.resetConfiguration().toVariant();
    }
}
Copy
语言: 中文