Class: Couchbase::SearchQuery::DocIdQuery

Inherits:

Couchbase::SearchQuery

• Object
• Couchbase::SearchQuery
• Couchbase::SearchQuery::DocIdQuery

Defined in:

lib/couchbase/search_options.rb,
/code/couchbase-ruby-client/lib/couchbase/search_options.rb

Overview

Allows to restrict matches to a set of specific documents.

Instance Attribute Summary

• #boost ⇒ Float

Instance Method Summary

• #initialize(*doc_ids) {|self| ... } ⇒ DocIdQuery constructor

  A new instance of DocIdQuery.

• #to_h ⇒ Hash<Symbol, #to_json>

Methods inherited from Couchbase::SearchQuery

boolean_field, booleans, conjuncts, date_range, disjuncts, doc_id, geo_bounding_box, geo_distance, geo_polygon, match, match_all, match_none, match_phrase, numeric_range, phrase, prefix, query_string, regexp, term, term_range, #to_json, wildcard

Constructor Details

#initialize(*doc_ids) {|self| ... } ⇒ DocIdQuery

Returns a new instance of DocIdQuery.

Parameters:

• doc_ids (String...)

Yield Parameters:

• self (DocIdQuery)

# File 'lib/couchbase/search_options.rb', line 304

def initialize(*doc_ids)
  super()
  @doc_ids = doc_ids
  yield self if block_given?
end

Instance Attribute Details

#boost ⇒ Float

Returns:

• (Float)

# File 'lib/couchbase/search_options.rb', line 299

def boost
  @boost
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:

• (Hash<Symbol, #to_json>)

# File 'lib/couchbase/search_options.rb', line 311

def to_h
  data = {:ids => @doc_ids.flatten.uniq}
  data[:boost] = boost if boost
  data
end