Class: Rails::DBConsole

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ DBConsole

Returns a new instance of DBConsole.



11
12
13
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 11

def initialize(options = {})
  @options = options
end

Class Method Details

.start(*args) ⇒ Object 



7
8
9
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 7

def self.start(*args)
  new(*args).start
end

Instance Method Details

#config ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 90

def config
  @config ||= begin
    # We need to check whether the user passed the connection the
    # first time around to show a consistent error message to people
    # relying on 2-level database configuration.
    if @options["connection"] && configurations[connection].blank?
      raise ActiveRecord::AdapterNotSpecified, "'#{connection}' connection is not configured. Available configuration: #{configurations.inspect}"
    elsif configurations[environment].blank? && configurations[connection].blank?
      raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations.inspect}"
    else
      configurations[environment].presence || configurations[connection]
    end
  end
end

#connection ⇒ Object 



109
110
111
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 109

def connection
  @options.fetch(:connection, "primary")
end

#environment ⇒ Object 



105
106
107
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 105

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

#start ⇒ Object 



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

def start
  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"].dup
      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']}".dup
      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