spring-data-mongodb icon indicating copy to clipboard operation
spring-data-mongodb copied to clipboard

@Collation annotation on documents, repositories or queries not interpreted

Open dirkbolte opened this issue 2 years ago • 3 comments

I'm using Spring data mongo and want to use collations for various queries. The collations need to work with the default repository methods as well as with custom queries.

According to the reference doc and the #2755 , the following should work:

@Collation(value = "...")
data class SampleDocument(
    @field:MongoId
    var id: String? = null,
    val value: String
)

interface RepositoryWithCollationInQuery: CrudRepository<SampleDocument, String> {
    @Collation(value = "...")
    @Query(
        value = "{}",
        sort = """{ "value":  1}""",
    )
    fun findAllCollationInAnnotation(): List<SampleDocument>
}

But the collation is not evaluated. It is only evaluated when adding it to @Query directly.

A sample project with the expected usage (and failing tests) can be found here: https://github.com/dirkbolte/mongodb_collation_test

The following approaches were tried:

  • adding @Collation to the data class (failed)
  • adding @Collation to the repository interface (failed)
  • adding @Collation to the query method (failed)
  • specifying collation=... on the @Query annotation (worked)

I would expect that adding the @Collation annotation to repository and/or document would allow all repository methods to make use of it, especially when using findAll(pageable) of the default spring repository interfaces. When requiring @Query for everything, I would have to specify every query manually and explicitly, which doesn't feel right.

Versions:

  • Spring Boot: 3.1.5
  • Spring Data Mongo: 4.1.5
  • MongoDB: 6 (4 showed no differences)

For reference, the I asked the question on stack overflow as well, in case this is a user error.

dirkbolte avatar Oct 23 '23 08:10 dirkbolte

@dirkbolte thanks for reporting and the reproducer - we'll have a look.

christophstrobl avatar Oct 23 '23 09:10 christophstrobl

The custom query ones seem to fail due to duplicate test data.

Good catch on the inherited methods. BasicPersistentEntity did not properly consider @Collation but was only looking for @Document and the collation was not properly passed on in SimpleMongoRepository - we'll take care of that.

christophstrobl avatar Oct 23 '23 10:10 christophstrobl