ensureIndex method

void ensureIndex(
  1. dynamic keys, {
  2. String key = '',
  3. bool unique = false,
  4. bool sparse = false,
  5. bool background = false,
  6. bool dropDups = false,
  7. Map<String, dynamic>? partialFilterExpression,
  8. String name = '',
})

Adds index definition to create it on opening

  • keys index keys (fields)
  • options index options

Implementation

void ensureIndex(keys,
    {String key = '',
    bool unique = false,
    bool sparse = false,
    bool background = false,
    bool dropDups = false,
    Map<String, dynamic>? partialFilterExpression,
    String name = ''}) {
  if (keys == null) return;
  _indexes.add(MongoDbIndex(keys, key, unique, sparse, background, dropDups,
      partialFilterExpression ?? <String, dynamic>{}, name));
}