find()
语法
db.collectionspace.collection.find([cond],[sel])
db.collectionspace.collection.find([cond],[sel]).hint([hint])
db.collectionspace.collection.find([cond],[sel]).skip([skipNum]).limit([retNum]).sort([sort])
db.collectionspace.collection.find([cond],[sel])[.hint([hint])][.skip([skipNum])][.limit([retNum])][.sort([sort])]
db.collectionspace.collection.find([SdbQueryOption])
类别
Collection
选择集合的记录,并通过游标(cursor)将记录返回。在 SequoiaDB 中,游标是一个指针,指向一个查询结果集,客户端可以通过游标遍历检索结果。
参数
- ( Object, 选填 )
sel
( Object, 选填 )
查询返回记录的字段名。为空时,返回记录的所有字段;如果指定的字段名记录中不存在,则按用户设定的内容原样返回。如:{"name":"","age":"","addr":""}。
hint
( Object, 选填 )
指定查询使用索引的情况。
- 不指定
hint
:查询是否使用索引及使用哪个索引将由数据库决定; hint
为{"":null}:查询走表扫描;- 为单个索引:如:{"":"myIdx"},表示查询将使用当前集合中名字为"myIdx"的索引进行;
自定义从结果集哪条记录开始返回。默认值为0,表示从第一条记录开始返回。
retNum
( Int32, 选填 )
自定义返回结果集的记录条数。默认值为-1,表示返回从skipNum
位置开始到结果集结束位置的所有记录。
- ( Object, 选填 )
指定结果集按指定字段名排序的情况。字段名的值为1或者-1,如:{"name":1,"age":-1}。
- 不指定
sort
:表示不对结果集做排序; - 字段名的值为1:表示按该字段名升序排序;
- 字段名的值为-1:表示按该字段名降序排序。
SdbQueryOption
( Object, 选填 )
使用一个对象来指定记录查询参数。使用方法可参考。
注意:
hint
参数为Object类型,其字段名可以为任意不重复的字符串,数据库只关心起字段内容。
返回值
成功:返回DBCursor对象。
失败:抛出异常。
函数常见异常如下:
当异常抛出时,可以通过获取错误码,或通过获取错误信息。可以参考常见错误处理指南了解更多内容。
版本
v1.0及以上版本。
示例
- 查询所有记录,不指定 cond 和 sel 字段。
- 查询匹配条件的记录,即设置 cond 参数的内容。如下操作返回集合 bar 中符合条件 age 字段值大于25且 name 字段值为"Tom"的记录。
- > db.foo.bar.find( { age: { $gt: 25 }, name: "Tom" } )
- 指定返回的字段名,即设置 sel 参数的内容。如有记录{ age: 25, type: "system" }和{ age: 20, name: "Tom", type: "normal" },如下操作返回记录的age字段和name字段。
- 使用索引 ageIndex 遍历集合 bar 下存在 age 字段的记录,并返回。
- > db.foo.test.find( {age: {$exists:1} } ).hint( { "": "ageIndex" } )
- "_id": {
- "$oid": "5812feb6c842af52b6000007"
- },
- "age": 10
- }
- {
- "_id": {
- "$oid": "5812feb6c842af52b6000008"
- },
- "age": 20
- }
- 选择集合 bar 下 age 字段值大于10的记录(如使用 查询),从第5条记录开始返回,即跳过前面的四条记录。
如果结果集的记录数不大于3,那么无记录返回;如果结果集的记录数大于3,则从第4条开始, 最多返回5条记录。
- 返回集合 bar 中 age 字段值大于20的记录(如使用 $gt 查询),设置只返回记录的 name 和 age 字段,并按 age 字段值的升序排序。
- > db.foo.bar.find( { age: { $gt: 20 } }, { age: "", name: "" } ).sort( { age: 1 } )
- 指定一个无效的排序字段。
因为“sex”字段并不存在 find() 方法的 sel 选项 {age:"",name:""} 中,所以 sort() 指定的排序字段 {"sex":1} 将被忽略。
- > db.foo.bar.find({"":{"$Text":{"query":{"match":{"about" : "rock climbing"}}}}})