⚠️

This is the documentation for the old GraphQL Mesh version v0. We recommend upgrading to the latest GraphQL Mesh version v1.

Migrate to GraphQL Mesh v1

Neo4j

This handler allows you to use the GraphQL schema created by @neo4j/graphql.

To get started, install the handler library:


npm i @graphql-mesh/neo4j


pnpm add @graphql-mesh/neo4j


yarn add @graphql-mesh/neo4j


bun add @graphql-mesh/neo4j

Now, you can use it directly in your Mesh config file:

.meshrc.yaml


sources:
  - name: Neo4j
    handler:
      neo4j:
        url: neo4j://localhost
        username: neo4j
        password: MY_PASSWORD

Config API Reference

endpoint (type: String, required) - URL for the Neo4j Instance e.g. neo4j://localhost
source (type: String) - Provide GraphQL Type Definitions instead of inferring
username (type: String, required) - Username for basic authentication
password (type: String, required) - Password for basic authentication
alwaysIncludeRelationships (type: Boolean) - Specifies whether relationships should always be included in the type definitions as relationship types, even if the relationships do not have properties.
database (type: String) - Specifies database name