Class: Backup::Database

Inherits:
Object
  • Object
show all
Includes:
Helper
Defined in:
lib/backup/database.rb

Constant Summary collapse

IGNORED_ERRORS =
[
  # 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 Helper

#access_denied_error, #gzip_cmd, #resource_busy_error

Constructor Details

#initialize(progress, filename: nil) ⇒ Database

Returns a new instance of Database.


19
20
21
22
23
# File 'lib/backup/database.rb', line 19

def initialize(progress, filename: nil)
  @progress = progress
  @config = YAML.load_file(File.join(Rails.root, 'config', 'database.yml'))[Rails.env]
  @db_file_name = filename || File.join(Gitlab.config.backup.path, 'db', 'database.sql.gz')
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

#db_file_nameObject (readonly)

Returns the value of attribute db_file_name


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

def db_file_name
  @db_file_name
end

#progressObject (readonly)

Returns the value of attribute progress


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

def progress
  @progress
end

Instance Method Details

#dumpObject

Raises:


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

def dump
  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 #{config['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, config['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 Backup::Error, 'Backup failed' unless success
end

#restoreObject

Raises:


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/backup/database.rb', line 65

def restore
  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 #{config['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

  errors
end