Queries dinâmicas no servidor DataSnap

Quando eu digo que lugar de SQL é no servidor é porque vejo muitos programadores Delphi usando DataSnap como um simples middleware de conectividade com o banco de dados, não como uma verdadeira camada de “regras de negócio” que proporcione abstração de dados do lado cliente.

Uma dificuldade comum, que muitos consideram justificativa para usar a famigerada opção poAllowCommandText no TDataSetProvider, é fazer queries customizadas na aplicação cliente que não tenham um conjunto definido de parâmetros.

Como fazer uma pesquisa em um cadastro de clientes, por exemplo, por Cidade e/ou Nome e/ou Data de Cadastro? Só esses três parâmetros permitem 8 combinações de consulta (2³). Uma solução seria escrever 8 queries diferentes no servidor e mais 8 dataset providers. Uma trabalheira danada. Já se fossem 5 campos de pesquisa para o usuário, seriam 32 combinações! Por aí que muita gente escolhe construir dinamicamente a query no cliente e usar a propriedade CommandText de TClientDataSet.

Uma alternativa é escrever uma query em que a cláusula WHERE contemple parâmetros nulos. Por exemplo:

WHERE
((:Cidade IS NOT NULL) AND (Cidade = :Bairro)) OR
((:Cadastro IS NOT NULL) AND (Cadastro >= :Cadastro))

O problema com essa técnica é que a performance da query fica muito comprometida. Não há como o otimizador do banco de dados fazer um plano de execução eficiente.

A minha solução preferida é simplesmente mandar os valores dos parâmetros para o TDataSetProvider montar a query dinamicamente. Falando assim parece simples, mas… na verdade é simples! :)

A chave é usar o evento BeforeGetRecords, presente tanto no TClientDataSet (no lado cliente), quanto no TDataSetProvider (no lado servidor). O evento tem um parâmetro OwnerData do tipo OleVariant (para todos efeitos, idêntico a um Variant) que pode ser atribuido no cliente e depois lido no servidor.

Construí uma pequena aplicação de exemplo que lê a tabela Country do banco de dados Access de demonstração que fica em “…\Borland Shared\Data\dbdemos.mdb”. Veja abaixo uma imagem da aplicação filtrando os campos “Continent”, “Population” (valo mínimo) e “Name” (iniciais).

O que eu fiz no cliente foi apenas montar um array Variant com os parâmetros definidos pelo usuário e atribuí-lo a OwnerData. Não mexi com a propriedade Params do ClientDataSet simplesmente porque não existe nenhum parâmetro no dataset: o SQL será montado no servidor dinamicamente.

  procedure TForm1.cdsCountryBeforeGetRecords(
    Sender: TObject; var OwnerData: olevariant);
  var
    ContinentEqual: string;
    PopulationMin: integer;
    NameStart: string;
  begin
    ContinentEqual := Trim(Edit1.Text);
    PopulationMin := StrToIntDef(Trim(Edit2.Text), 0);
    NameStart := Trim(Edit3.Text);
    OwnerData := VarArrayOf([ContinentEqual, PopulationMin, NameStart]);
  end;

Com isso o cliente só precisa deixar o usuário entrar com os parâmetros que quiser na tela e dar Open no dataset (não esqueça de dar um Close antes de fazer uma nova pesquisa). O servidor se encarregará de montar o código SQL apropriado com os parâmetros que não forem vazios.

O mesmo evento BeforeGetRecords é usado no servidor de aplicação, mas agora usamos o do componente TDataSetProvider para alterar em código a propriedade SQL do objeto de query (no caso, um TADOQuery):

  procedure TRemoteDataModule1.dspCountryBeforeGetRecords(
    Sender: TObject; var OwnerData: olevariant);
  var
    ContinentEqual: string;
    PopulationMin: integer;
    NameStart: string;
    SQLWhere: string;
 
    procedure AddWhere(const S: string);
    begin
      if SQLWhere = '' then
        SQLWhere := 'WHERE'
      else
        SQLWhere := SQLWhere + ' AND';
      SQLWhere := SQLWhere + ' (' + S + ')';
    end;
 
  begin
    if VarIsArray(OwnerData) and (VarArrayHighBound(OwnerData, 1) = 2) then
    begin
      ContinentEqual := OwnerData[0];
      PopulationMin := OwnerData[1];
      NameStart := Ownerdata[2];
 
      SQLWhere := '';
      if ContinentEqual = '' then
        AddWhere(Format('Continent = ''%s''', [ContinentEqual]));
      if Populationmin > 0 then
        AddWhere(Format('Population >= %d', [PopulationMin]));
      if NameStart = '' then
        AddWhere(Format('Name LIKE ''%s%%''', [NameStart]));
 
      qryCountry.SQL.Clear;
      qryCountry.SQL.Add('SELECT * FROM Country');
      qryCountry.SQL.Add(SQLWhere);
    end;
  end;

Veja abaixo o resultado de uma query mais específica, que define o continente “South America” e uma quantidade mínima de 100.000.000 habitantes.

Com essa técnica a aplicação cliente fica totalmente independente da estrutura do banco de dados. Se mudar o banco de dados, ou mesmo a estrutura das tabelas, nada tem que ser alterado no cliente! O simples fato de isolar a camada de apresentação do acesso a dados já é uma vantagem na administração do projeto.

Repitam comigo: CommandText nunca mais! ;-)

Artigo publicado originalmente em 20/08/2006.

Comments

• Artigos Recentes

  • Reordenação de Items em ListBox
  • Teclas Enter e Esc no Delphi
  • Modelos de interface SDI, MDI, TDI e NDI
  • MySQL no Delphi 2007
  • Delphi Prism Video
  • Delphi Prism no Visual Studio .NET
  • TField.Name do seu jeito
  • Previna AV com Assert

• Recent Comments

  Mauro Otoni commented on Reordenação de Items em ListBox Maravilha de artigo, sensacional. Gostaria de aproveitar este espaço e pedir sua ajuda mais uma vez.
  
  Cesar Romero commented on Teclas Enter e Esc no Delphi Muito bem colocado.
  
  Malta commented on Modelos de interface SDI, MDI, TDI e NDI Parece que eu consegui criar alguma polêmica... :) Esperava que o artigo traria opiniões fortes cont
  
  Sandro commented on Modelos de interface SDI, MDI, TDI e NDI Discordo completamente sobre usuário preferir o modelo SDI. O Dener citou o exemplo que presenciei v
  
  Dener commented on Modelos de interface SDI, MDI, TDI e NDI Exatamente isso ! Seu último parágrafo diz tudo, mas discordo onde você diz que "o usuário gosta de
  
  

• Twitter

  
  follow dmalta at http://twitter.com

• 
  

• Sobre

  Malta on Delphi é um site de artigos técnicos originais sobre Delphi.

  

• Marcadores

  .NET Borland class helpers CodeGear compilador compressão comunicação criptografia DataSnap DB dbExpress DB Helpers Delphi DevExpress expressões regulares generics impressora Java JCL kbmMemTable kbmMW linguagem localização macros memória OOP Prism RTL Ruby on Rails SQL Synapse TCP/IP thread Tiburón tradução UI VCL

• Archives

  • November 2008
  • October 2008
  • August 2008
  • May 2008
  • April 2008
  • March 2008
  • January 2008
  • December 2007
  • November 2007

• Blogroll

  • Cesar Romero
  • Delphi Feeds
  • Erick Sasse
  • Estação ZN
  • Leonel Togniolli