コールバック¶

同期コールバック¶

同期コールバックは、SQLコマンドのトリガーの一部として呼び出されます。同期コールバックは呼び出し元のSQLコマンドをブロックします。コールバックがエラーを返す場合、コマンドはエラーを返し、コールバックのエラーメッセージはコマンドのSQLエラーメッセージの一部として返されます。

同期コールバックはウェアハウスで実行されるため、呼び出しプロシージャにはセッションウェアハウスが設定されている必要があります。

非同期コールバック¶

非同期コールバックは、SQLコマンドの呼び出しが完了した後、バックグラウンドで実行されます。非同期コールバックは呼び出し元SQLコマンドをブロックせず、非同期コールバックのエラーは、呼び出し元のコマンドによって返されません。

非同期コールバックが最新の情報を持っていることを確認するために、コールバック署名は状態またはステータス情報を提供しません。代わりに、コールバックは、:doc:`SHOW CONFIGURATIONS </sql-reference/sql/show-configurations>`や:doc:`SHOW SPECIFICATIONS </sql-reference/sql/show-specifications>`など、適切なSQLコマンドを使用して最新の情報を取得する必要があります。詳細については、各非同期コールバックの説明をご参照ください。

非同期コールバックからの戻り値は無視されます。

権限¶

このトピックにリストされているコールバックプロシージャは、アプリケーションロールに付与する必要はありません。プロシージャはアプリの内部に配置でき、コンシューマーが実行できるようにする必要はありません。コールバックは|naf|によってトリガーされます。

仕様と接続コールバック¶

:ref:`label-native_apps_specification_callbacks_after_specification_change`および:ref:`label-native_apps_connection_callbacks_after_server_connection_change`はどちらも、仕様が承認または拒否されたときに実行されます。2つのコールバックの違いは次のとおりです。

• after_specification_change はアプリケーション仕様フレームワークの一部です。これは、コンシューマーが仕様リクエストを承認または拒否した場合にのみトリガーされます。

• after_server_connection_change はアプリ間通信フレームワークの一部です。これは、アプリケーション仕様の接続状態に直接的または間接的に影響を与えるあらゆる操作によってトリガーされます。これには以下が含まれます。

  • 仕様の承認

  • 承認された仕様の拒否

  • 承認された仕様のドロップ

  • サーバーアプリのドロップ

接続の確立、切断、サーバーアプリの削除など、接続自体の変化にアプリが対応する必要がある場合は、:ref:`label-native_apps_connection_callbacks_after_server_connection_change`を使用してください。このコールバックは、仕様の承認飲みの場合よりも幅広いイベントをカバーするため、より優れた接続追跡を提供します。

アプリケーションが仕様リクエストの承認または拒否にのみ対応する必要がある場合、または``CONNECTION``以外のアプリケーション仕様タイプを処理する場合は、:ref:`label-native_apps_specification_callbacks_after_specification_change`を使用します。

構成コールバック¶

これらのコールバックは、:doc:`構成</developer-guide/native-apps/app-configuration>`が変更されたときにトリガーされます。

• validate_configuration_change

• before_configuration_change

• after_configuration_change

validate_configuration_change(configuration_name, configuration_value)

{
  "type": "SUCCESS | ERROR",
  "payload":{
      "error_message": "Error message indicating the validation failure"
  }
}

before_configuration_change(configuration_name, configuration_value)

after_configuration_change(configuration_name)

session.sql(f"""
  SHOW CONFIGURATIONS ->>
      SELECT "status", "value"
      FROM $1
      WHERE "name" = '{configuration_name}';
  """);

接続コールバック¶

これらのコールバックは、接続のステータスが変更されたときにトリガーされます。

• after_server_connection_change

• after_client_connection_change

• after_server_version_change

after_server_connection_change(server_name)

session.sql(f"""
  SHOW SPECIFICATIONS ->>
  SELECT "status"
  FROM $1
  WHERE PARSE_JSON("definition"):"SERVER_APPLICATION"::STRING = '{server_name}';
  """);

after_client_connection_change(client_name)

session.sql(f"""
  SHOW GRANTS TO APPLICATION {client_name} ->>
  SELECT "name"
  FROM $1
  WHERE "granted_on" = 'APPLICATION_ROLE'
      AND STARTSWITH("name", CURRENT_DATABASE())
  """);

after_server_version_change(server_name)

session.sql(f"""
  SHOW APPLICATIONS ->>
  SELECT "version", "patch"
  FROM $1
  WHERE "name" = {server_name}
  """);

仕様コールバック¶

コールバックは、いずれかの型の仕様でステータスが変更されたときにトリガーされます。

• after_specification_change

after_specification_change(spec_name)

session.sql(f"""
  SHOW SPECIFICATIONS ->>
      SELECT "status"
      FROM $1
      WHERE "name" = '{spec_name}';
  """);