Class: MultitenancyTools::SchemaDumper

Inherits:
Object
  • Object
show all
Defined in:
lib/multitenancy_tools/schema_dumper.rb

Overview

SchemaDumper can be used to generate SQL dumps of the structure of a PostgreSQL schema. It requires pg_dump.

The generated dump DOES NOT contain:

  • privilege statements (GRANT/REVOKE)

  • tablespace assigments

  • ownership information

  • any table data

  • extensions (CREATE EXTENSION)

SchemaDumper is suitable to create SQL templates for SchemaCreator.

Examples:

dumper = MultitenancyTools::SchemaDumper.new('my_db', 'my_schema')
dumper.dump_to('path/to/file.sql')

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(database, schema, options = {}) ⇒ SchemaDumper

Returns a new instance of SchemaDumper.

Parameters:

  • database (String) —

    database name

  • schema (String) —

    schema name



24
25
26
27
28
29
 
# File 'lib/multitenancy_tools/schema_dumper.rb', line 24

def initialize(database, schema, options = {})
  @database = database
  @schema = schema
  @host = options.fetch(:host, '')
  @username = options.fetch(:username, '')
end

Instance Method Details

#dump_to(file, mode: 'w') ⇒ Object

Generates a dump an writes it into a file. Please see IO.new for open modes.

Parameters:

  • file (String) —

    file path

  • mode (String) (defaults to: 'w') —

    IO open mode

See Also:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/multitenancy_tools/schema_dumper.rb', line 38

def dump_to(file, mode: 'w')
  stdout, stderr, status = Dump::SchemaOnly.new(
    schema: @schema,
    host: @host,
    username: @username,
    database: @database
  ).dump

  fail(PgDumpError, stderr) unless status.success?

  File.open(file, mode) do |f|
    f.write DumpCleaner.new(stdout, @schema).clean
  end
end