Skip to content

Clarify QueryDSL usage in reference documentation #4951

Closed
@hojoungjang

Description

@hojoungjang

Hello, I've been working on getting Spring Data MongoDB to work with QueryDSL for a while.
I just wanted to share my findings and see if it makes sense to update the documentation page.

  1. There is no jakarta classifier for querydsl-mongodb (at least not in any of the versions found here), so trying to fetch the dependency with the jakarta classifier fails. And this makes sense because the jakarta classifier makes sense mostly in the context of JPA related libraries.

    implementation 'com.querydsl:querydsl-mongodb:${querydslVersion}:jakarta'

  2. Generating Q classes
    QueryDSL does not support any Spring data annotations like @Document so by default Q-class is not generated. I think this part of the document is trying to solve this issue

    tasks.withType(JavaCompile).configureEach {
    options.compilerArgs += [
    "-processor",
    "org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor"]
    }

    but unfortunately if the project uses other QueryDSL annotation processors, those processors also have to be manually added to this list as well (I may be wrong. This is my speculation. Apologies, I am new to Java build systems). For example, for my project, I was using QueryDSL JPA as well, and when I added the above lines to my build.gradle Q-classes for my JPA entities were not generated.

    I ended up using com.querydsl.core.annotations.QueryEntity annotation on my document entity class that is processed by the annotation processor provided by querydsl-apt with general classifier (ex. 'com.querydsl:querydsl-apt:5.0.0:general').

    After that I was able to use methods from QuerydslPredicateExecutor with the generated Q-class.

Frankly, I am not sure what would be a clear solution for number 2. Since my case is a bit specific and the solution is a workaround to the actual issue which is being able generate Q-class with Spring Data MonogDB annotations.

But at least I wanted to point out number 1 and share the findings I had for number 2 to see if the documentation can be improved.

Activity

self-assigned this
on Apr 22, 2025
mp911de

mp911de commented on Apr 22, 2025

@mp911de
Member

Good catch about the jakarta classifier, that's an oversight on our end.

but unfortunately if the project uses other QueryDSL annotation processors, those processors also have to be manually added to this list as well (I may be wrong. This is my speculation. Apologies, I am new to Java build systems). For example, for my project, I was using QueryDSL JPA as well, and when I added the above lines to my build.gradle Q-classes for my JPA entities were not generated.

Our documentation shows the simple case, assuming you're not already using annotation processing. I think we can call out that specifying annotation processors by class name requires specifying all annotation processors that way.

changed the title [-]Clarify QueryDSL usage on the documentation page[/-] [+]Clarify QueryDSL usage in reference documentation[/+] on Apr 22, 2025
added 2 commits that reference this issue on Apr 22, 2025
516b39d
2d7f083
added this to the 4.4.5 (2024.1.5) milestone on Apr 22, 2025
hojoungjang

hojoungjang commented on Apr 22, 2025

@hojoungjang
Author

That sounds good. Thanks!

added 2 commits that reference this issue on Apr 22, 2025
ff0fd94
81acf1b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Clarify QueryDSL usage in reference documentation · Issue #4951 · spring-projects/spring-data-mongodb