📜  mongoose ensureindex (1)

📅  最后修改于: 2023-12-03 15:17:42.581000             🧑  作者: Mango

Mongoose ensureIndex

mongoose.ensureIndex() 是 Mongoose 库提供的一个方法,用于在 MongoDB 中创建索引。索引是一种数据结构,可以提高查询的效率。通过使用索引,可以在数据库中快速定位和检索数据。

语法
mongoose.ensureIndex(keys, options, callback)
  • keys (Object):定义要在集合中建立索引的字段。每个字段可以指定为1(升序)或-1(降序)。
  • options (Object, optional):可选的配置选项。
  • callback (Function, optional):回调函数,在索引创建完成后被调用。
示例

以下示例演示了如何使用 ensureIndex() 方法创建索引:

const mongoose = require('mongoose');
const Schema = mongoose.Schema;

const userSchema = new Schema({
  name: String,
  email: String
});

userSchema.index({ name: 1, email: -1 });

const User = mongoose.model('User', userSchema);

User.ensureIndexes((err) => {
  if (err) {
    console.log("索引创建失败:", err);
  } else {
    console.log("索引创建成功!");
  }
});

在上面的示例中,我们定义了一个名为 name 的升序索引和一个名为 email 的降序索引。然后使用 ensureIndexes() 方法创建索引。

注意事项
  • ensureIndex() 方法在 Mongoose 5.12.0 版本之后被废弃,建议使用 createIndexes() 方法。
  • 需要在 Mongoose 连接到 MongoDB 之后才能调用 ensureIndex() 方法。
参考链接