nginstack

Module: @nginstack/dev-tools/lib/database/QueryAnalyzer

Methods

<inner> getHtmlExecutionPlan(sql [, options])

Obtém uma análise em HTML do plano de execução gerado pelo banco de dados para a expressão SQL informada. O plano de execução é uma informação gerada pelo banco de dados que permite ao desenvolvedor compreender como o query será executado e determinar se a expressão SQL criada tem bom desempenho.

Cada banco de dados possui um modelo de plano de execução e a documentação dele deve ser lida para compreender as informações retornadas.

Parameters:
Name Type Argument Description
sql string

Expressão SQL que deve ser analisada.
options Object <optional>

Opções para a geração do relatório.

Properties
Name Type Argument Description
disableHeader boolean <optional>

Desabilita o cabeçalho do relatório.
Returns:

Relatório HTML do plano de execução.

Type
string

<inner> getTxtExecutionPlan(sql [, options])

Obtém uma análise em TXT do plano de execução gerado pelo banco de dados para a expressão SQL informada. O plano de execução é uma informação gerada pelo banco de dados que permite ao desenvolvedor compreender como o query será executado e determinar se a expressão SQL criada tem bom desempenho.

Cada banco de dados possui um modelo de plano de execução e a documentação dele deve ser lida para compreender as informações retornadas.

Parameters:
Name Type Argument Description
sql string

Expressão SQL que deve ser analisada.
options Object <optional>

Opções para a geração do relatório.

Properties
Name Type Argument Description
disableHeader boolean <optional>

Desabilita o cabeçalho do relatório.
Returns:

Relatório textual do plano de execução.

Type
string