grantr/rubberband

View on GitHub
lib/elasticsearch/client/index.rb

Summary

Maintainability
A
55 mins
Test Coverage
require 'client/hits'

module ElasticSearch
  module Api
    module Index
      def index(document, options={})
        index, type, options = extract_required_scope(options)
        # type
        # index
        # id (optional)
        # op_type (optional)
        # timeout (optional)
        # document (optional)

        id = options.delete(:id)
        if @batch
          #TODO add routing, parent
          @batch << { :index => { :_index => index, :_type => type, :_id => id }.merge(options)}
          @batch << document
        else
          result = execute(:index, index, type, id, document, options)
          if result["ok"]
            result["_id"]
          else
            false
          end
        end
      end

      def get(id, options={})
        index, type, options = extract_required_scope(options)
        # index
        # type
        # id
        # fields
        
        hit = execute(:get, index, type, id, options)
        if hit
          Hit.new(hit)
        end
      end

      def delete(id, options={})
        index, type, options = extract_required_scope(options)

        if @batch
          #TODO add routing, parent
          @batch << { :delete => { :_index => index, :_type => type, :_id => id }}
        else
          result = execute(:delete, index, type, id, options)
          result["ok"]
        end
      end
      
      def delete_by_query(query, options = {})
        index, type, options = extract_scope(options)
        execute(:delete_by_query, index || '_all', type, query, options)
      end

      #df     The default field to use when no field prefix is defined within the query.
      #analyzer     The analyzer name to be used when analyzing the query string.
      #default_operator     The default operator to be used, can be AND or OR. Defaults to OR.
      #explain     For each hit, contain an explanation of how to scoring of the hits was computed.
      #fields     The selective fields of the document to return for each hit (fields must be stored), comma delimited. Defaults to the internal _source field.
      #field     Same as fields above, but each parameter contains a single field name to load. There can be several field parameters.
      #sort     Sorting to perform. Can either be in the form of fieldName, or fieldName:desc (for reverse sorting). The fieldName can either be an actual field within the document, or the special score name to indicate sorting based on scores. There can be several sort parameters (order is important).
      #from     The starting from index of the hits to return. Defaults to 0.
      #size     The number of hits to return. Defaults to 10.
      #search_type     The type of the search operation to perform. Can be dfs_query_then_fetch, dfs_query_and_fetch, query_then_fetch, query_and_fetch. Defaults to query_then_fetch.
      #scroll Get a scroll id to continue paging through the search results. Value is the time to keep a scroll request around, e.g. 5m
      #ids_only Return ids instead of hits
      def search(query, options={})
        index, type, options = extract_scope(options)

        options[:size] ||= (options[:per_page] || options[:limit]) if options[:per_page] || options[:limit]
        options[:from] ||= options[:size] * (options[:page].to_i-1) if options[:page] && options[:page].to_i > 1
        options[:from] ||= options[:offset] if options[:offset]

        options[:fields] = "_id" if options[:ids_only]

        # options that elasticsearch doesn't recognize: page, per_page, ids_only, limit, offset
        search_options = options.reject { |k, v| [:page, :per_page, :ids_only, :limit, :offset].include?(k) }

        response = execute(:search, index, type, query, search_options)

        Hits.new(response, {:per_page => options[:per_page], :page => options[:page], :ids_only => options[:ids_only]}) #ids_only returns array of ids instead of hits
      end

      #ids_only Return ids instead of hits
      #pass a block to execute the block for each batch of hits
      def scroll(scroll_id, options={}, &block)
        begin
          search_options = options.reject { |k, v| [:page, :per_page, :ids_only, :limit, :offset].include?(k) }
          response = execute(:scroll, scroll_id, options)
          hits = Hits.new(response, { :ids_only => options[:ids_only] })
          if block_given? && !hits.empty?
            yield hits 
            scroll_id = hits.scroll_id
          end
        end until !block_given? || hits.empty?
        hits
      end 

      #df     The default field to use when no field prefix is defined within the query.
      #analyzer     The analyzer name to be used when analyzing the query string.
      #default_operator     The default operator to be used, can be AND or OR. Defaults to OR.
      def count(query, options={})
        index, type, options = extract_scope(options)

        response = execute(:count, index, type, query, options)
        response["count"].to_i #TODO check if count is nil
      end

      # Starts a bulk operation batch and yields self. Index and delete requests will be 
      # queued until the block closes, then sent as a single _bulk call.
      def bulk(options={})
        # allow nested bulk calls
        if @batch
          yield(self)
        else
          begin
            @batch = []
            yield(self)
            response = execute(:bulk, @batch, options)
          ensure
            @batch = nil
          end
        end
      end
      
      # minor multi get support
      def multi_get(ids, options={})
        index, type, options = extract_required_scope(options)
        results = execute(:multi_get, index, type, ids, options)
        if(results)
          hits = []
          results.each { |hit| hits << Hit.new(hit) }
          hits
        end
      end
    end
  end
end