Class: Couchbase::Cluster::SearchQuery::TermRangeQuery

Inherits:
Couchbase::Cluster::SearchQuery show all
Defined in:
lib/couchbase/search_options.rb

Overview

The term range query finds documents containing a string value in the specified field within the specified range.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Couchbase::Cluster::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, wildcard

Constructor Details

#initialize {|self| ... } ⇒ TermRangeQuery

Returns a new instance of TermRangeQuery.

Yield Parameters:



474
475
476
477
478
479
480
481
# File 'lib/couchbase/search_options.rb', line 474

def initialize
  super
  @min = nil
  @min_inclusive = nil
  @max = nil
  @max_inclusive = nil
  yield self if block_given?
end

Instance Attribute Details

#boostFloat

Returns:

  • (Float)


446
447
448
# File 'lib/couchbase/search_options.rb', line 446

def boost
  @boost
end

#fieldString

Returns:

  • (String)


449
450
451
# File 'lib/couchbase/search_options.rb', line 449

def field
  @field
end

Instance Method Details

#max(upper_bound, inclusive = nil) ⇒ Object

Sets upper bound of the range.

The upper boundary is considered exclusive by default on the server side.

Parameters:

  • upper_bound (String)
  • inclusive (Boolean) (defaults to: nil)


468
469
470
471
# File 'lib/couchbase/search_options.rb', line 468

def max(upper_bound, inclusive = nil)
  @max = upper_bound
  @max_inclusive = inclusive
end

#min(lower_bound, inclusive = nil) ⇒ Object

Sets lower bound of the range.

The lower boundary is considered inclusive by default on the server side.

Parameters:

  • lower_bound (String)
  • inclusive (Boolean) (defaults to: nil)


457
458
459
460
# File 'lib/couchbase/search_options.rb', line 457

def min(lower_bound, inclusive = nil)
  @min = lower_bound
  @min_inclusive = inclusive
end

#to_json(*args) ⇒ String

Returns:

  • (String)

Raises:

  • (ArgumentError)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/couchbase/search_options.rb', line 484

def to_json(*args)
  raise ArgumentError, "either min or max must be set for TermRangeQuery" if @min.nil? && @max.nil?

  data = {}
  data["boost"] = boost if boost
  data["field"] = field if field
  if @min
    data["min"] = @min
    data["inclusive_min"] = @min_inclusive unless @min_inclusive.nil?
  end
  if @max
    data["max"] = @max
    data["inclusive_max"] = @max_inclusive unless @max_inclusive.nil?
  end
  data.to_json(*args)
end