mschuerig-index_lifter 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-04-02
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/index_lifter.rb
+test/test_helper.rb
+test/test_index_lifter.rb

data/README.rdoc

@@ -0,0 +1,75 @@
+= index_lifter
+
+http://github.com/mschuerig/index_lifter
+
+== DESCRIPTION:
+
+ActiveRecord utility class that disables database indexes during a block.
+
+== FEATURES/PROBLEMS:
+
+* Speeds up large database imports and large-scale data generation
+* Only use it in "maintenance mode", i.e., when there are no other
+  connections to the database.
+* If your application depends on unique indexes for working properly
+  even during data generation, make sure they are not lifted.
+
+== SYNOPSIS:
+
+  desc "Populate the database with sample data"
+  task :populate => :environment do
+
+    retained_indexes = [
+      'index_people_on_lastname_and_firstname',
+      { :table => :movies, :columns => :title }
+      { :table => 'people', :columns => ['lastname', :firstname] }
+    ]
+
+    ActiveRecord::Base.transaction do
+      IndexLifter.without_indexes(
+        :movies,                       # Only consider indexes on these tables;
+        :people,                       #   all tables by default.
+        :except => retained_indexes,   # Don't lift these indexes
+        :except_unique => true         # Don't lift unique indexes; default: false.
+      ) do
+        ActiveRecord::Base.silence do
+
+          # import or generate large amounts of data here
+
+        end
+      end
+    end
+  end
+
+== REQUIREMENTS:
+
+* ActiveRecord
+
+== INSTALL:
+
+* sudo gem install index_lifter
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Michael Schuerig
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,23 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/index_lifter'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('index_lifter', IndexLifter::VERSION) do |p|
+  p.developer('Michael Schuerig', 'michael@schuerig.de')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps         = [
+    ['activesupport','>= 2.0.2'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/index_lifter.rb

@@ -0,0 +1,66 @@
+
+class IndexLifter
+  VERSION = '0.0.1'
+  SYSTEM_TABLES = ['schema_migrations'].freeze
+  attr_reader :tables, :indexes
+  
+  def self.without_indexes(*tables, &block)
+    IndexLifter.new(*tables).without_indexes(&block)
+  end
+  
+  def initialize(*tables)
+    @options = tables.extract_options!
+    @connection = @options[:connection] || ActiveRecord::Base.connection
+    @tables = (tables.empty? ? @connection.tables : tables) - SYSTEM_TABLES
+    @indexes = index_definitions
+    @tables.freeze
+    @indexes.freeze
+  end
+  
+  def without_indexes(&block)
+    lift_indexes(indexes)
+    yield
+  ensure
+    reinstate_indexes(indexes)
+  end
+  
+  private
+
+  def index_definitions
+    indexes = @tables.inject([]) { |defs, table|
+      defs += @connection.indexes(table)
+    }
+    if @options[:except_unique]
+      indexes.delete_if(&:unique)
+    end
+    exceptions = [@options[:except]].flatten
+    
+    exception_names = exceptions.map { |exc|
+      (exc.kind_of?(::Hash) ? exc[:name] : exc)
+    }.compact.map(&:to_s)
+    indexes.delete_if { |idx| exception_names.include?(idx.name) }
+    
+    exception_hashes = exceptions.select { |exc| exc.kind_of?(::Hash) }.map { |exc|
+      { :table => exc[:table].to_s,
+        :columns => Array(exc[:column] || exc[:columns]).map(&:to_s)
+      }}
+    indexes.delete_if { |idx| exception_hashes.any? { |exc|
+        exc[:table]   == idx.table && 
+        exc[:columns] == idx.columns
+      }}
+    
+    indexes
+  end
+  
+  def lift_indexes(indexes)
+    indexes.each do |idx|
+      @connection.remove_index(idx.table, :name => idx.name)
+    end
+  end
+  
+  def reinstate_indexes(indexes)
+    indexes.each do |idx|
+      @connection.add_index(idx.table, idx.columns, :unique => idx.unique)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/index_lifter'

data/test/test_index_lifter.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+require 'active_support'
+
+class TestIndexLifter < Test::Unit::TestCase
+  
+  class TestConnection
+    #<struct ActiveRecord::ConnectionAdapters::IndexDefinition 
+    #  table="movies",
+    #  name="index_movies_on_title",
+    #  unique=false,
+    #  columns=["title"]>
+    class IndexDefinition < Struct.new(:table, :name, :unique, :columns)
+      def to_hash
+        { :table => table, :name => name, :unique => unique, :columns => columns }
+      end
+    end
+      
+    def initialize(*defs)
+      @indexes = defs.inject({}) do |memo, idef|
+        memo[idef[:table].to_s] ||= []
+        memo[idef[:table].to_s] << IndexDefinition.new(
+          idef[:table].to_s,
+          idef[:name].to_s,
+          idef[:unique],
+          Array(idef[:columns]).map { |c| c.to_s }
+        )
+        memo
+      end
+    end
+    def tables
+      @indexes.keys.sort
+    end
+    def indexes(table)
+      @indexes[table.to_s]
+    end
+  end
+  
+  def setup
+    @index_people_on_lastname_firstname_unique = {
+      :name => 'index_people_on_lastname_firstname',
+      :table => 'people', :columns => ['lastname', 'firstname'], :unique => true
+    }
+    @index_movies_on_title = {
+      :name => 'index_movies_on_title',
+      :table => 'movies', :columns => ['title'], :unique => false
+    }
+    @connection = TestConnection.new(
+      @index_movies_on_title,
+      @index_people_on_lastname_firstname_unique
+    )
+  end
+  
+  def test_find_indexes
+    lifter = IndexLifter.new(:connection => @connection)
+    assert_equal [@index_movies_on_title, @index_people_on_lastname_firstname_unique], 
+      lifter.indexes.map(&:to_hash)
+  end
+  
+  def test_exclude_unique_indexes
+    lifter = IndexLifter.new(:connection => @connection,
+      :except_unique => true)
+    assert_equal [@index_movies_on_title], 
+      lifter.indexes.map(&:to_hash)
+  end
+  
+  def test_exclude_index_by_name_as_string
+    lifter = IndexLifter.new(:connection => @connection,
+      :except => 'index_people_on_lastname_firstname')
+    assert_equal [@index_movies_on_title], 
+      lifter.indexes.map(&:to_hash)
+  end
+
+  def test_exclude_index_by_hashed_name
+    lifter = IndexLifter.new(:connection => @connection,
+      :except => { :name => 'index_people_on_lastname_firstname' })
+    assert_equal [@index_movies_on_title], 
+      lifter.indexes.map(&:to_hash)
+  end
+
+  def test_exclude_index_by_name_array
+    lifter = IndexLifter.new(:connection => @connection,
+      :except => ['index_people_on_lastname_firstname'])
+    assert_equal [@index_movies_on_title], 
+      lifter.indexes.map(&:to_hash)
+  end
+
+  def test_exclude_index_by_table_and_column
+    lifter = IndexLifter.new(:connection => @connection,
+      :except => { :table => :movies, :column => :title})
+    assert_equal [@index_people_on_lastname_firstname_unique], 
+      lifter.indexes.map(&:to_hash)
+  end
+
+  def test_exclude_index_by_table_and_columns
+    lifter = IndexLifter.new(:connection => @connection,
+      :except => { :table => :people, :columns => [:lastname, :firstname]})
+    assert_equal [@index_movies_on_title], 
+      lifter.indexes.map(&:to_hash)
+  end
+
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: mschuerig-index_lifter
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Schuerig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ActiveRecord utility class that disables database indexes during a block.
+email: 
+- michael@schuerig.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/index_lifter.rb
+- test/test_helper.rb
+- test/test_index_lifter.rb
+has_rdoc: true
+homepage: http://github.com/mschuerig/index_lifter
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: index_lifter
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ActiveRecord utility class that disables database indexes during a block.
+test_files: 
+- test/test_helper.rb
+- test/test_index_lifter.rb