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

Polishing contribution

Browse Source 
Closes gh-215
This commit is contained in:
Rossen Stoyanchev
2021-12-09 21:23:37 +00:00
parent ddec60a68e
commit 58f2afebb5
5 changed files with 15 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
spring-graphql-docs/src/docs/asciidoc/index.adoc
View File

@@ -538,12 +538,11 @@ detects `@GraphQlRepository` beans and applies the `GraphQLTypeVisitor`.
=== Query by Example
Spring Data supports the use of
https://docs.spring.io/spring-data/commons/docs/current/reference/html/#query-by-example[Query by Example] as a means to
fetch data.
Query by Example provides a flexible approach to express queries by allowing the user to define what fields are vital
and what are not.
https://docs.spring.io/spring-data/commons/docs/current/reference/html/#query-by-example[Query by Example]
to fetch data. Query by Example (QBE) is a simple querying technique that does not require
you to write queries through store-specific query languages.
For example, declare a repository as `QueryByExampleExecutor`:
Start by declaring a repository that is `QueryByExampleExecutor`:
[source,java,indent=0,subs="verbatim,quotes"]
----
@@ -552,7 +551,7 @@ public interface AccountRepository extends Repository<Account, Long>,
}
----
Then use it to create a `DataFetcher`:
Use `QueryByExampleDataFetcher` to turn the repository into a `DataFecher`:
[source,java,indent=0,subs="verbatim,quotes"]
----
@@ -565,9 +564,9 @@ Then use it to create a `DataFetcher`:
QueryByExampleDataFetcher.builder(repository).many();
----
The `DataFetcher` builds a Query by Example `Example` from GraphQL request parameters, and
uses it to fetch data. Spring Data supports `QueryByExampleDataFetcher` for JPA,
MongoDB, Neo4j, and Redis.
The `DataFetcher` uses the GraphQL arguments map to create the domain type of the
repository and use that as the example object to fetch data with. Spring Data supports
`QueryByExampleDataFetcher` for JPA, MongoDB, Neo4j, and Redis.
If the repository is `ReactiveQueryByExampleExecutor`, the builder returns
`DataFetcher<Mono<Account>>` or `DataFetcher<Flux<Account>>`. Spring Data supports this
@@ -577,8 +576,8 @@ variant for MongoDB, Neo4j, Redis, and R2dbc.
[[data-querybyexample-build]]
==== Build Setup
Query by Example is already included in the Spring Data modules that support it.
No extra setup is required to enable it.
Query by Example is already included in the Spring Data modules for the data stores where
it is supported, so no extra setup is required to enable it.
[[data-querybyexample-customizations]]

4
spring-graphql/src/main/java/org/springframework/graphql/data/query/QueryByExampleDataFetcher.java
View File

@@ -70,7 +70,7 @@ import org.springframework.util.Assert;
* {@link QueryByExampleDataFetcher.ReactiveBuilder} for further options on
* result projections and sorting.
*
* <p>{@code QueryByExampleDataFetcher} {@link #registrationTypeVisitor(List, List) exposes}
* <p>{@code QueryByExampleDataFetcher} {@link #autoRegistrationTypeVisitor(List, List) exposes}
* a {@link GraphQLTypeVisitor} that can auto-register repositories annotated with
* {@link GraphQlRepository @GraphQlRepository}.
*
@@ -161,7 +161,7 @@ public abstract class QueryByExampleDataFetcher<T> {
* @param reactiveExecutors reactive repositories to consider for registration
* @return the created visitor
*/
public static GraphQLTypeVisitor registrationTypeVisitor(
public static GraphQLTypeVisitor autoRegistrationTypeVisitor(
List<QueryByExampleExecutor<?>> executors,
List<ReactiveQueryByExampleExecutor<?>> reactiveExecutors) {

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/jpa/QueryByExampleDataFetcherJpaTests.java
View File

@@ -179,7 +179,7 @@ class QueryByExampleDataFetcherJpaTests {
private static GraphQlSetup initGraphQlSetup(@Nullable QueryByExampleExecutor<?> executor) {
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.registrationTypeVisitor(
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.autoRegistrationTypeVisitor(
executor != null ? Collections.singletonList(executor) : Collections.emptyList(),
Collections.emptyList());

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/mongo/QueryByExampleDataFetcherMongoDbTests.java
View File

@@ -177,7 +177,7 @@ class QueryByExampleDataFetcherMongoDbTests {
private static GraphQlSetup initGraphQlSetup(@Nullable QueryByExampleExecutor<?> executor) {
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.registrationTypeVisitor(
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.autoRegistrationTypeVisitor(
(executor != null ? Collections.singletonList(executor) : Collections.emptyList()),
Collections.emptyList());

2
spring-graphql/src/test/java/org/springframework/graphql/data/query/mongo/QueryByExampleDataFetcherReactiveMongoDbTests.java
View File

@@ -149,7 +149,7 @@ class QueryByExampleDataFetcherReactiveMongoDbTests {
private static GraphQlSetup initGraphQlSetup(@Nullable ReactiveQueryByExampleExecutor<?> executor) {
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.registrationTypeVisitor(
GraphQLTypeVisitor visitor = QueryByExampleDataFetcher.autoRegistrationTypeVisitor(
Collections.emptyList(),
(executor != null ? Collections.singletonList(executor) : Collections.emptyList()));