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.



13
14
15
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 13

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

Class Method Details

.start(*args) ⇒ Object 



9
10
11
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 9

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

Instance Method Details

#config ⇒ Object 



93
94
95
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 93

def config
  db_config.configuration_hash
end

#database ⇒ Object 



119
120
121
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 119

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

#db_config ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 98

def db_config
  return @db_config if defined?(@db_config)

  # We need to check whether the user passed the database the
  # first time around to show a consistent error message to people
  # relying on 2-level database configuration.

  @db_config = configurations.configs_for(env_name: environment, name: database, include_replicas: true)

  unless @db_config
    raise ActiveRecord::AdapterNotSpecified,
      "'#{database}' database is not configured for '#{environment}'. Available configuration: #{configurations.inspect}"
  end

  @db_config
end

#environment ⇒ Object 



115
116
117
 
# File 'lib/rails/commands/dbconsole/dbconsole_command.rb', line 115

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

#start ⇒ Object 



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

def start
  ENV["RAILS_ENV"] ||= @options[:environment] || environment
  config = db_config.configuration_hash

  case db_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 << db_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", db_config.database)

  when "sqlite3"
    args = []

    args << "-#{@options[:mode]}" if @options[:mode]
    args << "-header" if @options[:header]
    args << File.expand_path(db_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 << "@#{db_config.database}" if db_config.database
    end

    find_cmd_and_exec("sqlplus", logon)

  when "sqlserver"
    args = []

    args += ["-d", "#{db_config.database}"] if db_config.database
    args += ["-U", "#{config[:username]}"] if config[:username]
    args += ["-P", "#{config[:password]}"] if config[:password]

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

    find_cmd_and_exec("sqlcmd", *args)

  else
    abort "Unknown command-line client for #{db_config.database}."
  end
end