upsert 0.3.2 → 0.3.3

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.3.3 / 2012-06-26
+
+* Bug fixes
+
+  * Properly quote table names - don't assume that everybody has ANSI_QUOTES turned on in MySQL :)
+
 0.3.2 / 2012-06-22
 
 * Enhancements

data/README.md

@@ -1,37 +1,32 @@
 # Upsert
 
-Finally, all those SQL MERGE tricks codified so that you can do "upsert" on MySQL, PostgreSQL, and SQLite.
-
-You pass a selector that uniquely identifies a row, whether it exists or not. You pass a set of attributes that should be set on that row. Based on what database is being used, one of a number of SQL MERGE-like tricks are used.
-
-The second argument is currently (mis)named a "document" because this was inspired by [mongo-ruby-driver's update method](http://api.mongodb.org/ruby/1.6.4/Mongo/Collection.html#update-instance_method).
+MySQL, PostgreSQL, and SQLite all have different SQL MERGE tricks that you can use to simulate upsert. This library codifies them under a single syntax.
 
 ## Usage
 
-### One by one
+You pass a selector that uniquely identifies a row, whether it exists or not. You pass a set of attributes that should be set on that row. Syntax inspired by [mongo-ruby-driver's update method](http://api.mongodb.org/ruby/1.6.4/Mongo/Collection.html#update-instance_method).
 
-Faster than just doing `Pet.create`... 85% faster on PostgreSQL, for example, than all the different native ActiveRecord methods I've tried. But no validations or anything.
+### Single record
+
+    # if you have required 'upsert/active_record_upsert'
+    Pet.upsert({:name => 'Jerry'}, :breed => 'beagle')
 
-    upsert = Upsert.new Pet.connection, Pet.table_name
+    # if you're not using activerecord, that's ok
+    connection = Mysql2::Client.new([...])
+    upsert = Upsert.new connection, 'pets'
     upsert.row({:name => 'Jerry'}, :breed => 'beagle')
-    upsert.row({:name => 'Pierre'}, :breed => 'tabby')
 
-### Batch mode
+### Multiple records (batch mode)
 
-Rows are buffered in memory until it's efficient to send them to the database. Currently this only provides an advantage on MySQL because it uses `ON DUPLICATE KEY UPDATE`... but if a similar method appears in PostgreSQL, the same code will still work.
+Rows are buffered in memory until it's efficient to send them to the database.
 
-    Upsert.batch(Pet.connection, Pet.table_name) do |upsert|
+    connection = Mysql2::Client.new([...])
+    Upsert.batch(connection, 'pets') do |upsert|
       upsert.row({:name => 'Jerry'}, :breed => 'beagle')
       upsert.row({:name => 'Pierre'}, :breed => 'tabby')
     end
 
-### `ActiveRecord::Base.upsert` (optional)
-
-For bulk upserts, you probably still want to use `Upsert.batch`.
-
-    require 'upsert/active_record_upsert'
-    Pet.upsert({:name => 'Jerry'}, :breed => 'beagle')
-    Pet.upsert({:name => 'Pierre'}, :breed => 'tabby')
+Tested to be much about 85% faster on PostgreSQL and 50% faster on MySQL than comparable methods (see the tests).
 
 ### Gotchas
 
@@ -58,9 +53,10 @@ You would need to use a new `Upsert` object. On the other hand, this is totally
 Pull requests for any of these would be greatly appreciated:
 
 1. Fix SQLite tests.
-2. Provide `require 'upsert/debug'` that will make sure you are selecting on columns that have unique indexes
-2. If you think there's a fix for the "fixed column set" gotcha...
-3. Naming suggestions: should "document" be called "setters" or "attributes"?
+2. For PG, be smarter about when you create functions - try to re-use them within a connection.
+3. Provide `require 'upsert/debug'` that will make sure you are selecting on columns that have unique indexes
+4. Make `Upsert` instances accept arbitrary columns, which is what people probably expect.
+5. Naming suggestions: should "document" be called "setters" or "attributes"?
 
 ## Real-world usage
 

data/lib/upsert/mysql2_client.rb

@@ -32,7 +32,7 @@ class Upsert
     end
 
     def insert_part
-      @insert_part ||= %{INSERT INTO "#{table_name}" (#{columns.join(',')}) VALUES }
+      @insert_part ||= %{INSERT INTO #{quote_ident(table_name)} (#{columns.join(',')}) VALUES }
     end
 
     def update_part
@@ -58,16 +58,7 @@ class Upsert
 
     # since setting an option like :as => :hash actually persists that option to the client, don't pass any options
     def max_sql_bytesize
-      @max_sql_bytesize ||= begin
-        case (row = connection.query("SHOW VARIABLES LIKE 'max_allowed_packet'").first)
-        when Array
-          row[1]
-        when Hash
-          row['Value']
-        else
-          raise "Don't know what to do if connection.query returns a #{row.class}"
-        end.to_i
-      end
+      @max_sql_bytesize ||= database_variable_get(:MAX_ALLOWED_PACKET).to_i
     end
 
     def quote_boolean(v)
@@ -98,5 +89,16 @@ class Upsert
     def quote_big_decimal(v)
       v.to_s('F')
     end
+
+    def database_variable_get(k)
+      case (row = connection.query("SHOW VARIABLES LIKE '#{k}'").first)
+      when Array
+        row[1]
+      when Hash
+        row['Value']
+      else
+        raise "Don't know what to do if connection.query returns a #{row.class}"
+      end
+    end
   end
 end

data/lib/upsert/pg_connection.rb

@@ -65,7 +65,7 @@ $$
 BEGIN
   LOOP
       -- first try to update the key
-      UPDATE #{table_name} SET #{column_definitions.map { |c| "#{c.name} = #{c.input_name}" }.join(',')} WHERE #{example_row.raw_selector.keys.map { |k| "#{quote_ident(k)} = #{quote_ident([k,'input'].join('_'))}" }.join(' AND ') };
+      UPDATE #{quote_ident(table_name)} SET #{column_definitions.map { |c| "#{c.name} = #{c.input_name}" }.join(',')} WHERE #{example_row.raw_selector.keys.map { |k| "#{quote_ident(k)} = #{quote_ident([k,'input'].join('_'))}" }.join(' AND ') };
       IF found THEN
           RETURN;
       END IF;
@@ -73,7 +73,7 @@ BEGIN
       -- if someone else inserts the same key concurrently,
       -- we could get a unique-key failure
       BEGIN
-          INSERT INTO #{table_name}(#{column_definitions.map { |c| c.name }.join(',')}) VALUES (#{column_definitions.map { |c| c.input_name }.join(',')});
+          INSERT INTO #{quote_ident(table_name)}(#{column_definitions.map { |c| c.name }.join(',')}) VALUES (#{column_definitions.map { |c| c.input_name }.join(',')});
           RETURN;
       EXCEPTION WHEN unique_violation THEN
           -- Do nothing, and loop to try the UPDATE again.

data/lib/upsert/sqlite3_database.rb

@@ -4,7 +4,7 @@ class Upsert
     def chunk
       return if buffer.empty?
       row = buffer.shift
-      %{INSERT OR IGNORE INTO "#{table_name}" (#{row.columns_sql}) VALUES (#{row.values_sql});UPDATE "#{table_name}" SET #{row.set_sql} WHERE #{row.where_sql}}
+      %{INSERT OR IGNORE INTO #{quote_ident(table_name)} (#{row.columns_sql}) VALUES (#{row.values_sql});UPDATE #{quote_ident(table_name)} SET #{row.set_sql} WHERE #{row.where_sql}}
     end
 
     def execute(sql)

data/lib/upsert/version.rb

@@ -1,3 +1,3 @@
 class Upsert
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/test/shared/precision.rb

@@ -0,0 +1,8 @@
+shared_examples_for 'is precise' do
+  it "stores small numbers precisely" do
+    small = -0.00000000634943
+    upsert = Upsert.new connection, :pets
+    upsert.row({:name => 'NotJerry'}, :lovability => small)
+    Pet.first.lovability.must_equal small
+  end
+end

data/test/test_mysql2.rb

@@ -35,6 +35,8 @@ describe Upsert::Mysql2_Client do
 
   it_also 'is thread-safe'
 
+  it_also 'is precise'
+
   it_also "doesn't mess with timezones"
 
   it_also "doesn't blow up on reserved words"

data/test/test_pg.rb

@@ -37,6 +37,8 @@ describe Upsert::PG_Connection do
 
   it_also 'is thread-safe'
 
+  it_also 'is precise'
+
   it_also "doesn't mess with timezones"
 
   it_also "doesn't blow up on reserved words"

data/test/test_sqlite.rb

@@ -37,6 +37,8 @@ describe Upsert::SQLite3_Database do
 
   it_also 'is thread-safe'
 
+  it_also 'is precise'
+
   it_also "doesn't mess with timezones"
 
   it_also 'supports binary upserts'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: upsert
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2012-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -204,6 +204,7 @@ files:
 - test/shared/correctness.rb
 - test/shared/database.rb
 - test/shared/multibyte.rb
+- test/shared/precision.rb
 - test/shared/reserved_words.rb
 - test/shared/speed.rb
 - test/shared/threaded.rb
@@ -248,6 +249,7 @@ test_files:
 - test/shared/correctness.rb
 - test/shared/database.rb
 - test/shared/multibyte.rb
+- test/shared/precision.rb
 - test/shared/reserved_words.rb
 - test/shared/speed.rb
 - test/shared/threaded.rb