vsql_allow_preview_extensions = ON para instalar. Consulte Capabilities Preview para saber como habilitar o nível Preview e registrar uma capability.
A capability statement event (vsql::preview::statement_event) executa um handler
fornecido pela extensão após cada consulta terminar de executar. O servidor invoca
o handler sincronamente na própria thread da consulta e passa metadados de
execução — o texto da consulta, tempo, contagens de linhas, identidade da conexão
e indicadores de qualidade do otimizador. Use-o para registro de consultas lentas,
auditoria ou coleta de métricas.
O nome da capability VEF_PREVIEW_STATEMENT_EVENT_NAME é
"vsql::preview::statement_event".
Declarando a Capability
Declare umStatementEventCapability, instanciado sobre a fase de disparo e a sua
função handler, no escopo do arquivo e passe-o para .with():
vef_statement_event_phase_t. VEF_STATEMENT_EVENT_POSTEXECUTE dispara após uma
consulta terminar de executar, em caso de sucesso ou falha, e é a única fase
implementada nesta versão. Os outros valores de vef_statement_event_phase_t são
reservados; declarar um handler para um deles faz o servidor rejeitar o
INSTALL EXTENSION.
Argumentos do Handler
StatementEventArgs é um view somente leitura da consulta concluída; na fase
POSTEXECUTE todos os campos estão populados. Acessadores selecionados:
Como
query() retorna a forma reescrita do servidor quando existe uma, as
instruções que carregam credenciais chegam com o segredo ofuscado em vez de em
texto claro, correspondendo à forma como os logs geral e lento já os
ofuscam: SET PASSWORD, CREATE/ALTER USER ... IDENTIFIED BY,
CHANGE REPLICATION SOURCE ... SOURCE_PASSWORD e
CREATE SERVER ... OPTIONS(PASSWORD ...). As instruções sem regra de reescrita
são entregues literalmente.
Os acessadores de string como query(), sqlstate() e error_message() apontam
para armazenamento que é válido apenas durante a chamada do handler — copie os
bytes se você precisar deles depois que o handler retornar.
StatementEventResult::error_msg(fmt, ...) escreve uma mensagem formatada com
printf. Na fase POSTEXECUTE a mensagem é informativa: o servidor a registra, mas
não a propaga para o cliente.
Exemplo Completo
Uma forma condensada da extensão de testevsql_slow_query_log.
Ela registra cada consulta cujo tempo de
execução excede um limiar, combinando a capability statement event com
variáveis de sistema para configuração em tempo de execução:
Habilitando a partir do SQL
Com o nível Preview habilitado (consulte Habilitando o Nível Preview), compile a extensão, copie o seu arquivo.veb para o veb_dir,
instale-a e configure-a através de suas variáveis de sistema: