Module: ActiveRecord::Import::PostgreSQLAdapter

Includes:
ImportSupport, OnDuplicateKeyUpdateSupport
Included in:
ConnectionAdapters::PostgreSQLAdapter
Defined in:
lib/activerecord-import/adapters/postgresql_adapter.rb

Constant Summary collapse

MIN_VERSION_FOR_UPSERT = 
90_500

Instance Method Summary collapse

Methods included from ImportSupport

#supports_import?

Instance Method Details

#add_column_for_on_duplicate_key_update(column, options = {}) ⇒ Object

Add a column to be updated on duplicate key update



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 42

def add_column_for_on_duplicate_key_update( column, options = {} ) # :nodoc:
  arg = options[:on_duplicate_key_update]
  if arg.is_a?( Hash )
    columns = arg.fetch( :columns ) { arg[:columns] = [] }
    case columns
    when Array then columns << column.to_sym unless columns.include?( column.to_sym )
    when Hash then columns[column.to_sym] = column.to_sym
    end
  elsif arg.is_a?( Array )
    arg << column.to_sym unless arg.include?( column.to_sym )
  end
end

#duplicate_key_update_error?(exception) ⇒ Boolean

Return true if the statement is a duplicate key record error

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 129

def duplicate_key_update_error?(exception) # :nodoc:
  exception.is_a?(ActiveRecord::StatementInvalid) && exception.to_s.include?('duplicate key')
end

#insert_many(sql, values, *args) ⇒ Object

:nodoc:



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 7

def insert_many( sql, values, *args ) # :nodoc:
  number_of_inserts = 1
  ids = []

  base_sql, post_sql = if sql.is_a?( String )
    [sql, '']
  elsif sql.is_a?( Array )
    [sql.shift, sql.join( ' ' )]
  end

  sql2insert = base_sql + values.join( ',' ) + post_sql
  if post_sql =~ /RETURNING\s/
    ids = select_values( sql2insert, *args )
  else
    insert( sql2insert, *args )
  end

  ActiveRecord::Base.connection.query_cache.clear

  [number_of_inserts, ids]
end

#next_value_for_sequence(sequence_name) ⇒ Object 



29
30
31
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 29

def next_value_for_sequence(sequence_name)
  %{nextval('#{sequence_name}')}
end

#post_sql_statements(table_name, options) ⇒ Object

:nodoc:



33
34
35
36
37
38
39
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 33

def post_sql_statements( table_name, options ) # :nodoc:
  if options[:no_returning] || options[:primary_key].blank?
    super(table_name, options)
  else
    super(table_name, options) << "RETURNING #{options[:primary_key]}"
  end
end

#sql_for_conflict_target(args = {}) ⇒ Object 



113
114
115
116
117
118
119
120
121
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 113

def sql_for_conflict_target( args = {} )
  constraint_name = args[:constraint_name]
  conflict_target = args[:conflict_target]
  if constraint_name.present?
    "ON CONSTRAINT #{constraint_name} "
  elsif conflict_target.present?
    '(' << Array( conflict_target ).reject( &:empty? ).join( ', ' ) << ') '
  end
end

#sql_for_default_conflict_target(table_name) ⇒ Object 



123
124
125
126
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 123

def sql_for_default_conflict_target( table_name )
  conflict_target = primary_key( table_name )
  "(#{conflict_target}) " if conflict_target
end

#sql_for_on_duplicate_key_ignore(table_name, *args) ⇒ Object

Returns a generated ON CONFLICT DO NOTHING statement given the passed in args.



57
58
59
60
61
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 57

def sql_for_on_duplicate_key_ignore( table_name, *args ) # :nodoc:
  arg = args.first
  conflict_target = sql_for_conflict_target( arg ) if arg.is_a?( Hash )
  " ON CONFLICT #{conflict_target}DO NOTHING"
end

#sql_for_on_duplicate_key_update(table_name, *args) ⇒ Object

Returns a generated ON CONFLICT DO UPDATE statement given the passed in args.



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
93
94
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 65

def sql_for_on_duplicate_key_update( table_name, *args ) # :nodoc:
  arg = args.first
  arg = { columns: arg } if arg.is_a?( Array ) || arg.is_a?( String )
  return unless arg.is_a?( Hash )

  sql = " ON CONFLICT "
  conflict_target = sql_for_conflict_target( arg )

  columns = arg.fetch( :columns, [] )
  if columns.respond_to?( :empty? ) && columns.empty?
    return sql << "#{conflict_target}DO NOTHING"
  end

  conflict_target ||= sql_for_default_conflict_target( table_name )
  unless conflict_target
    raise ArgumentError, 'Expected :conflict_target or :constraint_name to be specified'
  end

  sql << "#{conflict_target}DO UPDATE SET "
  if columns.is_a?( Array )
    sql << sql_for_on_duplicate_key_update_as_array( table_name, columns )
  elsif columns.is_a?( Hash )
    sql << sql_for_on_duplicate_key_update_as_hash( table_name, columns )
  elsif columns.is_a?( String )
    sql << columns
  else
    raise ArgumentError, 'Expected :columns to be an Array or Hash'
  end
  sql
end

#sql_for_on_duplicate_key_update_as_array(table_name, arr) ⇒ Object

:nodoc:



96
97
98
99
100
101
102
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 96

def sql_for_on_duplicate_key_update_as_array( table_name, arr ) # :nodoc:
  results = arr.map do |column|
    qc = quote_column_name( column )
    "#{qc}=EXCLUDED.#{qc}"
  end
  results.join( ',' )
end

#sql_for_on_duplicate_key_update_as_hash(table_name, hsh) ⇒ Object

:nodoc:



104
105
106
107
108
109
110
111
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 104

def sql_for_on_duplicate_key_update_as_hash( table_name, hsh ) # :nodoc:
  results = hsh.map do |column1, column2|
    qc1 = quote_column_name( column1 )
    qc2 = quote_column_name( column2 )
    "#{qc1}=EXCLUDED.#{qc2}"
  end
  results.join( ',' )
end

#support_setting_primary_key_of_imported_objects? ⇒ Boolean

Returns:

  • (Boolean) 


141
142
143
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 141

def support_setting_primary_key_of_imported_objects?
  true
end

#supports_on_duplicate_key_ignore?(current_version = postgresql_version) ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 137

def supports_on_duplicate_key_ignore?(current_version = postgresql_version)
  supports_on_duplicate_key_update?(current_version)
end

#supports_on_duplicate_key_update?(current_version = postgresql_version) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/activerecord-import/adapters/postgresql_adapter.rb', line 133

def supports_on_duplicate_key_update?(current_version = postgresql_version)
  current_version >= MIN_VERSION_FOR_UPSERT
end