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

def initialize(progress, force:)
  super(progress)
  @force = force
end

Instance Attribute Details

#force ⇒ Object (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(destination_dir, backup_id) ⇒ Object 



27
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
67
68
69
70
71
72
73
74
75
 
# File 'lib/backup/database.rb', line 27

def dump(destination_dir, backup_id)
  FileUtils.mkdir_p(destination_dir)

  each_database(destination_dir) do |database_name, current_db|
    model = current_db[:model]
    snapshot_id = current_db[:snapshot_id]

    pg_env = model.config[:pg_env]
    connection = model.connection
    active_record_config = model.config[:activerecord]
    pg_database = active_record_config[:database]

    db_file_name = file_name(destination_dir, database_name)
    FileUtils.rm_f(db_file_name)

    progress.print "Dumping PostgreSQL database #{pg_database} ... "

    pgsql_args = ["--clean"] # Pass '--clean' to include 'DROP TABLE' statements in the DB dump.
    pgsql_args << '--if-exists'
    pgsql_args << "--snapshot=#{snapshot_id}" if snapshot_id

    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

    success = with_transient_pg_env(pg_env) do
      Backup::Dump::Postgres.new.dump(pg_database, db_file_name, pgsql_args)
    end

    connection.rollback_transaction if snapshot_id

    raise DatabaseBackupError.new(active_record_config, db_file_name) unless success

    report_success(success)
    progress.flush
  end
ensure
  ::Gitlab::Database::EachDatabase.each_connection(
    only: base_models_for_backup.keys, include_shared: false
  ) do |connection, _|
    Gitlab::Database::TransactionTimeoutSettings.new(connection).restore_timeouts
  end
end

#post_restore_warning ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/backup/database.rb', line 150

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/backup/database.rb', line 133

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



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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/backup/database.rb', line 78

def restore(destination_dir)
  base_models_for_backup.each do |database_name, _base_model|
    backup_model = Backup::DatabaseModel.new(database_name)

    config = backup_model.config[:activerecord]

    db_file_name = file_name(destination_dir, database_name)
    database = config[:database]

    unless File.exist?(db_file_name)
      raise(Backup::Error, "Source database file does not exist #{db_file_name}") if main_database?(database_name)

      progress.puts "Source backup for the database #{database_name} doesn't exist. Skipping the task"
      return false
    end

    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
    drop_tables(database_name)

    pg_env = backup_model.config[:pg_env]
    success = with_transient_pg_env(pg_env) do
      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} ... "
          execute_and_track_errors(pg_restore_cmd(database), decompress_rd)
        end
      decompress_rd.close

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

    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
end