Class: ActiveRecord::Tasks::PostgreSQLDatabaseTasks

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/tasks/postgresql_database_tasks.rb

Overview

:nodoc:

Constant Summary collapse

DEFAULT_ENCODING =
ENV["CHARSET"] || "utf8"
ON_ERROR_STOP_1 =
"ON_ERROR_STOP=1"
SQL_COMMENT_BEGIN =
"--"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db_config) ⇒ PostgreSQLDatabaseTasks

Returns a new instance of PostgreSQLDatabaseTasks.


19
20
21
22
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 19

def initialize(db_config)
  @db_config = db_config
  @configuration_hash = db_config.configuration_hash
end

Class Method Details

.using_database_configurations?Boolean

Returns:

  • (Boolean)

15
16
17
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 15

def self.using_database_configurations?
  true
end

Instance Method Details

#charsetObject


35
36
37
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 35

def charset
  connection.encoding
end

#collationObject


39
40
41
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 39

def collation
  connection.collation
end

#create(master_established = false) ⇒ Object


24
25
26
27
28
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 24

def create(master_established = false)
  establish_master_connection unless master_established
  connection.create_database(db_config.database, configuration_hash.merge(encoding: encoding))
  establish_connection(db_config)
end

#dropObject


30
31
32
33
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 30

def drop
  establish_master_connection
  connection.drop_database(db_config.database)
end

#purgeObject


43
44
45
46
47
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 43

def purge
  clear_active_connections!
  drop
  create true
end

#structure_dump(filename, extra_flags) ⇒ Object


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
76
77
78
79
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 49

def structure_dump(filename, extra_flags)
  set_psql_env

  search_path = \
    case ActiveRecord::Base.dump_schemas
    when :schema_search_path
      configuration_hash[:schema_search_path]
    when :all
      nil
    when String
      ActiveRecord::Base.dump_schemas
    end

  args = ["--schema-only", "--no-privileges", "--no-owner", "--file", filename]
  args.concat(Array(extra_flags)) if extra_flags
  unless search_path.blank?
    args += search_path.split(",").map do |part|
      "--schema=#{part.strip}"
    end
  end

  ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
  if ignore_tables.any?
    args += ignore_tables.flat_map { |table| ["-T", table] }
  end

  args << db_config.database
  run_cmd("pg_dump", args, "dumping")
  remove_sql_header_comments(filename)
  File.open(filename, "a") { |f| f << "SET search_path TO #{connection.schema_search_path};\n\n" }
end

#structure_load(filename, extra_flags) ⇒ Object


81
82
83
84
85
86
87
# File 'activerecord/lib/active_record/tasks/postgresql_database_tasks.rb', line 81

def structure_load(filename, extra_flags)
  set_psql_env
  args = ["--set", ON_ERROR_STOP_1, "--quiet", "--no-psqlrc", "--file", filename]
  args.concat(Array(extra_flags)) if extra_flags
  args << db_config.database
  run_cmd("psql", args, "loading")
end