ntalbs / tabledoc

Generates documentations about tables, columns, indexes, etc. of Oracle database in JavaDoc style.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TableDoc

Generates documentation about tables, columns, indexes, etc. of Specified database in JavaDoc style.

Setup

Clone this project and edit config.clj.

$ git clone https://github.com/ntalbs/tabledoc.git
$ cd tabledoc
$ vim config.clj
...

Usage

$ lein run -d ${target} -s "owner1,owner2,..."

Before running this, JRE and Clojure (Leiningen) should be installed.

Oracle memo

If you want to connect to Oracle DBMS, you should prepare the Oracle JDBC Driver. Download it from Oracle and install the driver file to local Maven repository.

$ mvn install:install-file -X -DgroupId=local -DartifactId=ojdbc6 -Dversion=11.2.0.3 -Dpackaging=jar -Dfile=/opt/oracle/instantclient/ojdbc6.jar -DgeneratePom=true

And when you specify the owners, they should be upper case.

Todo

  • Separate configuration
  • Support MySQL, PostgreSQL

About

Generates documentations about tables, columns, indexes, etc. of Oracle database in JavaDoc style.

License:MIT License


Languages

Language:Clojure 71.0%Language:HTML 24.7%Language:CSS 4.3%