bulk-insert-active-record 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50a047ec99ae044e95e2ece35f7ed6a98f774369
+  data.tar.gz: c81b2276e7d97ba319cbfed840c28eff00b0db12
+SHA512:
+  metadata.gz: 6bf3fca5d20ee03cbc94ea6de6de28e7940074c17106ecc36eb8ebbb0a31e63d96debcb3a46456055591e768e3b5e024a84abd6a4f0f91dacedbd8cf7a39b14a
+  data.tar.gz: 72bad9ef5d4e3ca8f1990fd95ccaad3c4ea7bd2984fcc48c1a3e704a5c46b67e348426c333941a1b0c9c65ccb8cd3a00172d8d3363d193eae6dfed391a6dda2a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+bulk-insert-active-record

data/Gemfile

@@ -0,0 +1,3 @@
+source('https://rubygems.org')
+
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# Bulk Insert Active Record (for ActiveRecord 3 or higher)
+
+This gem extends Active Record and allows you to insert multiple records in one SQL statement,
+dramatically increasing performance.
+
+## Current status
+
+This gem is currently actively in development, but because it's already useful, I've decided to
+publish it in its premature state. Right now it has been manually tested with MySQL and SQL Server
+via JDBC.
+
+## Usage
+
+Installation is done by adding the gem your *Gemfile* and running Bundler. After loading Active
+Record an extra class method is available for your models.
+
+## Examples
+
+Suppose you want to insert multiple Post records in the database. This can be done in different
+ways:
+
+	# suppose it has 3 columns (`id`, `author` and `text`)
+	class Post < ActiveRecord::Base
+	end	
+
+	# create an array of arrays
+	posts = [
+		# author, # text
+		['John Doe', 'An article about me'],
+		['John Smith', 'Something interesting']
+	]
+
+	# call class method bulk_insert with two arguments (the posts and the column names)
+	Post.bulk_insert(posts, ['author', 'name])
+
+
+# Copyright
+
+&copy; 2014 Walter Horstman, [IT on Rails](http://itonrails.com)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bulk-insert-active-record.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'bulk-insert-active-record'
+  spec.summary               = 'Lightweight bulk insert mechanism for ActiveRecord 3 or higher'
+  spec.description           = 'This gem allows you to insert multiple rows as once, dramatically increasing performance.'
+  spec.version               = '0.0.1'
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.author                = 'Walter Horstman'
+  spec.email                 = 'walter.horstman@itonrails.com'
+  spec.homepage              = 'https://github.com/walterhorstman/bulk-insert-active-record'
+
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.executables           = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path          = 'lib'
+
+  spec.add_dependency('activerecord', '>= 3')
+end

data/lib/bulk-insert-active-record.rb

@@ -0,0 +1,45 @@
+require_relative('inserters')
+
+module BulkInsertActiveRecord
+
+  def self.included(base)
+    base.class_eval do
+
+      def self.bulk_insert(records, column_names = self.column_names)
+        fail('No connection with the database') unless self.connection.active?
+
+        inserter = Inserters::factory(self)
+        self.transaction do
+          if inserter.nil?
+            self.insert_one_by_one(records, column_names)
+          else
+            sql = inserter.statement(records, column_names)
+            self.connection.insert(sql)
+          end
+        end
+      end
+
+      private
+
+      def self.insert_one_by_one(records, column_names)
+        self.transaction do
+          records.each do |record|
+            if record.is_a?(self)
+              record.save
+            else
+              item = self.new
+              column_names.each_with_index do |column_name, index|
+                item[column_name] = record[index]
+              end
+              item.save
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  include(BulkInsertActiveRecord)
+end

data/lib/inserters.rb

@@ -0,0 +1,16 @@
+Dir[File.expand_path('../inserters/*.rb', __FILE__)].each { |file_name| require(file_name) }
+
+module BulkInsertActiveRecord
+  module Inserters
+
+    def self.factory(active_record_class, options = {})
+      inserter_class = case active_record_class.connection.adapter_name.downcase
+                       when 'mssql', 'mysql', 'sqlserver' then Base
+                       when 'oracle' then Oracle
+                       else nil
+                       end
+
+      inserter_class.nil? ? nil : inserter_class.new(active_record_class, options)
+    end
+  end
+end

data/lib/inserters/base.rb

@@ -0,0 +1,36 @@
+# This base implementation works for MySQL and SQLServer
+module BulkInsertActiveRecord
+  module Inserters
+    class Base
+
+      def initialize(active_record_class, options = {})
+        @connection = active_record_class.connection
+        @quoted_table_name = active_record_class.quoted_table_name
+
+        # basic bulk insert statement
+        @statement = options[:statement] || 'INSERT INTO %{table_name}(%{columns_clause}) VALUES %{values_clause}'
+        # character(s) used to separate columns in the columns_clause of the statement
+        @column_separator = options[:column_separator] || ','
+        # character(s) used to separate records in the values_clause of the statement
+        @record_separator = options[:record_separator] || ','
+        # sql fragment for individual records in the values_clause of the statement
+        @record_statement = options[:record_statement] || '(%{value_clause})'
+        # character(s) used to separate values in the value_clause of the record statement
+        @value_separator = options[:value_separator] || ','
+      end
+
+      # returns bulk insert statement
+      def statement(records, column_names)
+        @statement % {
+          table_name: @quoted_table_name,
+          columns_clause: column_names.map { |column_name| @connection.quote_column_name(column_name) }.join(@column_separator),
+          values_clause: records.map do |record|
+            @record_statement % {
+              value_clause: record.map { |value| @connection.quote(value) }.join(@value_separator)
+            }
+          end.join(@record_separator)
+        }
+      end
+    end
+  end
+end

data/lib/inserters/oracle.rb

@@ -0,0 +1,16 @@
+require_relative('base')
+
+module BulkInsertActiveRecord
+  module Inserters
+    class Oracle < Base
+
+      def initialize(active_record_class, options = {})
+        super(active_record_class, {
+          statement: 'INSERT INTO %{table_name}(%{columns_clause}) %{values_clause}',
+          record_statement: 'SELECT %{value_clause} FROM dual',
+          record_separator: ' UNION '
+        }.merge(options))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: bulk-insert-active-record
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Walter Horstman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: This gem allows you to insert multiple rows as once, dramatically increasing
+  performance.
+email: walter.horstman@itonrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- Gemfile
+- README.md
+- Rakefile
+- bulk-insert-active-record.gemspec
+- lib/bulk-insert-active-record.rb
+- lib/inserters.rb
+- lib/inserters/base.rb
+- lib/inserters/oracle.rb
+homepage: https://github.com/walterhorstman/bulk-insert-active-record
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lightweight bulk insert mechanism for ActiveRecord 3 or higher
+test_files: []