メインコンテンツへスキップ
このページの機能はプレビュー段階です。API は安定しておらず、これらの機能を宣言する拡張機能は、vsql_allow_preview_extensions = ON が設定されている場合にのみインストールできます。プレビュー層の有効化と機能の登録方法については、プレビュー機能を参照してください。 statement event 機能(vsql::preview::statement_event)は、各クエリの実行完了後に拡張機能提供のハンドラを実行します。サーバーはハンドラをクエリ自身のスレッドで同期的に呼び出し、実行メタデータ — クエリテキスト、タイミング、行数、接続元の識別情報、オプティマイザ品質インジケータ — を渡します。スロークエリのログ記録、監査、メトリクス収集に使用します。 機能名 VEF_PREVIEW_STATEMENT_EVENT_NAME は "vsql::preview::statement_event" です。

機能の宣言

発火フェーズとハンドラ関数でインスタンス化した StatementEventCapability をファイルスコープで宣言し、.with() に渡します:
最初のテンプレート引数は発火フェーズで、vef_statement_event_phase_t 値です。VEF_STATEMENT_EVENT_POSTEXECUTE はクエリの実行完了後に、成功または失敗にかかわらず発火し、このバージョンで実装されている唯一のフェーズです。その他の vef_statement_event_phase_t 値は予約されており、そのいずれかに対してハンドラを宣言すると、サーバーは INSTALL EXTENSION を拒否します。

ハンドラ引数

StatementEventArgs は完了したクエリの読み取り専用ビューです。POSTEXECUTE フェーズではすべてのフィールドに値が設定されています。主なアクセサ: query() は存在する場合サーバーの書き換え形式を返すため、認証情報を含む文はシークレットが平文ではなく難読化された状態で到着し、一般ログとスローログが既にそれらを難読化(伏字化)する方法と一致します:SET PASSWORD、CREATE/ALTER USER ... IDENTIFIED BY、CHANGE REPLICATION SOURCE ... SOURCE_PASSWORD、CREATE SERVER ... OPTIONS(PASSWORD ...)。書き換えルールのない文はそのまま配信されます。 query()、sqlstate()、error_message() などの文字列アクセサは、ハンドラ呼び出しの実行中のみ有効なストレージを指しています — ハンドラが返った後にそれらが必要な場合はバイトをコピーしてください。 StatementEventResult::error_msg(fmt, ...) は printf 形式のメッセージを書き込みます。POSTEXECUTE フェーズでは、メッセージは参考情報(アドバイザリ)であり、サーバーはログに記録しますが、クライアントには伝播しません。

完全な例

vsql_slow_query_log テスト拡張機能の簡略化された形式です。実行時間がしきい値を超える各クエリをログに記録し、statement event 機能をシステム変数と組み合わせて実行時設定を行います:

SQL からの有効化

プレビュー層を有効化した上で(プレビュー層の有効化を参照)、拡張機能をビルドし、その .veb ファイルを veb_dir にコピーしてインストールし、そのシステム変数を通じて設定します:
しきい値より遅い各クエリは、設定されたログファイルに追記されます: