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

Comment about accepting a string order_by value.

Browse Source
This commit is contained in:
Jim Menard 2009-01-07 10:10:51 -05:00
parent 9446d50145
commit 2bde6b4029
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/mongo/query.rb
View File

@ -43,16 +43,18 @@ module XGen
# in calls to Collection#find.) Default is 0 (all
# records).
#
# 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.)
# order_by :: If not +nil+, specifies record sort order. May be a
# String, Hash, OrderedHash, or Array. If a string, the
# results will be ordered by that field in ascending
# order. 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