Class: Couchbase::SearchSort::SearchSortField
- Inherits:
-
Couchbase::SearchSort
- Object
- Couchbase::SearchSort
- Couchbase::SearchSort::SearchSortField
- Defined in:
- lib/couchbase/search_options.rb
Instance Attribute Summary collapse
-
#desc ⇒ Boolean
If descending order should be applied.
-
#field ⇒ String
readonly
Name of the field to sort by.
-
#missing ⇒ :first, :last
Where the documents with missing field should be placed.
- #mode ⇒ :default, ...
- #type ⇒ :auto, ...
Instance Method Summary collapse
-
#initialize(field) {|| ... } ⇒ SearchSortField
constructor
A new instance of SearchSortField.
- #to_json(*args) ⇒ Object private
Methods inherited from Couchbase::SearchSort
field, geo_distance, id, score
Constructor Details
#initialize(field) {|| ... } ⇒ SearchSortField
Returns a new instance of SearchSortField.
1215 1216 1217 1218 1219 |
# File 'lib/couchbase/search_options.rb', line 1215 def initialize(field) super() @field = field yield self if block_given? end |
Instance Attribute Details
#desc ⇒ Boolean
Returns if descending order should be applied.
1202 1203 1204 |
# File 'lib/couchbase/search_options.rb', line 1202 def desc @desc end |
#field ⇒ String (readonly)
Returns name of the field to sort by.
1199 1200 1201 |
# File 'lib/couchbase/search_options.rb', line 1199 def field @field end |
#missing ⇒ :first, :last
Returns where the documents with missing field should be placed.
1208 1209 1210 |
# File 'lib/couchbase/search_options.rb', line 1208 def missing @missing end |
#mode ⇒ :default, ...
1211 1212 1213 |
# File 'lib/couchbase/search_options.rb', line 1211 def mode @mode end |
#type ⇒ :auto, ...
1205 1206 1207 |
# File 'lib/couchbase/search_options.rb', line 1205 def type @type end |
Instance Method Details
#to_json(*args) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1222 1223 1224 |
# File 'lib/couchbase/search_options.rb', line 1222 def to_json(*args) {by: :field, field: field, desc: desc, type: type, missing: missing, mode: mode}.to_json(*args) end |