Class: Rails::DBConsole

Inherits:
Object show all
Defined in:
railties/lib/rails/commands/dbconsole.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (DBConsole) initialize(app)

Returns a new instance of DBConsole



18
19
20
# File 'railties/lib/rails/commands/dbconsole.rb', line 18

def initialize(app)
  @app = app
end

Class Method Details

+ (Object) start(app)



14
15
16
# File 'railties/lib/rails/commands/dbconsole.rb', line 14

def self.start(app)
  new(app).start
end

Instance Method Details

- (Object) find_cmd(*commands)



49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'railties/lib/rails/commands/dbconsole.rb', line 49

def find_cmd(*commands)
  dirs_on_path = ENV['PATH'].to_s.split(File::PATH_SEPARATOR)
  commands += commands.map{|cmd| "#{cmd}.exe"} if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/

  full_path_command = nil
  found = commands.detect do |cmd|
    dir = dirs_on_path.detect do |path|
      full_path_command = File.join(path, cmd)
      File.executable? full_path_command
    end
  end
  found ? full_path_command : abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
end

- (Object) start



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
# File 'railties/lib/rails/commands/dbconsole.rb', line 22

def start
  include_password = false
  options = {}
  OptionParser.new do |opt|
    opt.banner = "Usage: dbconsole [environment] [options]"
    opt.on("-p", "--include-password", "Automatically provide the password from database.yml") do |v|
      include_password = true
    end

    opt.on("--mode [MODE]", ['html', 'list', 'line', 'column'],
      "Automatically put the sqlite3 database in the specified mode (html, list, line, column).") do |mode|
        options['mode'] = mode
    end

    opt.on("-h", "--header") do |h|
      options['header'] = h
    end

    opt.parse!(ARGV)
    abort opt.to_s unless (0..1).include?(ARGV.size)
  end

  unless config = YAML::load(ERB.new(IO.read("#{@app.root}/config/database.yml")).result)[Rails.env]
    abort "No database is configured for the environment '#{Rails.env}'"
  end


  def find_cmd(*commands)
    dirs_on_path = ENV['PATH'].to_s.split(File::PATH_SEPARATOR)
    commands += commands.map{|cmd| "#{cmd}.exe"} if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/

    full_path_command = nil
    found = commands.detect do |cmd|
      dir = dirs_on_path.detect do |path|
        full_path_command = File.join(path, cmd)
        File.executable? full_path_command
      end
    end
    found ? full_path_command : abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
  end

  case config["adapter"]
  when /^mysql/
    args = {
      'host'      => '--host',
      'port'      => '--port',
      'socket'    => '--socket',
      'username'  => '--user',
      'encoding'  => '--default-character-set'
    }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact

    if config['password'] && include_password
      args << "--password=#{config['password']}"
    elsif config['password'] && !config['password'].to_s.empty?
      args << "-p"
    end

    args << config['database']

    exec(find_cmd('mysql', 'mysql5'), *args)

  when "postgresql", "postgres"
    ENV['PGUSER']     = config["username"] if config["username"]
    ENV['PGHOST']     = config["host"] if config["host"]
    ENV['PGPORT']     = config["port"].to_s if config["port"]
    ENV['PGPASSWORD'] = config["password"].to_s if config["password"] && include_password
    exec(find_cmd('psql'), config["database"])

  when "sqlite"
    exec(find_cmd('sqlite'), config["database"])

  when "sqlite3"
    args = []

    args << "-#{options['mode']}" if options['mode']
    args << "-header" if options['header']
    args << config['database']

    exec(find_cmd('sqlite3'), *args)

  when "oracle", "oracle_enhanced"
    logon = ""

    if config['username']
      logon = config['username']
      logon << "/#{config['password']}" if config['password'] && include_password
      logon << "@#{config['database']}" if config['database']
    end

    exec(find_cmd('sqlplus'), logon)

  else
    abort "Unknown command-line client for #{config['database']}. Submit a Rails patch to add support!"
  end
end