Module: BulkUpdate::ActiveRecordInflections

Defined in:
lib/bulk_update/active_record_inflections.rb

Instance Method Summary collapse

Instance Method Details

#bulk_insert(columns, values, args = {}) ⇒ Object

Bulk insert records



37
38
39
40
41
42
43
44
45
46
47
48
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
80
81
 
# File 'lib/bulk_update/active_record_inflections.rb', line 37

def bulk_insert(columns, values, args = {})
  # Limit inserts
  max_records_per_insert = args[:max_records_per_insert] || 100
  table                  = args[:into] || table_name
  columns                = columns.clone

  # Add timestamp
  timestamp      = Time.now.to_s(:db)
  add_timestamp  = false
  add_updated_at = false
  unless columns.map(&:to_sym).include?(:created_at)
    columns << :created_at
    add_created_at = true
  end
  unless columns.map(&:to_sym).include?(:updated_at)
    columns << :updated_at
    add_updated_at = true
  end

  if table_name
    # Create header for insert with all column names
    case ActiveRecord::Base.connection_config[:adapter]
    when 'postgresql'
      columns = columns.map! { |c| "\"#{c}\"" }
      insert_head = "INSERT INTO \"#{table}\" (#{columns.join(', ')})"
    else
      columns = columns.map!{ |c| "`#{c}`" }
      insert_head = "INSERT INTO `#{table}` (#{columns.join(', ')})"
    end

    # Create inserts
    inserts = []
    values.each do |values_per_record|
      values_per_record = values_per_record.clone
      values_per_record << timestamp if add_created_at
      values_per_record << timestamp if add_updated_at
      inserts << "(#{values_per_record.map{ |e| insert_str(e) }.join(', ')})"
      if inserts.count > max_records_per_insert
        ActiveRecord::Base.connection.execute "#{insert_head} VALUES #{inserts.join(', ')}"
        inserts.clear
      end
    end
    ActiveRecord::Base.connection.execute "#{insert_head} VALUES #{inserts.join(', ')}" unless inserts.empty?
  end
end

#bulk_update(columns, values, args = {}) ⇒ Object

Create, update and delete Records according to a set of new values through ActiveRecord but optimized for performance by finding all diferences by SQL.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/bulk_update/active_record_inflections.rb', line 87

def bulk_update(columns, values, args = {})
  temp_table     = "#{table_name}_temp_table_#{$$}"
  key            = args[:key] || args[:keys] || 'id'
  condition      = args[:condition]
  exclude_fields = args[:exclude_fields]
  insert         = args[:insert].nil? ? true : args[:insert]
  update         = args[:update].nil? ? true : args[:update]
  remove         = args[:remove].nil? ? true : args[:remove]

  # Clone temp-table and load it
  clone_table to: temp_table
  bulk_insert columns, values, into: temp_table

  # Find differences and create, update and delete these through ActiveRecord to handle Callbacks, etc.
  create(get_new_records for: self, compare_with: temp_table, on: key, condition: condition, exclude_fields: exclude_fields) if insert
  if update
    get_updated_records(for: self, compare_with: temp_table, on: key, condition: condition, exclude_virtual: args[:exclude_virtual], exclude_fields: exclude_fields).each do |id, new_attributes|
      find(id).update_attributes new_attributes
    end
  end
  destroy(get_deleted_records for: self, compare_with: temp_table, on: key, condition: condition, exclude_virtual: args[:exclude_virtual]) if remove

ensure
  # Drop temp table
  ActiveRecord::Base.connection.execute "DROP TABLE IF EXISTS #{temp_table}"
end

#clone_table(args = {}) ⇒ Object

Clone the database structure of a table



5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/bulk_update/active_record_inflections.rb', line 5

def clone_table(args = {})
  if args[:to]
    case ActiveRecord::Base.connection_config[:adapter]
    when 'sqlite3'
      ActiveRecord::Base.connection.execute "CREATE TABLE `#{args[:to]}` AS SELECT * FROM `#{table_name}` LIMIT 1"
      ActiveRecord::Base.connection.execute "DELETE FROM `#{args[:to]}`"
    when 'postgresql'
      ActiveRecord::Base.connection.execute "CREATE TABLE \"#{args[:to]}\" (LIKE \"#{table_name}\" INCLUDING DEFAULTS INCLUDING CONSTRAINTS INCLUDING INDEXES);"
    else
      ActiveRecord::Base.connection.execute "CREATE TABLE `#{args[:to]}` LIKE `#{table_name}`"
    end
  end
end

#default_exclude ⇒ Object

Exclude List



117
118
119
 
# File 'lib/bulk_update/active_record_inflections.rb', line 117

def default_exclude
  @default_exclude ||= ['id', 'created_at', 'updated_at']
end

#default_exclude=(excludes) ⇒ Object

Exclude List



124
125
126
 
# File 'lib/bulk_update/active_record_inflections.rb', line 124

def default_exclude=(excludes)
  @default_exclude = excludes
end

#get_deleted_records(args = {}) ⇒ Object

Compare Table of args with its temporary table args and return all deleted records as a Array of IDs



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
 
# File 'lib/bulk_update/active_record_inflections.rb', line 232

def get_deleted_records(args = {})
  model           = args[:for] || self
  compare_table   = args[:compare_with]
  keys            = args[:on] || 'id'
  exclude_virtual = args[:exclude_virtual].nil? ? false : args[:exclude_virtual]

  # Generate conditions for query and sub-query
  conditions    =  []
  conditions2   =  []
  conditions    << "NOT #{model.table_name}.virtual" if exclude_virtual
  conditions    << "#{args[:condition].gsub('--tt--', model.table_name)}" if args[:condition]
  conditions2   << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
  if keys.class == String || keys.class == Symbol
    key = keys.to_s
  else
    key = keys[0].to_s
    conditions2 |= keys[1..-1].map{|k| "#{model.table_name}.#{k.to_s} = #{compare_table}.#{k.to_s}" }
  end

  # Generate and execute SQL-Statement
  condition  = conditions.join(' AND ')
  condition2 = conditions2.join(' AND ')
  sql        = "SELECT id, #{key} FROM #{model.table_name} WHERE #{condition} #{'AND' unless conditions.blank?} #{model.table_name}.#{key} NOT IN " +
               "(SELECT #{key} FROM #{compare_table} #{'WHERE' unless conditions2.blank?} #{condition2})"
  results    = ActiveRecord::Base.connection.execute sql

  # Generate Array with ids of all deleted records
  deleted_records = []
  keys_to_log     = []
  results.each do |attributes|
    attributes      =  attributes2array(attributes)
    deleted_records << attributes[0]
    keys_to_log     << attributes[1]
  end
  args[:logger].info "Deleting Records from Model #{model.to_s}: #{keys_to_log.join(', ')}" unless keys_to_log.blank? || args[:logger].blank?
  deleted_records
end

#get_new_records(args = {}) ⇒ Object

Compare Table of args with its temporary table args and return all new records as a Array of Hashes



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
159
160
161
162
163
164
165
166
167
 
# File 'lib/bulk_update/active_record_inflections.rb', line 131

def get_new_records(args = {})
  model         =  args[:for] || self
  compare_table =  args[:compare_with]
  keys          =  args[:on] || 'id'
  exclude       =  args[:exclude_fields] || []
  exclude       |= default_exclude - %w(created_at updated_at)

  # Generate conditions for query and sub-query
  conditions  =  []
  conditions2 =  []
  conditions  << "#{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
  conditions2 << "#{args[:condition].gsub('--tt--', model.table_name)}" if args[:condition]
  if keys.class == String || keys.class == Symbol
    key = keys.to_s
  else
    key = keys[0].to_s
    conditions2 << keys[1..-1].map{|k| "#{model.table_name}.#{k.to_s} = #{compare_table}.#{k.to_s}" }
  end

  # Generate and execute SQL-Statement
  condition  = conditions.join(' AND ')
  condition2 = conditions2.join(' AND ')
  sql = "SELECT * FROM #{compare_table} WHERE #{condition} #{'AND' unless conditions.blank?} #{compare_table}.#{key} NOT IN " +
        "(SELECT #{key} FROM #{model.table_name} #{'WHERE' unless conditions2.blank?} #{condition2})"
  results = ActiveRecord::Base.connection.execute sql

  # Generate Array with Hashes of all new records
  new_records = []
  keys_to_log = []
  results.each do |attributes|
    attributes = attributes2array(attributes)
    new_records << result2hash(attributes, exclude)
    keys_to_log << new_records.last[key.to_sym]
  end
  args[:logger].info "New Records for Model #{model.to_s}: #{keys_to_log.join(', ')}" unless keys_to_log.blank? || args[:logger].blank?
  new_records
end

#get_updated_records(args = {}) ⇒ Object

Compare Table of args with its temporary table args and return all updated records as a Hash of Hashes whose key is the ID of the changed record



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/bulk_update/active_record_inflections.rb', line 173

def get_updated_records(args = {})
  model           =  args[:for] || self
  compare_table   =  args[:compare_with]
  keys            =  args[:on] || 'id'
  exclude         =  args[:exclude_fields] || []
  exclude         |= default_exclude
  exclude_virtual =  args[:exclude_virtual].nil? ? false : args[:exclude_virtual]

  # Generate conditions for query and sub-query
  conditions  = []
  conditions2 = []
  conditions << "NOT #{model.table_name}.virtual" if exclude_virtual
  if keys.class == String || keys.class == Symbol
    key        =  keys.to_s
    conditions << "#{model.table_name}.#{key} = #{compare_table}.#{key}"
    exclude    |= [keys.to_s]
  else
    key        =  keys[0].to_s
    conditions |= keys.map{|k| "#{model.table_name}.#{k.to_s} = #{compare_table}.#{k.to_s}" }
    exclude    |= keys.map(&:to_s)
  end
  conditions << "#{args[:condition].gsub('--tt--', model.table_name)} AND #{args[:condition].gsub('--tt--', compare_table)}" if args[:condition]
  model.attribute_names.each do |an|
    unless exclude.include?(an)
      case ActiveRecord::Base.connection_config[:adapter]
      when /mysql?/
        conditions2 << "NOT #{model.table_name}.#{an} <=> #{compare_table}.#{an}"
      when 'postgresql'
        conditions2 << "#{model.table_name}.#{an} IS DISTINCT FROM #{compare_table}.#{an}"
      else
        conditions2 << "(#{model.table_name}.#{an} IS NOT NULL AND #{compare_table}.#{an} IS NOT NULL AND #{model.table_name}.#{an} != #{compare_table}.#{an}) OR (#{model.table_name}.#{an} IS NOT NULL AND #{compare_table}.#{an} IS NULL) OR (#{model.table_name}.#{an} IS NULL AND #{compare_table}.#{an} IS NOT NULL)"
      end
    end
  end

  # Generate and execute SQL-Statement
  condition       =  conditions.join(' AND ')
  condition       += " AND (#{conditions2.join(' OR ')})" unless conditions2.blank?
  compare_columns =  attribute_names.select { |e| e != 'id' }.map { |e| "#{compare_table}.#{e}" }.join(', ')
  sql             =  "SELECT #{model.table_name}.id, #{compare_columns} FROM #{model.table_name}, #{compare_table} WHERE #{condition}"
  results         =  ActiveRecord::Base.connection.execute sql

  # Generate Hash with id as the key and values as a Hashes of all changed records
  results_hash = {}
  keys_to_log  = []
  results.each do |attributes|
    attributes       =  attributes2array(attributes)
    id               =  attributes[0]
    results_hash[id] =  result2hash attributes, exclude - %w(updated_at)
    keys_to_log      << (args[:debug] ? model.find(id).send(key) : id)
  end
  args[:logger].info "Change Records for Model #{model.to_s}: #{keys_to_log.join(', ')}" unless keys_to_log.blank? || args[:logger].blank?

  results_hash
end

#insert_str(element) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/bulk_update/active_record_inflections.rb', line 20

def insert_str(element)
  if element.class == Fixnum || element.class == Float
    element
  elsif element.class == NilClass
    'NULL'
  else
    if element.to_s[0] == '(' || element.to_s.downcase == 'true' || element.to_s.downcase == 'false'
      element.to_s
    else
      "'#{element}'"
    end
  end
end