Evitando Palavras-chave SQL ao Nomear Variáveis no PL/pgSQL do PostgreSQL

Ao escrever código em PL/pgSQL no PostgreSQL, uma boa prática é evitar o uso de palavras-chave SQL como nomes de variáveis. Isto é importante para evitar confusão e possíveis erros de sintaxe. Neste artigo, exploraremos por que isso é importante e algumas práticas recomendadas para nomear suas variáveis.

O perigo de usar palavras-chave SQL como nomes de variáveis

SQL é uma linguagem rica com muitas palavras-chave que têm significados específicos, tais como SELECT, INSERT, DELETE, WHERE e muitas outras. Se você usar essas palavras-chave como nomes de variáveis em seu código PL/pgSQL, isso pode resultar em código confuso e potencialmente inválido. Por exemplo, considere o seguinte trecho de código:

DECLARE
  SELECT INTEGER := 5;
BEGIN
  RAISE NOTICE 'O valor de SELECT é %', SELECT;
END;

Ao tentar executar esse bloco de código, o PostgreSQL retornará um erro de sintaxe porque estamos tentando usar SELECT (uma palavra-chave SQL) como nome de variável.

Output do erro

ERROR:  syntax error at or near "INTEGER"
LINE 3:   SELECT INTEGER := 5;

A mensagem de erro é bastante clara: há um erro de sintaxe na linha onde tentamos declarar SELECT como uma variável INTEGER. Isto acontece porque o PostgreSQL espera uma instrução SELECT após a palavra-chave SELECT, e não uma declaração de variável.

Exemplo de código PL/pgSQL corrigido

Agora, vamos corrigir isso alterando o nome da variável para evitar o uso de uma palavra-chave SQL.

DO $$
DECLARE
  my_var INTEGER := 5;
BEGIN
  RAISE NOTICE 'O valor de my_var é %', my_var;
END $$;

Ao executar este bloco de código, não haverá erro e você verá a seguinte saída:

NOTICE:  O valor de my_var é 5

Este exemplo destaca a importância de evitar o uso de palavras-chave SQL ao nomear variáveis no PL/pgSQL para evitar erros de sintaxe e garantir que o código seja mais legível e menos propenso a erros.

Práticas recomendadas para nomear variáveis

Em vez de usar palavras-chave SQL, recomendamos que você adote convenções de nomenclatura claras e significativas para suas variáveis. Aqui estão algumas dicas:

1. Nomes significativos: Os nomes das variáveis devem ser claros e refletir o propósito da variável. Por exemplo, em vez de v1, você poderia usar total_sales.
2. Evite palavras-chave SQL: Como mencionado acima, evite usar palavras-chave SQL para nomes de variáveis.
3. Consistência: Seja consistente com suas convenções de nomenclatura. Por exemplo, se você usar underscores para separar palavras em nomes de variáveis, use essa convenção consistentemente em todo o seu código.
4. Caso: Em SQL, o caso dos identificadores pode ser significativo, dependendo da configuração do seu sistema. Para evitar confusão, é geralmente uma boa prática usar sempre minúsculas para nomes de variáveis.

Ao seguir estas práticas recomendadas, você poderá escrever código PL/pgSQL mais limpo, mais fácil de ler e manter.

A seguir copie a tabela das palavras chaves da própria documentação do postgresql, recomendo sempre avaliarem diretamente do site as palavras / variaveis que estão usando.

https://www.postgresql.org/docs/current/sql-keywords-appendix.html