= JVM Library to translate GraphQL queries and mutations to Neo4j's Cypher :version: 1.9.0 :toc: :toclevels: 1 :toc-title: Quick Links
NOTE: This is a https://neo4j.com/labs/[Neo4j Labs Project^], it is not supported by Neo4j engineering or support and developed on an best-effort basis. It is also not functionally equivalent to the https://github.com/neo4j/graphql[neo4j-graphql (Javascript) library and API^] even as we try to stay close to it. Please use the official library for a JavaScript based GraphQL Middleware for production use-cases.
This is a https://graphql.org[GraphQL] to https://neo4j.com/developer/cypher[Cypher] transpiler written in Kotlin.
License: Apache 2.
== How does it work
This library
Those Cypher queries can then be executed, e.g. via the Neo4j-Java-Driver (or other JVM drivers) against the graph database and the results can be returned directly to the caller.
The request, result and error handling is not part of this library, but we provide demo programs on how to use it in different languages.
NOTE: All the <<features,supported features>> are listed and explained below, more detailed docs will be added in time.
== Examples
For complex examples take a look at our link:examples/readme.adoc[example projects]
== API compatibility to @neo4j/graphql
Since the javascript pendant of this library (neo4j-graphql-js) has majored into a neo4j product, we want to migrate our augmented schema, to match as much as possible to the one of the https://github.com/neo4j/graphql[`@neo4j/graphql`]. Therefore, we created a https://github.com/neo4j-graphql/neo4j-graphql-java/issues?q=label%3AAPI-Alignment[list of issues to track progress].
We will try to make the migration as smooth as possible.
For this purpose we will support the old, and the new way of schema augmentation until the next major release.
To already test the new features, you can enable them via link:core/src/main/kotlin/org/neo4j/graphql/SchemaConfig.kt[some setting in the SchemaConfig]
== FAQ
=== How does this relate to the other neo4j graphql libraries?
https://grandstack.io[The GRANDstack^] is a full-stack package that integrates React frontends via GraphQL through neo4j-graphql-js with Neo4j.
Similar to https://grandstack.io/docs/neo4j-graphql-js-quickstart[`neo4j-graphql-js`] this library focuses on query translation, just for the JVM instead of Node.js. It does not provide a server (except as examples) or other facilities but is meant to be used as a dependency included for a single purpose.
We plan to replace the code in the current Neo4j server plugin neo4j-graphql with a single call to this library.
The server plugin could still exist as an example that shows how to handle request-response and error-handling, and perhaps some minimal schema management but be slimmed down to a tiny piece of code.
=== How does this related to graphql-java
This library uses graphql-java under the hood for parsing of schema and queries, and managing the GraphQL state and context.
But not for nested field resolvers or data fetching.
If you wanted, you could combine graphql-java resolvers with this library to have a part of your schema handled by Neo4j.
Thanks a lot to the maintainers of graphql-java for the awesome library.
NOTE: We also use neo4j-opencypher-dsl provided graciously by the spring-data-neo4j-rx project to generate our cypher queries.
== Usage
You can use the library as dependency: org.neo4j:neo4j-graphql-java:{version} in any JVM program.
The basic usage should be:
val schema = """ type Person { name: ID! age: Int }
type Query {
person : [Person]
personByName(name:ID) : Person
}"""val query = """ { p:personByName(name:"Joe") { age } } """
val schema = SchemaBuilder.buildSchema(idl) val ctx = QueryContext() val (cypher, params) = Translator(schema).translate(query, params, ctx)
You find more usage examples in the:
== Demo
Here is a minimalistic example in Groovy using the Neo4j-Java driver and Spark-Java as webserver.
It is running against a Neo4j instance at bolt://localhost (username: neo4j, password: s3cr3t) containing the :play movies graph.
(You can also use a link:core/src/test/kotlin/GraphQLServer.kt[Kotlin based server example].)
In case you wand to bind the neo4j driver directly to the graphql schema you can link:core/src/test/kotlin/DataFetcherInterceptorDemo.kt[use the DataFetchingInterceptor to intercept the cypher queries].
// Simplistic GraphQL Server using SparkJava @Grapes([ @Grab('com.sparkjava:spark-core:2.7.2'), @Grab('org.neo4j.driver:neo4j-java-driver:1.7.2'), @Grab('com.google.code.gson:gson:2.8.5'), @Grab('org.neo4j:neo4j-graphql-java:{version}') ])
import spark. import static spark.Spark. import com.google.gson.Gson import org.neo4j.graphql. import org.neo4j.driver.v1.
schema = """ type Person { name: ID! born: Int actedIn: [Movie] @relation(name:"ACTED_IN") } type Movie { title: ID! released: Int tagline: String } type Query { person : [Person] } """
gson = new Gson() render = (ResponseTransformer)gson.&toJson def query(value) { gson.fromJson(value,Map.class)["query"] }
graphql = new Translator(SchemaBuilder.buildSchema(schema)) def translate(query) { graphql.translate(query) }
driver = GraphDatabase.driver("bolt://localhost",AuthTokens.basic("neo4j","s3cr3t")) def run(cypher) { driver.session().withCloseable { it.run(cypher.query, Values.value(cypher.params)).list{ it.asMap() }}}
// include::docs/Server.groovy[]
Run the example with:
and use http://localhost:4567/graphql as your GraphQL URL.
It uses a schema of:
And can run queries like:
image::docs/graphiql.jpg[]
You can also test it with curl
This example doesn't handle introspection queries, but the one in the test directory does.
== Advanced Queries
[[features]] == Features
=== Current
passThrough:true argument, that gives sole responsibility for the nested query result for this field to your Cypher query.
You will have to provide all data/structure required by client queries.
Otherwise, we assume if you return object-types that you will return the appropriate nodes from your statement.=== Next
== Documentation
=== Parse SDL schema
@relation directives on fields and types for rich relationships@cypher directives on fields and top-level query and mutation fields.=== Resolve query Fields via Result Types
For query fields that result in object types (even if wrapped in list/non-null), the appropriate object type is determined via the schema and used to translate the query.
e.g.
type Query { person: [Person] }
=== Neo4j 5.x support
This library supports queries for both neo4j 4.x and 5.x.
By default, the neo4j 5 dialect is enabled.
The dialect can be changed via QueryContext.
=== Handle Arguments as Equality Comparisons for Top Level and Nested Fields
If you add a simple argument to your top-level query or nested related fields, those will be translated to direct equality comparisons.
to an equivalent of
The literal values are turned into Cypher query parameters.
=== Handle Relationships via @relation Directive on Schema Fields
If you want to represent a relationship from the graph in GraphQL you have to add a @relation directive which contains the relationship-type and the direction.
The default direction for a relationship is 'OUT'.
Other values are 'IN' and 'BOTH'.
So you can use different domain names in your GraphQL fields that are independent of your graph model.
NOTE: We use Neo4j's pattern comprehensions to represent nested graph patterns in Cypher. This will be updated to subqueries from 4.1
=== Handle first, offset Arguments
To support pagination first is translated to LIMIT in Cypher and offset into SKIP
For nested queries these are converted into slices for arrays.
=== Argument Types: string, int, float, array
The default Neo4j Cypher types are handled both as argument types as well as field types.
NOTE: Spatial is not yet covered.
=== Usage of ID
Each type is expected to have exactly one filed of type ID defined.
If the field is named _id, it is interpreted as the database internal graph ID.
So there are 3 cases:
IMPORTANT: For the auto generated queries and mutations the ID field is used as primary key.
TIP: You should create a unique constraint on the ID fields
=== Parameter Support
GraphQL parameter's are passed onto Cypher, these are resolved correctly when used within the GraphQL query.
=== Parametrization
For query injection prevention and caching purposes, literal values are translated into parameters.
to
Those parameters are returned as part of the Cypher type that's returned from the translate()-method.
=== Aliases
We support query aliases, they are used as Cypher aliases too, so you get them back as keys in your result records.
For example:
=== Inline and Named Fragments
This is more of a technical feature, both types of fragments are resolved internally.
=== Sorting (top-level)
We support sorting via an orderBy argument, which takes an Enum or String value of fieldName_asc or fieldName_desc.
MATCH (person:Person) RETURN person { .name, .age } AS person
NOTE: We don't yet support ordering on nested relationship fields.
=== Handle Rich Relationships via @relation Directive on Schema Types
To represent rich relationship types with properties, a @relation directive is supported on an object type.
In our example it would be the Role type.
[[filters]] === Filters
Filters are a powerful way of selecting a subset of data. Inspired by the https://www.graph.cool/docs/reference/graphql-api/query-api-nia9nushae[graph.cool/Prisma filter approach^], our filters work the same way.
These filters are documented in detail in the https://grandstack.io/docs/graphql-filtering [GRANDstack docs^].
We use nested input types for arbitrary filtering on query types and fields.
You can also apply nested filter on relations, which use suffixes like ("",not,some, none, single, every)
==== Optimized Filters
If you encounter performance problems with the cypher queries generated for the filter, you can activate an alternative algorithm using:
If no query can be generated by the alternative algorithm, an OptimizedQueryException is thrown, so that a fallback to the actual algorithm can be used.
link:core/src/test/resources/optimized-query-for-filter.adoc[Examples of the alternative algorithm] can be seen in the tests.
=== Inline and Named Fragments
We support inline and named fragments according to the GraphQL spec. Most of this is resolved on the parser/query side.
=== @cypher Directives
With @cypher directives you can add the power of Cypher to your GraphQL API.
It allows you, without code to compute field values using complex queries.
You can also write your own, custom top-level queries and mutations using Cypher.
Arguments on the field are passed to the Cypher statement and can be used by name.
They must not be prefixed by $ since they are no longer parameters.
Just use the same name as the field's argument.
The current node is passed to the statement as this.
The statement should contain exactly one return expression without any alias.
Input types are supported, they appear as Map type in your Cypher statement.
NOTE: Those Cypher directive queries are only included in the generated Cypher statement if the field or query is included in the GraphQL query.
==== On Fields
Here the this-variable is bound to the current movie.
You can use it to navigate the graph and collect data.
The limit variable is passed to the query as parameter.
==== On Queries
Similarly, you can use the @cypher directive with a top-level query.
You can also return arrays from your query, the statements on query fields should be read-only queries.
==== On Mutations
You can do the same for mutations, just with updating Cypher statements.
You can use more complex statements for creating these entities or even subgraphs.
NOTE: The common CRUD mutations and queries are auto-generated, see below.
=== Auto Generated Queries and Mutations
To reduce the amount of boilerplate code you have to write, we auto-generate generate top-level CRUD queries and mutations for all types.
This is configurable via the API, you can:
For a schema like this:
It would auto-generate quite a lot of things:
person(id:ID, name:String , age: Int, _id: Int, filter:_PersonFilter, orderBy:_PersonOrdering, first:Int, offset:Int) : [Person]_PersonOrdering enum, for the orderBy argument with all fields for _asc and _desc sort order_PersonInput for creating Person objects_PersonFilter for the filter argument, which is a deeply nested input object (see <createPerson(id:ID!, name:String, age: Int) : Person
mergePerson: mergePerson(id:ID!, name:String, age:Int) : Person
updatePerson: updatePerson(id:ID!, name:String, age:Int) : Person
deletePerson: deletePerson(id:ID!) : Person
addPersonMovies: addPersonMovies(id:ID!,movies:[ID!]!) : Person
deletePersonMovies: deletePersonMovies(id:ID!,movies:[ID!]!) : PersonYou can then use those in your GraphQL queries like this:
or
You find more examples in the link:core/src/test/resources/augmentation-tests.adoc[Augmentation Tests] and the link:core/src/test/resources/custom-fields.adoc[Custom queries and mutations Tests]
== Build time schema augmentation
Sometimes you need the possibility to generate the augmented schema at compile time. To achieve this, we provide a maven plugin which can be used as follows: