Essa é uma revisão anterior do documento!


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

Imagem do logo (se você tiver ela na sua wiki)

TRIBUNAL DE CONTAS DO ESTADO DE GOIÁS

= Versão 1.0.0 =

HISTÓRICO DE REVISÃO
DATA VERSÃO DESCRIÇÃO AUTOR
——————–——————————————-
07/12/2023 1.0.0 Criação do documento Helion N. Mendanha
15/12/2023 1.0.0 Revisão Celso P. V. Junior

Informações de rodapé (você pode colocar isso no final ou em um rodapé template da sua wiki) 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// Pág. 1/10 = Sumário = 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 = Introdução = <a name=“introducao”></a> 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. = Objetivo = <a name=“objetivo”></a> 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. = Escopo = <a name=“escopo”></a> 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. = Regras Gerais = <a name=“regras_gerais”></a> 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. = Regras Específicas = <a name=“regras_especificas”></a> A nomenclatura específica dos objetos do banco de dados deverá seguir as regras dispostas a seguir, conforme cada caso. == Nome De Schema == <a name=“nome_de_schema”></a> 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”; == Nome De Tabela == <a name=“nome_de_tabela”></a> 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 == <a name=“nome_de_colunas”></a> 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. == Nome De Visão/View == <a name=“nome_de_visao_view”></a> 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 == Nome De Sequência == <a name=“nome_de_sequencia”></a> 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”. == Nome de Gatilho/Trigger == <a name=“nome_de_gatilho_trigger”></a> 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 == Nome de Funções/Function == <a name=“nome_de_funcoes_function”></a> 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 == Nome de Procedimento/Procedure == <a name=“nome_de_procedimento_procedure”></a> 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 == Nome de Pacote/Package == <a name=“nome_de_pacote_package”></a> 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 = Anexo 01 – Siglas das Aplicações Existentes no TCE = <a name=“anexo_01”></a> | Sigla | Aplicação | |——-|——————————–| | AIF | ACESSO A INFORMAÇÃO | | PAC | ACESSO AS APLICAÇÕES | | DPD | ACESSO COMPLETO DPD | | ACE | APOIO AO CONTROLE EXTERNO | | ACI | APOIO AO CONTROLE EXTERNO - INFORMAÇÕES | | A30 | ARTIGO 30 | | D30 | ARTIGO 30 | | IAF | ATIVIDADES FINS | | AME | ATIVIDADES MEIO | | ADI | AUDITORIAS E INSPEÇÕES | | BID | BIBLIOTECA DIGITAL | | BIB | BIBLIOTECA ILB | | USU | CADASTRO DE USUÁRIOS | | ICD | CADASTRO GERAL | | CHK | CHECKIN API | | COF | COMUNICAÇÃO OFICIAL | | CEX | CONTEX | | COC | CONTRATOS E CONVÊNIOS | | PRO | CONTROLE DE PROCESSOS | | VEI | CONTROLE DE VEICULOS | | DIR | DECLARAÇÃO DE IMPOSTO DE RENDA | | DDC | DEMANDAS DA COMUNICAÇÃO | | DEC | DIÁRIO ELETRÔNICO DE CONTAS | | GDR | DIRETORIA GERAL | | EDI | EDITAIS | | EQE | ENQUETE ESPORTIVA | | PEW | ENVIO DE ARQUIVO DE FOLHA DE PAGAMENTO | | EDW | ESTAÇÃO DIGITAL | | EDT | ESTACAO DIGITAL DE TRABALHO | | ETW | E-TCE WEB | | AFP | FOLHA DE PAGAMENTO | | CAD | GCAD NOVO | | ARM | GERÊNCIA DE ARQUIVO MORTO | | BAN | GERÊNCIA DE BALANÇOS ANUAIS | | CAR | GERÊNCIA DE CARTÓRIO | | DGW | GERÊNCIA DE DIRETORIA GERAL WEB | | FUR | GERÊNCIA DE FUNDO ROTATIVO | | MDI | GERÊNCIA DE MALA DIRETA INTEGRADA | | MAP | GERÊNCIA DE MATERIAL E PATRIMÔNIO | | EOP | GERÊNCIA DE OBRAS PÚBLICAS | | PEX | GERÊNCIA DE PESSOAL EXTERNO | | PES | GERÊNCIA DE PESSOAS | | PON | GERÊNCIA DE PONTO | | GPR | GERÊNCIA DE PROCESSOS | | REH | GERÊNCIA DE RECURSOS HUMANOS | | REG | GERÊNCIA DE REGISTRO | | VES | GERÊNCIA DE VERSÕES DE SISTEMA | | FIN | GERÊNCIA DO FINANCEIRO | | WEB | GERÊNCIA WEBSITE | | ADP | GESTÃO DE PESSOAS | | PRD | GPRO ESTACAO | | GUA | GUARITA | | HED | HELPDESK | | HDP | HELPDESK PREDIAL | | INF | INFORMA | | ACW | INSTALADOR GACE | | ILB | INSTITUTO LEOPOLDO DE BULHÕES | | NET | INTRANET TCE | | APM | MINISTÉRIO PÚBLICO DE CONTAS | | N30 | NOVO ARTIGO 30 | | ORC | ORÇAMENTO | | OR2 | ORÇAMENTO 2 | | APP | OUTROS APLICATIVOS | | OVD | OUVIDORIA | | REL | PAINÉIS DE CONTROLE | | PDC | PAINEL DE CONTROLE | | POS | PLANEJAMENTO DE OS | | PL2 | PLENÁRIO | | PLE | PLENÁRIO AUTOMÁTICO | | PLD | PLENÁRIO DIGITAL | | PVA | PLENÁRIO VIRTUAL ADMIN | | PDP | PORTAL DO DEPARTAMENTO PESSOAL | | TCE | PROCESSO ELETRÔNICO | | PDI | PROTOCOLO ELETRÔNICO | | REC | RECEPÇÃO | | RAD | REGISTRO DE ADMISSÃO | | RAC | REGISTRO DE ATO DE CONCESSÃO | | RET | REQUISIÇÃO DE TRANSPORTE | | REQ | REQUISIÇÕES DE MATERIAL | | ROL | ROL DE RESPONSÁVEIS | | SIC | SERVIÇO DE INFORMAÇÃO AO CIDADÃO | | NOT | SERVIÇO DE NOTÍCIAS | | SOP | SOPHOS | | COM | TCE COMUNICAÇÃO | | INT | TCE INTEGRADOR | | MIC | TCE MICROSERVICE | | DOC | TCE-DOCS | | NOI | TCE-JURIS | | TRN | TRANSFERÊNCIA DE NOTÍCIAS | | TRA | TRANSPORTES | | WED | WEB DIARIAS | | WKF | WORKFLOW |

  • pres/gerti/documento_de_arquitetura_de_software/padrao_banco_oracle.1740495533.txt.gz
  • Última modificação: 25/02/2025 14:58
  • por bholiveira