Imov-Soft. Padrão para Nomenclatura de Banco de Dados

Transcrição

1 Imov-Soft Padrão para Nomenclatura de Banco de Dados

2 Histórico Data Versão Descrição Autor 29/04/ Versão inicial. Tiago Oliveira Charlles Jamisson

3 1. Introdução Banco de Dados Regra Geral Sintaxe Exemplos Tabelas Regra Geral Sintaxe Exemplos Atributos Regra Geral Sintaxe Exemplos Views Regra Geral Sintaxe Exemplos Índices Regra Geral Sintaxe Exemplos Stored Procedures Regra Geral Sintaxe Exemplos...7

4 1 INTRODUÇÃO Este documento tem como propósito definir as regras de nomenclatura do banco de dados, para que possa garantir um melhor entendimento para os desenvolvedores do software. Possuir as regras bem definidas garante uma maior produtividade tanto na construção do software, como em relação à manutenção do sistema, pois sempre há mudança na equipe de desenvolvedores e construindo um padrão, faz com que o código fique claro para qualquer integrante da equipe. 2 BANCO DE DADOS 2.1 Regra Geral O nome do banco de dados deverá identificar o negócio que está sendo automatizado ou deverá refletir a sigla da aplicação. 2.2 Sintaxe {[A..Z][a..z]} nome do banco de dados: 2.3 Exemplos Banco Financeiro Imov-Soft 3 TABELAS 3.1 Regra Geral O nome das tabelas deve ser sugestivo e refletir os dados armazenados nesta. O nome deve ser pré-fixado com as três primeiras letras da entidade em maiúsculo.

5 3.2 Sintaxe PES_{[A..Z][a..z]} PES_ nome da datbela no banco de dados : Evite usar abreviações, se necessário use as conhecidas. 3.3 Exemplos PES_Nome PES_Cpf PES_Rg IMO_Valor - Nome da Pessoa - Cpf da Pessoa - Rg da Pessoa - Valor do Imóvel 4 ATRIBUTOS 4.1 Regra Geral O nome dos atributos deve identificar a coluna de maneira clara e descritiva. 4.2 Sintaxe {[A..Z][a..z]} nome do atributo: 4.3 Exemplos NomeFuncionario DataNascimento ValorSalario ContraCheque 5 VIEWS

6 5.1 Regra Geral Usa-se as letras VW e após o símbolo _ e depois o nome da view. 5.2 Sintaxe VW_nome da view no banco de dados: Evite usar abreviações, se necessário use as conhecidas. 5.3 Exemplos VW_Pessoa VW_Imovel Visão da Tabela de Pessoas Visão da Tabela de Imóveis 6 ÍNDICES 6.1 Regra Geral Usa-se da mesma forma das views, antes do nome do índice, colocar as letras IDX 6.2 Sintaxe IDX_nome do indice no banco de dados: Evite usar abreviações, se necessário use as conhecidas. 6.3 Exemplos IDX_PessoaCodigo IDX_FuncionarioNome Índice da Tabela Pessoa pelo atributo Código. Índice da Tabela Funcionário pelo atributo Nome. 7 STORED PROCEDURES 7.1 Regra Geral

7 Deve-se usar a mesma regra utilizada para as views. O nome deve ser pré-fixado pela palavra STP seguido por _. 7.2 Sintaxe STP_{INS DEL UPD SLC}_{[A..Z][a..z]} STP_ ação, onde: Após o _ é identificada a ação da stored procedure: INS Inserção, DEL Exclusão, UPD atualização e SLC consulta a dados. Depois da ação coloca-se outro _ e depois o nome da stored procedure no banco de dados. Usar palavras no singular, sem acentuaçõe. 7.3 Exemplos STP_INS_Pessoa STP_SLC_HistoricoFunc Stored Procedure para atualização de dados de Pessoa. Stored Procedure para consulta do histórico do Funcionário.