MANUAL DE PADRÕES E NORMAS PARA MODELAGEM DE BANCO DE DADOS

(Substitua com o link real do logo)

TRIBUNAL DE CONTAS DO ESTADO DE GOIÁS

1. Introdução
2. Objetivo
3. Escopo
4. Regras Gerais
5. Regras Específicas
   • 5.1 Nome De Schema
   • 5.2 Nome De Tabela
   • 5.3 Nome De Colunas
   • 5.4 Nome De Visão/View
   • 5.5 Nome De Sequência
   • 5.6 Nome de Gatilho/Trigger
   • 5.7 Nome de Funções/Function
   • 5.8 Nome de Procedimento/Procedure
   • 5.9 Nome de Pacote/Package
6. Anexo 01 - Siglas das Aplicações Existentes no TCE

O objetivo do presente documento é trazer o correto entendimento das informações que se deseja armazenar por meio dos dados distribuídos nas tabelas e esquemas do banco de dados.

Visa criar um padrão tornando possível sua correta interpretação por todos os atores envolvidos no fluxo dos dados, além de permitir a manutenibilidade da base de dados por outros profissionais que não os criadores das tabelas e campos.

De certa forma, a padronização deixará mais simples também o compartilhamento de informações e a integração entre os sistemas.

Por fim, o presente visa estabelecer uma convenção de nomenclatura e modelagem de dados a ser seguida por todos os envolvidos no processo de desenvolvimento de sistemas que utilizam o armazenamento de informações em banco de dados.

Este documento visa determinar as regras a serem seguidas no tocante a nomenclatura dos objetos de um banco de dados.

Visa estabelecer um conjunto de regras padronize o processo de criação de objetos e de seus atributos para as diversas áreas.

Os objetos legados não serão afetados, entretanto novos objetos criados e/ou alterados, mesmo que derivados dos objetos legados, devem se enquadrar aos padrões e normas de nomenclatura estabelecida neste documento.

As regras gerais deverão ser aplicadas de forma cumulativa com as demais regras específicas.

• Deverão ser utilizados apenas caracteres alfanuméricos;
• O tamanho máximo do nome de qualquer objeto deve ser 30 caracteres (limite do SGBD Oracle);
• O nome de um objeto pode ser formado por uma ou mais palavras e cada palavra deverá ser separada pelo caractere separador;
• O caractere separador de prefixo, palavras utilizadas no nome de um objeto e sufixos é o underscore (“_”);
• Deverão ser utilizadas apenas palavras no singular;
• Números podem ser utilizados, desde que não iniciem a denominação (também chamado “complemento denominativo”) do objeto;
• Deve ser evitado o uso de abreviações na palavra principal que compõe o nome do objeto, utilizando no máximo trinta caracteres, contudo, verifique atentamente se as abreviações não resultarão em interpretações dúbias quanto ao valor semântico do objeto dentro do sistema;
• Não deverão ser utilizados acentuação gráfica e caracteres especiais (tais como #, $, %, &, etc.);
• Não deverão ser utilizadas preposições, artigos, conectivos (o, a, de…), etc;
• É indispensável o preenchimento dos comentários para tabelas e colunas, tornando-os essenciais para a compreensão e documentação do banco de dados.
• Deve ser cadastrada na tabela “TCE_GO.CBD_APLICACAO” cada aplicação criada, sendo obrigatório o nome da aplicação e sigla de 3 (três) caracteres, exemplo da aplicação: “Estação Digital De Trabalho” com sigla “EDT”.
• Para criar nomes de objetos devem ser utilizadas as siglas das aplicações como prefixo. Consulte a tabela “TCE_GO.CBD_APLICACAO” que contem as aplicação juntamente com sua sigla, ou consulte o anexo 1 que contém as aplicações existentes no TCE na data de criação deste documento.

A nomenclatura específica dos objetos do banco de dados deverá seguir as regras dispostas a seguir, conforme cada caso.

O nome do schema para novas aplicações deve utilizar como nome a sigla definida para a aplicação, já as aplicações anteriores deste documento estão no schema “TCE_GO”;

Para tabelas deve ser utilizado o prefixo que corresponde à sigla da aplicação. Desta forma, os objetos criados possuirão uma sigla com o propósito de classifica-los conforme a aplicação.

Exemplo da tabela: DCO_ANEXO

Sigla da Aplicação: DCO

Aplicação: Demandas Da Comunicação.

Nome de colunas é utilizado prefixo e sufixo conforme descrito abaixo:

Prefixos:

• DESC
  • Colunas descritivas - Texto livre
  • Ex: DESC_SOLICITACAO_A – Armazena o texto de uma solicitação de um usuário
• INDR
  • Colunas indicadoras (Enum) – Número limitado de opções
  • Ex: INDR_ATIVO_A (I, A)
  • Ex: INDR_ESOLARIDADE_N (0,1,2)
• NUMR
  • Colunas numéricas que não se encaixam em indicadoras e descritivas
  • Ex: NUMR_MATRICULA_N Matricula de um usuário, somente números.
• DATA
  • Colunas de data
  • Ex: DATA_NASCIMENTO_D
• CODG
  • Códigos identificadores (Em sua maioria UK)
  • Ex: CODG_SETOR_A – Código do setor
• NOME
  • Colunas descritivas de nomes (Em sua maioria nomes de pessoas)
  • Ex: NOME PAI A–Nome do Pai
• TEXT
  • Colunas que armazenam grandes textos (Normalmente de arquivos e tipo CLOB)
  • Ex: TEXT_ASSINADO_L – Texto do documento assinado

Sufixos:

• A
  • Identifica colunas de texto
• ID
  • Colunas identificadoras (PK)
• N
  • Colunas numéricas
• D
  • Colunas de Data
• L
  • Colunas BLOB ou CLOB

Nomes de colunas, quando for chave estrangeira, devem possuir o mesmo nome da chave primária referenciada, sendo criada a restrição de referência.

O nome de visões segue o seguinte padrão: “V”+ Sigla da Aplicação + “_” + nome da visão.

Exemplo da visão: VPLD_MEMBROS_SESSAO

Sigla da Aplicação: PLD

Aplicação: Plenário Digital

As sequências devem ter o mesmo nome da primary key com o sufixo “_SEQ”.

O uso de sequência para o auto-incremento é acionado via trigger.

O nome desta trigger deve conter o prefixo “TINS_” + Nome da tabela + sufixo “BEF”.

O Nome da trigger é composto de:

• Ação de gatilho:
  • INSERT: TINS_
  • UPDATE: TUPD_
  • DELETE: TDEL_
• Tabela Alvo
• Momento da trigger
  • Antes: _BEF
  • Depois: _AFT

O nome de funções segue o seguinte padrão: “F”+ Sigla da Aplicação + “_” + nome do procedimento.

Exemplo da função: FWEB_INTERESSADOS

Sigla da Aplicação: FWEB

Aplicação: Gerência Website

O nome de procedimentos segue o seguinte padrão: “P”+ Sigla da Aplicação + “_” + nome do procedimento.

Exemplo da procedure: PPLD_SALVAMEMBRO

Sigla da Aplicação: PLD

Aplicação: Plenário Digital

Para pacotes de sistemas segue o seguinte padrão: “+ Sigla da Aplicação +”_“ + “PACKAGE”.

Exemplo do pacote: CTX_PACKAGE

Sigla da Aplicação: CTX

Aplicação: Sistema Contex

Av. Ubirajara Berocan Leite, nº 640 Setor Jaó - Goiânia - Goiás - CEP: 74.674-015

Telefone/PABX: (62) 3228-2000 - www.tce.go.gov.br//