TOTVSTEC

Árvore de páginas

Permite obter junto ao banco de dados SQLITE, o plano de execução de um statement SQL.

Sintaxe
DBSqlPlan( < cQuery >, < cRDD >, < aResult >, [ nLevel ], [ cError ] )
Parâmetros
NomeTipoDescriçãoObrigatórioReferência
cQuerycaractereString contendo a instrução SQL para gerar o plano de execução.X
cRDDcaractereString contendo a RDD SQLITE a ser considerada ( SQLITE_SYS, SQLITE_TMP, SQLITE_MEM ).X
aResultvetorArray por referencia, onde será retornado o plano de execução da instrução SQL.X
nLevelnuméricoNivel de detalhamento do plano de execução. 1= básico (default), 2 = detalhado.

cErrorcaractereString por referencia, para recuperar detalhes em caso de erro na obtenção do plano de execução.

Retorno
NomeTipoDescrição
lRetlógicoRetorna .T. em caso de sucesso, .F. em caso de falha ao obter o plano de execução.
Observações

O plano de execução é retornado como um array de múltiplas dimensões, onde o primeiro elemento contém um array de strings, que identifica as informações retornadas, e a partir do segundo elemento, arrays contendo os detalhes do plano de execução, vide exemplo abaixo:


aPlan -> ARRAY (    3) [...]
     aPlan[1] -> ARRAY (    4) [...]
          aPlan[1][1] -> C (    2) [id]
          aPlan[1][2] -> C (    6) [parent]
          aPlan[1][3] -> C (    7) [notused]
          aPlan[1][4] -> C (    6) [detail]
     aPlan[2] -> ARRAY (    4) [...]
          aPlan[2][1] -> N (   15) [         3.0000]
          aPlan[2][2] -> N (   15) [         0.0000]
          aPlan[2][3] -> N (   15) [         0.0000]
          aPlan[2][4] -> C (   17) [SCAN TABLE TSTQRY]
     aPlan[3] -> ARRAY (    4) [...]
          aPlan[3][1] -> N (   15) [        16.0000]
          aPlan[3][2] -> N (   15) [         0.0000]
          aPlan[3][3] -> N (   15) [         0.0000]
          aPlan[3][4] -> C (   28) [USE TEMP B-TREE FOR ORDER BY]

Atenção

Esta função está disponivel em builds de Totvs Application Server iguais ou superiores a 20.3.1.0.

Exemplos
USER FUNCTION TEST()

RETURN
Veja também
  • Sem rótulos