activerecord-concurrent-index 0.0.1

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-concurrent-index.gemspec
+gemspec

data/README.md

@@ -0,0 +1,70 @@
+# ActiveRecord Concurrent Index
+
+Extension to allow indexes to be added concurrently on supported
+databases (e.g., postgres)
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'activerecord-concurrent-index'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install activerecord-concurrent-index
+```
+
+## Usage
+
+Inside your database migration:
+
+```ruby
+def self.up
+  add_index_concurrently :table_name, :field_to_index
+end
+```
+
+## Why?
+
+Postgres allows you to add an [index to a table concurrently](http://www.postgresql.org/docs/8.3/static/sql-createindex.html#SQL-CREATEINDEX-CONCURRENTLY)
+which means it will not block regular database operations, such as inserts,
+while the index is being applied. This is especially useful on production tables
+with a lot of data where the time to create an index can be measured in seconds or
+minutes rather than being near-instant. During this period, inserts to the
+table will be blocked and users may ultimately experience an outage.
+
+The downside to running indexes concurrently is that they will take longer to
+be applied.
+
+## Status
+
+Production ready
+
+## Bugs, Feature Requests, etc.
+
+If you think you've found a bug or have a feature you'd like to contribute here are the ways to let me know, in order of likelihood for a speedy resolution:
+
+Fork the repo, add a test, implement the feature, send me a pull request
+Fork the repo, add a failing test, send me a pull request
+Create an issue on Github.
+
+## License
+
+ActiveRecord Concurrent Index is released under the MIT license.
+
+Copyright (c) 2012 Glenn Gillen
+
+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,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/activerecord-concurrent-index.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/activerecord-concurrent-index/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Glenn Gillen"]
+  gem.email         = ["me@glenngillen.com"]
+  gem.description   = %q{Concurrently adds database indexes}
+  gem.summary       = %q{Extension to allow indexes to be added concurrently on supported databases (e.g., postgres)}
+  gem.homepage      = "https://github.com/glenngillen/activerecord-concurrent-index"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "activerecord-concurrent-index"
+  gem.require_paths = ["lib"]
+  gem.version       = Activerecord::Concurrent::Index::VERSION
+  gem.add_dependency 'activerecord'
+  gem.add_development_dependency 'rake'
+end

data/lib/activerecord-concurrent-index.rb

@@ -0,0 +1,50 @@
+require "activerecord-concurrent-index/version"
+
+module ActiveRecord
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      def without_transaction
+        original_value = ActiveRecord::Base.connection.supports_ddl_transactions?
+        commit_db_transaction unless outside_transaction?
+        ActiveRecord::Base.connection.class_eval do
+          def supports_ddl_transactions?
+            false
+          end
+        end
+        yield
+      ensure
+        if original_value
+          ActiveRecord::Base.connection.class_eval do
+            def supports_ddl_transactions?
+              true
+            end
+          end
+        end
+      end
+
+      def add_index_concurrently(table_name, column_name, options = {})
+        column_names = Array.wrap(column_name)
+        index_name   = index_name(table_name, :column => column_names)
+
+        if Hash === options # legacy support, since this param was a string
+          index_type = options[:unique] ? "UNIQUE" : ""
+          index_name = options[:name].to_s if options.key?(:name)
+        else
+          index_type = options
+        end
+
+        if index_name.length > index_name_length
+          raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' is too long; the limit is #{index_name_length} characters"
+        end
+        if index_name_exists?(table_name, index_name, false)
+          raise ArgumentError, "Index name '#{index_name}' on table '#{table_name}' already exists"
+        end
+        quoted_column_names = quoted_columns_for_index(column_names, options).join(", ")
+
+        without_transaction do
+          execute "CREATE #{index_type} INDEX CONCURRENTLY #{quote_column_name(index_name)} ON #{quote_table_name(table_name)} (#{quoted_column_names})"
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-concurrent-index/version.rb

@@ -0,0 +1,7 @@
+module Activerecord
+  module Concurrent
+    module Index
+      VERSION = "0.0.1"
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-concurrent-index
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Glenn Gillen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70225014254500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70225014254500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70225014253720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70225014253720
+description: Concurrently adds database indexes
+email:
+- me@glenngillen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-concurrent-index.gemspec
+- lib/activerecord-concurrent-index.rb
+- lib/activerecord-concurrent-index/version.rb
+homepage: https://github.com/glenngillen/activerecord-concurrent-index
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4507500718456437394
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4507500718456437394
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Extension to allow indexes to be added concurrently on supported databases
+  (e.g., postgres)
+test_files: []