graphglue-core/io.github.graphglue.data.execution

io.github.graphglue.data.execution

Types

AuthorizedRelationDefinition

class AuthorizedRelationDefinition(val relationshipDefinition: RelationshipDefinition, val relatedNodeDefinition: NodeDefinition, val authorizationCondition: CypherConditionGenerator?)

A RelationshipDefinition with an optional authorization condition

CypherConditionGenerator

fun interface CypherConditionGenerator

Used by classes which are able to generate conditions based on a Node

FieldFetchingContext

class FieldFetchingContext(val arguments: Map<String, Any>, val selectionSet: DataFetchingFieldSelectionSet, val resultKeyPath: String)

Context for fetching entries in a node query

NodeExtensionField

class NodeExtensionField(definition: ExtensionFieldDefinition, val dfe: DataFetchingEnvironment, val arguments: Map<String, Any>, onlyOnTypes: List<NodeDefinition>?, resultKeyPath: String) : NodeQueryEntry<ExtensionFieldDefinition>

Defines an extension field which should be loaded with a NodeQuery

class NodeQuery(definition: NodeDefinition, val options: NodeQueryOptions, entries: List<NodeQueryEntry<*>>) : QueryBase<NodeQuery>

Defines a query which fetches Nodes of type definition

NodeQueryEngine

class NodeQueryEngine(val configurationProperties: GraphglueCoreConfigurationProperties, val client: ReactiveNeo4jClient, val mappingContext: Neo4jMappingContext, val renderer: Renderer)

Engine for executing NodeQuerys

abstract class NodeQueryEntry<T : FieldDefinition>(val onlyOnTypes: List<NodeDefinition>?, val resultKeyPath: String, val fieldDefinition: T)

Subclass for NodeExtensionField and NodeSubQuery

NodeQueryExecutor

class NodeQueryExecutor(val client: ReactiveNeo4jClient, val mappingContext: Neo4jMappingContext, val renderer: Renderer)

Generates Cypher-DSL queries based on a NodeQuery, executes it and parses the result

NodeQueryOptions

data class NodeQueryOptions(val filters: List<CypherConditionGenerator> = emptyList(), val orderBy: Order<*>? = IdOrder, val after: Map<String, Any?>? = null, val before: Map<String, Any?>? = null, val first: Int? = null, val last: Int? = null, val skip: Int? = null, val fetchTotalCount: Boolean = true, val ignoreNodes: Boolean = false, val overrideIsAllQuery: Boolean = false)

Defines how a NodeQuery fetches data

NodeQueryParser

class NodeQueryParser(val nodeDefinitionCollection: NodeDefinitionCollection, val filterDefinitionCollection: FilterDefinitionCollection?, val objectMapper: ObjectMapper)

Parser to get NodeQuerys Can be used to create queries which load a subtree of nodes in one query

NodeQueryResult

data class NodeQueryResult<T : Node>(val options: NodeQueryOptions, val nodes: List<T>, val totalCount: Int?)

Result of a NodeQuery

class NodeSubQuery(definition: FieldDefinition, val query: NodeQuery, onlyOnTypes: List<NodeDefinition>?, val relationshipDefinitions: List<AuthorizedRelationDefinition>, resultKeyPath: String) : NodeQueryEntry<FieldDefinition>

Defines a SubQuery which is part of a NodeQuery Must only be evaluated if parent type is in onlyOnTypes

private data class OrderContext(val order: Order<*>, val variables: Map<String, SymbolicName>)

Wrapper for an Order and the variables used in it

PartialNodeQuery

class PartialNodeQuery(definition: NodeDefinition, entries: List<NodeQueryEntry<*>>) : QueryBase<PartialNodeQuery>

Defines a partial query which fetches Nodes of type definition

PartialNodeQueryResult

private data class PartialNodeQueryResult(val nodes: List<Node>, val totalCount: Int?)

Result of a query

abstract class QueryBase<T : QueryBase<T>>(val definition: NodeDefinition, val entries: List<NodeQueryEntry<*>>)

Base class for queries

class SearchQuery(definition: NodeDefinition, val options: SearchQueryOptions, entries: List<NodeQueryEntry<*>>) : QueryBase<SearchQuery>

Defines a search query which fetches Nodes of type definition

SearchQueryOptions

data class SearchQueryOptions(val filters: List<CypherConditionGenerator> = emptyList(), val query: String, val first: Int, val skip: Int?)

Defines how a SearchQuery fetches data

SearchQueryResult

data class SearchQueryResult<T : Node?>(val options: SearchQueryOptions, val nodes: List<T>)

Result of a SearchQuery

StatementWithResultNodesAndNodes

private data class StatementWithResultNodesAndNodes(val statement: Statement, val allResultNodes: SymbolicName, val allNodes: SymbolicName)

Statement with associated name for result nodes and all nodes

StatementWithSymbolicName

private data class StatementWithSymbolicName(val statement: Statement, val symbolicName: SymbolicName)

Wrapper for a Statement and an associated name

Properties

NODE_FETCH_OFFSET

private const val NODE_FETCH_OFFSET: Int = 1

Amount of nodes which are fetched additionally to determine if there are more nodes to come

const val NODE_KEY: String

Name for the single node map entry

const val NODES_KEY: String

Name for the node list map entry

ONE_NODE_QUERY_LIMIT

const val ONE_NODE_QUERY_LIMIT: Int = 2

Amount of nodes which are fetched when fetching a one-side of a query Fetches two nodes to detect an inconsistent state in the database

const val ORDER_KEY: String

Name for the order map entry

PARENT_NODE_ID_KEY

const val PARENT_NODE_ID_KEY: String

Name for the parent node id map entry

TOTAL_COUNT_KEY

const val TOTAL_COUNT_KEY: String

Name for the total count map entry