Oracle Schema Documentation Generator

Overview

Goal of oraschemadoc is "JavaDoc" style detailed documentation for all objects in schema covering Oracle specific features. Result of execution of oraschemadoc is set of static XHTM files mainly - more output formats in progress.

Latest release - 0.31, 2007-Apr-10

See example output.

Also it is possible to export datamodel to Dia UML Diagram. See example.

Contact

petr@yarpen.cz

Support Development

You can use Oraschemadoc free without any payments. But there can be some features you are missing. You can donate some funds to speed-up its development.

You can change priority of your bug/feature request with a donation. Please leave a note with your comment too.

IBAN account number: CZ4562106701002200732790

PayPal:

Screenshots

Well, screenshots... The most popular part of a project website... Oraschemadoc is a commandline tool so any screenshot is wasting of space.

Requirements

• Python, version 2.0 or later.
• Available Oracle Server, version 8.1.6 or later.
• Oracle Server Client (see supported versions by cx_Oracle)
• cx_Oracle - a Python extension module that allows access to Oracle
• Optional: GraphViz to get ERD in XHTML output
• OS independ, in other words will run even on Windows :-)
• There is a binary package for Windows available, so no Python on this platform needed. Actually support of this binary is very limited.
• There is a binary package for Linux available, so no Python on this platform needed. Actually support of this binary is very limited.

Download

Download stable versions.

I'm using SVN since 2007-Feb-05 so why don't to be on the edge of the sanity with the fresh features and all the bugs?

svn co https://oraschemadoc.svn.sourceforge.net/svnroot/oraschemadoc/trunk oraschemadoc

Current Features

Currently OraSchemaDoc prints:

• data about all tables, including columns
• table constraints(check, unique and referential)
• indexes, including functional and domain indexes
• views
• materialized views (snapshots)
• partitions informations
• PL/SQL triggers, procedures, functions, packages
• optional syntax highlighting of the source code
• Sanity check - report about missed indexes on foreign key columns, and automaticaly generated sql file with defenition of missed indexes.
• Source code highlighting
• ER diagrams as clickable images in XHTML docs (requires GraphViz)
• NLS support
• Optional access to the database objects out of currently logged schema
• Export datamodel to Dia UML diagram.
• DDL Scripts generator (for Oracle>8)

Authors

all authors and contacts

Cheers to