Guideline para Criação de Objetos Customizados

Descrição Geral

Este documento vem com o intuito de orientar todo o processo para criação de objetos (procedures, packages, functions, sequences, views e triggers) dentro dos devidos padrões. Na área de Links relacionados está disponibilizado um guia de referência e recursos para melhor desempenho na utilização dos objetos.

Requisitos para criação

• Ter privilégio de acesso banco de dados Storex
• Ter privilégio de criação dos objetos no Banco de Dados do Storex.
  

Visões (Views)

A criação de views vem da necessidade de apresentação de dados para facilitar o acesso a consultas, relatórios, etc.
A recomendação para a nomenclatura de visões é:

Onde:

Prefixo: Os prefixos válidos para nomes de visão são:
VM_CSTM - View Materializada
VW_CSTM - Demais views
Regra de Negócio: É a regra de negócio espelhada pela visão com verbo na terceira pessoa do presente do indicativo.

Exemplos:

VW_CSTM_CLIENTE_PRODUTO
VW_CSTM_BLOQUEIO_CARTAO

Recomendamos que o script seja salvo com o nome da view a ser criada utilizando o diretório VIEWS caso seja utilizada a ferramenta gera-installBD. 

Pacotes (Packages)

A criação de packages vem da necessidade de agrupar vários objetos em um único pacote no banco de dados. 
A recomendação para nomes de packages e packages body é:

Onde:

Prefixo: PKG_CSTM
Ação Contextual: Informar verbo na 3ª pessoa do singular do presente do indicativo.
Objeto da Ação Contextual: Objeto que sofrerá a ação do procedimento.

Exemplo:

PKG_CSTM_IMPORTA_PRODUTO

Recomendamos que o script seja salvo com o nome da package a ser criada utilizando o diretório PACKAGES caso seja utilizada a ferramenta gera-installBD. 

Procedimentos (Procedures)

A criação desses objetos vem da necessidade de execução de procedimentos a partir do banco de dados. 
A recomendação para nomes de procedimentos é:

Onde:

Prefixo: SP_CSTM
Ação Contextual: Informar verbo na 3ª pessoa do singular do presente do indicativo.
Objeto da Ação Contextual: Objeto que sofrerá a ação do procedimento.

Exemplo:

SP_CSTM_CONSULTA_CLIENTE

Recomendamos que o script seja salvo com o nome da procedure a ser criada utilizando o diretório PROCEDURES caso seja utilizada a ferramenta gera-installBD. 

Funções (Functions)

A criação desses objetos vem da necessidade de execução de funções a partir do banco de dados.
A recomendação para nomes de funções é:

Onde:

Prefixo: FN_CSTM
Ação Contextual: Informar verbo na 3ª pessoa do singular do presente do indicativo.
Objeto da Ação Contextual: Objeto que sofrerá a ação da função.

Exemplos:

FN_CSTM_VALIDA_CNPJ
FN_CSTM_INICIA_EXPORTACAO

Recomendamos que o script seja salvo com o nome da function a ser criada utilizando o diretório FUNCTIONS caso seja utilizada a ferramenta gera-installBD.

Sequências (Sequences)

A criação de sequências vem, na maioria dos casos, da necessidade de se utilizar sequências numéricas a partir do banco de dados para alimentar campos de chave primária.
A recomendação para nomes de sequências é:

Onde:

Prefixo: SEQ_CSTM
Nome da Tabela: Nome da tabela que utilizará a sequence.

Exemplos:

SEQ_CSTM_LOJA_PRODUTO
SEQ_CSTM_NOTAS_DESCONTO

Recomendamos que o script seja salvo com o nome da sequence a ser criada utilizando o diretório SEQUENCES caso seja utilizada a ferramenta gera-installBD. 

Gatilhos (Triggers)

A criação de gatilhos vem da necessidade de se disparar ações quando um comando DML (Data Manipulation Language – Insert, Update, Delete) é executado em uma tabela do banco de dados.
Os gatilhos deverão ser escritos por evento, desta forma poderão existir diversos gatilhos para uma única tabela.

A recomendação para nomes de gatilhos é:

Onde:

Prefixo: TRG_CSTM
Ação: combinação de uma ou mais ações que disparam a trigger (i=insert, u=update, d=delete).
Nome da tabela: Nome da tabela dona do gatilho.

Exemplos:

TRG_CSTM_IU_VIGENCIA_PRECO
TRG_CSTM_D_MOVIMENTO_SSF

Recomendamos que o script seja salvo com o nome da trigger a ser criada utilizando o diretório TRIGGERS caso seja utilizada a ferramenta gera-installBD.