You are on page 1of 10

Projeto SIEP - Gerencial

Padres para Nomenclatura de Banco de Dados

Joo Pessoa, outubro/2007

ndice

1. INTRODUO ............................................................................ 3 2. BANCO DE DADOS.................................................................... 3 3. TABELAS ..................................................................................... 3 4. NOME DOS DADOS (COLUNAS) ........................................... 4 5. VIEWS........................................................................................... 5 6. NDICES ....................................................................................... 6 6.1 Chaves primrias .................................................................... 6 6.2 Chaves estrangeiras ................................................................ 6 6.3 Constraints Check................................................................... 7 6.4 Constraints Unique ................................................................. 7 7. STORED PROCEDURES........................................................... 8 8. TRIGGER ..................................................................................... 9

1. INTRODUO
O objetivo deste documento prover informaes para formalizar a nomenclatura dos objetos de banco de dados, bem como apresentar regras para sua utilizao evitando assim o hbito de existir diferentes nomenclaturas dentro de uma mesma aplicao. O documento apresenta os objetos de banco de dados com trs itens: sintaxe, regras e exemplo. Isto para facilitar o entendimento do desenvolvedor. O documento est dividido em duas partes: os objetos para serem utilizados por todos os bancos de dados.

2. BANCO DE DADOS
O nome do banco de dados dever identificar o negcio que est sendo automatizado ou dever refletir a sigla da aplicao. Sintaxe: {[a.. z]} xxxxxx , onde: xxxxxx - indica o nome da aplicao que o banco de dados ir atender. Para o nome da aplicao utilizar tudo em minsculo com no mximo 15 caracteres de a a z.

3. TABELAS
O nome de uma tabela dever ser sugestivo. Deve-se fazer o uso de nomenclatura orientado a objeto, por exemplo: se no departamento Financeiro for necessrio manter uma tabela de feriados, esta tabela deve ser nomeada identificando claramente seu contedo, isto significa que seu nome ento dever ser Feriado (usar o nome sempre no singular). Sintaxe: tb{[A..Z][{a..z}]} tbXxxxXxxxx, onde: tb - indica que uma tabela do banco de dados Xxxxxxx indica o nome da tabela. Regras:
Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara.

Limite-se a usar 30 caracteres - padro da maioria dos bancos. Em caso de dvida, consulte esta informao no manual do banco de dados que estiver utilizando. O nome da tabela deve estar sempre no singular. (Exemplo: Cliente no lugar de Clientes). Evite usar abreviaes, se necessrio use as conhecidas. No utilize acentuaes ou caracteres especiais.

Exemplos: tbPessoa - Tabela de pessoas. tbFuncionario - Tabela de funcionrios. tbCliente - Tabela de clientes. tbFeriado - Tabela de feriados. tbLaudoNecroterio - Tabela de laudos do necrotrio

4. NOME DOS DADOS (COLUNAS)


Seguindo o mesmo padro utilizado para tabelas, deve-se identificar a coluna da tabela de maneira clara e descritiva, somente use abreviaes quando se tratar de domnio pblico, exemplo FGTS, fundo de garantia por tempo de servio. Sintaxe: {[A..Z][{a..z}] } XxxxxXxxxXxxxx, onde Xxxxx indica o nome do campo Regras:
Primeira

letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara; No usar preposies; Para siglas utilizar todas as letras em maisculo; Usar palavras no singular e sem acentuao; Usar nome que identifique e individualize o dado dentro da tabela; Dar nomes distintos para dados distintos; Utilizar o nome sempre no singular; Evite utilizar abreviaes, caso seja extremamente necessrio utilize as de domnio pblico. Caso contrrio limite-se a 4 letras. Exemplos: Sem abreviaes:

Nome NomeFuncionario DataNascimento ValorSalario Com abreviaes:


NomeFuncResp GestorResp CodTermo

Nota: Para campos de chave primria utilizar a seguinte regra: Identificador-da-chave[nome da tabela] Exemplos: Nome da tabela Identificador tbPessoa idPessoa tbLaudo idLaudo tbHistorico idHistorico Nota: Caso a chave seja composta utilize um nome simples que identifique a composio, evitando usar abreviaes.

5. VIEWS
Deve-se utilizar o mesmo semntica utilizada para as tabelas. Deve ser prefixada a palavra vw seguido do nome da tabela. Sintaxe: vw{ [A..Z][{a..z}] } vwXxxxxxxxXxxxxx, onde vw - indica que uma view Xxxxxx indica o nome da view Regras:
Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara; Limite-se a usar 30 caracteres - padro da maioria dos bancos. Em caso de dvida consulte esta informao no manual do banco de dados que estiver utilizando; O nome da viso (view) deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas;

No

utilize acentuaes ou caracteres especiais.

Exemplos: vwPessoa - Tabela de pessoas. vwFuncionario - Tabela de funcionrios. vwCliente - Tabela de clientes. vwFeriado - Tabela de feriados. vwLaudoIML - Tabelas de laudos do IML (SML e SMAP)

6. NDICES
Deve-se utilizar a mesma semntica utilizada para as tabelas. Sintaxe: ix{[A..Z][{a..z}]} {[1..99] | [identificador da chave]} ixXxxxxxxxXxxxxx, ou seja, ix<nome_da_tabela><identificador_da_chave>, onde: ix - prefixo para identificar que se trata de um ndice Xxxxxxx - nome da tabela a qual o ndice est associado nn nmero seqencial da tabela Xxxxxxx - nmero seqencial dos ndices que se referem a tabela ou identificador da chave 6.1 Chaves primrias Para nomear as chaves primrias utilizar: Sintaxe: pk{[A..Z][{a..z}]} pkXxxxxx, onde pk - indica que uma chave primria Xxxxx indica o nome da tabela a qual o ndice est associado 6.2 Chaves estrangeiras Para nomear as chaves estrangeiras utilizar: Sintaxe: fk{[A..Z][{a..z}]}_{[A..Z][{a..z}]} fkXxxxxx_Xxxxxx, ou seja, fk<nome da tabela origem (pai)>_<nome da tabela destino (filho)>, onde: fk - indica que se trata de uma chave estrangeira

Xxxxx - indica o nome da tabela origem (pai) Xxxxx - indica o nome da tabela destino (filho) Regras: Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara. Limite-se a usar 15 caracteres - Em caso de dvida consulte esta informao no manual do banco de dados que estiver utilizando. O nome da tabela deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas. No utilize acentuaes ou caracteres especiais. 6.3 Constraints Check Para nomear as constraint check utilizar: Sintaxe: chk{[A..Z][{a..z}]} chkXxxxxx, ou seja, chk<nome da coluna>, onde: chk - indica que se trata de uma constraint check Xxxxx - indica o nome da coluna Regras: Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara. Limite-se a usar 15 caracteres - Em caso de dvida consulte esta informao no manual do banco de dados que estiver utilizando. O nome da coluna deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas. No utilize acentuaes ou caracteres especiais. 6.4 Constraints Unique Para nomear as constraint unique utilizar: Sintaxe: unq{[A..Z][{a..z}]} unqXxxxxx, ou seja, unq<nome da coluna>, onde: unq - indica que se trata de uma constraint unique Xxxxx - indica o nome da coluna

Regras: Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara. Limite-se a usar 15 caracteres - Em caso de dvida consulte esta informao no manual do banco de dados que estiver utilizando. O nome da coluna deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas. No utilize acentuaes ou caracteres especiais.

7. STORED PROCEDURES
Deve-se utilizar a mesma semntica utilizada para as tabelas. Deve ser prefixada com a sigla stp seguida do nome da tabela para uma stored procedure. Para stored procedures especifica de criao (C), excluso (D), alterao (U) e consulta (R) utilizar a notao especfica apresentada na sintaxe. Sintaxe: stp{[ C | R | U | D ]}_{[A..Z][{a..z}]} stpX_Xxxxxx, ou seja, stp<identificador_da_ao_principal><nome_da_stored_procedured>, onde: stp indica que se trata de uma stored procedure X - Identificador-da-Ao Principal C CREATE, R READ, U UPDATE e D DELETE , quando houver operaes compostas utilizar o identificador em ordem alfabtica. Xxxxxx nome da stored procedure Regras: Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara; O nome da stored procedure deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas; No utilize acentuaes ou caracteres especiais; Definir uma rea de identificao geral, onde devero existir informaes tais como: Autor Funo Alteraes Data Autor Descrio da alterao

Identificar as alteraes efetuadas na rea apropriada, para permitir fcil localizao de problemas no cdigo; Endentar de modo a tornar a codificao clara e facilitar o trabalho de manuteno, utilizar endentao; Inserir comentrios sempre que necessrio. Comentrios adicionais que auxiliem a compreenso de processamentos complexos. No poluir o cdigo com comentrios desnecessrios, que descrevam procedimentos bvios; Evitar o aninhamento excessivo de comandos, o que costuma dificultar a manuteno do cdigo. Dar preferncia codificao mais longa, porm mais clara, desde que no prejudique a performance; Exemplos para nome de stored procedure: stpC_[nome-da-sp] stpR_[nome-da-sp] stpU_[nome-da-sp] stpD_[nome-da-sp] - stored procedure de incluso. - stored procedure de consulta. - stored procedure de alterao. - stored procedure de excluso.

8. TRIGGER
Deve-se utilizar a mesma semntica utilizada para as tabelas. Deve ser prefixada a sigla trg seguida do nome da tabela para uma stored procedure. Para trigger especifica como incluso (C), excluso (D) e alterao (U) utilizar a notao especfica, apresentada na sintaxe. Sintaxe: trg{[ C | U | D ]}_{[A..Z][{a..z}]} trgX_Xxxxxx, ou seja, trg<identificador_da_ao_principal><nome_da_stored_procedured>, onde: trg - indica que se trata de uma trigger X - Identificador-da-ao_principal D DELETE, C CREATE e U UPDATE, quando houver operaes compostas utilizar o identificador em ordem alfabtica. Xxxxxx nome da trigger Regras: Primeira letra em maiscula, demais em minsculas. Para cada palavra interna, primeira letra em maiscula, notao hngara; O nome da trigger deve estar sempre no singular. Evite usar abreviaes, se necessrio use as conhecidas; No utilize acentuaes ou caracteres especiais; Definir uma rea de identificao geral, onde devero existir informaes tais como: -Autor Funo 9

-Alteraes -Data -Autor -Descrio da alterao Identificar as alteraes efetuadas na rea apropriada, para permitir fcil localizao de problemas no cdigo; Endentar de modo a tornar a codificao clara e facilitar o trabalho de manuteno, utilizar endentao; Inserir comentrios sempre que necessrio. Comentrios adicionais que auxiliem a compreenso de processamentos complexos. No poluir o cdigo com comentrios desnecessrios, que descrevam procedimentos bvios; Evitar o aninhamento excessivo de comandos, o que costuma dificultar a manuteno do cdigo. Dar preferncia codificao mais longa, porm mais clara, desde que no prejudique a performance. Exemplos para nome de stored procedure: trgC_[nome-da-trg] trgU_[nome-da-trg] trgD_[nome-da-trg] - trigger de incluso. - trigger de alterao. - trigger de excluso.

10

You might also like