]> jaekl.net Git - squelch.git/blob - README
Fix and fine-tune suppress_nulls.
[squelch.git] / README
1 SQueLch
2
3 This is a simple console-based SQL client.
4
5 It is database-agnostic.  Support for PostgreSQL is built-in, and 
6 MS SQL Server, MySQL and Oracle should work so long as you have the 
7 relevant JDBC driver .jar in your CLASSPATH.  If you want to add 
8 support for a different database, see net.jaekl.db.DbDriver for details.
9
10 To build it:
11
12   $ mvn clean package
13
14 To run it:
15
16   Add your JDBC jar to your CLASSPATH, then:
17   $ java -jar ./target/squelch-0.1-SNAPSHOT-jar-with-dependencies.jar --help
18
19 For example:
20
21   $ java -jar squelch.jar -u chris -p passwordGoesHere -r postgresql:localhost/cfb
22
23 Note that it's more secure to put your password in a config file instead, 
24 for example:
25
26   $ cat >config.properties
27   db.user=chris
28   db.password=passwordGoesHere
29   db.url=postgresql:localhost/cfb
30   ^D
31   $ java -jar squelch.jar --config ./config.properties
32
33 The code is available under the GNU General Public Licence (GPL) version 3, 
34 or (at your option) any later version.  See the file COPYING for details.
35
36 Note that this code, like Isaac Newton, stands on the shoulders of giants;
37 it uses libraries from several other projects.  Their licence terms are 
38 reproduced in the file THIRD_PARTY.
39
40
41 *> Chris Jaekl
42 https://www.jaekl.net/chris/
43