Início / dba / Perguntas / 24937
Accepted
jrara
Asked: 2012-09-27 01:45:31 +0800 CST

Como documentar o banco de dados Oracle?

  • 772

Sou novo em bancos de dados Oracle. Eu usei o SQL Server e os campos de descrição (MS_Description) para tabelas e colunas para fins de documentação. Existe um equivalente para Oracle? Qual é a melhor prática para documentar o banco de dados Oracle?

oracle metadata

4 respostas

  1. Best Answer

    No Oracle, você usaria o comando COMMENT para:

    [...] adicionar ao dicionário de dados um comentário sobre uma tabela ou coluna de tabela, visão, visão materializada, operador, tipo de índice, modelo de mineração ou edição.

    A maioria das ferramentas (PL/SQL Developer, Toad...) exibirá esses comentários nos campos apropriados quando você navegar pelo esquema do banco de dados.

    Os comentários podem ser consultados diretamente com as *COMMENTSvisualizações de dicionário, como ALL_TAB_COMMENTS.

    • 10

  2. No Oracle existem comentários de tabelas e colunas que podem ser usados ​​para documentação.

    Esses comentários podem ser facilmente adicionados pelos seguintes comandos:

    COMMENT ON TABLE my_table IS 'Documentation of my table'
/


COMMENT ON COLUMN my_table.my_columns IS 'Documentation of my column'
/
    • 8

  3. A Oracle expõe seu dicionário de dados por meio de visualizações. Você pode usar essas exibições para consultar as informações de que precisa.

    As principais visualizações que você precisará usar são:

    • DBA_OBJECTS- lista todos os objetos do banco de dados
    • DBA_TABLES- listar todas as tabelas (e seus donos, que são esquemas no Oracle)
    • DBA_TAB_COLUMNS- listar todas as tabelas e suas colunas

    Existem também ALL_%e USER_%equivalentes a essas visualizações (por exemplo: `USER_TABLES) que mostram apenas todos os objetos nos quais você tem permissão e os objetos que você possui.

    • 0

  4. Se você precisar fazer isso no banco de dados Oracle, o comando comment é sua resposta. Mas há algumas desvantagens de documentar o esquema dessa maneira:

    • certos privilégios são necessários (nem sempre é possível)
    • em alguns casos, você não pode interferir no banco de dados (de terceiros/legado)
    • você não pode usar descrições longas (limite de 4.000 caracteres)
    • você não pode usar ou texto formatado (diretamente)
    • você não pode adicionar imagens
    • nenhuma maneira fácil de navegar na documentação

    Eu recomendaria armazenar a documentação em um repositório dedicado - verifique a ferramenta de documentação do banco de dados Dataedo . Ele lê esquemas (e comentários existentes) e permite que você descreva cada item com rich text e imagens (para seus diagramas ERD). Você pode então exportar para um bom documento PDF ou HTML interativo. Quando o esquema muda, você pode sincronizar sua documentação com alguns cliques.

    Sou gerente de produto da Dataedo.

    • 0

relate perguntas