module ForemanMaintain::Concerns::BaseDatabase
Public Instance Methods
backup_dir()
click to toggle source
TODO: remove the backup file path tools from here. Lib Utils::Backup
?
# File lib/foreman_maintain/concerns/base_database.rb, line 108 def backup_dir @backup_dir ||= File.expand_path(ForemanMaintain.config.db_backup_dir) end
backup_local(backup_file, extra_tar_options = {})
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 91 def backup_local(backup_file, extra_tar_options = {}) dir = extra_tar_options.fetch(:data_dir, data_dir) restore_dir = extra_tar_options.fetch(:restore_dir, data_dir) command = extra_tar_options.fetch(:command, 'create') FileUtils.cd(dir) do tar_options = { :archive => backup_file, :command => command, :transform => "s,^,#{restore_dir[1..]},S", :files => '*', }.merge(extra_tar_options) feature(:tar).run(tar_options) end end
configuration()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 40 def configuration raise NotImplementedError end
data_dir()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 4 def data_dir if debian_or_ubuntu? deb_postgresql_data_dir else '/var/lib/pgsql/data/' end end
db_version(config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 125 def db_version(config = configuration) if ping(config) # Note - t removes headers, -A removes alignment whitespace server_version_cmd = psql_command(config) + ' -c "SHOW server_version" -t -A' version_string = execute!(server_version_cmd, :hidden_patterns => [config['password']]) version(version_string) else raise_service_error end end
deb_postgresql_config_dirs()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 34 def deb_postgresql_config_dirs deb_postgresql_versions.map do |ver| "/etc/postgresql/#{ver}/main/" end end
deb_postgresql_data_dir()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 12 def deb_postgresql_data_dir deb_postgresql_versions.map do |ver| "/var/lib/postgresql/#{ver}/main/" end end
deb_postgresql_versions()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 18 def deb_postgresql_versions installed_pkgs = package_manager.list_installed_packages('${binary:Package}\n') @deb_postgresql_versions ||= installed_pkgs.grep(/^postgresql-\d+$/).map do |name| name.split('-').last end @deb_postgresql_versions end
dropdb(config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 112 def dropdb(config = configuration) if local? execute!("runuser - postgres -c 'dropdb #{config['database']}'") else delete_statement = psql(<<-SQL) select string_agg('drop table if exists \"' || tablename || '\" cascade;', '') from pg_tables where schemaname = 'public'; SQL psql(delete_statement) end end
dump_db(file, config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 72 def dump_db(file, config = configuration) execute!(dump_command(config) + " > #{file}", :hidden_patterns => [config['password']]) end
local?(config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 44 def local?(config = configuration) ['localhost', '127.0.0.1', `hostname`.strip].include?(config['host']) end
ping(config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 66 def ping(config = configuration) execute?(psql_command(config), :stdin => 'SELECT 1 as ping', :hidden_patterns => [config['password']]) end
postgresql_conf()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 26 def postgresql_conf return "#{data_dir}/postgresql.conf" if el? deb_postgresql_config_dirs.map do |conf_dir| "#{conf_dir}postgresql.conf" end end
psql(query, config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 56 def psql(query, config = configuration) if ping(config) execute(psql_command(config), :stdin => query, :hidden_patterns => [config['password']]) else raise_service_error end end
psql_cmd_available?()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 136 def psql_cmd_available? exit_status, _output = execute_with_status('which psql') exit_status == 0 end
query(sql, config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 48 def query(sql, config = configuration) parse_csv(query_csv(sql, config)) end
query_csv(sql, config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 52 def query_csv(sql, config = configuration) psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER}, config) end
raise_psql_missing_error()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 141 def raise_psql_missing_error raise Error::Fail, 'The psql command not found.'\ ' Make sure system has psql utility installed.' end
restore_dump(file, localdb, config = configuration)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 76 def restore_dump(file, localdb, config = configuration) if localdb dump_cmd = "runuser - postgres -c 'pg_restore -C -d postgres #{file}'" execute!(dump_cmd) else # TODO: figure out how to completely ignore errors. Currently this # sometimes exits with 1 even though errors are ignored by pg_restore dump_cmd = base_command(config, 'pg_restore') + ' --no-privileges --clean --disable-triggers -n public ' \ "-d #{config['database']} #{file}" execute!(dump_cmd, :hidden_patterns => [config['password']], :valid_exit_statuses => [0, 1]) end end
Private Instance Methods
base_command(config, command = 'psql')
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 148 def base_command(config, command = 'psql') "PGPASSWORD='#{config[%(password)]}' "\ "#{command} -h #{config['host'] || 'localhost'} "\ " -p #{config['port'] || '5432'} -U #{config['username']}" end
dump_command(config)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 158 def dump_command(config) base_command(config, 'pg_dump') + " -Fc #{config['database']}" end
psql_command(config)
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 154 def psql_command(config) base_command(config, 'psql') + " -d #{config['database']}" end
raise_service_error()
click to toggle source
# File lib/foreman_maintain/concerns/base_database.rb, line 162 def raise_service_error raise Error::Fail, 'Please check whether database service is up & running state.' end