github-migration
/
mongo-ruby-driver
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add docs about order_by Hash/OrderedHash

This commit is contained in:
Jim Menard 2009-01-06 16:52:29 -05:00
parent f709bc6290
commit b6a515f870
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/mongo/query.rb
View File

@ -42,11 +42,16 @@ module XGen
# number_to_return :: Max number of records to return. (Called :limit
# in calls to Collection#find.)
#
# order_by :: If not +nil+, specifies record return order. Either hash
# of field names as keys and 1/-1 as values; 1 ==
# ascending, -1 == descending, or array of field names
# (all assumed to be sorted in ascending order). (Called
# :sort in calls to Collection#find.)
# order_by :: If not +nil+, specifies record sort order. May be either
# a hash or an array. If an array, it should be an array
# of field names which will all be sorted in ascending
# order. If a hash, it may be either a regular Hash or an
# OrderedHash. The keys should be field names, and the
# values should be 1 (ascending) or -1 (descending). Note
# that if it is a regular Hash then sorting by more than
# one field probably will not be what you intend because
# key order is not preserved. (order_by is called :sort in
# calls to Collection#find.)
def initialize(sel={}, return_fields=nil, number_to_skip=0, number_to_return=0, order_by=nil)
@number_to_skip, @number_to_return, @order_by = number_to_skip, number_to_return, order_by
self.selector = sel