db2c 0.0.4 → 1.0.0

data/README.md

@@ -1,13 +1,13 @@
-a db2 console with with history and autocomplete support
+A DB2 console with history and autocomplete support, and few other goodies
 ====================================
 
-DB2 console mode does not support readline and autocomplete, this is a wrapper for the db2 command with support for both.
+DB2 console mode does not support readline and autocomplete, this is a wrapper for the db2 command mode with support for both. It also tries to make using db2 a little bit more tolerable, adding support for psql-like commands and other shortcuts.
 
 Install
 -------
 
-  $ apt-get install [rlwrap][0]
-  $ gem install db2c
+* apt-get install [rlwrap][0]
+* gem install db2c
 
 Contributing
 ------------
@@ -23,8 +23,8 @@ Once you've made your great commits:
 Acknowledgement
 ------------
 
-Chris Jester-Young ([CKY][4]) found out the problem of using shell metacharacters when executing commands from Ruby.
-The initial script was inspired by [defunkt's repl][3], for a genenral purpose repl/wrapper, this is your friend.
+* Chris Jester-Young ([CKY][4]) found out the problem of using shell metacharacters when executing commands from Ruby.
+* The initial script was inspired by [defunkt's repl][3], for a genenral purpose repl/wrapper, this is your friend.
 
 Meta
 ----

data/bin/db2c

@@ -4,19 +4,38 @@ $LOAD_PATH.unshift 'lib'
 require "db2c"
 
 run = Db2c::Run.new *ARGV
+$DB2CDBG = run.debug?
 
 exec "man #{run.gdir}/man/db2c.1" if run.help?
-exec "rlwrap -z pipeto -i -r -s 999999 -pBLUE -f #{run.autocomplete} -H ~/.db2c_history db2c --no-rlwrap #{run.args}" if run.wrap?
+
+puts "wrapping #{$0} #{run.args}" if run.debug? && !run.nowrap?
+exec "RLWRAP_FILTERDIR=#{run.filters} rlwrap -z 'pipes less grep' -i -r -s 999999 -pBLUE -f #{run.autocomplete} -H ~/.db2c_history #{$0} --now #{run.args}" unless run.nowrap?
+
+Db2c::Command.execute "use #{run.default_db}" if run.default_db
+$/ = ";" if run.multiline?
 
 loop do
   print Db2c::Command.prompt
   begin
-    command = Db2c::Command.new $stdin.gets
+    input = $stdin.gets
+    input = input.gsub(/;$/,'') if input
+    if input =~ /^(edit|vi|vim|emacs)$/
+      command = Db2c::Command.new Db2c::Editor.edit input
+      next if command.quit?
+    elsif input =~ /^(cat|cp|date|df|du|find|grep|irb|kill|less|ls|man|more|mv|ps|rm|sudo|tail|touch|top|wc|which|who)/
+      system input
+      next
+    elsif input =~ /^!/
+      system input[1..-1]
+      next
+    else
+      command = Db2c::Command.new input
+    end
   rescue Interrupt
     exit
   end
   exit if command.quit?
-  system 'less ~/.db2c_history' if command.history?
+  system 'cat ~/.db2c_history' if command.history?
   system "man #{run.gdir}/man/db2c.1" if command.help?
   command.execute
 end

data/lib/db2c.rb

@@ -1,7 +1,12 @@
 module Db2c
   DEFAULT_PROMPT = "db2c => "
-  VERSION = "0.0.4"
+  VERSION = "1.0.0"
+  module CONSTANTS
+    DTSELECT = "select char(strip(tabschema) || '.' || strip(tabname), 128) as table from syscat.tables"
+    DTORDER  = "order by tabschema, tabname"
+  end
 end
 
 require "db2c/run.rb"
 require "db2c/command.rb"
+require "db2c/editor.rb"

data/lib/db2c/command.rb

@@ -1,14 +1,14 @@
 module Db2c
   class Command
 
+    include CONSTANTS
     @@cdb = ''
-    @@debug = false
 
     def initialize input
       if input
-        puts "initializing: #{input}" if @@debug
-        @input = input.chomp.strip
-        parse
+        puts "initializing: #{input}" if $DB2CDBG
+        @input = input.chomp.strip.gsub(/^db2 /i,'')
+        parse unless @input =~ /^(select|update|delete|insert)/i
       end
     end
 
@@ -17,17 +17,46 @@ module Db2c
     end
 
     def parse
-      @input.gsub! /^db2 /i, ''
-      @input.gsub! /;$/, ''
       @input.gsub! /^use /, 'connect to '
-      @input.gsub! /^\\d /, 'describe '
-      @input.insert 0, "? sql" if @input =~ /^\-\d+$/
-      @input.insert 0, "? " if @input =~ /^\d+$/
-      @input.insert 0, "values " if @input =~ /^current.+$/i
 
+      @input.gsub! /^\\d /, 'describe '
       if @input =~ /describe [^. ]+\.[^.+ ]+/
         @input.gsub! /describe /, 'describe table '
+        return
+      end
+
+      if @input =~ /^(show|list) databases/ || @input == '\l'
+        @input = "list database directory"
+        return
+      end
+
+      if @input =~ /^\\lt ?(\w*)$/
+        @input = "list tables"
+        unless $1.empty?
+          @input += $1 == "all" ? " for all" : " for schema #{$1}"
+        end
+        return
+      end
+
+      if @input =~ /^\\d([a|s|t|v]) ?(\w*)$/
+        @input = DTSELECT
+        @input += " where type = '#{$1.upcase}'"
+        @input += " and tabschema = '#{$2.upcase}'" unless $2.empty?
+        @input += " #{DTORDER}"
+        return
       end
+
+      shortcuts
+    end
+
+    def shortcuts
+      prepend /^\-\d+$/, "? sql"
+      prepend /^\d+$/, "? "
+      prepend /^current.+$/i, "values "
+    end
+
+    def prepend regex, value
+      @input.insert 0, value if @input =~ regex
     end
 
     def quit?
@@ -47,7 +76,7 @@ module Db2c
     end
 
     def execute
-      puts "executing: #{@input}" if @@debug
+      puts "executing: #{@input}" if $DB2CDBG
       system 'db2', @input if valid?
       if @input =~ /^connect to (.*)$/i
         @@cdb = $1.downcase
@@ -57,14 +86,6 @@ module Db2c
       end
     end
 
-    def self.debug=(value)
-      @@debug = value
-    end
-
-    def self.debug?
-      @@debug
-    end
-
     def self.prompt
       "db2c".tap do |pr|
         pr << "(#{@@cdb})" if @@cdb.length > 0
@@ -72,5 +93,9 @@ module Db2c
       end
     end
 
+    def self.execute command
+      new(command).execute
+    end
+
   end
 end

data/lib/db2c/editor.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+require 'tempfile'
+
+module Db2c
+  class Editor
+    def self.edit editor
+      puts "editor #{editor}" if $DB2CDBG
+      @file ||= Tempfile.new(["db2_tempfile", ".sql"])
+      mtime = File.stat(@file.path).mtime
+
+      args = []
+      args << command(editor)
+      args << @file.path
+      args.flatten!
+
+      @file.close
+
+      puts "editor args: #{args.inspect}" if $DB2CDBG
+
+      system(*args)
+
+      if mtime < File.stat(@file.path).mtime
+        return IO.read(@file.path)
+      end
+    end
+
+    def self.command editor
+      return ["emacs", "-nw"] if editor =~ /^emacs/
+      ["vi"]
+    end
+
+  end
+end

data/lib/db2c/run.rb

@@ -4,18 +4,17 @@ module Db2c
 
     def initialize *args
       @args = args
-      puts "args: #{@args}" if debug?
+      puts "args: #{@args.inspect}" if debug?
       @gdir = File.expand_path('../../../', __FILE__)
-      puts "cdir: #{@gdir}" if debug?
-      Db2c::Command.debug = debug?
+      puts "cdir: #{@gdir.inspect}" if debug?
 
       die "version #{Db2c::VERSION}" if version?
       die "The db2 command was not found!" unless system("which db2 > /dev/null 2> /dev/null")
-      die "This program depends on rlwrap, please install rlwrap" if wrap? && !system("which rlwrap > /dev/null 2> /dev/null")
+      die "This program depends on rlwrap, please install rlwrap" unless nowrap? || system("which rlwrap > /dev/null 2> /dev/null")
     end
 
     def help?
-      !(@args & %w{-h help -help --help --man}).empty?
+      !(@args & %w{-h help -help --help man --man}).empty?
     end
     def version?
       !(@args & %w{-v version -version --version}).empty?
@@ -23,18 +22,33 @@ module Db2c
     def debug?
       !(@args & %w{-d debug -debug --debug}).empty?
     end
-    def wrap?
-      (@args & %w{--no-rlwrap --now}).empty?
+    def nowrap?
+      !(@args & %w{--no-rlwrap --now}).empty?
+    end
+    def multiline?
+      !(@args & %w{-t}).empty?
+    end
+
+    def default_db
+      words.first if words.length == 1 && words.first !~ /(help|man|debug|version)/
     end
 
     def autocomplete
       "#{@gdir}/lib/autocomplete"
     end
 
+    def filters
+      "#{@gdir}/rlwrap/filters"
+    end
+
     def args
       @args.join(' ')
     end
 
+    def words
+      @args.reject { |arg| arg.start_with?('-') }
+    end
+
     def die message
       puts "DB2C: #{message}"
       puts "DB2C: #{self.inspect}" if debug?

data/man/db2c.1

@@ -1,13 +1,13 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "DB2C" "1" "November 2011" "" ""
+.TH "DB2C" "1" "February 2012" "" ""
 .
 .SH "NAME"
 \fBdb2c\fR \- A DB2 console with with history and autocomplete support, and few other goodies
 .
 .SH "SYNOPSIS"
-\fBdb2c\fR \fI\fIoptions\fR\fR
+\fBdb2c\fR [\fIoptions\fR] [dbname]
 .
 .SH "DESCRIPTION && EXAMPLES"
 DB2 console mode does not support readline and autocomplete, this is a wrapper for the db2 command with support for both\.
@@ -51,15 +51,15 @@ db2(testdb) => select * from xyz\.tab[double\-tab]
 
 .
 .IP "\(bu" 4
-\fBYou can pipe\fR:
+For example, if a command outputs long lines, \fBless \-S\fR is your friend:
 .
 .IP "" 4
 .
 .nf
 
 
-db2(testdb) => select * from large\.table | grep \-v something
-db2(testdb) => select * from large\.table | less
+db2(testdb) => select * from table\.with\.many\.columns | less \-S
+(you can scorll horizontally with left/right arrows)
 .
 .fi
 .
@@ -67,15 +67,15 @@ db2(testdb) => select * from large\.table | less
 
 .
 .IP "\(bu" 4
-For example, if a command outputs long lines, \fBless \-S\fR is your friend:
+\fBYou can edit last statement or use the editor to write a new multiline statement\fR:
 .
 .IP "" 4
 .
 .nf
 
 
-db2(testdb) => select * from table\.with\.many\.columns | less \-S
-(you can scorll horizontally with left/right arrows)
+db2(testdb) => edit
+db2(testdb) => emacs
 .
 .fi
 .
@@ -83,23 +83,78 @@ db2(testdb) => select * from table\.with\.many\.columns | less \-S
 
 .
 .IP "\(bu" 4
-You can use \fIsome psql\-like\fR commands
+\fBAny !command will be sent to the shell as is\fR:
+.
+.IP "" 4
+.
+.nf
+
+
+db2(testdb) => !clear
+.
+.fi
+.
+.IP "" 0
+
+.
+.IP "\(bu" 4
+You can use \fIsome\fR common shell commands directly:
+.
+.IP "" 4
+.
+.nf
+
+
+db2(testdb) => ls ~
+db2(testdb) => less ~/somefile
+db2(testdb) => top
+db2(testdb) => irb
+.
+.fi
+.
+.IP "" 0
+
+.
+.IP "\(bu" 4
+You can use \fIsome psql\-like\fR meta commands
 .
 .IP "" 4
 .
 .nf
 
 
-db2(testdb) => \fB\ed schema\.table\fR
-  == describe table schema\.table
 db2(testdb) => \fB\eh\fR
   == To see this help from within the console
+db2(testdb) => \fB\el\fR
+  == list database directory
+db2(testdb) => \fB\elt [all|schema]\fR
+  == list tables for all or one schema using db2 list command
+db2(testdb) => \fB\el[t|v|a|s] [schema]\fR
+  == list tables|views|aliases|summary\-tables for all or one schema using syscat\.tables
+db2(testdb) => \fB\ed schema\.table\fR
+  == describe table schema\.table
 db2(testdb) => \fB\eq\fR
 .
 .fi
 .
 .IP "" 0
 
+.
+.IP "\(bu" 4
+\fBYou can pipe\fR:
+.
+.IP "" 4
+.
+.nf
+
+
+db2(testdb) => \edv | grep \-v SYS
+db2(testdb) => select * from large\.table | less
+.
+.fi
+.
+.IP "" 0
+
 .
 .IP "" 0
 .
@@ -110,6 +165,10 @@ db2(testdb) => \fB\eq\fR
 Displays this help page\.
 .
 .TP
+\fB\-t\fR
+Commands will be executed when you enter a terminating semicolon (;)
+.
+.TP
 \fB\-\-debug\fR
 Displays annoying messages\.
 .

data/man/db2c.1.html

@@ -75,7 +75,7 @@
 
 <h2 id="SYNOPSIS">SYNOPSIS</h2>
 
-<p><code>db2c</code> <var><a href="#OPTIONS" title="OPTIONS" data-bare-link="true">options</a></var></p>
+<p><code>db2c</code> [<var>options</var>] [dbname]</p>
 
 <h2 id="DESCRIPTION-EXAMPLES">DESCRIPTION &amp;&amp; EXAMPLES</h2>
 
@@ -98,24 +98,46 @@ it remembers..
 db2(testdb) => list tables for schema xyz
 db2(testdb) => select * from xyz.tab[double-tab]
 </pre></li>
-<li><p><strong>You can pipe</strong>:
-</p><pre>
-db2(testdb) => select * from large.table | grep -v something
-db2(testdb) => select * from large.table | less
-</pre></li>
 <li><p>For example, if a command outputs long lines, <strong>less -S</strong> is your friend:
 </p><pre>
 db2(testdb) => select * from table.with.many.columns | less -S
 (you can scorll horizontally with left/right arrows)
 </pre></li>
-<li><p>You can use <em>some psql-like</em> commands
+<li><p><strong>You can edit last statement or use the editor to write a new multiline statement</strong>:
+</p><pre>
+db2(testdb) => edit
+db2(testdb) => emacs
+</pre></li>
+<li><p><strong>Any !command will be sent to the shell as is</strong>:
+</p><pre>
+db2(testdb) => !clear
+</pre></li>
+<li><p>You can use <em>some</em> common shell commands directly:
+</p><pre>
+db2(testdb) => ls ~
+db2(testdb) => less ~/somefile
+db2(testdb) => top
+db2(testdb) => irb
+</pre></li>
+<li><p>You can use <em>some psql-like</em> meta commands
 </p><pre>
-db2(testdb) => <strong>\d schema.table</strong>
-  == describe table schema.table
 db2(testdb) => <strong>\h</strong>
   == To see this help from within the console
+db2(testdb) => <strong>\l</strong>
+  == list database directory
+db2(testdb) => <strong>\lt [all|schema]</strong>
+  == list tables for all or one schema using db2 list command
+db2(testdb) => <strong>\l[t|v|a|s] [schema]</strong>
+  == list tables|views|aliases|summary-tables for all or one schema using syscat.tables
+db2(testdb) => <strong>\d schema.table</strong>
+  == describe table schema.table
 db2(testdb) => <strong>\q</strong>
 </pre></li>
+<li><p><strong>You can pipe</strong>:
+</p><pre>
+db2(testdb) => \dv | grep -v SYS
+db2(testdb) => select * from large.table | less
+</pre></li>
 </ul>
 
 
@@ -123,6 +145,7 @@ db2(testdb) => <strong>\q</strong>
 
 <dl>
 <dt><code>-h</code>, <code>--help</code>, <code>--man</code></dt><dd><p>Displays this help page.</p></dd>
+<dt class="flush"><code>-t</code></dt><dd><p>Commands will be executed when you enter a terminating semicolon (;)</p></dd>
 <dt class="flush"><code>--debug</code></dt><dd><p>Displays annoying messages.</p></dd>
 <dt><code>--no-rlrwap</code></dt><dd><p>Don't use rlwrap</p></dd>
 </dl>
@@ -134,7 +157,7 @@ db2(testdb) => <strong>\q</strong>
 
 <h2 id="AUTHOR">AUTHOR</h2>
 
-<p>Samer Abukhait <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#111;&#x3a;&#115;&#97;&#109;&#101;&#x72;&#x40;&#111;&#110;&#45;&#x73;&#x69;&#x74;&#x65;&#x4e;&#79;&#x53;&#80;&#65;&#x4d;&#x2e;&#99;&#111;&#109;" data-bare-link="true">&#x73;&#x61;&#109;&#101;&#114;&#x40;&#x6f;&#110;&#x2d;&#x73;&#105;&#x74;&#101;&#x4e;&#79;&#83;&#x50;&#x41;&#x4d;&#46;&#99;&#111;&#x6d;</a>, @s4mer</p>
+<p>Samer Abukhait <a href="&#x6d;&#97;&#105;&#x6c;&#116;&#111;&#x3a;&#115;&#97;&#x6d;&#101;&#114;&#x40;&#x6f;&#110;&#x2d;&#115;&#x69;&#x74;&#x65;&#78;&#x4f;&#83;&#80;&#x41;&#x4d;&#46;&#99;&#x6f;&#x6d;" data-bare-link="true">&#x73;&#97;&#x6d;&#101;&#114;&#64;&#111;&#x6e;&#45;&#115;&#105;&#116;&#x65;&#x4e;&#79;&#x53;&#80;&#65;&#x4d;&#46;&#x63;&#x6f;&#x6d;</a>, @s4mer</p>
 
 <h2 id="SEE-ALSO">SEE ALSO</h2>
 
@@ -143,7 +166,7 @@ db2(testdb) => <strong>\q</strong>
 
   <ol class='man-decor man-foot man foot'>
     <li class='tl'></li>
-    <li class='tc'>November 2011</li>
+    <li class='tc'>February 2012</li>
     <li class='tr'>db2c(1)</li>
   </ol>