Neo4j GraphQL Toolbox
|
This is the documentation of the GraphQL Library version 7. For the long-term support (LTS) version 5, refer to GraphQL Library version 5 LTS. |
The Neo4j GraphQL Toolbox is an onboarding, low-code tool that can be integrated to Neo4j. It was created for development and experimentation with Neo4j GraphQL APIs. With it, you can:
-
Connect to a Neo4j database with valid credentials.
-
Define (or introspect) the type definitions.
-
Build the Neo4j GraphQL schema.
-
Experiment, query, and play.
Connect to a Neo4j database
Before you start using the Toolbox, make sure you have followed all requirements to run a Neo4j database. You can use Neo4j Desktop or Neo4j AuraDB for that.
Set the type definitions
Set your type definitions directly in the Toolbox editor or introspect the Neo4j database you connected to.
If you followed the self-hosted GraphQL tutorial, use Introspect to see these type definitions in the GraphQL Toolbox:
type Product @node {
productName: String
category: [Category!]! @relationship(type: "PART_OF", direction: OUT)
}
type Category @node {
categoryName: String
products: [Product!]! @relationship(type: "PART_OF", direction: IN)
}
|
If you modified your database after following the self-hosted GraphQL tutorial, you may see different introspection results. |
Build the schema and query the database
Build schema which takes you to Query editor tab.
Query the Neo4j database. Paste the following or interact with the autogenerated GraphQL queries and mutations from the @neo4j/graphql library from the Explorer:
{
products {
productName
}
}
The query returns the name of the single product in the database:
{ "data": { "products": [{ "productName": "New Product" }] } }