-
Notifications
You must be signed in to change notification settings - Fork 0
/
README_oraschemadoc
150 lines (112 loc) · 5.65 KB
/
README_oraschemadoc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
This is the license and Copyright and README from the original package::
oraschemadoc
This covers all works from the original fork of the project.
Copyright (C) Aram Kananov <arcanan@flashmail.com>, 2002
Copyright (C) Petr Vanek <petr@yarpen.cz>, 2005
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Exceptation: file oraschemadoc/subprocess24.py is licensed to PSF
under a Contributor Agreement.
http://www.python.org/download/releases/2.4/license/
--------
CONTENTS
--------
0. SOURCE CODE
1. OVERVIEW
2. INSTALLATION
3. USAGE
--------------
0. SOURCE CODE
--------------
Oraschemadoc is Python application so you propably have source codes alrady.
If you are using binary executable distribution, you can find sources at
http://www.yarpen.cz/oraschemadoc/
-----------
1. 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 html files.
--------------
2. INSTALLATION
--------------
Requirements:
a) Python, version 2.0 or later.
http://www.python.org
b) available connection to Oracle Server, version 8.1.6 or later.
http://otn.oracle.com
c) Oracle Server Client (see supported versions by cx_Oracle)
http://otn.oracle.com
d) cx_Oracle - a Python extension module that allows access to Oracle
http://www.computronix.com/utilities
Warning: you need Oracle client which is cs_Oracle compiled for
e) Optional GraphViz if you want to have ER diagrams in HTML output.
GraphViz is detected automatically.
http://www.graphviz.org
Installation
a) check version of python. type in shell "python -V" to get python version number
a) install cx_Oracle if neccessary
b) untar oraschemadoc file into destination directory
Or use precompiled binary distribution. Actually I don't provide any support for
this distribution. Believe me - Python is better ;)
--------
3. USAGE
--------
a) go to directory where oraschemadoc is installed
b) to generate documentation run:
% ./oracshemadoc.py connect_string output_directory name
or with optional parameters:
oraschemadoc [-v|--verbose] [-d|--dia [--dia-table-list=file]] [--no-html]
[--xml-file=filename] [-s|--syntax] [--no--ddl]
[--css=style] [--desc=description] oracleuser/password[@dbalias]
output_dir "application name"'
where:
--verbose - prints data helpfull for debugging. Use that option if you
encounter problems with oraschemadoc and include output if
you post a bug. Sending me emails is ok, but i would prefer
if u post a bug or support request on oraschemadoc.sourceforge.net
--no-html - turn off generation of html files
-d --dia=fname - export datamodel to dia uml diagram, fname file will be created under output_dir
--dia-table-list - path to file which contains table names for export to dia diagram. Useful if you
want to create diagram for some subset of tables. Separate table names with line breaks.
example of file content:
CLIENTS
ORDERS
etc.
--xml-file=fname - dump DM into xml file. File will be created under output_dir
-s --syntax - Enables syntax highlighting of the source code pieces.
Warning: it's very slow.
--no-ddl - Disable DDL scripts creation (running DBMS_METADATA calls.
It's enabled by default.
--css=filename - File name of the chosen file from css directory.
It'll be used as CSS in produced HTML
--desc=description - If is description filename with path, the text from file is taken.
If the file doesn't exist the description is taken as text string.
--pb - Generates source code for package bodies too.
--nn - Index NOT NULL constraints too. It\'s skipped by default:
NOT NULL constraints are reported in columns list only.
--schema=schemalist
- specify schema/usernames to select from ALL_% obejcts.
If it's not given standard USER_% objects are used.
Schemalist can be e.g. "SCOTT,FOO,BAR" - coma separated list
or empty - it means all granted objects will be documented
Examples:
--schema="" performs selects from current users's ALL_% with
no owner restrictions
--schema="scott,hr" persorms selects from current user's ALL_%
with restrictions for scott, hr and current
user too.
no --schema option - performs selects from USER% objects.
connect_string - username/password@dbalias
output_directory - directory where html files will be placed
name - short name which will be shown as title in html files.
for example "My Project Data Model"