vsql_allow_preview_extensions = ON 才能安装。有关如何启用预览层和注册功能,请参阅预览功能。
语句事件功能 (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 测试扩展的精简形式。它记录每个执行时间超过阈值的查询,将语句事件功能与系统变量结合以进行运行时配置:
从 SQL 启用
启用预览层后(请参阅启用预览层),构建该扩展,将其.veb 文件复制到 veb_dir 中,安装它,并通过其系统变量进行配置: