クラス QueryByExampleDataFetcher<T>
java.lang.ObjectSE
org.springframework.graphql.data.query.QueryByExampleDataFetcher<T>
- 型パラメーター:
T- 返される結果の型
Query By Example リポジトリから
DataFetcher を作成するためのメインクラスです。インスタンスを作成するには、次のいずれかを使用します。例:
interface BookRepository extends
Repository<Book, String>, QueryByExampleExecutor<Book>{}
TypeRuntimeWiring wiring = … ;
BookRepository repository = … ;
DataFetcher<?> forMany =
wiring.dataFetcher("books", QueryByExampleDataFetcher.builder(repository).many());
DataFetcher<?> forSingle =
wiring.dataFetcher("book", QueryByExampleDataFetcher.builder(repository).single());
結果の射影と並べ替えに関するその他のオプションについては、QueryByExampleDataFetcher.Builder と QueryByExampleDataFetcher.ReactiveBuilder のメソッドを参照してください。
QueryByExampleDataFetcher exposes @GraphQlRepository でアノテーションが付けられたリポジトリを自動登録できる RuntimeWiringConfigurer。
- 導入:
- 1.0.0
- 作成者:
- Greg Turnquist, Rossen Stoyanchev
- 関連事項:
ネストされたクラスの概要
ネストされたクラス修飾子と型クラス説明static class例示による問い合わせベースのDataFetcher用のビルダー。static interfaceQueryByExampleDataFetcherQueryByExampleDataFetcher.Builderをカスタマイズして構成を変更するために使用できるコールバックインターフェース。static classリアクティブ Query by Example ベースのDataFetcher用のビルダー。static interfaceQueryByExampleDataFetcherQueryByExampleDataFetcher.ReactiveBuilderをカスタマイズして構成を変更するために使用できるコールバックインターフェース。方法の概要
修飾子と型メソッド説明static RuntimeWiringConfigurerautoRegistrationConfigurer(ListSE<org.springframework.data.repository.query.QueryByExampleExecutor<?>> executors, ListSE<org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<?>> reactiveExecutors) CursorStrategyのないautoRegistrationConfigurer(List, List, CursorStrategy, ScrollSubrange)とデフォルトのScrollSubrangeのバリエーション。static RuntimeWiringConfigurerautoRegistrationConfigurer(ListSE<org.springframework.data.repository.query.QueryByExampleExecutor<?>> executors, ListSE<org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<?>> reactiveExecutors, @Nullable CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy, @Nullable ScrollSubrange defaultScrollSubrange) 指定されたリポジトリのドメイン型名と一致する名前の戻り値の型を持つクエリを見つけるためにWiringFactoryをインストールし、それらのDataFetcherを登録するRuntimeWiringConfigurerを返します。static <T> QueryByExampleDataFetcher.Builder<T, T> builder(org.springframework.data.repository.query.QueryByExampleExecutor<T> executor) static <T> QueryByExampleDataFetcher.ReactiveBuilder<T, T> builder(org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<T> executor) ReactiveQueryByExampleExecutorを受け入れてDataFetcherを構築する新しいQueryByExampleDataFetcher.ReactiveBuilderを作成します。protected org.springframework.data.domain.Example<T> buildExample(graphql.schema.DataFetchingEnvironment environment) GraphQL リクエスト引数からExampleを準備します。protected CollectionSE<StringSE> buildPropertyPaths(graphql.schema.DataFetchingFieldSelectionSet selection, ClassSE<?> resultType) すべてのサブクラスにSelfDescribingDataFetcher.getDescription()の共有実装を提供します。protected booleanrequiresProjection(ClassSE<?> resultType) toString()
メソッドの詳細
getDescription
すべてのサブクラスにSelfDescribingDataFetcher.getDescription()の共有実装を提供します。- 導入:
- 1.2.0
buildExample
protected org.springframework.data.domain.Example<T> buildExample(graphql.schema.DataFetchingEnvironment environment) throws BindException GraphQL リクエスト引数からExampleを準備します。- パラメーター:
environment- GraphQL リクエストのコンテキスト情報- 戻り値:
- 結果の例
- 例外:
BindException
requiresProjection
buildPropertyPaths
protected CollectionSE<StringSE> buildPropertyPaths(graphql.schema.DataFetchingFieldSelectionSet selection, ClassSE<?> resultType) toString
builder
public static <T> QueryByExampleDataFetcher.Builder<T,T> builder(org.springframework.data.repository.query.QueryByExampleExecutor<T> executor) - 型パラメーター:
T- リポジトリのドメイン型- パラメーター:
executor- 使用する QBE リポジトリオブジェクト- 戻り値:
- 新しいビルダー
builder
public static <T> QueryByExampleDataFetcher.ReactiveBuilder<T,T> builder(org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<T> executor) ReactiveQueryByExampleExecutorを受け入れてDataFetcherを構築する新しいQueryByExampleDataFetcher.ReactiveBuilderを作成します。- 型パラメーター:
T- リポジトリのドメイン型- パラメーター:
executor- 使用する QBE リポジトリオブジェクト- 戻り値:
- 新しいビルダー
autoRegistrationConfigurer
public static RuntimeWiringConfigurer autoRegistrationConfigurer(ListSE<org.springframework.data.repository.query.QueryByExampleExecutor<?>> executors, ListSE<org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<?>> reactiveExecutors) CursorStrategyのないautoRegistrationConfigurer(List, List, CursorStrategy, ScrollSubrange)とデフォルトのScrollSubrangeのバリエーション。デフォルト値については、QueryByExampleDataFetcher.BuilderおよびQueryByExampleDataFetcher.ReactiveBuilderのそれぞれのメソッドを参照してください。- パラメーター:
executors- 登録を検討するリポジトリreactiveExecutors- 登録を検討するリアクティブリポジトリ
autoRegistrationConfigurer
public static RuntimeWiringConfigurer autoRegistrationConfigurer(ListSE<org.springframework.data.repository.query.QueryByExampleExecutor<?>> executors, ListSE<org.springframework.data.repository.query.ReactiveQueryByExampleExecutor<?>> reactiveExecutors, @Nullable CursorStrategy<org.springframework.data.domain.ScrollPosition> cursorStrategy, @Nullable ScrollSubrange defaultScrollSubrange) 指定されたリポジトリのドメイン型名と一致する名前の戻り値の型を持つクエリを見つけるためにWiringFactoryをインストールし、それらのDataFetcherを登録するRuntimeWiringConfigurerを返します。注意 : これは、
@GraphQlRepositoryでアノテーションが付けられたトップレベルのクエリとリポジトリにのみ適用されます。- パラメーター:
executors- 登録を検討するリポジトリreactiveExecutors- 登録を検討するリアクティブリポジトリcursorStrategy- ページネーションリクエストのカーソルをデコードするため。nullの場合は、QueryByExampleDataFetcher.Builder.cursorStrategyのデフォルトが適用されます。defaultScrollSubrange- スクロール用のデフォルトパラメーター。nullの場合、QueryByExampleDataFetcher.Builder.defaultScrollSubrange(int, java.util.function.Function<java.lang.Boolean, org.springframework.data.domain.ScrollPosition>)のデフォルトが適用されます。- 戻り値:
- 作成された設定者
- 導入:
- 1.2.0