db_leftovers 1.3.3 → 1.4.0

data/Changelog

@@ -0,0 +1,6 @@
+1.4.0
+-----
+
+- Added support for functional indexes.
+
+

data/README.md

@@ -44,7 +44,7 @@ Within the DSL file, the following methods are supported:
 
 ### index(table\_name, columns, [opts])
 
-This ensures that you have an index on the given table and column(s). The `columns` parameter can be either a string/symbol or a list of strings/symbols. Opts is a hash with the following possible keys:
+This ensures that you have an index on the given table and column(s). The `columns` parameter can be either a symbol or a list of strings/symbols. (If you pass a single string for the `columns` parameter, it will be treated as the expression for a functional index rather than a column name.) Opts is a hash with the following possible keys:
 
 * `:name` The name of the index. Defaults to `index_`*table\_name*`_on_`*column\_names*, like the `add_index` method from Rails migrations.
 
@@ -54,11 +54,15 @@ This ensures that you have an index on the given table and column(s). The `colum
 
 * `:using` Lets you specify what kind of index to create. Default is `btree`, but if you're on Postgres you might also want `gist`, `gin`, or `hash`.
 
+* `:function` Lets you specify an expression rather than a list of columns. If you give this option, you should pass an empty list of column names. Alternately, you can pass a string as the column name (rather than a symbol), and db\_leftovers will interpret it as a function.
+
 #### Examples
 
     index :books, :author_id
     index :books, [:publisher_id, :published_at]
     index :books, :isbn, :unique => true
+    index :authors, [], function: 'lower(name)'
+    index :authors, 'lower(name)'
 
 ### foreign\_key(from\_table, [from\_column], to\_table, [to\_column], [opts])
 

data/lib/db_leftovers/generic_database_interface.rb

@@ -23,7 +23,7 @@ module DBLeftovers
         CREATE #{unique} INDEX #{idx.index_name}
         ON #{idx.table_name}
         #{using}
-        (#{idx.column_names.join(', ')})
+        (#{idx.index_function || idx.column_names.join(', ')})
         #{where}
       EOQ
       execute_sql(sql)

data/lib/db_leftovers/index.rb

@@ -3,23 +3,33 @@ module DBLeftovers
   # Just a struct to hold all the info for one index:
   class Index
     attr_accessor :table_name, :column_names, :index_name,
-      :where_clause, :using_clause, :unique
+      :where_clause, :using_clause, :unique, :index_function
 
     def initialize(table_name, column_names, opts={})
       opts = {
         :where => nil,
+        :function => nil,
         :unique => false,
         :using => nil
       }.merge(opts)
       opts.keys.each do |k|
-        raise "Unknown option: #{k}" unless [:where, :unique, :using, :name].include?(k)
+        raise "Unknown option: #{k}" unless [:where, :function, :unique, :using, :name].include?(k)
+      end
+      if column_names.is_a?(String) and opts[:function].nil?
+        opts[:function] = column_names
+        column_names = []
       end
       @table_name = table_name.to_s
       @column_names = [column_names].flatten.map{|x| x.to_s}
       @where_clause = opts[:where]
+      @index_function = opts[:function]
       @using_clause = opts[:using]
       @unique = !!opts[:unique]
       @index_name = (opts[:name] || choose_name(@table_name, @column_names)).to_s
+
+      raise "Indexes need a table!" unless @table_name
+      raise "Indexes need at least column or an expression!" unless (@column_names.any? or @index_function)
+      raise "Can't have both columns and an expression!" if (@column_names.size > 0 and @index_function)
     end
 
     def unique?
@@ -31,19 +41,30 @@ module DBLeftovers
       other.column_names == column_names and
       other.index_name == index_name and
       other.where_clause == where_clause and
+      other.index_function == index_function and
       other.using_clause == using_clause and
       other.unique == unique
     end
 
     def to_s
-      "<#{@index_name}: #{@table_name}.[#{column_names.join(",")}] unique=#{@unique}, where=#{@where_clause}, using=#{@using_clause}>"
+      "<#{@index_name}: #{@table_name}.[#{column_names.join(",")}] unique=#{@unique}, where=#{@where_clause}, function=#{@index_function}, using=#{@using_clause}>"
     end
 
     private 
 
     def choose_name(table_name, column_names)
+      topic = if column_names.any?
+                column_names.join("_and_")
+              else
+                index_function
+              end
+      ret = "index_#{table_name}_on_#{topic}"
+      ret = ret.gsub(/[^a-zA-Z0-9]/, '_').
+                gsub(/__+/, '_').
+                gsub(/^_/, '').
+                gsub(/_$/, '')
       # Max length in Postgres is 63; in MySQL 64:
-      "index_#{table_name}_on_#{column_names.join('_and_')}"[0,63]
+      ret[0,63]
     end
 
   end

data/lib/db_leftovers/postgres_database_interface.rb

@@ -16,7 +16,8 @@ module DBLeftovers
                   ix.indisunique AS is_unique,
                   array_to_string(ix.indkey, ',') AS column_numbers,
                   am.amname AS index_type,
-                  pg_get_expr(ix.indpred, ix.indrelid) AS where_clause
+                  pg_get_expr(ix.indpred, ix.indrelid) AS where_clause,
+                  pg_get_expr(ix.indexprs, ix.indrelid) AS index_function
           FROM    pg_class t,
                   pg_class i,
                   pg_index ix,
@@ -37,10 +38,11 @@ module DBLeftovers
                     ix.indrelid,
                     ix.indkey,
                     am.amname,
-                    ix.indpred
+                    ix.indpred,
+                    ix.indexprs
           ORDER BY t.relname, i.relname
       EOQ
-      @conn.select_rows(sql).each do |indexrelid, indrelid, table_name, index_name, is_unique, column_numbers, index_method, where_clause|
+      @conn.select_rows(sql).each do |indexrelid, indrelid, table_name, index_name, is_unique, column_numbers, index_method, where_clause, index_function|
         where_clause = remove_outer_parens(where_clause) if where_clause
         index_method = nil if index_method == 'btree'
         ret[index_name] = Index.new(
@@ -48,6 +50,7 @@ module DBLeftovers
           column_names_for_index(indrelid, column_numbers.split(",")),
           unique: is_unique == 't',
           where: where_clause,
+          function: index_function,
           using: index_method,
           name: index_name
         )
@@ -128,6 +131,7 @@ module DBLeftovers
     private
 
     def column_names_for_index(table_id, column_numbers)
+      return [] if column_numbers == ['0']
       column_numbers.map do |c|
         sql = <<-EOQ
             SELECT  attname

data/lib/db_leftovers/version.rb

@@ -1,3 +1,3 @@
 module DbLeftovers
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

data/spec/postgres_spec.rb

@@ -102,6 +102,22 @@ describe DBLeftovers::PostgresDatabaseInterface do
       @db.lookup_all_constraints['books_have_positive_pages'].check.should == 'pages_count > 12'
     end
 
+    it "should allow functional indexes, specified as a string" do
+      DBLeftovers::Definition.define :db_interface => @db do
+        index :authors, 'lower(name)'
+      end
+      @db.lookup_all_indexes.size.should == 1
+      @db.lookup_all_indexes.keys.sort.should == ['index_authors_on_lower_name']
+    end
+
+    it "should allow functional indexes, specified with an option" do
+      DBLeftovers::Definition.define :db_interface => @db do
+        index :authors, [], function: 'lower(name)'
+      end
+      @db.lookup_all_indexes.size.should == 1
+      @db.lookup_all_indexes.keys.sort.should == ['index_authors_on_lower_name']
+    end
+
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: db_leftovers
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -69,6 +69,7 @@ extra_rdoc_files: []
 files:
 - .document
 - .gitignore
+- Changelog
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -111,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3023613074233627262
+      hash: 1649859164079023412
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: