暂停连接器参考¶

数据库对象和过程¶

以下数据库对象是通过文件 lifecycle/pause.sql 创建的。

PUBLIC.PAUSE_CONNECTOR()¶

入口点过程可用于 ADMIN 角色。此过程会调用 Java 函数 PauseConnectorHandler.pauseConnector。

PUBLIC.PAUSE_CONNECTOR_VALIDATE()¶

用于暂停过程连接器特定验证的过程。默认情况下，它会返回 'response_code': 'OK'。它由 DefaultPauseConnectorStateValidator 调用。在 SQL 和 Java 中都可以被覆盖。

PUBLIC.PAUSE_CONNECTOR_INTERNAL()¶

用于连接器特定附加暂停职责的过程。默认情况下，它会返回 'response_code': 'OK'。它由 InternalPauseConnectorCallback 调用。在 SQL 和 Java 中都可以被覆盖。

自定义处理程序¶

可以使用以下两种方法对处理程序及其内部组件进行自定义。

过程替换方法¶

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

处理程序¶

若要提供 PauseConnectorHandler 的完整自定义实施，则必须替换 PUBLIC.PAUSE_CONNECTOR 过程。例如：

CREATE OR REPLACE PROCEDURE PUBLIC.PAUSE_CONNECTOR()
RETURNS VARIANT
LANGUAGE JAVA
RUNTIME_VERSION = '11'
PACKAGES = ('com.snowflake:snowpark:1.11.0')
IMPORTS = ('/connectors-native-sdk.jar')
HANDLER = 'com.custom.handler.CustomPauseConnectorHandler.pauseConnector';

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

内部过程¶

内部 VALIDATE 和 INTERNAL 过程也可以通过 SQL 进行自定义。它们还可以调用另一个 Java 处理程序：

CREATE OR REPLACE PROCEDURE PUBLIC.PAUSE_CONNECTOR_INTERNAL()
RETURNS VARIANT
LANGUAGE SQL
EXECUTE AS OWNER
AS
BEGIN
    -- SOME CUSTOM LOGIC BEGIN
    SELECT sysdate();
    -- SOME CUSTOM LOGIC END

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

CREATE OR REPLACE PROCEDURE PUBLIC.PAUSE_CONNECTOR_VALIDATE()
RETURNS VARIANT
LANGUAGE JAVA
RUNTIME_VERSION = '11'
PACKAGES = ('com.snowflake:snowpark:1.11.0')
IMPORTS = ('/connectors-native-sdk.jar')
HANDLER = 'com.custom.handler.CustomPauseConnectorInternalHandler.pauseConnector';

生成器方法¶

可以使用 PauseConnectorHandlerBuilder 对 PauseConnectorHandler 进行自定义。此生成器允许用户提供以下界面的自定义实施：

PauseConnectorStateValidator
PauseConnectorCallback
ConnectorErrorHelper

如果未提供函数，则将使用 SDK 提供的默认实施。

class CustomPauseConnectorStateValidator implements PauseConnectorStateValidator {
    @Override
    public ConnectorResponse validate() {
        // CUSTOM LOGIC
        return ConnectorResponse.success();
    }
}

class CustomHandler {

    // Path to this method needs to be specified in the PUBLIC.PAUSE_CONNECTOR procedure using SQL
    public static Variant pauseConnector(Session session) {
            //Using builder
        var handler = PauseConnectorHandlerBuilder.builder(session)
            .withStateValidator(new CustomPauseConnectorStateValidator())
            .build();
        return handler.pauseConnector().toVariant();
    }
}