Class: Couchbase::SearchSort

Inherits:

Object

• Object
• Couchbase::SearchSort

Defined in:

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

Direct Known Subclasses

SearchSortField, SearchSortGeoDistance, SearchSortId, SearchSortScore

Defined Under Namespace

Classes: SearchSortField, SearchSortGeoDistance, SearchSortId, SearchSortScore

Class Method Summary

• .field(name) {|| ... } ⇒ SearchSortField
• .geo_distance(name, longitude, latitude) {|| ... } ⇒ SearchSortGeoDistance
• .id {|| ... } ⇒ SearchSortScore
• .score {|| ... } ⇒ SearchSortScore

Class Method Details

.field(name) {|| ... } ⇒ SearchSortField

Parameters:

• name (String) —

  field name

Yield Parameters:

• (SearchSortField)

Returns:

• (SearchSortField)

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

def self.field(name, &)
  SearchSortField.new(name, &)
end

.geo_distance(name, longitude, latitude) {|| ... } ⇒ SearchSortGeoDistance

Parameters:

• name (String) —

  field name

• longitude (Float)
• latitude (Float)

Yield Parameters:

• (SearchSortField)

Returns:

• (SearchSortGeoDistance)

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

def self.geo_distance(name, longitude, latitude, &)
  SearchSortGeoDistance.new(name, longitude, latitude, &)
end

.id {|| ... } ⇒ SearchSortScore

Yield Parameters:

• (SearchSortId)

Returns:

• (SearchSortScore)

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

def self.id(&)
  SearchSortId.new(&)
end

.score {|| ... } ⇒ SearchSortScore

Yield Parameters:

• (SearchSortScore)

Returns:

• (SearchSortScore)

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

def self.score(&)
  SearchSortScore.new(&)
end