Nest.js - Create index in mongoose schema

user_2436448 0
Viewed 6570

How do I create an index of property in mongoose schema using Nest.js?

I tried to add index as a property option, But the index hasn't been created:

@Schema()
export class Schema extends Document {

  @Prop()
  _id: string;

  @Prop({required: true, index: true})
  type: string;

  @Prop()
  creationDate: string;

  @Prop()
  name: string;
}

export const MySchema = SchemaFactory.createForClass(Schema);

I tried this way too:

export const MySchema = SchemaFactory.createForClass(Schema).index({ type: 1 });

Both doesn't work as expected.

What is the way to do that?

Thanks

mongoose nestjs node.js
3 Answers

Use following option to create index

    @Schema({useCreateIndex: true})
    export class Schema extends Document {
    
      @Prop()
      _id: string;
    
      @Prop({required: true, index: true})
      type: string;
    
      @Prop()
      creationDate: string;
    
      @Prop()
      name: string;
    }

export const MySchema = SchemaFactory.createForClass(Schema);

use useCreateIndex flag either when defining the schema

or globally set the same flag when creating the connection object

 {
  uri: `....`,
  user: ,
  pass: ,
  //useNewUrlParser: true,
  useCreateIndex: true,
  //useUnifiedTopology: true,
  //useFindAndModify: false,
  retryAttempts: 3
}

Added other commented flags as well which could be required.

user_93818090

If someone came here looking for how to add index for a geo location/2dsphere, just like me, You can use the following in NestJs.

@Prop({ index: "2dsphere" })

Also when you are setting up the mongoose module, add useCreateIndex: true.

MongooseModule.forRootAsync({
 useFactory: async (config: ConfigService) => ({
   uri: config.get('mongo_url'),
   useNewUrlParser: true,
   useCreateIndex: true,
 }),
 inject: [ConfigService],
})
user_67088770

This works for me

export const MySchema = SchemaFactory.createForClass(Schema);
MySchema.index({ type: 1 }, { unique: true });

Same can be extended for compound index as well - ex:

MySchema.index({ type: 1, name: 1 }, { unique: true });
user_73676790
Related