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

DATACOUCH-170 - Fix N1QL annotation and inline querying in docs

Browse Source 
In some places in the doc (javadoc, README, asciidoc), the annotation was still referred to as N1QL instead of Query...

Improved doc on inline statement for N1QL queries allowing the use of positional `$1` placeholders.
This commit is contained in:
Simon Baslé
2015-10-15 17:28:37 +02:00
parent c6aa84ced4
commit 5beeaff9af
4 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -153,7 +153,7 @@ public interface UserRepository extends CrudRepository<UserInfo, String> {
/**
* Advanced querying with N1QL derivation
*/
@View
@Query
List<UserInfo> findByLastnameEqualsIgnoreCaseAndFirstnameStartsWithAndIsAdultTrue(String lastName, String fnamePrefix);
}
```
@@ -168,8 +168,11 @@ You can alternatively write the statement yourself inside the `@Query` annotatio
placeholder to make sure all necessary fields and metadata are selected by N1QL:
```java
@Query("$SELECT_ENTITY$ WHERE firstname LIKE "%ck%"
@Query("$SELECT_ENTITY$ WHERE firstname LIKE "%ck%")
List<UserInfo> findPatrickAndJackAmongOthers();
@Query("$SELECT_ENTITY$ WHERE firstname LIKE $1")
List<UserInfo> findUsersWithTheirFirstnameLike(String likePattern);
```
## Using The Repository

4
src/main/asciidoc/migrating.adoc
View File

@@ -21,8 +21,8 @@ The view-backed query method has evolved and support for N1QL has been introduce
* Simple View query (to return all elements emitted by a view) - @View annotated without `viewName`
* Intermediate View query by query derivation (to provide some criteria for the view) @View annotated with `viewName`
* N1QL with explicit statements inline - @N1QL annotated with value
* N1QL query derivation - @N1QL annotated without value / no annotation (default)
* N1QL with explicit statements inline - `@Query` annotated with value
* N1QL query derivation - `@Query` annotated without value / no annotation (default)
View backed queries are associated with the `@View` annotation, while N1QL backed queries are associated with the `@Query` annotation.

2
src/main/asciidoc/repository.adoc
View File

@@ -109,7 +109,7 @@ As of version `4.0`, Couchbase Server ships with a new query language called `N1
Prerequisite is to have a N1QL-compatible cluster and to have created a PRIMARY INDEX on the bucket where the entities will be stored.
WARNING: If it is detected at configuration time that the cluster doesn't support N1QL while there are @N1QL annotated methods or non-annotated methods in your repository interface, a `UnsupportedCouchbaseFeatureException` will be thrown.
WARNING: If it is detected at configuration time that the cluster doesn't support N1QL while there are `@Query` annotated methods or non-annotated methods in your repository interface, a `UnsupportedCouchbaseFeatureException` will be thrown.
Here is an example:

4
src/main/java/org/springframework/data/couchbase/repository/query/StringN1qlBasedQuery.java
View File

@@ -26,6 +26,10 @@ import org.springframework.data.repository.query.RepositoryQuery;
/**
* A {@link RepositoryQuery} for Couchbase, based on N1QL and a String statement.
* <p/>
* The statement can contain positional placeholders (eg. <code>name = $1</code>) that will map to the
* method's parameters, in the same order.
* <p/>
* The statement can contain placeholders for the {@link #PLACEHOLDER_BUCKET bucket namespace},
* the {@link #PLACEHOLDER_ENTITY ID and CAS fields} necessary for entity reconstruction or
* a shortcut that covers {@link #PLACEHOLDER_SELECT_FROM SELECT AND FROM clauses}.