Spring Data MongoDB - Where to create an index programmatically for a Mongo collection?

Question

To create an index for a collection (as documented here https://docs.spring.io/spring-data/mongodb/docs/current/reference/html/) one can use something like the following:

mongoTemplate.indexOps(Person.class).ensureIndex(new Index().on("name",Order.ASCENDING));

But where in the program should I place this code snippet?

In the relevant repository's constructor? I've did it like that now and it works, but I somehow feel like it is bad design.

Somewhere in Mongo configuration? I haven't found a suitable method to override for that here https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb/config/AbstractMongoConfiguration.html

Have you tried annotating (@Indexed) the indexed field(name) in the person pojo ? Did that not work you or may be that is not what you are looking for ? — s7vr
– s7vr, Commented Nov 1, 2017 at 13:30
@Veeram That's not what I am looking for. I have two similar DB model classes, one of which extends the other, and one of these should have a compound unique index over 2 fields, while the other should only have a simple unique index over 1 field. So I've put the @CompoundIndex annotation for the extending class and have to add the index programmatically for the extended class. — Maxim
– Maxim, Commented Nov 2, 2017 at 7:53
@NishantBhardwaz I've just placed it in the repository's constructor in absence of a better option. — Maxim
– Maxim, Commented Jan 17, 2018 at 8:47

Dawid Naczke · Accepted Answer · 2018-07-10 14:24:47Z

44

If you need to do it in programmatic way, you can just create new Spring's @Configuration and perform such initialization:

@Configuration
@DependsOn("mongoTemplate")
public class CollectionsConfig {

    @Autowired
    private MongoTemplate mongoTemplate;

    @PostConstruct
    public void initIndexes() {
        mongoTemplate.indexOps("collectionName") // collection name string or .class
            .ensureIndex(
                new Index().on("name", Sort.Direction.ASC)
        );
    }
}

answered Jul 10, 2018 at 14:24

Dawid Naczke

1,30413 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

fireball.1 Over a year ago

will this be part of controller, service or repository files ?

Monicka Over a year ago

This is a separate class and will be called on start.

ozma Over a year ago

Thanks Dawid. I found it comfortable to put this as an inner class of the interface of MongoRepository<MyObjectType>

Daniel Camarda Over a year ago

Am I correct in assuming the annotation @DependsOn("mongoTemplate") is not needed in this case because the autowired dependency on MongoTemplate implies the DependsOn relationship with that spring resource?

Taimoor Ahmad Over a year ago

I recommend following this answer so that @Index annotations can work without needing this. stackoverflow.com/a/62655088/11606132

parsa ahani · Accepted Answer · 2022-08-09 09:06:52Z

2

MongoDB supports compound indexes, where a single index structure holds references to multiple fields.

Let's see a quick example using compound indexes:

@QueryEntity
@Document
@CompoundIndexes({
    @CompoundIndex(name = "email_age", def = "{'email.id' : 1, 'age': 1}")
})
public class User {
    //
}

answered Aug 9, 2022 at 9:06

parsa ahani

711 silver badge4 bronze badges

Collectives™ on Stack Overflow

Spring Data MongoDB - Where to create an index programmatically for a Mongo collection?

2 Answers 2

5 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

5 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related