Class: Backup::Database

Inherits:
Task
  • Object
show all
Extended by:
Gitlab::Utils::Override
Includes:
Helper
Defined in:
lib/backup/database.rb

Constant Summary collapse

IGNORED_ERRORS =
[
  # Ignore warnings
  /WARNING:/,
  # Ignore the DROP errors; recent database dumps will use --if-exists with pg_dump
  /does not exist$/,
  # User may not have permissions to drop extensions or schemas
  /must be owner of/
].freeze
IGNORED_ERRORS_REGEXP =
Regexp.union(IGNORED_ERRORS).freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Methods included from Helper

#access_denied_error, #gzip_cmd, #resource_busy_error

Constructor Details

#initialize(progress, force:) ⇒ Database

Returns a new instance of Database.


21
22
23
24
25
# File 'lib/backup/database.rb', line 21

def initialize(progress, force:)
  super(progress)
  @config = ActiveRecord::Base.configurations.find_db_config(Rails.env).configuration_hash
  @force = force
end

Instance Attribute Details

#configObject (readonly)

Returns the value of attribute config.


9
10
11
# File 'lib/backup/database.rb', line 9

def config
  @config
end

#forceObject (readonly)

Returns the value of attribute force.


9
10
11
# File 'lib/backup/database.rb', line 9

def force
  @force
end

Instance Method Details

#dump(db_file_name, backup_id) ⇒ Object


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
# File 'lib/backup/database.rb', line 28

def dump(db_file_name, backup_id)
  FileUtils.mkdir_p(File.dirname(db_file_name))
  FileUtils.rm_f(db_file_name)
  compress_rd, compress_wr = IO.pipe
  compress_pid = spawn(gzip_cmd, in: compress_rd, out: [db_file_name, 'w', 0600])
  compress_rd.close

  dump_pid =
    case config[:adapter]
    when "postgresql" then
      progress.print "Dumping PostgreSQL database #{database} ... "
      pg_env
      pgsql_args = ["--clean"] # Pass '--clean' to include 'DROP TABLE' statements in the DB dump.
      pgsql_args << '--if-exists'

      if Gitlab.config.backup.pg_schema
        pgsql_args << '-n'
        pgsql_args << Gitlab.config.backup.pg_schema

        Gitlab::Database::EXTRA_SCHEMAS.each do |schema|
          pgsql_args << '-n'
          pgsql_args << schema.to_s
        end
      end

      Process.spawn('pg_dump', *pgsql_args, database, out: compress_wr)
    end
  compress_wr.close

  success = [compress_pid, dump_pid].all? do |pid|
    Process.waitpid(pid)
    $?.success?
  end

  report_success(success)
  progress.flush

  raise DatabaseBackupError.new(config, db_file_name) unless success
end

#post_restore_warningObject


125
126
127
128
129
130
131
132
133
134
135
# File 'lib/backup/database.rb', line 125

def post_restore_warning
  return unless @errors.present?

  <<-MSG.strip_heredoc
    There were errors in restoring the schema. This may cause
    issues if this results in missing indexes, constraints, or
    columns. Please record the errors above and contact GitLab
    Support if you have questions:
    https://about.gitlab.com/support/
  MSG
end

#pre_restore_warningObject


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/backup/database.rb', line 108

def pre_restore_warning
  return if force

  <<-MSG.strip_heredoc
    Be sure to stop Puma, Sidekiq, and any other process that
    connects to the database before proceeding. For Omnibus
    installs, see the following link for more information:
    https://docs.gitlab.com/ee/raketasks/backup_restore.html#restore-for-omnibus-gitlab-installations

    Before restoring the database, we will remove all existing
    tables to avoid future upgrade problems. Be aware that if you have
    custom tables in the GitLab database these tables and all data will be
    removed.
  MSG
end

#restore(db_file_name) ⇒ Object

Raises:


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
# File 'lib/backup/database.rb', line 69

def restore(db_file_name)
  unless force
    progress.puts 'Removing all tables. Press `Ctrl-C` within 5 seconds to abort'.color(:yellow)
    sleep(5)
  end

  # Drop all tables Load the schema to ensure we don't have any newer tables
  # hanging out from a failed upgrade
  puts_time 'Cleaning the database ... '.color(:blue)
  Rake::Task['gitlab:db:drop_tables'].invoke
  puts_time 'done'.color(:green)

  decompress_rd, decompress_wr = IO.pipe
  decompress_pid = spawn(*%w(gzip -cd), out: decompress_wr, in: db_file_name)
  decompress_wr.close

  status, @errors =
    case config[:adapter]
    when "postgresql" then
      progress.print "Restoring PostgreSQL database #{database} ... "
      pg_env
      execute_and_track_errors(pg_restore_cmd, decompress_rd)
    end
  decompress_rd.close

  Process.waitpid(decompress_pid)
  success = $?.success? && status.success?

  if @errors.present?
    progress.print "------ BEGIN ERRORS -----\n".color(:yellow)
    progress.print @errors.join.color(:yellow)
    progress.print "------ END ERRORS -------\n".color(:yellow)
  end

  report_success(success)
  raise Backup::Error, 'Restore failed' unless success
end