NORMA TÉCNICA PARA DEFINIÇÃO DE OBJETOS DE BANCO DE DADOS E DE ESTRUTURAS DE ARMAZENAMENTO QUE CONSTITUEM O BANCO DE DADOS CORPORATIVO

Transcrição

1 NORMA TÉCNICA PARA DEFINIÇÃO DE OBJETOS DE BANCO DE DADOS E DE ESTRUTURAS DE ARMAZENAMENTO QUE CONSTITUEM O BANCO DE DADOS CORPORATIVO Referência: NT-AI Data: 31/07/2000 STATUS: EM VIGOR A Assessoria de Informática, órgão executivo responsável pela normatização e padronização de procedimentos referentes à área de informática, de acordo com o Regulamento Geral para Uso e Administração de Computadores e Redes da Unesp (RG-AI , Portaria UNESP 65/98), define a seguinte NORMA TÉCNICA: 1. RESUMO Este documento estabelece normas, regras e procedimentos que devem ser seguidos para se definir objetos do banco de dados, objetos estes pertencentes ao Banco de Dados Corporativo, estabelecendo assim uma padronização de nomes. Esta norma também estabelece a padronização na definição das estruturas físicas e lógicas relacionadas com o armazenamento dos dados propriamente ditos. Entenda-se aqui por definição tanto a questão da nomenclatura quanto a questão de como devem ser constituídos os objetos de banco de dados e estruturas de armazenamento, abrangendo, inclusive, regras sobre os scripts de criação e alteração. 2. PALAVRAS CHAVES PL/SQL, tabela, coluna, índice, tablespace, datafile, schema, owner, banco de dados, corporativo, Oracle, trigger, view, sequence, constraint, chave, username, role, script, sinônimos. 3. DEFINIÇÕES 3.1 Terceiros : toda e qualquer entidade (empresa, micro-empresa, conjunto de um ou mais técnicos em informática tais como analistas, programadores, etc. que atuem como profissional liberal, consultores independentes ou ligados a alguma corporação, etc.) que porventura presta ou venha a prestar serviços para a UNESP,

2 contratada temporariamente ou não, independente da atividade que desempenhe ou venha a desempenhar relacionada ao desenvolvimento de sistemas e banco de dados. 3.2 Banco de Dados Corporativo : é um banco de dados relacional contendo objetos (tabelas, visões, procedimentos, etc.) que são compartilhados e usados por diversas aplicações ou sistemas ao mesmo tempo, evitando assim redundância de dados e garantindo integridade das informações, além de outras vantagens. Ele é composto por outros dois bancos de dados independentes, cada qual constituído por uma instância e uma base de dados. São assim denominados : Banco de Dados de Desenvolvimento e Banco de Dados de Produção. 3.3 Banco de Dados de Desenvolvimento : corresponde a uma instância e a uma base de dados com o objetivo de armazenar objetos de banco de dados e dados para testes dos novos sistemas ou aplicações, sendo um banco de dados relacional. Só é utilizado pelas equipes de desenvolvimento, devidamente autorizadas. Todo novo sistema ou aplicação deve, antes de ser colocado em produção, ser colocado no Banco de Dados de Desenvolvimento para testes e validação por parte do usuário final. 3.4 Banco de Dados de Produção : corresponde a uma instância e a uma base de dados com o objetivo de armazenar objetos de banco de dados e dados de sistemas ou aplicações já em produção, constituindo assim dados válidos e que são acessados por diversos usuários do banco de dados, devidamente autorizados. Também é um banco de dados relacional 3.5 DBA : O termo DBA é uma sigla de origem inglesa para Database Administrator. Como no jargão técnico, no comércio, em empresas, enfim, em tudo que se relaciona com administração de banco de dados no mundo (inclusive no Brasil) se utiliza o termo DBA, ao invés da tradução para a língua local, resolvemos adotá-lo também na UNESP para referenciar aquele que é responsável por gerenciar e administrar o banco de dados. 3.6 Equipe de DBAs : é um grupo formado por dois ou mais técnicos e/ou analistas da Assessoria de Informática responsáveis pela administração do Banco de Dados Corporativo, devidamente treinados para tal tarefa de administração. A necessidade de uma equipe deve-se ao fato de que a administração de um banco de dados não deve ficar centralizada em uma única pessoa. 3.7 Equipe de Desenvolvimento : é qualquer grupo de dois ou mais técnicos, analistas e/ou programadores de uma Unidade responsáveis por definir, projetar, desenvolver e implantar sistemas, sejam de uso local e restrito à Unidade, seja de âmbito da comunidade UNESP. 3.8 Schema : um schema na terminologia Oracle é um conjunto de vários objetos de bancos de dados que estão associados a um usuário específico do banco de dados (também chamado de owner ou proprietário).

3 3.9 Owner : um owner é um usuário do banco de dados que tem poder total de ação sobre os objetos de banco de dados do schema a que está associado sem precisar de algum direito ou privilégio especial para isso. Ele pode executar comandos DML e DDL naturalmente. Assim sendo, seu poder de ação é muito grande Tabela : é a unidade básica de armazenamento de dados sendo composta por linhas e colunas Coluna : é uma parte de uma Tabela que contém dados do mesmo tipo e que, semanticamente, são de mesma natureza Linha : corresponde a uma instância ou registro de uma Tabela View (Visão) : logicamente representam subconjuntos de uma ou mais tabelas e se comportam como tabelas quanto a inserção, alteração, exclusão e consulta de dados; ou seja, pode-se inserir, alterar, excluir ou consultar dados em uma view, respeitando sempre as regras de integridade e de segurança que estiverem definidas sobre as Tabelas envolvidas na constituição da view. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Pacote : é um conjunto de procedimentos PL/SQL agrupados numa mesma estrutura que fica armazenada no banco de dados. (???). Um pacote tem duas partes : a especificação do pacote e o corpo do pacote Especificação do Pacote : também é conhecido como cabeçalho do pacote; e a parte do Pacote que contém informações sobre o conteúdo do pacote mas não contém nenhum código de nenhum dos procedimentos Corpo do Pacote : é a parte do Pacote que contém o código de todos os procedimentos definidos na Especificação do Pacote Sequence (sequência) : é um objeto de banco de dados usado para gerar números únicos. Devido a isso, ela é geralmente utilizada para implementar chave primária em uma Tabela. Ela é gerada e incrementada (ou decrementada) internamente por uma rotina do próprio banco de dados Oracle. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Índice : é um objeto de banco de dados de um Schema que pode acelerar o acesso e a recuperação de linhas em uma Tabela através do uso de ponteiros, provendo assim um acesso direto e rápido às linhas da Tabela Constraint (regra de integridade) : correspondem a uma regra de integridade aplicada sobre uma determinada Tabela. A constraint é definida e mantida no banco de dados Oracle. Em linhas gerais, constraints, são utilizadas para prevenir entrada inválida de dados nas Tabelas. Ou seja, implementam regras a nível de Tabela que são verificadas toda vez que uma linha é inserida, alterada ou excluída na Tabela; se

4 a regra não for respeitada, a operação não é concluída no banco de dados. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Sinônimo : é um nome alternativo para um objeto do banco de dados Trigger (gatilho) : é um conjunto de comandos PL/SQL que são executados quando se realiza uma inserção, alteração e/ou exclusão em uma Tabela. A trigger é executada (disparada) antes da consumação da operação sobre a Tabela. Se, por algum motivo, a execução da trigger não for completada, a operação sobre a Tabela também não é. Por isso mesmo, geralmente se utiliza triggers para implementar regras de integridade complexas e que por isso não podem ser implementadas por Constraints; também são utilizadas para execução de ações diversas desencadeadas pela operação de inserção, alteração ou exclusão sobre a Tabela. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Role (cargo) : é um grupo de privilégios (de sistema e/ou sobre objetos do banco de dados) que podem ser concedidos a um ou mais usuários. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Username (nome do usuário): corresponde a um nome pelo qual o usuário é identificado e reconhecido no banco de dados, não sendo necessariamente parte do nome da pessoa que é o usuário do banco de dados. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Tablespace : corresponde a uma área lógica para armazenamento. Dentro de uma tablespace são armazenados objetos do banco de dados além dos próprios dados, inclusive os dados sobre o banco de dados (dicionário de dados). Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local Datafile : é uma estrutura física (um arquivo do sistema operacional) onde fisicamente o conteúdo de uma Tablespace é armazenado. Uma Tablespace é constituída por um ou mais datafiles. Preferimos utilizar o termo em inglês por ser mais comumente utilizado do que a tradução para língua local. 4. NORMA TÉCNICA 4.1 Esta Norma Técnica deve ser seguida por Equipe de DBAs, Equipes de Desenvolvimento e Terceiros. 4.2 A denominação do owner de um schema contendo todos os objetos de banco de dados diretamente relacionados a um sistema ou aplicação deve ser igual à sigla pela qual este mesmo sistema ou aplicação é conhecido.

5 4.3 O nome de uma Tabela deve ser alusivo a natureza dos dados que serão armazenados nela, 4.4 O nome de uma Coluna de uma Tabela deve ser alusivo a sua finalidade dentro da Tabela; no caso de um nome muito extenso, deve-se abreviá-lo mantendo, no entanto, a finalidade da Coluna. 4.5 O nome de uma Coluna deve, obrigatoriamente, começar com um grupo de três letras indicando o tipo de dado mais específico da Coluna, conforme tabela a seguir: Tipo de dado Grupo de Letras Utilização Varchar2 STR Utilizado para dados que representam cadeias de caracteres com um tamanho variável mas com possibilidade de se estimar o tamanho máximo. Cadeias de caracteres deste tipo podem variar de tamanho mas sem ultrapassar o tamanho máximo. Char CHR Utilizado para dados que representam cadeias de caracteres com tamanho fixo e invariável, ou seja, todas as cadeias de caracteres representadas por este tipo possuem um tamanho único. Number NUM Utilizado para dados que representam números de uma forma genérica Integer INT Utilizado para dados que representam números inteiros, ou seja, que não possuem de forma alguma casas decimais. REAL RAL Utilizado para dados que representam números reais, ou seja, de ponto flutuante e que apresentam casas decimais. Data DAT Utilizado para dados que representam datas cronológicas informando obrigatoriamente dia, mês e ano, não importa a ordem de disposição destas informações. Texto TXT Utilizado para dados que representam cadeias de caracteres com um tamanho variável e sem possibilidade de se estimar o tamanho máximo. Cadeias de caracteres deste tipo constituem textos que podem ser longos ou curtos. Imagens IMG Utilizado para dados que representam imagens estáticas ou vídeos.

6 4.6 O nome de uma trigger deve ter o seguinte formato : TG<nome_da_tabela>_<ocasião_disparo><operações> onde : <nome_da_tabela> - nome da Tabela <ocasião_disparo> - indica se a ocasião do disparo da trigger : PRE - Antes da operação de inserção, alteração ou exclusão. POS - Depois da operação de inserção, alteração ou exclusão. <operações> - indica o tipo de operação sobre o registro: INS - Inserção UPD - Alteração DEL - Exclusão 4.7 O nome de um procedimentos deve começar com PROC_, ser sugestivo e de fácil 4.8 O nome da função deve começar com FUNC_, ser sugestivos e de fácil 4.9 O nome da especificação de um Pacote deve começar com PKES_, ser sugestivo e de fácil 4.10 O nome do corpo de um Pacote deve começar com PKBY_, ser sugestivo e de fácil 4.11 O nome de uma View deve começar com VIEW_, ser sugestivo e de fácil 4.12 O nome de uma Sequence deve começar com SEQ_, ser sugestivo e de fácil 4.13 O nome de um Índice deve ser sugestivo, de fácil compreensão, indicar pelo menos o nome da Coluna a qual indexa e sempre terminar com _I O nome de uma Constraint cuja finalidade é estabelecer a chave-primária (primarykey) de uma Tabela, deve indicar o nome da Coluna sobre a qual está definida a Constraint e deve terminar com _PK O nome de uma Constraint cuja finalidade é estabelecer uma chave-estrangeira (foreign-key) em uma Tabela, deve indicar o nome da Coluna sobre a qual está definida a Constraint e deve terminar com _FK.

7 4.16 O nome de uma Constraint cuja finalidade é estabelecer uma chave-única (uniquekey) em uma Tabela, deve indicar o nome da Coluna sobre a qual está definida a Constraint e deve terminar com _UK O nome de uma Role deve ter o seguinte formato : RL<sigla_do_sistema>_<nome_do_grupo> onde : <sigla_do_sistema> corresponde à sigla do sistema que originou a Role, mesmo que ela esteja atribuída a usuários de outros sistemas ou aplicações. <nome_do_grupo> nome do grupo de usuários que compartilham a Role. Não há restriçõs sobre este nome, mas recomenda-se que seja um nome sugestivo Quando for criada uma conta para um novo usuário no Banco de Dados Corporativo, o Username para este novo usuário deve ser igual a identificação que constar no (antes do ) da pessoa na UNESP associada a este novo usuário Quando for criada uma conta para um novo usuário no Banco de Dados Corporativo, se a pessoa associada a este novo usuário não possuir na UNESP ou já existir outro usuário com Username igual ao que seria dado ao novo usuário, cabe à Equipe de DBAs definir qual o Username a ser dado para o novo usuário O nome de uma Tablespace deve ter o seguinte formato : <sigla_do_sistema_módulo><finalidade> onde : <sigla_do_sistema_módulo> corresponde à sigla do sistema ou a sigla do módulo (quando o sistema é muito grande e for sub-dividido em módulos menores) cujos dados devem ficar armazenados na Tablespace. <finalidade> pode ser : DATA - se a Tablespace se destinar a armazenar dados puros e os objetos de banco de dados do sistema ou aplicação. IDX - se a Tablespace se destinar a armazenar Índices O nome do arquivo que representa um Datafile deve ser igual ao nome da Tablespace a qual estiver associado o Datafile, seguido da extensão.ora, sendo este nome e a extensão em letras minúsculas.

8 4.22 Quando houver a necessidade de se acrescentar mais Datafiles a uma Tablespace com o objetivo de aumentar a capacidade de armazenamento dela, o nome de cada arquivo que representa cada um destes Datafiles (nome este em letras minúsculas apenas) deve ter o seguinte formato : <nome_do_datafile_original><número_sequencia>.ora onde : <nome_do_datafile_original> é o nome do primeiro Datafile que foi associado à Tablespace quando ela foi criada. <número_sequência> é o número de sequência de cada um dos Datafiles subsequentes que forem sendo acrescentados à Tablespace; este número deve ser representado por dois dígitos, preenchido com zero à esquerda quando necessário e o primeiro número da sequência deve ser As regras de nomenclatura para Tablespaces e Datafiles definidas nesta Norma Técnica devem ser seguidas apenas quando tais Tablespaces e Datafiles estiverem associados a sistemas ou aplicações desenvolvidos por Equipes de Desenvolvimento e Terceiros, não se aplicando, portanto, a Tablespaces e Datafiles próprios da estrutura do Banco de Dados Corporativo ou associados a alguma de suas funcionalidades ou serviços que o banco oferece Quando, num script de criação ou de alteração de um objeto do banco de dados, aparecer o nome do objeto do banco de dados, este deve ser antecedido sempre pelo Owner do Schema ao qual pertence o objeto de banco de dados, seguido por um ponto, ficando no seguinte formato : Owner_do_Schema.nome_do_objeto_de_banco_de_dados Isto se aplica para os seguintes objetos de banco de dados : Tabela Índice View Procedimento Função Especificação de Pacote Corpo de Pacote Trigger Sequence 4.25 O nome de um Sinônimo deve ser exatamente igual ao nome dado ao objeto do banco de dados sem a parte do Owner do Schema.

9 4.26 Apenas a Equipe de DBAs deve poder criar, alterar ou excluir Sinônimos Os scripts para criação de Tabelas devem ter as Colunas ordenadas segundo os critérios a seguir : Primeiro devem vir as Colunas cujo preenchimento é obrigatório (NOT NULL). A seguir devem vir as Colunas cujo preenchimento não é obrigatório (NULL) mas que tem maior probabilidade de serem preenchidas futuramente. Por último devem vir as Colunas cujo preenchimento não é obrigatório (NULL) e que tem maior probabilidade de não serem preenchidas No script de criação ou alteração de uma Tabela, deve ser colocado o parâmetro CACHE para o comando CREATE TABLE quando : a Tabela será ou é acessada com muito frequência; a Tabela possuir poucas Colunas; a Tabela possuir poucas linhas Esta Norma Técnica está sujeita a revisões e alterações periódicas em função da evolução da tecnologia existente no banco de dados Oracle e da evolução e expansão do próprio Banco de Dados Corporativo. Fim do Documento : 31/07/2.000 Este documento pode ser obtido em