multisert 0.0.3 → 0.0.4

data/README.md

@@ -71,6 +71,22 @@ script. This ensures that any pending entries are written to the database table
 that were not automatically taken care of by the auto-write that will kick in
 during the iteration.
 
+## Insert Strategies
+
+Multisert defaults to using `INSERT INTO` on `#write!`, but you can set the
+insert strategy to `REPLACE INTO` or `INSERT IGNORE`:
+
+```ruby
+buffer = Multisert.new
+#=> would use INSERT INTO on #write! by default
+
+buffer.insert_strategy = :replace
+#=> would now use REPLACE INTO on #write!
+
+buffer.insert_strategy = :ignore
+#=> would now use INSERT IGNORE on #write!
+```
+
 ## Performance
 
 ### Individual vs Buffer

data/lib/multisert.rb

@@ -1,11 +1,14 @@
 class Multisert
   MAX_BUFFER_COUNT_DEFAULT = 10_000
+  INSERT_OPERATION_DEFAULT = 'INSERT INTO'
 
-  attr_accessor :connection
-  attr_accessor :database
-  attr_accessor :table
-  attr_accessor :fields
-  attr_writer   :max_buffer_count
+  attr_accessor :connection,
+                :database,
+                :table,
+                :fields,
+                :insert_strategy
+
+  attr_writer :max_buffer_count
 
   def initialize attrs = {}
     attrs.each do |attr, value|
@@ -42,6 +45,10 @@ class Multisert
 
 private
 
+  def insert_strategy?
+    !!insert_strategy
+  end
+
   def buffer
     @buffer ||= []
   end
@@ -63,7 +70,7 @@ private
   end
 
   def multisert_preamble
-    "INSERT INTO #{database}.#{table} (#{fields.join(',')}) VALUES"
+    "#{insert_operation} #{database}.#{table} (#{fields.join(',')}) VALUES"
   end
 
   def multisert_values
@@ -73,6 +80,16 @@ private
     }.join(",")
   end
 
+  def insert_operation
+    return INSERT_OPERATION_DEFAULT unless insert_strategy?
+
+    case insert_strategy.to_s.downcase
+    when 'replace' then 'REPLACE INTO'
+    when 'ignore'  then 'INSERT IGNORE'
+    else raise "no operation for \"#{insert_strategy}\" insert strategy"
+    end
+  end
+
   def cast value
     case value
     # TODO: want to escape the string too, checking for " and ;

data/lib/multisert/version.rb

@@ -1,3 +1,3 @@
 class Multisert
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/multisert_spec.rb

@@ -3,8 +3,9 @@ require './spec/spec_helper'
 require './lib/multisert'
 
 # TODO: allow overriding in yaml config
-TEST_DATABASE = 'multisert_test'
-TEST_TABLE    = 'test_data'
+TEST_DATABASE      = 'multisert_test'
+TEST_TABLE         = 'test_data'
+TEST_INDEXED_TABLE = 'test_indexed_data'
 
 # TODO: make into yaml config
 $connection = Mysql2::Client.new(host: 'localhost', username: 'root')
@@ -18,8 +19,13 @@ $cleaner = MultisertSpec::MrClean.new(database: TEST_DATABASE, connection: $conn
       test_field_int_4 int default null,
       test_field_varchar varchar(10) default null,
       test_field_date DATE default null,
-      test_field_datetime DATETIME default null
-    )]
+      test_field_datetime DATETIME default null)]
+
+  mgr.create_table_schemas << %[
+    CREATE TABLE IF NOT EXISTS #{mgr.database}.#{TEST_INDEXED_TABLE} (
+      test_id int not null,
+      test_field varchar(15) default null,
+      primary key (test_id))]
 end
 
 describe Multisert do
@@ -48,8 +54,7 @@ describe Multisert do
     end
 
     it "does not fall over when there are no entries" do
-      write_buffer_records = connection.query "DELETE FROM #{TEST_DATABASE}.#{TEST_TABLE}"
-      expect(write_buffer_records.to_a).to eq []
+      connection.query "DELETE FROM #{TEST_DATABASE}.#{TEST_TABLE}"
 
       buffer.write_buffer!
 
@@ -58,7 +63,7 @@ describe Multisert do
       expect(buffer.entries).to eq []
     end
 
-    it "multi-inserts all added entries" do
+    it "multi-inserts all added entries and clears #entries" do
       pre_write_buffer_records = connection.query "SELECT * FROM #{TEST_DATABASE}.#{TEST_TABLE}"
       expect(pre_write_buffer_records.to_a).to eq []
 
@@ -89,8 +94,7 @@ describe Multisert do
         {'test_field_int_1' => 1,  'test_field_int_2' => 3,  'test_field_int_3' => 4,  'test_field_int_4' => 5},
         {'test_field_int_1' => 6,  'test_field_int_2' => 7,  'test_field_int_3' => 8,  'test_field_int_4' => 9},
         {'test_field_int_1' => 10, 'test_field_int_2' => 11, 'test_field_int_3' => 12, 'test_field_int_4' => 13},
-        {'test_field_int_1' => 14, 'test_field_int_2' => 15, 'test_field_int_3' => 16, 'test_field_int_4' => 17}
-      ]
+        {'test_field_int_1' => 14, 'test_field_int_2' => 15, 'test_field_int_3' => 16, 'test_field_int_4' => 17}]
 
       expect(buffer.entries).to eq []
     end
@@ -116,8 +120,7 @@ describe Multisert do
         {'test_field_varchar' => 'a'},
         {'test_field_varchar' => 'b'},
         {'test_field_varchar' => 'c'},
-        {'test_field_varchar' => 'd'}
-      ]
+        {'test_field_varchar' => 'd'}]
 
       expect(buffer.entries).to eq []
     end
@@ -146,8 +149,7 @@ describe Multisert do
         {'test_field_date' => Date.parse('2013-01-15')},
         {'test_field_date' => Date.parse('2013-01-16')},
         {'test_field_date' => Date.parse('2013-01-17')},
-        {'test_field_date' => Date.parse('2013-01-18')}
-      ]
+        {'test_field_date' => Date.parse('2013-01-18')}]
 
       expect(buffer.entries).to eq []
     end
@@ -195,4 +197,87 @@ describe Multisert do
       expect(flush_method).to eq instance.method(:write_buffer!)
     end
   end
+
+  describe "#insert_strategy" do
+    let(:connection) { $connection }
+    let(:buffer) { described_class.new }
+
+    before do
+      $cleaner.ensure_clean_database! teardown_tables: (!!ENV['TEARDOWN'] || false)
+    end
+
+    context "set to replace" do
+      it "writes over an existing record with the same primary / unique key" do
+        connection.query %[INSERT INTO #{TEST_DATABASE}.#{TEST_INDEXED_TABLE} (test_id, test_field)
+                           VALUES (1, 'ONE'), (2, 'TWO')]
+
+        buffer.connection      = connection
+        buffer.database        = TEST_DATABASE
+        buffer.table           = TEST_INDEXED_TABLE
+        buffer.fields          = ['test_id', 'test_field']
+        buffer.insert_strategy = :replace
+
+        buffer << [1, 'SOMETHING NEW']
+
+        buffer.write_buffer!
+
+        post_write_buffer_records = connection.query %[
+          SELECT
+              test_id
+            , test_field
+          FROM #{TEST_DATABASE}.#{TEST_INDEXED_TABLE}]
+
+        expect(post_write_buffer_records.to_a).to eq [
+          {'test_id' => 1, 'test_field' => 'SOMETHING NEW'},
+          {'test_id' => 2, 'test_field' => 'TWO'}]
+      end
+    end
+
+    context "set to ignore" do
+      before do
+        connection.query %[INSERT INTO #{TEST_DATABASE}.#{TEST_INDEXED_TABLE} (test_id, test_field)
+                           VALUES (1, 'ONE'), (2, 'TWO')]
+
+        buffer.connection      = connection
+        buffer.database        = TEST_DATABASE
+        buffer.table           = TEST_INDEXED_TABLE
+        buffer.fields          = ['test_id', 'test_field']
+        buffer.insert_strategy = :ignore
+
+        buffer << [1, 'NEW']
+      end
+
+      it "does not raise an error" do
+        expect { buffer.write_buffer! }.to_not raise_error
+      end
+
+      it "writes over an existing record with the same primary / unique key" do
+        buffer.write_buffer!
+
+        post_write_buffer_records = connection.query %[
+          SELECT
+              test_id
+            , test_field
+          FROM #{TEST_DATABASE}.#{TEST_INDEXED_TABLE}]
+
+        expect(post_write_buffer_records.to_a).to eq [
+          {'test_id' => 1, 'test_field' => 'ONE'},
+          {'test_id' => 2, 'test_field' => 'TWO'}]
+      end
+    end
+
+    context "set to non-supported insert strategy" do
+      it "tells of an error" do
+        buffer.connection      = connection
+        buffer.database        = TEST_DATABASE
+        buffer.table           = TEST_INDEXED_TABLE
+        buffer.fields          = ['test_id', 'test_field']
+        buffer.insert_strategy = :some_bogus_operation
+
+        buffer << [1, 'NEW']
+
+        expect { buffer.write_buffer! }.to raise_error
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multisert
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2