How to generate database documentation with Toad for Oracle

Bart Gawrych - Dataedo Team Bart Gawrych 2019-04-11

Table of Contents:


    In this article I will show you how to generate database documentation in Toad for Oracle.

    Option 1: With ER Diagram

    1. choose on toolbar Database -> Report -> ER Diagram.

    1. In ER Diagram window click add object button (1) and select objects you want to add to the ER diagram (2). Next click ok button to create ER diagram.

    2. To create documentation click on Report button.

    In report window you can: - select format as RTF or HTML file - providing path where report report will be saved - change details like parameters or Layout

    1. Next click on OK button and documentation generation starts. You can see sample generated documentation below:

    Sample documentation with ERD

    Open sample documentation in new window

    Option 2: Without Diagram

    Open from Toolbar Html Schema Doc Generator by clicking on Database -> Report.

    HTML Schema Doc Generator in Toolbar

    New window consists of multiple tabs. Configure them according to your preferences:

    • Sources - source of object which will be in documentation (Schema/Snapshot)
    • Content - which type of object should be in documentation and which object descriptions should be included
    • Format - here you can modify CSS style
    • In/Exclusion - including or excluding specific objects (e.g single table)
    • Headers/Footers - additional header or Footer in HTML file
    • Aliases for Schema Names - if you don’t want to use official schema name in documentation you can mask it here by alias

    To get report click on Begin HTML Schema Doc Generation button. After generation is complete, pop-up window will appear with asking if you want to open report.

    Open sample documentation in new window

    0
    There are no comments. Click here to write the first comment.