File: dbi

package info (click to toggle)
libdbi-ruby 0.4.3-2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 472 kB
  • ctags: 619
  • sloc: ruby: 4,583; makefile: 62; perl: 12
file content (518 lines) | stat: -rw-r--r-- 12,406 bytes parent folder | download | duplicates (3)
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
#!/usr/bin/env ruby
#
# Copyright (c) 2001, 2002 Michael Neumann <neumann@s-direktnet.de>
# 
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without 
# modification, are permitted provided that the following conditions 
# are met:
# 1. Redistributions of source code must retain the above copyright 
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright 
#    notice, this list of conditions and the following disclaimer in the 
#    documentation and/or other materials provided with the distribution.
# 3. The name of the author may not be used to endorse or promote products
#    derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
# INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
# THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# $Id: sqlsh.rb,v 1.2 2006/01/24 04:20:01 francis Exp $
#

begin
    require 'rubygems'
    gem 'dbi'
rescue LoadError => e
end

require "dbi"

begin
    require "readline"
    $use_readline = true
rescue LoadError
    $use_readline = false
end

require "irb"
require "irb/completion"

$paging = true
$irb_completion = Readline.completion_proc

require "getoptlong"

class ReadlineControl

    attr_accessor :keywords

    def initialize
        @keywords = []
        set_prompt
        initCompletion
    end

    def initCompletion
        if $use_readline
            Readline.completion_proc = proc {|str| complete(str) }
        end
    end

    def complete(str)
        @keywords.grep(/^#{Regexp.escape(str)}/i)
    end

    def set_prompt(prompt="> ")
        @prompt = prompt
    end

    def readline
        if $use_readline 
            Readline.readline(@prompt, true)
        else
            print @prompt
            $stdin.readline
        end
    end

end

class Command

    def tokens(sql)
        DBI::SQL::PreparedStatement.tokens(sql)
    end

    def readCommand
        line = ""

        $rd.set_prompt(PROMPT)
        begin
            if $input.nil? 
                # no source file to read from
                l = $rd.readline
            else                   
                # source file has still data
                l = $input.gets
                if l.nil?
                    $input = nil
                    next
                end
            end

            next if l.strip.empty?
            l = l.chomp + "\n"
            line << l 

            puts $file + INPUT + l unless $input.nil?
            $rd.set_prompt(PROMPT_CONT)
        end until complete?(line)

        return line.strip
    end

    private

    def complete?(line)
        line =~ /^\s*\\/ or (tokens(line).last || "") =~ /;\s*$/
    end
end

class Actions
    ACTIONS = [
        [ /^\\q(uit)?\s*$/i,     :quit ],
        [ /^\\h(elp)?\s*$/i,     :help ],
        [ /^\\t(ables)?/i,       :tables ],
        [ /^\\dt/i,              :describeTable ],
        [ /^\\s(elect)?/i,       :select ],

        [ /^\\rb/i,              :ruby ],
        [ /^\\irb/i,             :irb ],

        [ /^\\c(ommit)?\s*$/i,   :commit ],
        [ /^\\r(ollback)?\s*$/i, :rollback ],
        [ /^\\a(utocommit)?(\s+(on|off)?)?\s*$/i, :autocommit ],
        [ /^\\i(nput)?/i,        :input ],
        [ /^\\o(utput)?/i,       :output ],
        [ /^\\pl/i,              :pageLength ],
        [ /^\\p/i,               :togglePaging ],

        [ //,                    :unknownCommand ]
    ] 

    def dispatchCommand(line)
        ACTIONS.each do |regexp, action|
            if line =~ regexp then
                send(action, $~)
                return
            end
        end
    end

    def quit(match)
        puts
        puts "BYE"
        puts

        begin
            Conn.disconnect
        rescue DBI::Error => err
            puts
            puts err.message
            p err.backtrace if $DEBUG
            puts
        end

        exit
    end

    def help(match)
        head = %w(Function Description)
        rows = [
            ["\\h[elp]",     "Display this help screen"],
            ["", ""],

            ["\\t[ables]",   "Display all available tables"],
            ["\\dt table",   "Describe columns of 'table'"],
            ["\\s[elect] table", "short for SELECT * FROM 'table'"],

            ["", ""],
            ["\\c[ommit]",   "Commits the current transaction"],
            ["\\r[ollback]", "Rolls back the current transaction"],
            ["\\a[utocommit]", "Show current autocommit mode"],
            ["\\a[utocommit] on|off", "Switch autocommit mode on/off"],
            ["", ""],

            ["\\i[nput] filename", "Read and execute lines from 'filename'"],
            ["\\o[utput]", "Disable output"],
            ["\\o[utput] filename", "Store SQL statments the user inputs into 'filename'"],
            ["", ""],

            ["\\pl n",   "Set page length to 'n'"],
            ["\\p",      "Toggle paging"],
            ["", ""],
            ["\\rb ...", "Execute the rest of the line as Ruby sourcecode"],
            ["\\irb",    "Execute irb within this context"],

            ["", ""],

            ["\\q[uit]",     "Quit this program"]
        ]

        puts
        puts "Help: "
        output_table(head, rows)
        puts
    end

    def tables(match)
        head = ["Table name"]
        rows = Conn.tables.collect {|name| [name]}

        puts
        puts "Tables: "
        output_table(head, rows)
        puts
    end

    def describeTable(match)
        table = match.post_match.strip

        head = %w(name type_name precision scale default nullable indexed primary unique)

        rows = Conn.columns(table).collect {|col| head.collect{|a| col[a]} }

        puts
        puts "Table '#{table}': "
        output_table(head, rows)
        puts
    end

    def select(match)
        executeSQL("SELECT * FROM #{match.post_match};")
    end

    def commit(match)
        Conn.commit
        puts
        puts "COMMIT"
        puts
    end

    def rollback(match)
        Conn.rollback
        puts
        puts "ROLLBACK"
        puts
    end

    def autocommit(match)
        mode = match[3]
        if mode =~ /on/i
            Conn['AutoCommit'] = true
            puts
            puts "AUTOCOMMIT IS NOW ON"
            puts
        elsif mode =~ /off/i
            Conn['AutoCommit'] = false
            puts
            puts "AUTOCOMMIT IS NOW OFF"
            puts
        else
            puts
            if Conn['AutoCommit'] == true
                puts "AUTOCOMMIT is currently switched ON"
            elsif Conn['AutoCommit'] == false
                puts "AUTOCOMMIT is currently switched OFF"
            else
                puts "AUTOCOMMIT is in unknown state"
            end
            puts 
        end 
    end

    def input(match)
        puts
        $file = match.post_match.strip

        begin
            $input = File.open($file)
            puts "EXECUTE file #{$file}" 
            puts
        rescue
            puts "Couldn't read from file #{$file}"
            puts
        end
    end

    def output(match)
        puts
        file = match.post_match.strip

        if file.empty?
            $output.close if $output
            $output = nil
            puts "Disabled OUTPUT"
            puts
        else
            begin
                $output = File.new(file, "w+")
                puts "Set OUTPUT to file #{file}" 
                puts
            rescue
                puts "Couldn't set OUTPUT to file #{file}"
                puts
            end
        end
    end

    def togglePaging(match)
        $paging = !$paging

        puts "Paging is now " + ($paging ? "on" : "off") + "."
    end

    def pageLength(match)
        puts
        $page_len = match.post_match.strip.to_i
        $page_len = DEFAULT_PAGE_LENGTH if $page_len <= 0

        puts "New page length is #{$page_len}."
        puts
    end

    def irb(match)
        Readline.completion_proc = $irb_completion
        puts
        puts "================================== IRB ==============================="
        begin 
            IRB.start 
        rescue SystemExit 
        end
        puts "======================================================================"
        $rd.initCompletion
    end

    def ruby(match)
        puts
        eval match.post_match
        puts
    end

    def unknownCommand(match)
        puts
        puts "Unknown command!"
        puts
    end

end

def output_table(header, rows)
    DBI::Utils::TableFormatter.ascii(header, rows, nil, nil, nil, nil, $page_len) do   
        if $paging
            print "[enter to continue, a to abort]"
            break if $stdin.readline.chomp.downcase == "a"
        end
    end
end

def executeSQL(sql)
    sql = $` if sql =~ /;\s*$/

        start = ::Time.now
    stmt = Conn.execute(sql)

    head = stmt.column_names

    # DDL, DCL
    if head.empty? 
        puts
        nr = stmt.rows
        if nr == 0
            puts "  No rows affected"
        elsif nr == 1
            puts "  1 row affected"
        else 
            puts "  #{nr} rows affected"
        end
        puts
    else
        rows = stmt.fetch_all
        tm = ::Time.now - start

        puts
        output_table(head, rows || [])
        print "  "
        if rows.nil?
            print "No rows in set"
        elsif rows.size == 1
            print "1 row in set"
        else
            print "#{rows.size} rows in set"
        end

        puts " (#{(tm.to_f*1000).to_i / 1000.0} sec)"
        puts
    end

    $rd.keywords = SQL_KEYWORDS + Conn.tables
end

DEFAULT_PAGE_LENGTH = 37 

$output     = nil
$input      = nil
$page_len   = DEFAULT_PAGE_LENGTH 
PROMPT      = "dbi => "
PROMPT_CONT = "dbi -> "
INPUT       = " >> "

SQL_KEYWORDS = %w(
  INSERT DELETE UPDATE SELECT FROM WHERE IN LIKE SET VALUES INTO
  CREATE TABLE DROP 
  COMMIT ROLLBACK
  CHAR VARCHAR VARCHAR2 INT INTEGER NUMBER FLOAT REAL LONG CLOB BLOB DECIMAL 
  DBCLOB DBBLOB
)

# ---------------------------------------------------------------------------

opts = GetoptLong.new(
    ["--file", "-f", GetoptLong::REQUIRED_ARGUMENT ]
)
opts.each do |opt, arg|
    case opt
    when "--file"
        $input_file_name = arg
    end
end

if ARGV.size < 1 or ARGV.size > 3
    puts
    puts "USAGE: #{$0} [--file file] driver_url [user [password] ]"
    puts

    puts "Available driver and datasources:"
    puts
    for driver in DBI.available_drivers do
        puts driver 
        begin
            ds = DBI.data_sources(driver)
            for datasource in ds
                puts "  " + datasource
            end
        rescue => err
        end
        puts
    end
    puts 

    exit 1
else
    DRIVER_URL = ARGV.shift
    USER       = ARGV.shift
    PASS       = ARGV.shift
end

puts
begin
    Conn = DBI.connect(DRIVER_URL, USER, PASS)
    print "CONNECT TO #{DRIVER_URL} "
    print "USER #{USER} " unless USER.nil?
    print "PASS #{PASS} " unless PASS.nil?
    print "\n"

rescue DBI::Error, DBI::Warning => err
    p err
    exit
end

puts

$rd = ReadlineControl.new
$rd.keywords = SQL_KEYWORDS + Conn.tables

cmd = Command.new
act = Actions.new

# --file option
if $input_file_name
    def $input_file_name.post_match
        $input_file_name
    end
    act.input($input_file_name) 
end

# Main-Loop -----------------------------------

loop do 
    line = cmd.readCommand

    $output.puts line unless $output.nil?

    begin
        if line =~ /^\\/ then
            # Internal Command
            act.dispatchCommand(line)
        else
            # SQL Command
            executeSQL(line)
        end
    rescue DBI::Error => err
        puts
        puts err.message
        p err.backtrace if $DEBUG
        puts
    end
end