# neo4jGraphQLBinding

## Strategy

The current strategy is to create a schema using [makeRemoteExecutableSchema](https://www.apollographql.com/docs/graphql-tools/remote-schemas.html#makeRemoteExecutableSchema) from [graphql-tools](https://www.npmjs.com/package/graphql-tools) with your `typeDefs` and a custom [Apollo Link](https://github.com/apollographql/apollo-link). The binding is then created over this schema.

When you send a GraphQL request to a resolver that delegates to the binding, the link receives the operation, processes it to support various features, and finally uses the Neo4j Bolt [driver](https://www.npmjs.com/package/neo4j-driver) to send the operation to your Neo4j instance as a Cypher query that calls a custom procedure provided by the Neo4j-GraphQL extension. Queries use the read-only [graphql.query](https://github.com/neo4j-graphql/neo4j-graphql/tree/3.3#procedures) procedure and mutations use the read/write [graphql.execute](https://github.com/neo4j-graphql/neo4j-graphql/tree/3.3#procedures).

## API Reference

* `typeDefs` (required): Your GraphQL type definitions in [SDL format](https://www.prisma.io/blog/graphql-sdl-schema-definition-language-6755bcb9ce51/). <br>
* `driver`(required): Your Neo4j driver instance (More info [here](https://www.npmjs.com/package/neo4j-driver)). <br>
* `log` (default: `false`): Logs results from query or mutation operations.  <br>
* `indexConfig`
  * `use` (default: `'cuid'`) Configures what method to use when generating id field values.&#x20;

## Example

```javascript
import { neo4jGraphQLBinding } from 'neo4j-graphql-binding';

const binding = neo4jGraphQLBinding({
  typeDefs: typeDefs,
  driver: driver,
  log: true
});

const context = {
  neo4j: binding
  ...
};
```