Module: PostgresUtility

Extended by:
PostgresUtility
Included in:
PostgresUtility
Defined in:
lib/postgres_utility.rb,
lib/postgres_utility/version.rb

Overview

PostgresUtility module

Constant Summary collapse

DEFAULT_BATCH_SIZE = 
1000
VERSION = 
'1.0.2'

Instance Method Summary collapse

Instance Method Details

#batch_insert(model:, values:, batch_size: DEFAULT_BATCH_SIZE, include_pkey: false) ⇒ Object

Accepts an array of hashes to insert in bulk into the table



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/postgres_utility.rb', line 450

def batch_insert(model:, values:, batch_size: DEFAULT_BATCH_SIZE, include_pkey: false)
  # Nothing to do if there are no values
  return if values.blank?

  columns = model.column_names.map(&:to_sym)
  columns.delete(model.primary_key.to_sym) unless include_pkey
  columns_string = columns.map(&:to_s).join(', ').to_s
  table = model.table_name

  value_batches = Array(values.in_groups_of(batch_size).map do |batch|
    batch.compact.map do |item|
      "(#{columns.map do |col|
            process_value(item[col])
          end.join(', ')})"
    end.join(', ')
  end)

  model.transaction do
    value_batches.each do |vb|
      rails_connection.execute("INSERT INTO #{table}(#{columns_string}) VALUES #{vb}")
    end
  end
end

#clear_table(conn, tbl_name, cond = nil) ⇒ Object 



398
399
400
401
402
403
404
405
 
# File 'lib/postgres_utility.rb', line 398

def clear_table(conn, tbl_name, cond = nil)
  stmts = if cond
            ["DELETE FROM #{tbl_name} WHERE #{cond}"]
          else
            ["DELETE FROM #{tbl_name}"]
          end
  stmts.each { |stmt| conn.execute(stmt) }
end

#clear_table_reset_sequence(tblcls) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/postgres_utility.rb', line 407

def clear_table_reset_sequence(tblcls)
  return unless tblcls.respond_to?(:table_name)

  tbl = tblcls.table_name
  stmts = ["TRUNCATE TABLE #{tbl}"]
  id = tblcls.primary_key
  schema = 'public'
  schema = tbl.split('.').first if tbl.include?('.')
  tbl_without_schema_name = tbl.split('.').last
  seq_name = "#{tbl_without_schema_name}_#{id}_seq"
  # check if sequence exists
  if tblcls.connection
           .select_value("SELECT sequence_name FROM information_schema.sequences
      WHERE sequence_name = '#{seq_name}' AND sequence_schema = '#{schema}'").present?
    stmts += [
      "ALTER SEQUENCE #{schema}.#{seq_name} RESTART",
      "UPDATE #{tbl} SET #{id} = DEFAULT"
    ]
  end
  tblcls.transaction do
    stmts.each { |stmt| tblcls.connection.execute(stmt) }
  end
  nil
end

#copy_table_query(src_table_class, dest_table_class, opts = {}) ⇒ Object

rubocop:disable Metrics/MethodLength

Raises:

  • (StandardError) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/postgres_utility.rb', line 109

def copy_table_query(src_table_class, dest_table_class, opts = {})
  unless src_table_class.respond_to?(:table_name)
    raise StandardError,
          "#{src_table_class} must be an ActiveRecord::Base Class"
  end
  unless dest_table_class.respond_to?(:table_name)
    raise StandardError,
          "#{dest_table_class} must be an ActiveRecord::Base Class"
  end

  conn = rails_connection(opts[:cls])
  src_table  = src_table_class.table_name
  dest_table = dest_table_class.table_name
  raise StandardError, "#{src_table} Table missing!" unless conn.tables.include?(src_table)
  raise StandardError, "#{dest_table} Table missing!" unless conn.tables.include?(dest_table)

  query = ''
  # truncate dest_table and insert into dest_table from src_table,
  # then vacuum dest_table
  query += "TRUNCATE TABLE #{dest_table};\n"
  id = dest_table_class.primary_key
  schema = 'public'
  schema = dest_table.split('.').first if dest_table.include?('.')
  tbl_without_schema_name = dest_table.split('.').last
  seq_name = "#{tbl_without_schema_name}_#{id}_seq"
  # check if sequence exists
  if dest_table_class.connection
                     .select_value("SELECT sequence_name FROM information_schema.sequences WHERE sequence_name = '#{seq_name}' AND sequence_schema = '#{schema}'").present?
    query += "ALTER SEQUENCE #{schema}.#{seq_name} RESTART;\n"
    query += "UPDATE #{dest_table} SET #{id} = DEFAULT;\n"
  end
  query += "INSERT INTO #{dest_table} SELECT * FROM #{src_table};"

  unless opts[:do_not_truncate_src]
    # truncate src_table and get it primed for next time
    query += "TRUNCATE TABLE #{src_table};\n"
    id = src_table_class.primary_key
    schema = 'public'
    schema = src_table.split('.').first if src_table.include?('.')
    tbl_without_schema_name = src_table.split('.').last
    seq_name = "#{tbl_without_schema_name}_#{id}_seq"
    # check if sequence exists
    if dest_table_class.connection
                       .select_value("SELECT sequence_name FROM information_schema.sequences WHERE sequence_name = '#{seq_name}' AND sequence_schema = '#{schema}'").present?
      query += "ALTER SEQUENCE #{schema}.#{seq_name} RESTART;\n"
      query += "UPDATE #{src_table} SET #{id} = DEFAULT;\n"
    end
  end
  query
end

#create_database ⇒ Object

Returns true if created, false if already exists, raise if failed.



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/postgres_utility.rb', line 72

def create_database
  # Stolen from activerecord-3.2.3\lib\active_record\railties\databases.rake
  raise 'Not implemented' unless postgresql?

  begin
    rails_connection.create_database(db_name)
    true
  rescue PG::Error, ActiveRecord::StatementInvalid => e
    return false if e.to_s.include? "database \"#{db_name}\" already exists"

    raise e
  end
end

#db_adapter_name ⇒ Object 



51
52
53
 
# File 'lib/postgres_utility.rb', line 51

def db_adapter_name
  db_connection_config[:adapter]
end

#db_connection_config ⇒ Object 



45
46
47
48
49
 
# File 'lib/postgres_utility.rb', line 45

def db_connection_config
  config = ActiveRecord::Base.connection_config
  config = rails_connection.config if config[:adapter].match(/makara/i)
  config
end

#db_name ⇒ Object 



41
42
43
 
# File 'lib/postgres_utility.rb', line 41

def db_name
  rails_connection.current_database
end

#db_size ⇒ Object 



67
68
69
 
# File 'lib/postgres_utility.rb', line 67

def db_size
  rails_connection.select_value("select pg_database_size('#{db_name}');").to_i
end

#db_version ⇒ Object 



63
64
65
 
# File 'lib/postgres_utility.rb', line 63

def db_version
  rails_connection.select_value('select version();')
end

#delete_primary_key(table) ⇒ Object 



351
352
353
 
# File 'lib/postgres_utility.rb', line 351

def delete_primary_key(table)
  rails_connection.execute "ALTER TABLE \"#{table}\" DROP CONSTRAINT \"#{table}_pkey\";"
end

#drop_database ⇒ Object 



86
87
88
 
# File 'lib/postgres_utility.rb', line 86

def drop_database
  rails_connection.drop_database(db_name)
end

#fix_sequence_value(table, key = nil, conn = nil) ⇒ Object

rubocop:enable Metrics/MethodLength



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/postgres_utility.rb', line 305

def fix_sequence_value(table, key = nil, conn = nil)
  if table.respond_to?(:table_name) # Take care of the case where table is an ActiveRecord::Base class
    conn ||= table.connection
    key ||= table.primary_key
    table = table.table_name
  else
    conn ||= rails_connection
    key ||= 'id'
  end
  seqname = "#{table}_#{key}_seq"
  unless conn.select_value("SELECT sequence_name FROM information_schema.sequences WHERE sequence_name = '#{seqname}'")
    return
  end

  maxid = conn.select_value("SELECT MAX(#{key}) from \"#{table}\"").to_i
  conn.execute("SELECT setval('#{seqname}', #{maxid});") if maxid >= 1
rescue StandardError
  Rails.logger.debug("WARNING: #{$ERROR_INFO}\n")
end

#fix_sequence_value_with_cap(table, cutoff_id = nil, key = nil, conn = nil) ⇒ Object 



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/postgres_utility.rb', line 325

def fix_sequence_value_with_cap(table, cutoff_id = nil, key = nil, conn = nil)
  if table.respond_to?(:table_name) # Take care of the case where table is an ActiveRecord::Base class
    conn ||= table.connection
    key ||= table.primary_key
    table = table.table_name
  else
    conn ||= rails_connection
    key ||= 'id'
  end
  seqname = "#{table}_#{key}_seq"
  unless conn.select_value("SELECT sequence_name FROM information_schema.sequences WHERE sequence_name = '#{seqname}'")
    return
  end

  sql = "SELECT MAX(#{key}) from \"#{table}\""
  sql << " WHERE #{key} < #{cutoff_id}" if cutoff_id
  maxid = conn.select_value(sql).to_i
  conn.execute("SELECT setval('#{seqname}', #{maxid});") if maxid >= 1
rescue StandardError
  Rails.logger.debug("WARNING: #{$ERROR_INFO}\n")
end

#get_random_record(klass, opt = nil) ⇒ Object 



432
433
434
435
436
437
438
 
# File 'lib/postgres_utility.rb', line 432

def get_random_record(klass, opt = nil)
  opt ||= {}
  c = klass.connection
  select_clause = opt[:dense] ? "MAX(\"#{klass.primary_key}\")" : 'COUNT(*)'
  cnt = c.select_value("SELECT #{select_clause} FROM \"#{klass.table_name}\"").to_i
  klass.offset(rand(cnt)).first
end

#migration_version ⇒ Object 



59
60
61
 
# File 'lib/postgres_utility.rb', line 59

def migration_version
  ActiveRecord::Migrator.current_version
end

#multi_dump_query_result_to_csv(query, csv_path, opts = {}) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/postgres_utility.rb', line 203

def multi_dump_query_result_to_csv(query, csv_path, opts = {})
  conn = rails_connection(opts[:cls])
  pg_conn = conn.raw_connection
  qcopy = "COPY (#{query}) TO STDOUT WITH DELIMITER ',' CSV HEADER"

  csv = []
  # rubocop:disable Lint/AssignmentInCondition
  pg_conn.copy_data(qcopy.to_s) do
    while row = pg_conn.get_copy_data
      csv.push(row)
    end
  end
  # rubocop:enable Lint/AssignmentInCondition

  File.open(csv_path, 'w') do |f|
    f.write(csv.join('').force_encoding('UTF-8'))
  end
end

#multi_dump_to_csv(tables, opts = {}) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/postgres_utility.rb', line 172

def multi_dump_to_csv(tables, opts = {})
  conn = rails_connection(opts[:cls])
  pg_conn = conn.raw_connection
  tables.each do |table|
    tbl = table[:tbl]
    csv_path = table[:csv_path]
    # Take care of the case where table is an ActiveRecord::Base class
    tbl = tbl.table_name if tbl.respond_to?(:table_name)
    if opts[:column_names].present? && opts[:column_names].is_a?(Array)
      cols = opts[:column_names].join(',')
      qcopy = "COPY #{tbl}(#{cols}) TO STDOUT WITH DELIMITER ',' CSV HEADER"
    else
      qcopy = "COPY #{tbl} TO STDOUT WITH DELIMITER ',' CSV HEADER"
    end

    csv = []
    # rubocop:disable Lint/AssignmentInCondition
    pg_conn.copy_data(qcopy.to_s) do
      while row = pg_conn.get_copy_data
        csv.push(row)
      end
    end
    # rubocop:enable Lint/AssignmentInCondition
    File.open(csv_path, 'w') do |f|
      csv.each_slice(100_000).each do |chunk|
        f.write(chunk.join('').force_encoding('UTF-8'))
      end
    end
  end
end

#multi_truncate_reset_populate_from_csv(tables, opts = {}) ⇒ Object

rubocop:disable Metrics/MethodLength



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/postgres_utility.rb', line 224

def multi_truncate_reset_populate_from_csv(tables, opts = {})
  # Cant execute PGConnection#copy_data within an
  # Activerecord transaction block
  # so this whole method is not in a single transaction block unfortunately

  conn = rails_connection(opts[:cls])
  pg_conn = conn.raw_connection

  # First we loop thru all tables and create a copy of each
  # Load the csv into these copy tables and these will be used
  # to populate the original tables in a transaction
  tables.each do |table|
    tblcls = table[:tblcls]
    csv_path = table[:csv_path]
    # Take care of the case where table is not an ActiveRecord::Base class
    raise StandardError, "#{tblcls} must be an ActiveRecord::Base Class" unless tblcls.respond_to?(:table_name)

    tbl = tblcls.table_name
    tbl_copy = generate_temptable_name(tbl)
    # create a regular table and not temp table here
    # since we dont want the table to be auto dropped at the end of this
    # loop (transaction), temp tables are auto dropped at the commit of
    # transaction, we will manually need to drop this table
    pg_conn.exec("CREATE TABLE #{tbl_copy} (LIKE #{tbl} INCLUDING DEFAULTS)")
    #   pg_conn.exec("DROP TABLE IF EXISTS #{tbl_copy}")
    if table[:column_names].present? && table[:column_names].is_a?(Array)
      cols = table[:column_names].join(',')
      qcopy = "COPY #{tbl_copy}(#{cols}) FROM STDIN WITH DELIMITER ',' CSV HEADER"
    else
      qcopy = "COPY #{tbl_copy} FROM STDIN WITH DELIMITER ',' CSV HEADER"
    end
    pg_conn.copy_data(qcopy.to_s) do
      File.open(csv_path, 'r').each do |line|
        pg_conn.put_copy_data(line)
      end
    end
    table[:tbl_copy] = tbl_copy
  end

  # transaction block to truncate table and reset sequence if needed
  # Populate using the copy table just created
  # drop the copy table
  query = "BEGIN;\n"
  tables.each do |table|
    tblcls = table[:tblcls]
    tbl_copy = table[:tbl_copy]
    raise StandardError, "#{tbl_copy} Table missing!" unless conn.tables.include?(tbl_copy)

    tbl = tblcls.table_name
    unless opts[:do_not_truncate]
      id = tblcls.primary_key
      schema = 'public'
      schema = tbl.split('.').first if tbl.include?('.')
      tbl_without_schema_name = tbl.split('.').last
      seq_name = "#{tbl_without_schema_name}_#{id}_seq"
      query += "TRUNCATE TABLE #{tbl};\n"
      # check if sequence exists
      if tblcls.connection
               .select_value("SELECT sequence_name FROM information_schema.sequences WHERE sequence_name = '#{seq_name}' AND sequence_schema = '#{schema}'").present?
        query += "ALTER SEQUENCE #{schema}.#{seq_name} RESTART;\n"
        query += "UPDATE #{tbl} SET #{id} = DEFAULT;\n"
      end
    end
    query += "INSERT INTO #{tbl} SELECT * FROM #{tbl_copy};"
    query += "DROP TABLE #{tbl_copy};"
  end
  query += 'COMMIT;'
  pg_conn.exec(query)

  # ensuring the sequence is reset to be > max id (postgres has a bug where sequence can sometimes can become out of sync specially when doing bulk imports)
  # refer to: https://stackoverflow.com/questions/11068800/rails-auto-assigning-id-that-already-exists
  tables.each do |table|
    tblcls = table[:tblcls]
    tblcls.connection.reset_pk_sequence!(tblcls.table_name)
  end

  tables.each { |t| vacuum_analyze(t[:tblcls], opts) } if opts[:vacuum]
end

#pending_migration? ⇒ Boolean

Copied from db:migrate:status

Returns:

  • (Boolean) 


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/postgres_utility.rb', line 24

def pending_migration?
  db_list = rails_connection
            .select_values("SELECT version FROM
                #{ActiveRecord::Migrator.schema_migrations_table_name}")
  db_list.map! { |version| format('%.3d', version) }
  ActiveRecord::Migrator.migrations_paths.each do |path|
    Dir.foreach(Rails.root.join(path)) do |file|
      # match "20091231235959_some_name.rb" and "001_some_name.rb" pattern
      if match_data == /^(\d{3,})_(.+)\.rb$/.match(file)
        is_up = db_list.delete(match_data[1])
        return true unless is_up
      end
    end
  end
  false
end

#pg_dump_custom(filename, dbname = nil) ⇒ Object 



355
356
357
358
359
360
 
# File 'lib/postgres_utility.rb', line 355

def pg_dump_custom(filename, dbname = nil)
  dbname ||= db_name
  system_with_print(
    "pg_dump #{host_param} -U #{username} -w --file=#{filename} -T data_parts -T data_part_applications --format=custom #{dbname}", "Dump #{dbname} to #{filename}"
  )
end

#pg_load(filename, dbname = nil) ⇒ Object 



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/postgres_utility.rb', line 375

def pg_load(filename, dbname = nil)
  dbname ||= db_name
  bz2 = false
  if filename.to_s.ends_with?('.sql.bz2')
    filename = filename.to_s[0..-9]
    bz2 = true
  end
  if bz2
    system_with_print(
      "bzip2 -cd #{filename}.sql.bz2 | PGPASSWORD=\'#{password}\' psql #{host_param} -q -U #{username} -w #{dbname}", "Loading #{dbname} from #{filename}"
    )
  else
    system_with_print("PGPASSWORD=\'#{password}\' psql #{host_param} -q -U #{username} -w #{dbname} < #{filename}",
                      "Loading #{dbname} from #{filename}")
  end
end

#pg_restore_data_and_schema(filename, dbname = nil) ⇒ Object 



369
370
371
372
373
 
# File 'lib/postgres_utility.rb', line 369

def pg_restore_data_and_schema(filename, dbname = nil)
  dbname ||= db_name
  system_with_print("pg_restore #{host_param} -U #{username} -w -d #{dbname} -j 4 #{filename}",
                    "Restore #{dbname} from #{filename}")
end

#pg_save_data(filename, table_name, dbname = nil) ⇒ Object 



362
363
364
365
366
367
 
# File 'lib/postgres_utility.rb', line 362

def pg_save_data(filename, table_name, dbname = nil)
  dbname ||= db_name
  system_with_print(
    "pg_dump #{host_param} -U #{username} -w -t #{table_name} --data-only --dbname=#{dbname} -f #{filename}", "Save #{dbname} to #{filename}"
  )
end

#postgresql? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/postgres_utility.rb', line 55

def postgresql?
  !!db_adapter_name.match(/postgresql/i)
end

#rails_connection(cls = nil) ⇒ Object

Shorthand for rails environment based connection



18
19
20
21
 
# File 'lib/postgres_utility.rb', line 18

def rails_connection(cls = nil)
  cls ||= ActiveRecord::Base
  cls.connection
end

#recreate_database ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/postgres_utility.rb', line 90

def recreate_database
  raise unless Rails.env.development? || Rails.env.test?
  return if create_database # Try create first

  Rails.logger.debug("Recreate the DB:#{db_name}\n")

  if postgresql?
    drop_database
    create_database
  else # My sql
    c = rails_connection
    c.recreate_database(db_name)
    c.execute("USE `#{db_name}`;")
  end
  nil # void function
end

#setup_primary_key(table, key) ⇒ Object 



347
348
349
 
# File 'lib/postgres_utility.rb', line 347

def setup_primary_key(table, key)
  rails_connection.execute "ALTER TABLE \"#{table}\" ADD PRIMARY KEY (\"#{key}\");"
end

#system_with_print(cmd, toprint = nil) ⇒ Object 



440
441
442
443
444
445
446
447
 
# File 'lib/postgres_utility.rb', line 440

def system_with_print(cmd, toprint = nil)
  toprint ||= cmd
  puts "EXEC:#{toprint} ... "
  start = Time.now
  ret = system(cmd)
  puts (ret ? 'success' : 'failed') + " (#{Time.now - start} seconds)\n"
  ret
end

#truncate_table(conn, tbl) ⇒ Object

Much faster when it works, but does not work for foreign key enable tables



393
394
395
396
 
# File 'lib/postgres_utility.rb', line 393

def truncate_table(conn, tbl)
  stmt = "TRUNCATE TABLE #{tbl}"
  conn.execute(stmt)
end

#vacuum_analyze(tbl, opts = {}) ⇒ Object

rubocop:enable Metrics/MethodLength



162
163
164
165
166
167
168
169
170
 
# File 'lib/postgres_utility.rb', line 162

def vacuum_analyze(tbl, opts = {})
  query = ''
  if tbl.respond_to?(:table_name)
    # Take care of the case where table is an ActiveRecord::Base class
    tbl = tbl.table_name
  end
  query += "VACUUM ANALYSE #{tbl};"
  rails_connection(opts[:cls]).execute(query)
end