<< Click to Display Table of Contents >>

Generating database documentation

Top Previous Next

After starting the database documentation utility, you will see a dialog similar to the following one:




Enter a user name, password and connect string (or for a direct TCP/IP connection, enter the TCP/IP address, port number, and service name) to establish a database connection.

The utility suggests defaults for the output file name and the title of the HTML document. You can change them as you wish.

The default title contains symbolic references to both the current date (#d) and the schema (#o). These can also be incorporated into custom titles.

The report can be produced in either English or German. This means that titles and column headings, for example, can appear in either language.

There are three check boxes that affect the HTML generation process:

Views may or may not be included

PL/SQL objects may or may not be included.

HTML tables used to display data may or may not have visible borders.

Include Triggers or not

Include master/Detail relations or not

Include dependencies or not

Include "See also" section or not


The facility also includes filters that will specify which tables or objects should be included.

You can filter tables by either TABLESPACE_NAME or TABLE_NAME.

PL/SQL objects may be filtered by OBJECT_NAME or OBJECT_TYPE.

After checking your preferences, press the Start HTML generation button. Then turn on your electric teapot and see which tool finishes first.