File: README

package info (click to toggle)
rhdb-explain 2.0-1
  • links: PTS
  • area: contrib
  • in suites: sarge
  • size: 1,348 kB
  • ctags: 2,029
  • sloc: java: 13,411; xml: 209; makefile: 42; sh: 22
file content (110 lines) | stat: -rw-r--r-- 3,164 bytes parent folder | download
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
=======================================================
Visual Explain 2.0 for PostgreSQL - Red Hat Edition 3.0
=======================================================

Copyright (c) 2003 Red Hat, Inc. All rights reserved.
This software may be freely redistributed under the terms of the
GNU General Public License.

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., 675 Mass Ave, Cambridge, MA 02139, USA.


-------------------
General Information
-------------------

Visual Explain (rhdb-explain) is a GUI tool for visualizing the output of 
the PostgreSQL - Red Hat Edition EXPLAIN command. rhdb-explain is written 
in Java.

---------
Platforms
---------

Any platform that can run Java applications should be able to run rhdb-explain.

---------------
Getting Started
---------------

Before running rhdb-explain, make sure that you have a Java 2 Runtime
Environment (JRE) installed on your system. The recommended version is
the Sun JRE 1.4.2 in which it was tested.

For building rhdb-explain, you must have a Java 2 Software Development
Kit (SDK) of at least version 1.4. Ant 1.4.1 or later must also be
installed on your system. See http://jakarta.apache.org/ant for more
information on Ant.

--------------------
Running rhdb-explain
--------------------

The binary version of rhdb-explain comes in a jar file called
rhdb-explain.jar. To run the program, make sure that your PostgreSQL
JDBC driver is in the lib/ext directory of your JRE installation. Eg:
my JRE is located in /home/liams/linux/java/jdk1.4.1/jre so if the
JDBC driver was called postgresql.jar, I would put it in
/home/liams/linux/java/jdk1.4.1/jre/lib/ext.  Then

 $ java -jar rhdb-explain.jar

(assuming rhdb-explain.jar is in the current directory). Note that any
the CLASSPATH environment variable will be ignored as well as the -cp
or -classpath options to java, if they are specified.

If you do not want to have the JDBC driver located in your JRE installation,
you can edit your CLASSPATH environment variable to include its location and
then run rhdb-explain:

(ba)sh:

 $ export CLASSPATH=${CLASSPATH}:/path/to/postgresql/jdbc/driver.jar
 $ java -cp ${CLASSPATH}:rhdb-explain.jar com.redhat.rhdb.vise.Vise

(t)csh:

 $ setenv CLASSPATH ${CLASSPATH}:/path/to/postgresql/jdbc/driver.jar
 $ java -cp ${CLASSPATH}:rhdb-explain.jar com.redhat.rhdb.vise.Vise

(again, assuming that rhdb-explain.jar is in the current directory).

If you installed rhdb-explain from an RPM, you can just run the
rhdb-explain command. Eg:

 $ rhdb-explain

---------------------
Building rhdb-explain
---------------------

Change to the directory that contains the build.xml file (the top
level directory).

To build rhdb-explain:

 $ ant

To build a binary distribution:

 $ ant dist

To build the Javadoc documentation:

 $ ant javadoc

To clean-up:

 $ ant clean

After building rhdb-explain, you can run it by going into the build
subdirectory and typing:

 $ java com.redhat.rhdb.vise.Vise

After building a binary distribution, you can run it with the
following:

 $ java -jar dist/rhdb-explain.jar