HiveBrain v1.2.0
Get Started
← Back to all entries
snippetModerate

How to document Oracle database?

Submitted by: @import:stackexchange-dba··
0
Viewed 0 times
databaseoracledocumenthow

Problem

I'm new to Oracle databases. I have used to SQL Server and the description fields (MS_Description) for tables and columns for documentation purposes. Is there an equivalent for Oracle? What is the best practice for documenting Oracle database?

Solution

In Oracle, you would use the COMMENT command to:


[...] add to the data dictionary a comment about a table or table
column, view, materialized view, operator, indextype, mining model, or
edition.

Most tools (PL/SQL Developer, Toad...) will display these comments in appropriate fields when you browse the database schema.

The comments can be queried directly with the *COMMENTS dictionary views, such as ALL_TAB_COMMENTS.

Context

StackExchange Database Administrators Q#24937, answer score: 10

Revisions (0)

No revisions yet.