postgres_upsert 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00a22a21bea95bc98d7a991c5ed30a5bbea6a67c
-  data.tar.gz: 9824edf28ac08e7a8aed28ebcdee8c07c46ffa11
+  metadata.gz: a30c825147ef323c1e0d60d9fc08e9668b6bdf02
+  data.tar.gz: d3f8799b61a273b4abde1eae7a6b38eea3ba614c
 SHA512:
-  metadata.gz: b6183d68e0791491f6417ffbc99b7f2a984090aa3640f1348cfe74e39e11011edce3985029b259bd28296fc7725ad4def14db3f209d95b15f7324d2ebb5dbba3
-  data.tar.gz: 4dd39aa87168d5866874de9c6a11097731e015bbdea624535164f413cf1fabb7c9fbca73612c805289db800383d134c5e88f1198efe2cc9d7d365a72f4f2a9be
+  metadata.gz: 07649b13cae7be995e12c02e5418bde744f932127587141a160bd09f502f9342f2ce5f2038d20953eed9425043f67c056dde96dec78ed5a8fcf5ec0c11392bea
+  data.tar.gz: e963592a3c91c61d206d018cbcc63aa07995a50165c97dbb88e9352e8b16c76cdcbaef85a9c9b655716d0e0ab387c9c155bf1890200374ce074e5405899929fd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postgres_upsert (0.1.0)
+    postgres_upsert (1.0.0)
       activerecord (>= 3.0.0)
       pg (~> 0.17.0)
       rails (>= 3.0.0)

data/README.md

@@ -75,6 +75,17 @@ This merge/upsert happend in 5 steps (assume your data table is called "users")
 * issue a query to update all records in users with the data in users_temp_### (matching on primary key)
 * drop the temp table.
 
+### overriding the key_column
+
+By default pg_upsert uses the primary key on your ActiveRecord table to determine if each record should be inserted or updated.  You can override the column using the :key_field option:
+
+```ruby
+User.pg_upsert "/tmp/users.dat", :format => :binary, :key_column => ["external_twitter_id"]
+```
+
+obviously, the field you pass must be a unique key in your database (this is not enforced at the moment, but will be)
+
+
 ## Note on Patches/Pull Requests
 
 * Fork the project

data/lib/postgres_upsert/active_record.rb

@@ -7,7 +7,7 @@ module ActiveRecord
     # * You can map fields from the file to different fields in the table using a map in the options hash
     # * For further details on usage take a look at the README.md
     def self.pg_upsert path_or_io, options = {}
-      options.reverse_merge!({:delimiter => ",", :format => :csv, :header => true})
+      options.reverse_merge!({:delimiter => ",", :format => :csv, :header => true, :key_column => primary_key})
       options_string = options[:format] == :binary ? "BINARY" : "DELIMITER '#{options[:delimiter]}' CSV"
 
       io = path_or_io.instance_of?(String) ? File.open(path_or_io, 'r') : path_or_io
@@ -20,7 +20,7 @@ module ActiveRecord
       destination_table = get_table_name(options)
 
       columns_string = columns_string_for_copy(columns_list)
-      create_temp_table(copy_table, destination_table, columns_list) if destination_table
+      create_temp_table(copy_table, destination_table, columns_list, options) if destination_table
 
       connection.raw_connection.copy_data %{COPY #{copy_table} #{columns_string} FROM STDIN #{options_string}} do
         if block_given?
@@ -33,7 +33,7 @@ module ActiveRecord
       end
 
       if destination_table
-        upsert_from_temp_table(copy_table, destination_table, columns_list)
+        upsert_from_temp_table(copy_table, destination_table, columns_list, options)
         drop_temp_table(copy_table)
       end
     end
@@ -80,9 +80,9 @@ module ActiveRecord
       str
     end
 
-    def self.select_string_for_create(columns_list)
+    def self.select_string_for_create(columns_list, options)
       columns = columns_list.map(&:to_sym)
-      columns << primary_key.to_sym unless columns.include?(primary_key.to_sym)
+      columns << options[:key_column].to_sym unless columns.include?(options[:key_column].to_sym)
       get_columns_string(columns)
     end
 
@@ -119,18 +119,18 @@ module ActiveRecord
       end
     end
 
-    def self.upsert_from_temp_table(temp_table, dest_table, columns_list)
-      update_from_temp_table(temp_table, dest_table, columns_list)
-      insert_from_temp_table(temp_table, dest_table, columns_list)
+    def self.upsert_from_temp_table(temp_table, dest_table, columns_list, options)
+      update_from_temp_table(temp_table, dest_table, columns_list, options)
+      insert_from_temp_table(temp_table, dest_table, columns_list, options)
     end
 
-    def self.update_from_temp_table(temp_table, dest_table, columns_list)
+    def self.update_from_temp_table(temp_table, dest_table, columns_list, options)
       ActiveRecord::Base.connection.execute <<-SQL
         UPDATE #{dest_table} AS d
           #{update_set_clause(columns_list)}
           FROM #{temp_table} as t
-          WHERE t.#{primary_key} = d.#{primary_key}
-          AND d.#{primary_key} IS NOT NULL;
+          WHERE t.#{options[:key_column]} = d.#{options[:key_column]}
+          AND d.#{options[:key_column]} IS NOT NULL;
       SQL
     end
 
@@ -142,7 +142,7 @@ module ActiveRecord
       "SET #{command.join(',')}"
     end
 
-    def self.insert_from_temp_table(temp_table, dest_table, columns_list)
+    def self.insert_from_temp_table(temp_table, dest_table, columns_list, options)
       columns_string = columns_string_for_insert(columns_list)
       select_string = select_string_for_insert(columns_list)
       ActiveRecord::Base.connection.execute <<-SQL
@@ -152,13 +152,13 @@ module ActiveRecord
           WHERE NOT EXISTS 
             (SELECT 1 
                   FROM #{dest_table} as d 
-                  WHERE d.#{primary_key} = t.#{primary_key})
-          AND t.#{primary_key} IS NOT NULL;
+                  WHERE d.#{options[:key_column]} = t.#{options[:key_column]})
+          AND t.#{options[:key_column]} IS NOT NULL;
       SQL
     end
 
-    def self.create_temp_table(temp_table, dest_table, columns_list)
-      columns_string = select_string_for_create(columns_list)
+    def self.create_temp_table(temp_table, dest_table, columns_list, options)
+      columns_string = select_string_for_create(columns_list, options)
       ActiveRecord::Base.connection.execute <<-SQL
         SET client_min_messages=WARNING;
         DROP TABLE IF EXISTS #{temp_table};

data/postgres_upsert.gemspec

@@ -5,7 +5,7 @@ $:.unshift lib unless $:.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "postgres_upsert"
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version     = ">= 1.8.7"

data/spec/fixtures/no_id.csv

@@ -0,0 +1,2 @@
+data,extra
+old stuff,ABC: Always Be Changing.

data/spec/pg_upsert_csv_spec.rb

@@ -4,6 +4,7 @@ describe "pg_upsert from file with CSV format" do
   before(:each) do
     ActiveRecord::Base.connection.execute %{
       TRUNCATE TABLE test_models;
+      TRUNCATE TABLE three_columns;
       SELECT setval('test_models_id_seq', 1, false);
     }
   end
@@ -183,5 +184,27 @@ describe "pg_upsert from file with CSV format" do
       ).to eq('id' => 1, 'data' => 'test data 1', 'extra' => "neva change!", 'created_at' => original_created_at, 'updated_at' => timestamp)
     end
   end
+
+  context 'overriding the comparison column' do
+    it 'updates records based the match column option if its passed in' do
+      three_col = ThreeColumn.create(id: 1, data: "old stuff", extra: "neva change!")
+      file = File.open(File.expand_path('spec/fixtures/no_id.csv'), 'r')
+
+
+      ThreeColumn.pg_upsert(file, :key_column => "data")
+      expect(
+        three_col.reload.extra
+      ).to eq("ABC: Always Be Changing.")
+    end
+
+    it 'inserts records if the passed match column doesnt exist' do
+      file = File.open(File.expand_path('spec/fixtures/no_id.csv'), 'r')
+
+      ThreeColumn.pg_upsert(file, :key_column => "data")
+      expect(
+        ThreeColumn.last.attributes
+      ).to include("id" => 1, "data" => "old stuff", "extra" => "ABC: Always Be Changing.")
+    end
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postgres_upsert
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Steve Mitchell
@@ -130,6 +130,7 @@ files:
 - spec/fixtures/comma_with_header_and_comma_values.csv
 - spec/fixtures/comma_with_header_and_unquoted_comma.csv
 - spec/fixtures/comma_without_header.csv
+- spec/fixtures/no_id.csv
 - spec/fixtures/reserved_word_model.rb
 - spec/fixtures/reserved_words.csv
 - spec/fixtures/semicolon_with_different_header.csv
@@ -176,6 +177,7 @@ test_files:
 - spec/fixtures/comma_with_header_and_comma_values.csv
 - spec/fixtures/comma_with_header_and_unquoted_comma.csv
 - spec/fixtures/comma_without_header.csv
+- spec/fixtures/no_id.csv
 - spec/fixtures/reserved_word_model.rb
 - spec/fixtures/reserved_words.csv
 - spec/fixtures/semicolon_with_different_header.csv