Frameworksp

Atalhos

Páginas filhas
  • Desenvolvendo queries no Protheus

Versões comparadas

Versão antiga 2

changes.mady.by.user Sergio Luis De Alcantara Silveira

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Sergio Luis De Alcantara Silveira

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

 

Objetivo

Abordar o desenvolvimento de queries utilizando o framework Protheus.

 

O DBAcess (antigo TopConnect)

 

O DBAcess possui várias funções. Destacamos as mais importantes:

  • Comunicação com o banco de dados.
  • Gerenciamento das conexões de estações Protheus x banco da dados.
  • Tradução dos comandos e funções enviados pela RDD (ISAM) em linguagem SQL.
  • Envio e tratamento dos comandos SQL nativos ao banco de dados.
  • Gerenciamento de travas (locks) através do lock manager.

O Top Connect DBAccess permite aos desenvolvedores trabalhar com banco de dados SQL usando uma metodologia ISAM, exatamente como se estivessem usando um banco ISAM nativo.

 No entanto, devido às diferenças intrínsecas ao dois modelos, esta forma de acesso é muito lenta, além de onerar demasiadamente o banco de dados, a rede e o próprio Top ConnectDBAccess.

A recomendação é utilizar sempre que possível a linguagem SQL para acesso aos dados quando se utiliza Top ConnectDBAccess.

A leitura de um conjunto de resultados (result set)  obtido através de uma query é muitíssimo mais rápida que a varredura na tabela real usando ISAM.

Além disso, a linguagem SQL permite o uso de funções de agregação, entre outros, que otimizam ainda mais o desempenho.

Implementação no banco de dados

Listamos abaixo algumas características exigidas para a manipulação de tabelas pelo Top ConnectDBAccess.

Campos especiais: as tabelas gerenciadas pelo Top Connect DBAccess devem possuir campos de controle. Eles são criados automaticamente quando da criação das tabelas. São eles:

 

  • R_E_C_N_O_ - Número do registro. É a chave primária de todas as tabelas de dados e por consequência único. É alimentado automaticamente quando da inserção de uma linha via TOP. É um inteiro de 4 bytes. Permite compatibilidade ISAM com a função DbGoto().
  • D_E_L_E_T_ - “Flag” de exclusão. Indica a exclusão “lógica” de uma linha ou registro, ou seja, a linha  não é mais considerada no Protheus mas continua no banco de dados. É um caractere de 1, e os conteúdos permitidos são branco (linha ativa) e asterisco (linha excluída). Criado também por questões de compatibilidade com ISAM.
  • R_E_C_D_E_L_ - Número do registro do item excluído. Este campo recebe o valor de R_E_C_N_O_ quando da exclusão lógica do registro. Este campo é necessário pois caso haja exclusão de duas  linhas com a mesma chave única alternativa (X2_UNICO), haveria duplicidade de chave. Dessa forma, todas as chaves únicas criadas por X2_UNICO recebem automaticamente D_E_L_E_T_ e R_E_C_D_E_L_ no final.

 

Implementação no banco de dados

  • Campos do tipo DATA.

Os campos tipo data são armazenados como caractere de 8 dígitos.

  • Campos do tipo NUMÉRICO

Os campos do tipo numérico são armazenados como FLOAT (ponto flutuante) de 8 dígitos. Os campos são armazenados de forma binária, dessa forma um campo de 8 dígitos pode armazenar um número muito maior que 8 inteiros ou decimais.

  • Campos do tipo LÓGICO (BOOLEANO)

    Os campos tipo lógico são armazenados como caractere de 1 dígito.Campos do tipo MEMO (texto grande)

  • Campos MEMO

Os campos tipo memo são armazenados como BLOB (binary large object). O nome do tipo de campo pode variar conforme o banco de dados. No MS Sql Server o campo é armazenado como image. Os campos MEMO vituais estilo Protheus (MSMM) são armazenados de forma diferente, na tabela SYP.

 

Tabela TOP_FIELD

 

A tabela Top Field é utilizada para conversão automática dos tipos de dados diferentes de caractere para os tipos correspondentes na linguagem ADVPL, quando utilizamos modo de acesso ISAM. Ela também armazena a quantidade de inteiros e casas decimais dos campos numéricos.

A Top Field é alimentada automaticamente durante a criação de uma tabela pelo Top Connect DBAccess e também é atualizada quando as propriedades dos campos são alteradas usando comandos e funções padrões do ADVPL.

Dessa forma, quando um campo é criado ou mantido pelo configurador, atualização de versão ou update, a top field é corretamente alimentada.

Por outro lado, se a tabela é manipulada diretamente no banco, pode ocorrer divergência entre a Top Field e a tabela física. Isso vai causar mau funcionamento do sistema.

 

A tabela Top Field só faz a conversão automática de tipo no modelo ISAM. Quando trabalhamos com result sets de querys, devemos utilizar a função TcSetField() para converter manualmente os tipos de dados. 

A linguagem SQL

 

Definição:

•Structured Query Language, ou Linguagem de Consulta Estruturada ou SQL, é uma linguagem de pesquisa declarativa para banco de dados relacional (base de dados relacional). Muitas das características originais do SQL foram inspiradas na álgebra relacional.
•O principal objetivo do SQL é o de providenciar um método de acesso às bases de dados de forma interativa através de consultas (queries) à base de dados.
•A linguagem SQL baseia-se na lógica de conjuntos ao invés da lógica procedural (varredura).

 

Vantagens do SQL:

 

•É uma linguagem universal de acesso a dados, e apesar das variações, roda em uma enorme quantidade de plataformas.
•Concentra-se nos resultados desejados, deixando ao banco de dados a missão de escolher a melhor estratégia para consulta dos dados.
•Reduz o trafego de rede pois muitos dados são avaliados no servidor do banco de dados, sem que obrigatoriamente sejam enviados à aplicação, como no ISAM.

 

Desvantagens:

 

•A lógica de conjuntos não é natural para muitas pessoas, o que exige certo tempo de adaptação.
•Queries grandes e complexas podem ser tornar muito abstratas, dificultando o entendimento.
•Devido ao desconhecimento dos fundamentos da linguagem, pode-se fazer uma query esperando uma resposta e receber algo totalmente diferente, e o pior, sem saber disso.

 Queries no Protheus

Existem duas formas de executar queries no Protheus:

 

•Construção de string: nesse modelo, o comando SQL (statement) é construído em uma varíável caractere e enviado ao banco de dados usando a função TcGenQry() ( mais usado ).
•Embedded SQL: nesse modelo a query é construída diretamente no programa ADVPL usando uma sintaxe específica.
•Em ambos os modelos, o funcionamento e a performance são os mesmos.

Abaixo listamos as principais funções e comandos de suporte a queries no ADVPL:

 

  • #IFDEF TOP / #ENDIF – Diretiva de compilação utilizada para separar o trecho de código a ser usado apenas em TOP / SQL.
  • TcGenQry( ) – Efetua o disparo da query passada como string para o Top ConnectDBAccess.
  • dbUseArea() – Efetua a criação de uma área de trabalho para o record set retornado por TcGenQry()
  • GetNextAlias() – Retorna um alias para ser utilizado no record set definido em dbUseArea()
  • ChangeQuery() – Função de framework para compatibilizar a sintaxe das queries aos diferentes bancos de dados (SQL Server, Oracle, IBM DB2, Informix, MySql entre outros). Seu uso é obrigatório, salvo em casos especiais.
  • TcSetField() – Compatibiliza os tipos de dados diferentes de caractere retornados pela query aos tipos do ADVPL.
  • SqlOrder() – Converte uma sintaxe de chave índice em ADVPL para sintaxe SQL para uso na cláusula ORDER BY da query.
  • xFilial( ) – Usada na construção da query para selecionar a filial corrente, da mesma forma que em ISAM.
  • RetSqlName() – Retorna o nome físico da tabela, baseado em um alias, para ser usado em na contrução do “SELECT ... FROM TABELA” da query.
  • DTOS() – Usada para quando deseja-se comparar um campo data do banco com uma variável tipo data do ADVPL.
  • dbGoTop() – Move o ponteiro do record set para a primeira linha.
  • dbSkip() – Move o ponteiro do record set para a linha seguinte. Diferentemente da varredura ISAM, o ponteiro só poderá ser movido “para frente”. Usado nos “loops” de varredura.
  • Eof() – Informa se o record set chegou ao fim.
  • dbCloseArea() – Fecha a área de trabalho e apaga o record set. Após essa função, o record set não pode mais ser acessado. Uso obrigatório ao final do processo.
  • TcGetDb() – Devolve o nome do SGBD (sistema gerenciador de banco de dados) em uso. Exemplo : “MSSQL” -> SQL Server, "ORACLE“ -> Oracle. Usado apenas em casos especiais, quando se deseja difenciar sintaxe, etc...
  • BeginSql – Comando que marca o início de uma query em “embedded SQL”
  • EndSql – Comando que marca o término de uma query em “embedded SQL”
  • % - Marca o início e o fim de uma expressão em “embedded SQL”.