Cabeçalho Padrão para Queries no Aspen SQLplus

Para construir um cabeçalho padrão para uma query ou uma procedure no Aspen SQLplus, é preciso incluir informações básicas sobre o objetivo da query, o autor, a data, a versão, entre outros campos que serão importantes para futuras manutenções do código. Aqui está um exemplo de como pode ser estruturado um cabeçalho padrão:

------------------------------------------------------------------
-- <Nome da empresa do colaborador que está criando a query>
------------------------------------------------------------------
-- NOME: <Nome da query>
-- PRODUTO: <Nome do produto quando a query fizer parte de um sistema específico>
-- AUTOR: <Nome do colaborador que está criado a query>
-- DATA: <Data de criação da query no formato DD/MM/YYYY>
-- VERSÃO: <Versão da query, começando em 1.0>
------------------------------------------------------------------
-- DESCRIÇÃO: <Descrição detalhada da query>
------------------------------------------------------------------
-- DEPENDÊNCIAS:
----------------
-- Tabelas : <Nomes de tabelas usadas pela query>
-- Famílias: <Nomes das famílias do IP21 utilizadas pela query>
-- Queries : <Nome de queries, procedures e functions usadas pela query>
------------------------------------------------------------------
-- ATIVAÇÃO:
------------
-- Schedule: <Intervalo de execução da query>
-- COS: <Nomes das tags que são trigger de execução da query>
-- Query: <Nome das queries que consomem a procedure ou function criada>
------------------------------------------------------------------
-- PARÂMETROS: <Nome e descrição dos parâmetros de entrada da query>
------------------------------------------------------------------
-- ALTERAÇÔES:
--------------
-- AUTOR: <Nome do colaborador que realizar a alteração na query>
-- DATA: <Data da alteração da query no formato DD/MM/YYYY>
-- DESCRIÇÃO: <Descrição da alteração realizada na query>
-- Versão: <Versão que a query assumiu com a alteração>
------------------------------------------------------------------

-- Início da Query
SELECT 
    campo1 AS 'Descrição do Campo 1',
    campo2 AS 'Descrição do Campo 2',
    campo3 AS 'Descrição do Campo 3'
FROM 
    nome_da_tabela
WHERE 
    [condições];

Este cabeçalho faz parte da documentação do código, ajudando a mantê-lo claro e compreensível para outros desenvolvedores ou analistas que possam vir a utilizá-lo ou revisá-lo no futuro.

Posts Relacionados:

Contatos
Telefone: (31) 98603-7741
Email: contato@pims.com.br

Junte-se a nós

Inscreva-se e receba conteúdos exclusivos

Você foi inscrito com sucesso! Conecte-se ao Mailchimp primeiro

PIMS.com.br – Copyright ® 2024 – Todos os Direitos Reservados.