DBIndex class

Configuration class for MongoDB database indexes.

This class encapsulates all the configuration options needed to create a MongoDB index. It provides a convenient way to define index properties that will be used when creating indexes on collection fields.

MongoDB indexes improve query performance and can enforce constraints like uniqueness. This class supports all major index options including:

• Single field and compound indexes
• Unique constraints
• Sparse indexes (ignore null values)
• Partial indexes with filter expressions
• Background index creation
• Custom collation for text sorting

Example:

var emailIndex = DBIndex(
  key: 'email',
  unique: true,
  sparse: true,
);

var compoundIndex = DBIndex(
  keys: {'category': 1, 'createdAt': -1},
  name: 'category_date_idx',
);