コネクタを再開¶
ウィザード終了後、コネクタを再開できます。 Finalize Configuration
の後に Pause Connector
を追加して実行することもできます。このステップにより、ユーザーはコネクタの起動後にそのステータスを操作できるようになります。このフェーズのエントリポイントは、 PUBLIC.RESUME_CONNECTOR()
と呼ばれるプロシージャです。SQL で置き換えるか、 ResumeConnectorHandlerBuilder
を使用してカスタマイズできます。コネクタを再開の逆プロセスで、ユーザーが一時停止できるようにするのは 一時停止コネクタ です。
このプロシージャを呼び出すには、ユーザーに ADMIN
アプリケーションロールが割り当てられている必要があります。
再開コネクタのステップは、内部的には複数のフェーズで構成されます。一部は完全にカスタマイズ可能で、デフォルトでは何も実行されません。フェーズは次のとおりです。
権限の検証
ステータスの検証
状態の検証
ステータス更新(STARTING)
内部コールバック
タスクリアクターの再開(タスクリアクターが有効な場合)
ステータス更新(STARTED)
要件¶
再開コネクタでは、ネイティブアプリのインストール中に少なくとも次のSQLファイルを実行する必要があります。
core.sql
configuration/app_config.sql
lifecycle/resume.sql
推奨:
lifecycle/pause.sql
推奨:
configuration/finalize_configuration.sql
権限の検証¶
コネクタを再開するには、アプリケーションに EXECUTE TASK
権限を付与する必要があります。
この検証は、 ResumeConnectorHandlerBuilder
を使用しても、ストアドプロシージャを上書きしても上書きできません。ただし、カスタムハンドラーを実装することはできます。
ステータスの検証¶
コネクタを再開するには、コネクタの内部ステータスを PAUSED
にする必要があります。
この検証は、 ResumeConnectorHandlerBuilder
を使用しても、ストアドプロシージャを上書きしても上書きできません。ただし、カスタムハンドラーを実装することはできます。
状態の検証¶
さらにカスタム検証が必要な場合は、ユーザーがカスタマイズできる PUBLIC.RESUME_CONNECTOR_VALIDATE()
ストアドプロシージャが用意されています。デフォルトでは、このプロシージャは単に 'response_code': 'OK'
を返します。このプロシージャは、 SQL を使って上書きするか、 ResumeConnectorHandlerBuilder
を使用して、 ResumeConnectorStateValidator
インターフェイスのカスタム実装を提供することでカスタマイズできます。
内部コールバック¶
内部コールバックは、もう1つのカスタマイズ可能なステップです。デフォルトでは、 PUBLIC.RESUME_CONNECTOR_INTERNAL()
を呼び出し、 'response_code': 'OK'
を返します。このプロシージャにより、ユーザーはコネクタを再開するときに必要な追加のタスクを実行できます。たとえば、追加のコネクタ固有のタスクを再開します。SQL スクリプトを通じて上書きすることも、 ResumeConnectorHandlerBuilder
を使用して ResumeConnectorCallback
インターフェイスのカスタム実装を提供することもできます。
ステータスの更新¶
上記のすべてのフェーズが正常に完了すると、コネクタの内部ステータスが次のように更新されます。
{
"status": "STARTED",
"configurationStatus": "FINALIZED"
}
状態遷移の全体図については、 コネクタフロー をご参照ください。
応答¶
正常な応答¶
プロシージャがバックグラウンドですべてのタスクを正常に再開し、ステータス tocSTARTED を変更すると、 ResumeConnectorHandler メソッド本体から Connector successfully resumed.
メッセージが直接返されます。次の形式を使用することをお勧めします。
{ "response_code": "OK" }
エラーの応答¶
エラーが発生した場合、応答は以下の形式になります。
{ "response_code": "<ERROR_CODE>", "message": "error message" }
考えられるエラーコードは次のとおりです。
INVALID_CONNECTOR_STATUS
-[PAUSED, STARTING]
とは異なる状態のコネクタでこのプロシージャが呼び出されました。CONNECTOR_STATUS_NOT_FOUND
- コネクタステータス記録がデータベースに存在しません(このステージではユーザーの入力とは無関係 - 内部エラー)ROLLBACK_CODE
- エラーが発生しましたが、変更は正常に元に戻されました。INTERNAL_ERROR
- 内部で問題が発生しました。メッセージには説明が必要ですUNKNOWN_ERROR_CODE
- 不明なエラーが発生したため、コネクタは現在指定されていない状態です