Interface
IndexDefinitionOptions
The options every index definition accepts.
interface IndexDefinitionOptionsDefined in packages/driver/src/indexes.ts:16
Properties#
name
#readonly name?: stringDefaults to the fields and directions, such as email_1 or
country_1_age_-1.
Defined in packages/driver/src/indexes.ts:31
sparse
#readonly sparse?: booleanDocuments without the field are left out, so they never conflict. A compound index leaves out only the documents that have none of its fields.
Defined in packages/driver/src/indexes.ts:26
unique
#readonly unique?: booleanAt most one document may hold a given value, or a given combination of values for a compound index, or lack the field.
Defined in packages/driver/src/indexes.ts:21