一時停止コネクタリファレンス

データベースオブジェクトとプロシージャ

次のデータベースオブジェクトは、ファイル 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でも上書きできます。

カスタムハンドラー

ハンドラーとその内部は、次の2つの方法を使用してカスタマイズできます。

プロシージャの代替アプローチ

以下のコンポーネントは 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;
Copy

内部プロシージャ

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';
Copy

ビルダーアプローチ

PauseConnectorHandler は、 PauseConnectorHandlerBuilder を使用してカスタマイズできます。このビルダーを使用すると、ユーザーは次のインターフェイスのカスタム実装を提供できます。

  • 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();
    }
}
Copy