graphql.nadel.engine.transform.hydration.batch.indexing.NadelBatchHydrationIndexer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nadel Show documentation

Nadel is a Java library that combines multiple GrahpQL services together into one API.

There is a newer version: 2024-11-20T03-31-21-302962b7

package graphql.nadel.engine.transform.hydration.batch.indexing

import graphql.nadel.engine.transform.hydration.batch.NadelResolvedObjectBatch
import graphql.nadel.engine.transform.result.json.JsonNode

/**
 * Interface to define a process to index the result objects.
 */
internal interface NadelBatchHydrationIndexer {
    /**
     * The [sourceInput] is not always the key for the result index.
     *
     * e.g. for
     *
     * ```graphql
     * @hydrated(
     *     field: "jira.commentsById"
     *     arguments : [{ name:"input" value:"$source.context.jiraComment"}]
     *     inputIdentifiedBy : [
     *         {sourceId: "context.jiraComment.id", resultId: "id"}
     *     ]
     * )
     * ```
     *
     * The value of [sourceInput] is `context.jiraComment` but [getIndexKey] would return
     * the value of `context.jiraComment.id` instead.
     */
    fun getIndexKey(sourceInput: JsonNode): NadelBatchHydrationIndexKey

    fun getIndex(
        batches: List,
    ): Map
}