2017-08-14 13:08:09 -04:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2017-10-21 09:08:33 -04:00
|
|
|
require "rails/command/environment_argument"
|
2016-05-28 16:04:13 -04:00
|
|
|
|
|
|
|
module Rails
|
|
|
|
class DBConsole
|
|
|
|
def self.start(*args)
|
|
|
|
new(*args).start
|
|
|
|
end
|
|
|
|
|
2016-09-18 13:17:12 -04:00
|
|
|
def initialize(options = {})
|
|
|
|
@options = options
|
2016-05-28 16:04:13 -04:00
|
|
|
end
|
|
|
|
|
|
|
|
def start
|
2017-07-16 20:11:21 -04:00
|
|
|
ENV["RAILS_ENV"] ||= @options[:environment] || environment
|
2016-05-28 16:04:13 -04:00
|
|
|
|
|
|
|
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"]
|
2017-07-22 08:45:53 -04:00
|
|
|
logon = config["username"].dup
|
2016-05-28 16:04:13 -04:00
|
|
|
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"]
|
2017-08-29 03:48:33 -04:00
|
|
|
host_arg = "#{config['host']}".dup
|
2016-05-28 16:04:13 -04:00
|
|
|
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
|
|
|
|
|
|
|
|
def config
|
|
|
|
@config ||= begin
|
2017-06-05 17:19:00 -04:00
|
|
|
# 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?
|
2016-05-28 16:04:13 -04:00
|
|
|
raise ActiveRecord::AdapterNotSpecified, "'#{environment}' database is not configured. Available configuration: #{configurations.inspect}"
|
|
|
|
else
|
2018-03-16 12:40:34 -04:00
|
|
|
configurations[connection] || configurations[environment].presence
|
2016-05-28 16:04:13 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
def environment
|
|
|
|
Rails.respond_to?(:env) ? Rails.env : Rails::Command.environment
|
|
|
|
end
|
|
|
|
|
2017-06-05 17:19:00 -04:00
|
|
|
def connection
|
|
|
|
@options.fetch(:connection, "primary")
|
|
|
|
end
|
|
|
|
|
2016-12-23 05:20:01 -05:00
|
|
|
private
|
|
|
|
def configurations # :doc:
|
2016-05-28 16:04:13 -04:00
|
|
|
require APP_PATH
|
|
|
|
ActiveRecord::Base.configurations = Rails.application.config.database_configuration
|
|
|
|
ActiveRecord::Base.configurations
|
|
|
|
end
|
|
|
|
|
2016-12-23 05:20:01 -05:00
|
|
|
def find_cmd_and_exec(commands, *args) # :doc:
|
2016-05-28 16:04:13 -04:00
|
|
|
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)
|
|
|
|
File.file?(full_path_command) && File.executable?(full_path_command)
|
|
|
|
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
|
|
|
|
end
|
|
|
|
|
|
|
|
module Command
|
2016-10-28 14:44:58 -04:00
|
|
|
class DbconsoleCommand < Base # :nodoc:
|
2016-05-28 16:04:13 -04:00
|
|
|
include EnvironmentArgument
|
|
|
|
|
|
|
|
class_option :include_password, aliases: "-p", type: :boolean,
|
|
|
|
desc: "Automatically provide the password from database.yml"
|
|
|
|
|
|
|
|
class_option :mode, enum: %w( html list line column ), type: :string,
|
|
|
|
desc: "Automatically put the sqlite3 database in the specified mode (html, list, line, column)."
|
|
|
|
|
2017-04-05 05:01:34 -04:00
|
|
|
class_option :header, type: :boolean
|
2016-05-28 16:04:13 -04:00
|
|
|
|
2017-06-05 17:19:00 -04:00
|
|
|
class_option :connection, aliases: "-c", type: :string,
|
|
|
|
desc: "Specifies the connection to use."
|
|
|
|
|
2016-05-28 16:04:13 -04:00
|
|
|
def perform
|
|
|
|
extract_environment_option_from_argument
|
|
|
|
|
2017-07-16 20:11:21 -04:00
|
|
|
# RAILS_ENV needs to be set before config/application is required.
|
|
|
|
ENV["RAILS_ENV"] = options[:environment]
|
|
|
|
|
2017-07-08 21:13:11 -04:00
|
|
|
require_application_and_environment!
|
2016-09-18 13:17:12 -04:00
|
|
|
Rails::DBConsole.start(options)
|
2016-05-28 16:04:13 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|