Padr�o de codifica��o/indenta��o SQL

ADS.FAQ-25735

Sempre que poss�vel, as consultas SQL (e comandos DML) dever�o ser registradas da seguinte forma:

select COL1 as ALIAS1
, COL2 as ALIAS2
, COL3 as ALIAS3
...
from TABELA1 a
join TABELA2 on condicao
left join TABELA3 on condicao
...
where condicao1
and condicao2
and condicao3
...
group by ...
, ...
order by ...
, ...
limit X offset Y

As regras s�o:

A primeira coluna � colocada logo ap�s o comando SELECT
Caso as colunas n�o couberem na mesma linha, as demais colunas s�o colocadas uma a cada linha que dever� come�ar com uma v�rgula seguida de um espa�o
As palavras-chave FROM, JOIN, WHERE, ORDER BY, GROUP BY, UNION, HAVING devem ser inclu�das em um anova linha
A primeira condi��o da clausula deve ser colocada logo ap�s o WHERE
Sempre que a condi��o n�o coube na mesma linha (exceder a 100 caracteres), as demais condi��es do tipo AND dever�o ser colocadas em linhas separadas, formando uma condi��o (AND) por linha.
Express�es com OR devem ser isoladas entre parenteses.

Express�es

Sempre que houverem express�es extensas dentro do SQL, deve-se quebrar as linhas utilizando os crit�rios abaixo.

Blocos separados por "(" e ")" devem ter a primeira linha logo a direita do "(" e todas as demais linhas devem ficar alinhadas com o primeiro. Exemplo:

select ...
, ped.valor_total / (bdx.fator_conversao * ped.valor_mercadorias
                     + bdy.taxas_administrativas) as abaco
, ...

Ao quebrar em operadores, o operador deve iniciar a pr�xima linha. Neste caso, o operador deve ser alinhado de forma que fique abaixo do in�cio da express�o para a qual ele est� associado. Exemplos:

select ...
, ped.valor_total
  / (bdx.fator_conversao * ped.valor_mercadorias
     + bdy.taxas_administrativas) as abaco
, ...

select ...
from pedidos pven
join itens_pedidos iven on iven.pedido_id = pven.id
join itens_pedidos icom on icom.item_pedido_venda_id = iven.id
join pedidos pcom on pcom.id = icom.pedido_id 
                     and pcom.fornecedor_id = pven.fornecedor_id
...

Sub-queries

Quando o SQL possuir uma sub-quey, devem ser utilizados os crit�rios abaixo.

Caso a sub-query ser muito pequena, ele pode ser completamente inserida como uma express�o simples. Exemplo:

select ped.id
, (select sum(valor) from itens where pai_id = ped.id) as soma
from pedidos ped
...

Caso a sub-query seja maior, sugere-se separar toda ela em linhas separadas, seguindo os mesmo crit�rios de um SQL normal, mas indentando o bloco de forma que a segunda linha fique alinhada � primeira linha que � iniciada logo ap�s o "(". A ultima linha � encerrada com o ")". Exemplo:

select ped.id
, (select sum(i.valor_unitario * i.quantidade)
   from itens_pedidos i
   where i.pai_id = ped.id) as soma
from pedidos ped
...

UNION

O uso do UNION implica que devem existir dois SELECTS com a mesma estrutura de colunas. Para facilitar a visibilidade disso, deve existir uma linha em branco antes e depois do comando UNION ou UNION ALL.

Exemplo:

select doc.emitente_uf as uf
, sum(valor_total_icms_estado_remetente) as valor
, 0.0 as fcp
from doc_entradas_saidas doc
inner join especies esp on esp.id = doc.especie_id
where estabelecimento_id = ?
and data_emissao between ? and ?
group by doc.emitente_uf

union all

select doc.destinatario_uf as uf
, sum(valor_total_icms_estado_destino) as valor
, sum(valor_total_icms_fcp) as fcp
from doc_entradas_saidas doc
inner join especies esp on esp.id = doc.especie_id
where estabelecimento_id = ?
and data_emissao between ? and ?
group by doc.destinatario_uf

Uso de SQL em c�digos Java

No caso de c�digos java que precisam de comandos SQL, a String contendo o SQL deve seguir a mesma regra acima e todas as linhas ap�s a primeira DEVEM iniciar com um espa�o. Exemplo:

String sql = "select gu.grupo"
        + " from permissoes_acesso_registros par"
        + " join grupos_usuarios gu on gu.id = par.grupo_id"
        + " where par.registro_id = ?"
        + " and par.tabela = ?"
        + " order by gu.grupo";

Os motivos para usar um espa�o no IN�CIO de cada linha s�o:

As palavras-chaves ficam mais destacadas com um espa�o antes do que com o sinal de aspas duplas.
� mais dif�cil de esquecer de informar um espa�o o que causaria um erro de execu��o no SQL. No final da linha, a falta do espa�o passa mais facilmente desapercebido.