Module: ForemanMaintain::Concerns::BaseDatabase

Defined in:
lib/foreman_maintain/concerns/base_database.rb

Instance Method Summary collapse

Instance Method Details

#backup_db_command(file_path, config = configuration) ⇒ Object

TODO: refactor to use dump_db



132
133
134
135
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 132

def backup_db_command(file_path, config = configuration)
  pg_dump_cmd = "pg_dump -Fc #{config['database']}"
  "runuser - postgres -c '#{pg_dump_cmd}' | bzip2 -9 > #{file_path}"
end

#backup_dir ⇒ Object

TODO: remove the backup file path tools from here. Lib Utils::Backup?



138
139
140
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 138

def backup_dir
  @backup_dir ||= File.expand_path(ForemanMaintain.config.db_backup_dir)
end

#backup_file_path(config = configuration) ⇒ Object 



87
88
89
90
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 87

def backup_file_path(config = configuration)
  dump_file_name = "#{config['database']}_#{Time.now.strftime('%Y-%m-%d_%H-%M-%S')}.dump"
  "#{backup_dir}/#{dump_file_name}.bz2"
end

#backup_global_objects(file) ⇒ Object 



142
143
144
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 142

def backup_global_objects(file)
  execute!("runuser - postgres -c 'pg_dumpall -g > #{file}'")
end

#backup_local(backup_file, extra_tar_options = {}) ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 116

def backup_local(backup_file, extra_tar_options = {})
  dir = extra_tar_options.fetch(:data_dir, data_dir)
  command = extra_tar_options.fetch(:command, 'create')

  FileUtils.cd(dir) do
    tar_options = {
      :archive => backup_file,
      :command => command,
      :transform => "s,^,#{dir[1..-1]},S",
      :files => '*'
    }.merge(extra_tar_options)
    feature(:tar).run(tar_options)
  end
end

#config_files ⇒ Object 



53
54
55
56
57
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 53

def config_files
  [
    '/etc/systemd/system/postgresql.service'
  ]
end

#configuration ⇒ Object

Raises:

  • (NotImplementedError) 


49
50
51
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 49

def configuration
  raise NotImplementedError
end

#data_dir ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 4

def data_dir
  if el7? && package_manager.installed?('rh-postgresql12-postgresql-server-syspaths')
    '/var/opt/rh/rh-postgresql12/lib/pgsql/data/'
  elsif debian_or_ubuntu?
    deb_postgresql_data_dir
  else
    '/var/lib/pgsql/data/'
  end
end

#db_version(config = configuration) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 193

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 ⇒ Object 



36
37
38
39
40
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 36

def deb_postgresql_config_dirs
  deb_postgresql_versions.map do |ver|
    "/etc/postgresql/#{ver}/main/"
  end
end

#deb_postgresql_data_dir ⇒ Object 



14
15
16
17
18
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 14

def deb_postgresql_data_dir
  deb_postgresql_versions.map do |ver|
    "/var/lib/postgresql/#{ver}/main/"
  end
end

#deb_postgresql_versions ⇒ Object 



20
21
22
23
24
25
26
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 20

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

#delete_records_by_ids(tbl_name, rec_ids) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 165

def delete_records_by_ids(tbl_name, rec_ids)
  quotize_rec_ids = rec_ids.map { |el| "'#{el}'" }.join(',')
  unless quotize_rec_ids.empty?
    psql(<<-SQL)
      BEGIN;
       DELETE FROM #{tbl_name} WHERE id IN (#{quotize_rec_ids});
      COMMIT;
    SQL
  end
end

#dropdb(config = configuration) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 180

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) ⇒ Object 



92
93
94
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 92

def dump_db(file, config = configuration)
  execute!(dump_command(config) + " > #{file}", :hidden_patterns => [config['password']])
end

#find_base_directory(directory) ⇒ Object 



176
177
178
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 176

def find_base_directory(directory)
  find_dir_containing_file(directory, 'postgresql.conf')
end

#local?(config = configuration) ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 59

def local?(config = configuration)
  ['localhost', '127.0.0.1', `hostname`.strip].include? config['host']
end

#perform_backup(config = configuration) ⇒ Object 



146
147
148
149
150
151
152
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 146

def perform_backup(config = configuration)
  file_path = backup_file_path(config)
  backup_cmd = backup_db_command(file_path, config)
  execute!(backup_cmd, :hidden_patterns => [config['password']])
  puts "\n Note: Database backup file path - #{file_path}"
  puts "\n In case of any exception, use above dump file to restore DB."
end

#ping(config = configuration) ⇒ Object 



81
82
83
84
85
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 81

def ping(config = configuration)
  execute?(psql_command(config),
           :stdin => 'SELECT 1 as ping',
           :hidden_patterns => [config['password']])
end

#postgresql_conf ⇒ Object 



28
29
30
31
32
33
34
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 28

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) ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 71

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? ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
207
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 204

def psql_cmd_available?
  exit_status, _output = execute_with_status('which psql')
  exit_status == 0
end

#query(sql, config = configuration) ⇒ Object 



63
64
65
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 63

def query(sql, config = configuration)
  parse_csv(query_csv(sql, config))
end

#query_csv(sql, config = configuration) ⇒ Object 



67
68
69
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 67

def query_csv(sql, config = configuration)
  psql(%{COPY (#{sql}) TO STDOUT WITH CSV HEADER}, config)
end

#raise_psql_missing_error ⇒ Object

Raises:



209
210
211
212
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 209

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) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 96

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

#restore_pg_globals(pg_globals, config = configuration) ⇒ Object 



111
112
113
114
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 111

def restore_pg_globals(pg_globals, config = configuration)
  execute!(base_command(config, 'psql') + " -f #{pg_globals} postgres 2>/dev/null",
           :hidden_patterns => [config['password']])
end

#restore_transform ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 42

def restore_transform
  if el8?
    # this allows to transform an EL7 backup to EL8 paths
    's,^var/opt/rh/rh-postgresql12/,var/,S'
  end
end

#table_exist?(table_name) ⇒ Boolean

Returns:

  • (Boolean) 


154
155
156
157
158
159
160
161
162
163
 
# File 'lib/foreman_maintain/concerns/base_database.rb', line 154

def table_exist?(table_name)
  sql = <<-SQL
    SELECT EXISTS ( SELECT *
    FROM information_schema.tables WHERE table_name =  '#{table_name}' )
  SQL
  result = query(sql)
  return false if result.nil? || (result && result.empty?)

  result.first['exists'].eql?('t')
end