activerecord-covering-index 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab81849fab4e6f4f806285e0260d6cd85dcf3b30ea6ca6ddf34246eade1d75ee
+  data.tar.gz: 154b89bcb99f80e44872b07d2192f799cc211e9e91c2ef8542881e2d0e97374b
+SHA512:
+  metadata.gz: a5c108baf5d51576070829e94af6789591f212ff712631b96f48948a85a17da8c31f8d6411eb1ed78833052a636000b0947fc2e51d0328481b49ed9eb221bda6
+  data.tar.gz: f658f0294875aeb8d9e482f4cad5485a27c9375e7d8a8d8240a969516ff510f0be8e854101faf4431cdca1308ce3b2f763c193be9557c582b968d4cb423123c5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.tool-versions
+
+Gemfile.lock
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "activerecord-5-2" do
+  gem "activerecord", "~> 5.2"
+end
+
+appraise "activerecord-6-0" do
+  gem "activerecord", "~> 6.0.0"
+end
+
+appraise "activerecord-6-1" do
+  gem "activerecord", "~> 6.1.0"
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,97 @@
+# activerecord-covering-index
+
+Extends ActiveRecord/Rails to support [covering indexes](https://www.postgresql.org/docs/11/indexes-index-only-scans.html) in PostgreSQL using the `INCLUDE` clause.
+
+From the [PostgreSQL documentation](https://www.postgresql.org/docs/11/sql-createindex.html):
+
+> The optional INCLUDE clause specifies a list of columns which will be included in the index as non-key columns. A non-key column cannot be used in an index scan search qualification, and it is disregarded for purposes of any uniqueness or exclusion constraint enforced by the index. However, an index-only scan can return the contents of non-key columns without having to visit the index's table, since they are available directly from the index entry. Thus, addition of non-key columns allows index-only scans to be used for queries that otherwise could not use them.
+
+## Compatibility
+
+- ActiveRecord 5.2, 6.0 and 6.1
+- PostgreSQL 11 and later
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-covering-index'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+In a migration, use the `include` option with `add_index`:
+
+```ruby
+class IndexUsersOnName < ActiveRecord::Migration[6.1]
+  def change
+    add_index :users, :name, include: :email
+  end
+end
+```
+
+Or within a `create_table` block:
+
+```ruby
+class CreateUsers < ActiveRecord::Migration[6.1]
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.string :email
+      t.timestamps
+
+      t.index :name, include: :email
+    end
+  end
+end
+```
+
+You can also `include` multiple columns:
+
+```ruby
+add_index :users, :name, include: [:email, :updated_at]
+```
+
+Or combine `include` with other index options:
+
+```ruby
+add_index :users, :name, include: :email, where: 'email IS NOT NULL', unique: true
+```
+
+## Caveats
+
+Non-key columns are not included in the name Rails generates for an index. For example, the following two indexes will receive the same name, which causes the second to raise a `PG::DuplicateTable` error:
+
+```ruby
+add_index :users, :name
+add_index :users, :name, include: :email
+```
+
+To avoid collisions, you can specify a different name:
+
+```ruby
+add_index :users, :name, include: :email, name: 'index_users_on_name_include_email'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/schlock/activerecord-covering-index.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+The gem was adapted from https://github.com/rails/rails/pull/37515, created by [@sebastian-palma](https://github.com/sebastian-palma).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-covering-index.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/activerecord-covering-index/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-covering-index"
+  spec.version       = ActiverecordCoveringIndex::VERSION
+  spec.authors       = ["Tiger Watson"]
+  spec.email         = ["tigerwnz@gmail.com"]
+
+  spec.summary       = %q{Create covering indexes in Rails with PostgreSQL}
+  spec.description   = %q{Extends ActiveRecord to support covering indexes in PostgreSQL using the INCLUDE clause.}
+  spec.homepage      = "https://gitlab.com/schlock/activerecord-covering-index"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.gitlab|spec|gemfiles)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 5.2", "< 7"
+  spec.add_dependency "pg"
+
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "appraisal", "~> 2.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord-covering-index"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord-covering-index.rb

@@ -0,0 +1,15 @@
+require 'active_record'
+require "active_record/connection_adapters/postgresql_adapter"
+
+require 'activerecord-covering-index/version'
+require 'activerecord-covering-index/abstract_adapter'
+require 'activerecord-covering-index/postgresql_adapter'
+require 'activerecord-covering-index/schema_creation'
+require 'activerecord-covering-index/index_definition'
+require 'activerecord-covering-index/schema_dumper'
+
+ActiveRecord::ConnectionAdapters::AbstractAdapter.send(:include, ActiverecordCoveringIndex::AbstractAdapter)
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send(:prepend, ActiverecordCoveringIndex::PostgreSQLAdapter)
+ActiveRecord::ConnectionAdapters::SchemaCreation.send(:prepend, ActiverecordCoveringIndex::SchemaCreation)
+ActiveRecord::ConnectionAdapters::IndexDefinition.send(:prepend, ActiverecordCoveringIndex::IndexDefinition)
+ActiveRecord::SchemaDumper.send(:prepend, ActiverecordCoveringIndex::SchemaDumper)

data/lib/activerecord-covering-index/abstract_adapter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiverecordCoveringIndex
+  module AbstractAdapter
+    def supports_covering_index?
+      false
+    end
+  end
+end

data/lib/activerecord-covering-index/index_definition.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ActiverecordCoveringIndex
+  module IndexDefinition
+    def self.prepended(base)
+      base.attr_reader :include
+    end
+
+    def initialize(
+      table, name,
+      unique = false,
+      columns = [],
+      lengths: {},
+      orders: {},
+      opclasses: {},
+      where: nil,
+      type: nil,
+      using: nil,
+      comment: nil,
+      include: []
+    )
+      @table = table
+      @name = name
+      @unique = unique
+      @columns = columns
+      @lengths = concise_options(lengths)
+      @orders = concise_options(orders)
+      @opclasses = concise_options(opclasses)
+      @where = where
+      @type = type
+      @using = using
+      @comment = comment
+      @include = include
+    end
+  end
+end

data/lib/activerecord-covering-index/postgresql_adapter.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module ActiverecordCoveringIndex
+  module PostgreSQLAdapter
+    def supports_covering_index?
+      if respond_to?(:database_version) # ActiveRecord 6+
+        database_version >= 110_000
+      else
+        postgresql_version >= 110_000
+      end
+    end
+
+    def add_index_options(table_name, column_name, name: nil, if_not_exists: false, internal: false, **options)
+      options.assert_valid_keys(:unique, :length, :order, :opclass, :where, :type, :using, :comment, :algorithm, :include)
+
+      options[:name] = name if name
+      options[:internal] = internal
+      non_key_columns = options.delete(:include)
+
+      original_index_options = super(table_name, column_name, **options)
+
+      if original_index_options.first.is_a?(String)
+        index_name, index_type, index_columns, index_options, algorithm, using, comment = original_index_options
+
+        if non_key_columns && supports_covering_index?
+          non_key_columns = [non_key_columns] if non_key_columns.is_a?(Symbol)
+          non_key_columns = quoted_columns_for_index(non_key_columns, {}).join(", ")
+
+          index_options = " INCLUDE (#{non_key_columns})" + index_options
+        end
+
+        [index_name, index_type, index_columns, index_options, algorithm, using, comment]
+      else
+        index, algorithm, if_not_exists = original_index_options
+
+        index_with_include = ActiveRecord::ConnectionAdapters::IndexDefinition.new(
+          index.table,
+          index.name,
+          index.unique,
+          index.columns,
+          lengths: index.lengths,
+          orders: index.orders,
+          opclasses: index.opclasses,
+          where: index.where,
+          type: index.type,
+          using: index.using,
+          comment: index.comment,
+          include: non_key_columns
+        )
+
+        [index_with_include, algorithm, if_not_exists]
+      end
+    end
+
+    def indexes(table_name)
+      scope = quoted_scope(table_name)
+
+      result = query(<<~SQL, "SCHEMA")
+        SELECT distinct i.relname, d.indisunique, d.indkey, pg_get_indexdef(d.indexrelid), t.oid,
+                        pg_catalog.obj_description(i.oid, 'pg_class') AS comment, d.indnkeyatts
+        FROM pg_class t
+        INNER JOIN pg_index d ON t.oid = d.indrelid
+        INNER JOIN pg_class i ON d.indexrelid = i.oid
+        LEFT JOIN pg_namespace n ON n.oid = i.relnamespace
+        WHERE i.relkind IN ('i', 'I')
+          AND d.indisprimary = 'f'
+          AND t.relname = #{scope[:name]}
+          AND n.nspname = #{scope[:schema]}
+        ORDER BY i.relname
+      SQL
+
+      result.map do |row|
+        index_name = row[0]
+        unique = row[1]
+        indkey = row[2].split(" ").map(&:to_i)
+        inddef = row[3]
+        oid = row[4]
+        comment = row[5]
+        indnkeyatts = row[6]
+
+        using, expressions, _, where = inddef.scan(/ USING (\w+?) \((.+?)\)(?: INCLUDE \((.+?)\))?(?: WHERE (.+))?\z/m).flatten
+
+        orders = {}
+        opclasses = {}
+
+        columns = Hash[query(<<~SQL, "SCHEMA")].values_at(*indkey)
+          SELECT a.attnum, a.attname
+          FROM pg_attribute a
+          WHERE a.attrelid = #{oid}
+          AND a.attnum IN (#{indkey.join(",")})
+        SQL
+
+        non_key_columns = columns.pop(columns.count - indnkeyatts)
+
+        if indkey.include?(0)
+          columns = expressions
+        else
+          # add info on sort order (only desc order is explicitly specified, asc is the default)
+          # and non-default opclasses
+          expressions.scan(/(?<column>\w+)"?\s?(?<opclass>\w+_ops)?\s?(?<desc>DESC)?\s?(?<nulls>NULLS (?:FIRST|LAST))?/).each do |column, opclass, desc, nulls|
+            opclasses[column] = opclass.to_sym if opclass
+            if nulls
+              orders[column] = [desc, nulls].compact.join(" ")
+            else
+              orders[column] = :desc if desc
+            end
+          end
+        end
+
+        ActiveRecord::ConnectionAdapters::IndexDefinition.new(
+          table_name,
+          index_name,
+          unique,
+          columns,
+          orders: orders,
+          opclasses: opclasses,
+          where: where,
+          using: using.to_sym,
+          comment: comment.presence,
+          include: non_key_columns
+        )
+      end
+    end
+  end
+end

data/lib/activerecord-covering-index/schema_creation.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ActiverecordCoveringIndex
+  module SchemaCreation
+    def self.prepended(base)
+      attr_opts = { to: :@conn }
+      attr_opts[:private] = true if ActiveRecord::VERSION::MAJOR >= 6
+
+      base.delegate :supports_covering_index?, **attr_opts
+    end
+
+    private
+
+    def visit_CreateIndexDefinition(o)
+      index = o.index
+
+      sql = ["CREATE"]
+      sql << "UNIQUE" if index.unique
+      sql << "INDEX"
+      sql << "IF NOT EXISTS" if o.if_not_exists
+      sql << o.algorithm if o.algorithm
+      sql << index.type if index.type
+      sql << "#{quote_column_name(index.name)} ON #{quote_table_name(index.table)}"
+      sql << "USING #{index.using}" if supports_index_using? && index.using
+      sql << "(#{quoted_columns(index)})"
+      sql << "INCLUDE (#{quoted_index_includes(index.include)})" if supports_covering_index? && index.include
+      sql << "WHERE #{index.where}" if supports_partial_index? && index.where
+
+      sql.join(" ")
+    end
+
+    def quoted_index_includes(columns)
+      String === columns ? columns : quoted_columns_for_index(Array(columns), {})
+    end
+  end
+end

data/lib/activerecord-covering-index/schema_dumper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiverecordCoveringIndex
+  module SchemaDumper
+    private
+
+    def index_parts(index)
+      index_parts = super
+      index_parts << "include: #{index.include.inspect}" if index.include.present?
+      index_parts
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+module ActiverecordCoveringIndex
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-covering-index
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiger Watson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+description: Extends ActiveRecord to support covering indexes in PostgreSQL using
+  the INCLUDE clause.
+email:
+- tigerwnz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- activerecord-covering-index.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-covering-index.rb
+- lib/activerecord-covering-index/abstract_adapter.rb
+- lib/activerecord-covering-index/index_definition.rb
+- lib/activerecord-covering-index/postgresql_adapter.rb
+- lib/activerecord-covering-index/schema_creation.rb
+- lib/activerecord-covering-index/schema_dumper.rb
+- lib/activerecord-covering-index/version.rb
+homepage: https://gitlab.com/schlock/activerecord-covering-index
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/schlock/activerecord-covering-index
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Create covering indexes in Rails with PostgreSQL
+test_files: []