Spring/spring-data-couchbase
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update QueryDSL doc. (#1994)

Browse Source 
Closes #1993.
This commit is contained in:
Michael Reiche
2024-10-17 14:29:27 -07:00
committed by GitHub
parent bc0c757df3
commit b751bdd12a
1 changed files with 43 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
src/main/antora/modules/ROOT/pages/couchbase/repository.adoc
View File

@@ -33,33 +33,47 @@ An advanced usage is described in <<couchbase.repository.multibucket>>.
[[couchbase.repository.configuration.dsl]] [[couchbase.repository.configuration.dsl]]
=== QueryDSL Configuration === QueryDSL Configuration
Spring Data Couchbase supports QueryDSL for building type-safe queries. To enable code generation you need to set `spring-data-couchbase` as annotation processor on your project. Spring Data Couchbase supports QueryDSL for building type-safe queries. To enable code generation, setting `CouchbaseAnnotationProcessor` as an annotation processor is required.
Additionally, the runtime needs querydsl-apt to enable QueryDSL on repositories.
.Maven Configuration Example .Maven Configuration Example
==== ====
[source,xml] [source,xml]
---- ----
. existing depdendencies including those required for spring-data-couchbase
.
.
<dependency>
<groupId>com.querydsl</groupId>
<artifactId>querydsl-apt</artifactId>
<version>${querydslVersion}</version>
</dependency>
</dependencies>
<build> <build>
<plugins> <plugins>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId> <artifactId>maven-compiler-plugin</artifactId>
<version>[compiler-plugin-version]</version> <executions>
<configuration> <execution>
<annotationProcessorPaths> <id>annotation-processing</id>
<!-- path to the annotation processor --> <phase>generate-sources</phase>
<path> <goals>
<groupId>com.querydsl</groupId> <goal>compile</goal>
<artifactId>querydsl-apt</artifactId> </goals>
<version>[version]</version> <configuration>
</path> <proc>only</proc>
<path> <annotationProcessors>
<groupId>org.springframework.data</groupId> <annotationProcessor>org.springframework.data.couchbase.repository.support.CouchbaseAnnotationProcessor</annotationProcessor>
<artifactId>spring-data-couchbase</artifactId> </annotationProcessors>
<version>[version]</version> <generatedTestSourcesDirectory>target/generated-sources</generatedTestSourcesDirectory>
</path> <compilerArgs>
</annotationProcessorPaths> <arg>-Aquerydsl.logInfo=true</arg>
</configuration> </compilerArgs>
</configuration>
</execution>
</executions>
</plugin> </plugin>
</plugins> </plugins>
</build> </build>
@@ -69,10 +83,19 @@ Spring Data Couchbase supports QueryDSL for building type-safe queries. To enabl
.Gradle Configuration Example .Gradle Configuration Example
==== ====
[source,groovy] [source,groovy,indent=0,subs="verbatim,quotes",role="secondary"]
---- ----
annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}' dependencies {
annotationProcessor 'org.springframework.data:spring-data-couchbase:${springDataCouchbaseVersion}' annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}'
annotationProcessor 'org.springframework.data:spring-data-couchbase'
testAnnotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}'
testAnnotationProcessor 'org.springframework.data:spring-data-couchbase'
}
tasks.withType(JavaCompile).configureEach {
options.compilerArgs += [
"-processor",
"org.springframework.data.couchbase.repository.support.CouchbaseAnnotationProcessor"]
}
---- ----
==== ====