redis-search 0.6.3 → 0.7.0

data/README.markdown

@@ -14,6 +14,7 @@ High performance real-time search (Support Chinese), index in Redis for Rails ap
 * Support ActiveRecord and Mongoid
 * Sort results by one field
 * Homophone search, pinyin search
+* Conditions support
 
 ## Requirements
 
@@ -26,7 +27,8 @@ in Rails application Gemfile
     gem 'redis','>= 2.1.1'
     gem 'chinese_pinyin', '0.4.1'
     gem 'rmmseg-cpp-huacnlee', '0.2.9'
-    gem 'redis-search', '0.6.2'
+    gem 'redis-namespace','~> 1.1.0'
+    gem 'redis-search', '0.6.3'
 
 install bundlers
 
@@ -36,9 +38,14 @@ install bundlers
 
 create file in: config/initializers/redis_search.rb
 
+    require "redis"
+    require "redis-namespace"
     require "redis-search"
     # don't forget change namespace
     redis = Redis.new(:host => "127.0.0.1",:port => "6379")
+    # We suggest you use a special db in Redis, when you need to clear all data, you can use flushdb command to clear them.
+    redis.select(3)
+    # Give a special namespace as prefix for Redis key, when your have more than one project used redis-search, this config will make them work fine.
     redis = Redis::Namespace.new("your_app_name:redis_search", :redis => redis)
     Redis::Search.configure do |config|
       config.redis = redis
@@ -63,6 +70,7 @@ bind Redis::Search callback event, it will to rebuild search indexes when data c
   
       redis_search_index(:title_field => :title,
                          :score_field => :hits,
+                         :condition_fields => [:user_id, :category_id],
                          :ext_fields => [:category_name])
   
       def category_name
@@ -88,12 +96,12 @@ bind Redis::Search callback event, it will to rebuild search indexes when data c
     class SearchController < ApplicationController
       # GET /searchs?q=title
       def index
-        Redis::Search.query("Post", params[:q])
+        Redis::Search.query("Post", params[:q], :conditions => {:user_id => 12})
       end
       
       # GET /search_users?q=j
       def search_users
-        Redis::Search.complete("Post", params[:q])
+        Redis::Search.complete("Post", params[:q], :conditions => {:user_id => 12, :category_id => 4})
       end
     end
 
@@ -109,6 +117,9 @@ see [Rdoc.info redis-search](http://rubydoc.info/gems/redis-search)
 
 ## Benchmark test
 
+You can run the rake command (see Rakefile) to make test.
+There is my performance test result.
+
 * [https://gist.github.com/1150933](https://gist.github.com/1150933)
     
 ## Demo

data/lib/redis/search/base.rb

@@ -15,15 +15,18 @@ class Redis
         prefix_index_enable = options[:prefix_index_enable] || false
         ext_fields = options[:ext_fields] || []
         score_field = options[:score_field] || :created_at
+        condition_fields = options[:condition_fields] || []
         # Add score field to ext_fields
-        ext_fields << score_field if !ext_fields.include?(score_field)
+        ext_fields |= [score_field]
+        # Add condition fields to ext_fields
+        ext_fields |= condition_fields
         
         # store Model name to indexed_models for Rake tasks
         Search.indexed_models = [] if Search.indexed_models == nil
         Search.indexed_models << self
         # bind instance methods and callback events
         class_eval %(
-          def redis_search_ext_fields(ext_fields)
+          def redis_search_fields_to_hash(ext_fields)
             exts = {}
             ext_fields.each do |f|
               exts[f] = instance_eval(f.to_s)
@@ -34,11 +37,12 @@ class Redis
           # after_create :redis_search_index_create
           def redis_search_index_create
             s = Search::Index.new(:title => self.#{title_field}, 
-                           :id => self.id, 
-                           :exts => self.redis_search_ext_fields(#{ext_fields.inspect}), 
-                           :type => self.class.to_s,
-                           :score => self.#{score_field}.to_i,
-                           :prefix_index_enable => #{prefix_index_enable})
+                                  :id => self.id, 
+                                  :exts => self.redis_search_fields_to_hash(#{ext_fields.inspect}), 
+                                  :type => self.class.to_s,
+                                  :condition_fields => #{condition_fields},
+                                  :score => self.#{score_field}.to_i,
+                                  :prefix_index_enable => #{prefix_index_enable})
             s.save
             # release s
             s = nil

data/lib/redis/search/finder.rb

@@ -20,39 +20,54 @@ class Redis
     # * Redis::Search.complete("Tag","red") => ["Redis", "Redmine"]
     # * Redis::Search.complete("Tag","redi") => ["Redis"]
     def self.complete(type, w, options = {})
-      return [] if w.blank? or type.blank?
       limit = options[:limit] || 10 
-
+      conditions = options[:conditions] || []
+      return [] if (w.blank? and conditions.blank?) or type.blank?
+      
       prefix_matchs = []
       # This is not random, try to get replies < MTU size
       rangelen = Redis::Search.config.complete_max_length
       prefix = w.downcase
       key = Search.mk_complete_key(type)
       
-      start = Redis::Search.config.redis.zrank(key,prefix)
-      return [] if !start
-      count = limit
-      max_range = start+(rangelen*limit)-1
-      range = Redis::Search.config.redis.zrange(key,start,max_range)
-      while prefix_matchs.length <= count
-        start += rangelen
-        break if !range or range.length == 0
-        range.each {|entry|
-          minlen = [entry.length,prefix.length].min
-          if entry[0...minlen] != prefix[0...minlen]
-            count = prefix_matchs.count
-            break
-          end
-          if entry[-1..-1] == "*" and prefix_matchs.length != count
-            prefix_matchs << entry[0...-1]
-          end
-        }
-        range = range[start..max_range]
+      
+      if start = Redis::Search.config.redis.zrank(key,prefix)
+        count = limit
+        max_range = start+(rangelen*limit)-1
+        range = Redis::Search.config.redis.zrange(key,start,max_range)
+        while prefix_matchs.length <= count
+          start += rangelen
+          break if !range or range.length == 0
+          range.each {|entry|
+            minlen = [entry.length,prefix.length].min
+            if entry[0...minlen] != prefix[0...minlen]
+              count = prefix_matchs.count
+              break
+            end
+            if entry[-1..-1] == "*" and prefix_matchs.length != count
+              prefix_matchs << entry[0...-1]
+            end
+          }
+          range = range[start..max_range]
+        end
       end
+      
+      # 组合 words 的特别 key 名
       words = []
       words = prefix_matchs.uniq.collect { |w| Search.mk_sets_key(type,w) }
+      
+      # 组合特别 key ,但这里不会像 query 那样放入 words， 因为在 complete 里面 words 是用 union 取的，condition_keys 和 words 应该取交集
+      condition_keys = []
+      if !conditions.blank?
+        conditions = conditions[0] if conditions.is_a?(Array)
+        conditions.keys.each do |c|
+          condition_keys << Search.mk_condition_key(type,c,conditions[c])
+        end
+      end
+      
+      # 按词语搜索
+      temp_store_key = "tmpsunionstore:#{words.join("+")}"
       if words.length > 1
-        temp_store_key = "tmpsunionstore:#{words.join("+")}"   
         if !Redis::Search.config.redis.exists(temp_store_key)
           # 将多个词语组合对比，得到并集，并存入临时区域   
           Redis::Search.config.redis.sunionstore(temp_store_key,*words)
@@ -60,16 +75,24 @@ class Redis
           Redis::Search.config.redis.expire(temp_store_key,86400)
         end
         # 根据需要的数量取出 ids
-        ids = Redis::Search.config.redis.sort(temp_store_key,
-                                              :limit => [0,limit], 
-                                              :by => Search.mk_score_key(type,"*"),
-                                              :order => "desc")
       else
-        ids = Redis::Search.config.redis.sort(words.first,
-                                              :limit => [0,limit], 
-                                              :by => Search.mk_score_key(type,"*"),
-                                              :order => "desc")
+        temp_store_key = words.first
       end
+      
+      # 如果有条件，这里再次组合一下
+      if !condition_keys.blank?
+        condition_keys << temp_store_key if !words. blank?
+        temp_store_key = "tmpsinterstore:#{condition_keys.join('+')}"
+        if !Redis::Search.config.redis.exists(temp_store_key)
+          Redis::Search.config.redis.sinterstore(temp_store_key,*condition_keys)
+          Redis::Search.config.redis.expire(temp_store_key,86400)
+        end
+      end
+      
+      ids = Redis::Search.config.redis.sort(temp_store_key,
+                                            :limit => [0,limit], 
+                                            :by => Search.mk_score_key(type,"*"),
+                                            :order => "desc")
       return [] if ids.blank?
       hmget(type,ids)
     end
@@ -85,14 +108,28 @@ class Redis
     def self.query(type, text,options = {})
       tm = Time.now
       result = []
-      return result if text.strip.blank?
-
+      
       limit = options[:limit] || 10
       sort_field = options[:sort_field] || "id"
+      conditions = options[:conditions] || []
+      
+      # 如果搜索文本和查询条件均没有，那就直接返回 []
+      return result if text.strip.blank? and conditions.blank?
 
       words = Search.split(text)
       words = words.collect { |w| Search.mk_sets_key(type,w) }
       
+      
+      condition_keys = []
+      if !conditions.blank?
+        conditions = conditions[0] if conditions.is_a?(Array)
+        conditions.keys.each do |c|
+          condition_keys << Search.mk_condition_key(type,c,conditions[c])
+        end
+        # 将条件的 key 放入关键词搜索集合内，用于 sinterstore 搜索
+        words += condition_keys
+      end
+      
       return result if words.blank?
       
       temp_store_key = "tmpinterstore:#{words.join("+")}"
@@ -108,6 +145,7 @@ class Redis
           if Search.config.pinyin_match
             pinyin_words = Search.split_pinyin(text)
             pinyin_words = pinyin_words.collect { |w| Search.mk_sets_key(type,w) }
+            pinyin_words += condition_keys
             temp_sunion_key = "tmpsunionstore:#{words.join("+")}"
             if Search.config.pinyin_match
               temp_pinyin_store_key = "tmpinterstore:#{pinyin_words.join("+")}"
@@ -182,6 +220,10 @@ class Redis
       def self.mk_score_key(type, id)
         "#{type}:_score_:#{id}"
       end
+      
+      def self.mk_condition_key(type, field, id)
+        "#{type}:_by:_#{field}:#{id}"
+      end
   
       def self.mk_complete_key(type)
         "Compl#{type}"

data/lib/redis/search/index.rb

@@ -1,9 +1,14 @@
 class Redis
   module Search
     class Index
-      attr_accessor :type, :title, :id,:score, :exts, :prefix_index_enable
+      attr_accessor :type, :title, :id,:score, :exts, :condition_fields, :prefix_index_enable
       def initialize(options = {})
+        # default data
+        self.condition_fields = []
         self.exts = []
+        self.prefix_index_enable = false
+        
+        # set attributes value from params
         options.keys.each do |k|
           eval("self.#{k} = options[k]")
         end
@@ -28,11 +33,16 @@ class Redis
           # score for search sort
           Redis::Search.config.redis.set(Search.mk_score_key(self.type,self.id),self.score)
         end
+        
+        # 将目前的编号保存到条件(conditions)字段所创立的索引上面
+        self.condition_fields.each do |field|
+          Redis::Search.config.redis.sadd(Search.mk_condition_key(self.type,field,data[field.to_sym]), self.id)
+        end
 
         # 建立前最索引
         if prefix_index_enable
           save_prefix_index
-        end
+        end     
       end
       
       def self.remove(options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-search
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000Z
+date: 2011-10-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chinese_pinyin
-  requirement: &2156524340 !ruby/object:Gem::Requirement
+  requirement: &2156513140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *2156524340
+  version_requirements: *2156513140
 - !ruby/object:Gem::Dependency
   name: rmmseg-cpp-huacnlee
-  requirement: &2156523860 !ruby/object:Gem::Requirement
+  requirement: &2156512660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.2.8
   type: :runtime
   prerelease: false
-  version_requirements: *2156523860
+  version_requirements: *2156512660
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &2156523400 !ruby/object:Gem::Requirement
+  requirement: &2156512200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.2
   type: :runtime
   prerelease: false
-  version_requirements: *2156523400
+  version_requirements: *2156512200
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2156522920 !ruby/object:Gem::Requirement
+  requirement: &2156511720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: 2.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2156522920
+  version_requirements: *2156511720
 description: High performance real-time search (Support Chinese), index in Redis for
   Rails application.
 email: