Class: Rails::DBConsole

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Constructor Details

#initialize(arguments = ARGV) ⇒ DBConsole

Returns a new instance of DBConsole.


49
50
51
# File 'railties/lib/rails/commands/dbconsole.rb', line 49

def initialize(arguments = ARGV)
  @arguments = arguments
end

Instance Attribute Details

#argumentsObject (readonly)

Returns the value of attribute arguments


10
11
12
# File 'railties/lib/rails/commands/dbconsole.rb', line 10

def arguments
  @arguments
end

Class Method Details

.parse_arguments(arguments) ⇒ Object


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

def parse_arguments(arguments)
  options = {}

  OptionParser.new do |opt|
    opt.banner = "Usage: rails dbconsole [environment] [options]"
    opt.on("-p", "--include-password", "Automatically provide the password from database.yml") do |v|
      options['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("--header") do |h|
      options['header'] = h
    end

    opt.on("-h", "--help", "Show this help message.") do
      puts opt
      exit
    end

    opt.on("-e", "--environment=name", String,
      "Specifies the environment to run this console under (test/development/production).",
      "Default: development"
    ) { |v| options[:environment] = v.strip }

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

  set_options_env(arguments, options)
end

Instance Method Details

#configObject


129
130
131
132
133
134
135
136
137
# File 'railties/lib/rails/commands/dbconsole.rb', line 129

def config
  @config ||= begin
    if configurations[environment].blank?
      raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations.inspect}"
    else
      configurations[environment]
    end
  end
end

#environmentObject


139
140
141
# File 'railties/lib/rails/commands/dbconsole.rb', line 139

def environment
  Rails.respond_to?(:env) ? Rails.env : super
end

#startObject


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

def start
  options = self.class.parse_arguments(arguments)
  ENV['RAILS_ENV'] = options[:environment] || environment

  case config["adapter"]
  when /^(jdbc)?mysql/
    args = {
      'host'      => '--host',
      'port'      => '--port',
      'socket'    => '--socket',
      'username'  => '--user',
      'encoding'  => '--default-character-set',
      'sslca'     => '--ssl-ca',
      'sslcert'   => '--ssl-cert',
      'sslcapath' => '--ssl-capath',
      'sslcipher' => '--ssl-cipher',
      'sslkey'    => '--ssl-key'
    }.map { |opt, arg| "#{arg}=#{config[opt]}" if config[opt] }.compact

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

    args << config['database']

    find_cmd_and_exec(['mysql', 'mysql5'], *args)

  when /^postgres|^postgis/
    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"] && options['include_password']
    find_cmd_and_exec('psql', config["database"])

  when "sqlite3"
    args = []

    args << "-#{options['mode']}" if options['mode']
    args << "-header" if options['header']
    args << File.expand_path(config['database'], Rails.respond_to?(:root) ? Rails.root : nil)

    find_cmd_and_exec('sqlite3', *args)

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

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

    find_cmd_and_exec('sqlplus', logon)

  when "sqlserver"
    args = []

    args += ["-D", "#{config['database']}"] if config['database']
    args += ["-U", "#{config['username']}"] if config['username']
    args += ["-P", "#{config['password']}"] if config['password']

    if config['host']
      host_arg = "#{config['host']}"
      host_arg << ":#{config['port']}" if config['port']
      args += ["-S", host_arg]
    end

    find_cmd_and_exec("sqsh", *args)

  else
    abort "Unknown command-line client for #{config['database']}."
  end
end