Class: Gitlab::Database::SchemaCleaner

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/database/schema_cleaner.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(original_schema) ⇒ SchemaCleaner

Returns a new instance of SchemaCleaner.



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

def initialize(original_schema)
  @original_schema = original_schema
end

Instance Attribute Details

#original_schema ⇒ Object (readonly)

Returns the value of attribute original_schema.



6
7
8
 
# File 'lib/gitlab/database/schema_cleaner.rb', line 6

def original_schema
  @original_schema
end

Instance Method Details

#clean(io) ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
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
 
# File 'lib/gitlab/database/schema_cleaner.rb', line 12

def clean(io)
  structure = original_schema.dup

  # Remove noise
  structure.gsub!(/^COMMENT ON EXTENSION.*/, '')
  structure.gsub!(/^SET.+/, '')
  structure.gsub!(/^SELECT pg_catalog\.set_config\('search_path'.+/, '')
  structure.gsub!(/^--.*/, "\n")

  # We typically don't assume we're working with the public schema.
  # pg_dump uses fully qualified object names though, since we have multiple schemas
  # in the database.
  #
  # The intention here is to not introduce an assumption about the standard schema,
  # unless we have a good reason to do so.
  structure.gsub!(/public\.(\w+)/, '\1')
  structure.gsub!(
    /CREATE EXTENSION IF NOT EXISTS (\w+) WITH SCHEMA public;/,
    'CREATE EXTENSION IF NOT EXISTS \1;'
  )

  # Table lock-writes triggers should not be added to the schema
  # These triggers are added by the rake task gitlab:db:lock_writes for a decomposed database.
  structure.gsub!(
    %r{
      ^CREATE.TRIGGER.gitlab_schema_write_trigger_\w+
      \s
      BEFORE.INSERT.OR.DELETE.OR.UPDATE.OR.TRUNCATE.ON.\w+
      \s
      FOR.EACH.STATEMENT.EXECUTE.FUNCTION.gitlab_schema_prevent_write\(\);$
    }x,
    ''
  )

  structure.gsub!(/\n{3,}/, "\n\n")

  io << structure.strip
  io << "\n"

  nil
end