edge badge
Methods
C
D
E
F
N
S
Class Public methods
new(options = {})
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 13
def initialize(options = {})
  @options = options
end
start(*args)
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 9
def self.start(*args)
  new(*args).start
end
Instance Public methods
config()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 92
def config
  db_config.configuration_hash
end
database()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 117
def database
  @options.fetch(:database, "primary")
end
db_config()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 96
def db_config
  return @db_config if @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, spec_name: database)

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

  @db_config
end
environment()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 113
def environment
  Rails.respond_to?(:env) ? Rails.env : Rails::Command.environment
end
start()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 17
def start
  ENV["RAILS_ENV"] ||= @options[:environment] || environment

  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 = +"#{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 #{db_config.database}."
  end
end
Instance Private methods
configurations()
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 122
def configurations # :doc:
  require APP_PATH
  ActiveRecord::Base.configurations = Rails.application.config.database_configuration
  ActiveRecord::Base.configurations
end
find_cmd_and_exec(commands, *args)
# File railties/lib/rails/commands/dbconsole/dbconsole_command.rb, line 128
def find_cmd_and_exec(commands, *args) # :doc:
  commands = Array(commands)

  dirs_on_path = ENV["PATH"].to_s.split(File::PATH_SEPARATOR)
  unless (ext = RbConfig::CONFIG["EXEEXT"]).empty?
    commands = commands.map { |cmd| "#{cmd}#{ext}" }
  end

  full_path_command = nil
  found = commands.detect do |cmd|
    dirs_on_path.detect do |path|
      full_path_command = File.join(path, cmd)
      begin
        stat = File.stat(full_path_command)
      rescue SystemCallError
      else
        stat.file? && stat.executable?
      end
    end
  end

  if found
    exec full_path_command, *args
  else
    abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
  end
end