对象 MongoCollection

mongodb 数据库数据集对象

使用 MongoDB.getCollection 创建：

1
2
var col1 = mdb.getCollection('test');
var col = mdb.test;

继承关系

操作符

operator[String]

以属性方式快速获取当前集合子命名空间的集合对象

1
readonly MongoCollection MongoCollection[String];

返回结果:

• 返回新集合对象

成员函数

find

根据给定的查询条件和返回字段设定，建立游标对象

1
2
MongoCursor MongoCollection.find(Object query = {},
    Object projection = {});

调用参数:

• query: Object, 指定查询条件的对象
• projection: Object, 指定返回字段的对象

返回结果:

• MongoCursor, 返回游标对象

---

findOne

根据给定的查询条件和返回字段设定，查询一条结果

1
2
Object MongoCollection.findOne(Object query = {},
    Object projection = {});

调用参数:

• query: Object, 指定查询条件的对象
• projection: Object, 指定返回字段的对象

返回结果:

• Object, 返回第一条结果

---

findAndModify

查询并修改

1
Object MongoCollection.findAndModify(Object query);

调用参数:

• query: Object, 指定查询条件，修改数据

返回结果:

• Object, 返回修改前的结果及其他信息

---

insert

插入一组数据

1
MongoCollection.insert(Array documents);

调用参数:

• documents: Array, 指定要插入的数据数组

---

插入一条数据

1
MongoCollection.insert(Object document);

调用参数:

• document: Object, 指定要插入的数据

---

save

保存一条数据，若数据包含 _id 字段，则为更新，否则为插入

1
MongoCollection.save(Object document);

调用参数:

• document: Object, 指定要保存的数据

---

update

根据给定的查询条件更新数据

1
2
3
4
MongoCollection.update(Object query,
    Object document,
    Boolean upsert = false,
    Boolean multi = false);

调用参数:

• query: Object, 指定查询条件的对象
• document: Object, 指定要更新的数据
• upsert: Boolean, 数据不存在时，插入一条新数据，缺省为 false，不插入
• multi: Boolean, 当符合条件的数据多于一条时，更新所有数据，缺省为 false，只更新第一条

---

根据给定的查询条件更新数据

1
2
3
MongoCollection.update(Object query,
    Object document,
    Object options);

调用参数:

• query: Object, 指定查询条件的对象
• document: Object, 指定要更新的数据
• options: Object, 以对象字段传递的 upsert 和 multi 选项

---

remove

根据给定的查询条件删除数据

1
MongoCollection.remove(Object query);

调用参数:

• query: Object, 指定查询条件的对象

---

runCommand

执行数据库命令

1
Object MongoCollection.runCommand(Object cmd);

调用参数:

• cmd: Object, 给定命令对象

返回结果:

• Object, 返回命令返回结果

---

执行数据库命令

1
2
Object MongoCollection.runCommand(String cmd,
    Object arg = {});

调用参数:

• cmd: String, 给定命令名称
• arg: Object, 给定命令参数选项

返回结果:

• Object, 返回命令返回结果

---

drop

删除当前集合

1
MongoCollection.drop();

---

ensureIndex

在当前集合上创建索引

1
2
MongoCollection.ensureIndex(Object keys,
    Object options = {});

调用参数:

• keys: Object, 给定索引字段、顺序和方向
• options: Object, 给定索引的选项，唯一索引等

---

reIndex

重建当前集合的索引

1
Object MongoCollection.reIndex();

返回结果:

• Object, 返回命令执行结果

---

dropIndex

删除当前集合指定名称的索引

1
Object MongoCollection.dropIndex(String name);

调用参数:

• name: String, 给定要删除的索引名称

返回结果:

• Object, 返回命令执行结果

---

dropIndexes

删除当前集合全部索引

1
Object MongoCollection.dropIndexes();

返回结果:

• Object, 返回命令执行结果

---

getIndexes

查询当前集合全部索引

1
Array MongoCollection.getIndexes();

返回结果:

• Array, 返回包含索引的结果集

---

getCollection

获取当前集合子命名空间的集合对象

1
MongoCollection MongoCollection.getCollection(String name);

调用参数:

• name: String, 子命名空间名称

返回结果:

• MongoCollection, 返回新集合对象

---

toString

返回对象的字符串表示，一般返回 "[Native Object]"，对象可以根据自己的特性重新实现

1
String MongoCollection.toString();

返回结果:

• String, 返回对象的字符串表示

---

toJSON

返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合

1
Value MongoCollection.toJSON(String key = "");

调用参数:

• key: String, 未使用

返回结果:

• Value, 返回包含可 JSON 序列化的值