Skip to content

Commit 9b8d855

Browse files
authored
Automatically set readonly query option for read only queries (#1730)
Closes #1724
1 parent 10aaf22 commit 9b8d855

File tree

9 files changed

+34
-4
lines changed

9 files changed

+34
-4
lines changed

src/main/java/org/springframework/data/couchbase/core/ReactiveFindByQueryOperationSupport.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ public Flux<T> all() {
229229

230230
public QueryOptions buildOptions(QueryOptions options) {
231231
QueryScanConsistency qsc = scanConsistency != null ? scanConsistency : template.getConsistency();
232-
return query.buildQueryOptions(options, qsc);
232+
return query.buildQueryOptions(options, qsc).readonly(query.isReadonly());
233233
}
234234

235235
private TransactionQueryOptions buildTransactionOptions(QueryOptions options) {

src/main/java/org/springframework/data/couchbase/core/query/N1QLQuery.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ public JsonObject n1ql() {
4848
return query;
4949
}
5050

51+
@Override
52+
public boolean isReadonly() {
53+
return options.build().readonly();
54+
}
55+
5156
@Override
5257
public String toN1qlSelectString(CouchbaseConverter template, String bucketName, String scopeName,
5358
String collectionName, Class domainClass, Class returnClass, boolean isCount, String[] distinctFields,

src/main/java/org/springframework/data/couchbase/core/query/Query.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,10 @@ public Meta getMeta() {
418418
return meta;
419419
}
420420

421+
public boolean isReadonly() {
422+
return true;
423+
}
424+
421425
public boolean equals(Object o) {
422426
if (!o.getClass().isAssignableFrom(getClass())) {
423427
return false;

src/main/java/org/springframework/data/couchbase/core/query/StringQuery.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,14 @@ scopeName, collectionName, converter, typeKey, typeValue, parameterAccessor, new
131131
return sbnqp;
132132
}
133133

134+
@Override
135+
public boolean isReadonly() {
136+
if (this.queryMethod.hasN1qlAnnotation()) {
137+
return this.queryMethod.getN1qlAnnotation().readonly();
138+
}
139+
return false;
140+
}
141+
134142
/**
135143
* toN1qlRemoveString - use toN1qlSelectString
136144
*

src/main/java/org/springframework/data/couchbase/repository/Query.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,4 +58,11 @@
5858
*/
5959
String value() default "";
6060

61+
/**
62+
* Mark query as readonly
63+
*
64+
* @see com.couchbase.client.java.query.QueryOptions#readonly(boolean)
65+
*/
66+
boolean readonly() default false;
67+
6168
}

src/main/java/org/springframework/data/couchbase/repository/support/BasicQuery.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,11 @@ private boolean querySettingsEquals(BasicQuery that) {
104104
return super.equals(that);
105105
}
106106

107+
@Override
108+
public boolean isReadonly() {
109+
return true;
110+
}
111+
107112
/*
108113
* (non-Javadoc)
109114
*/

src/test/java/org/springframework/data/couchbase/core/CouchbaseTemplateQueryCollectionIntegrationTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -698,7 +698,7 @@ public void findByIdOptions() { // 3
698698
@Test
699699
public void findByQueryOptions() { // 4
700700
QueryOptions options = QueryOptions.queryOptions().timeout(Duration.ofNanos(10));
701-
assertThrows(AmbiguousTimeoutException.class, () -> couchbaseTemplate.findByQuery(Airport.class)
701+
assertThrows(UnambiguousTimeoutException.class, () -> couchbaseTemplate.findByQuery(Airport.class)
702702
.withConsistency(REQUEST_PLUS).inScope(otherScope).inCollection(otherCollection).withOptions(options).all());
703703
}
704704

src/test/java/org/springframework/data/couchbase/core/query/ReactiveCouchbaseTemplateQueryCollectionIntegrationTests.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -689,7 +689,7 @@ public void findByIdOptions() { // 3
689689
@Test
690690
public void findByQueryOptions() { // 4
691691
QueryOptions options = QueryOptions.queryOptions().timeout(Duration.ofNanos(10));
692-
assertThrows(AmbiguousTimeoutException.class,
692+
assertThrows(UnambiguousTimeoutException.class,
693693
() -> template.findByQuery(Airport.class).withConsistency(REQUEST_PLUS).inScope(otherScope)
694694
.inCollection(otherCollection).withOptions(options).all().collectList().block());
695695
}

src/test/java/org/springframework/data/couchbase/repository/CouchbaseRepositoryQueryIntegrationTests.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
import static org.junit.jupiter.api.Assertions.assertTrue;
3131
import static org.springframework.data.couchbase.config.BeanNames.COUCHBASE_TEMPLATE;
3232

33+
import com.couchbase.client.core.error.UnambiguousTimeoutException;
3334
import jakarta.validation.ConstraintViolationException;
3435
import junit.framework.AssertionFailedError;
3536

@@ -644,7 +645,7 @@ void findBySimplePropertyWithOptions() {
644645
try {
645646
Airport saved = airportRepository.save(vie);
646647
// Duration of 1 nano-second will cause timeout
647-
assertThrows(AmbiguousTimeoutException.class,
648+
assertThrows(UnambiguousTimeoutException.class,
648649
() -> airportRepository.withOptions(queryOptions().timeout(Duration.ofNanos(1))).iata(vie.getIata()));
649650

650651
Airport airport3 = airportRepository

0 commit comments

Comments
 (0)