\n\n# Nest Neo4j\n\n> Neo4j integration for Nest\n\n## Description\n\nThis repository provides [Neo4j](https://www.neo4j.com) integration for [Nest](http://nestjs.com/).\n\n## Installation\n\n```\n$ npm i --save nest-neo4j\n```\n\n## Quick Start\n\nRegister the Neo4j Module in your application using the `forRoot` method, passing the neo4j connection information as an object:\n\n```ts\nimport { Module } from '@nestjs/common';\nimport { AppController } from './app.controller';\nimport { AppService } from './app.service';\nimport { Neo4jModule } from 'nest-neo4j'\n\n@Module({\n imports: [\n Neo4jModule.forRoot({\n scheme: 'neo4j',\n host: 'localhost',\n port: 7687,\n username: 'neo4j',\n password: 'neo'\n })\n ],\n controllers: [AppController],\n providers: [AppService],\n})\nexport class AppModule {}\n```\n\n## Querying Neo4j\n\nThe `Neo4jService` is `@Injectable`, so can be passed into any constructor:\n\n```ts\nimport { Neo4jService } from 'nest-neo4j'\n\n@Controller()\nexport class AppController {\n constructor(private readonly appService: AppService,\n private readonly neo4jService: Neo4jService\n ) {}\n\n @Get()\n async getHello(): Promise {\n const res = await this.neo4jService.read(`MATCH (n) RETURN count(n) AS count`)\n\n return `There are ${res.records[0].get('count')} nodes in the database`\n }\n}\n```\n\n## Methods\n\n```ts\ngetConfig(): Neo4jConnection;\ngetReadSession(database?: string): Session;\ngetWriteSession(database?: string): Session;\nread(query: string, params?: object, database?: string): Result;\nwrite(query: string, params?: object, database?: string): Result;\n```\n\n# More Information\n\nFor more information about running Neo4j in your Node.js or TypeScript project, check out [Neo4j GraphAcademy](https://graphacademy.neo4j.com).\n","readmeFilename":"README.md"}
![\"Nest](\"https://kamilmysliwiec.com/public/nest-logo.png#1\"){kind=logo}
![](\"https://dist.neo4j.com/wp-content/","main":"dist/index.js","types":"dist/index.d.js","scripts":{"build":"tsc","test":"echo)
![](\"https://dist.neo4j.com/wp-content/","homepage":"https://github.com/adam-cowley/nest-neo4j#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/adam-cowley/nest-neo4j.git"},"bugs":{"url":"https://github.com/adam-cowley/nest-neo4j/issues"},"license":"Apache-2.0","readme":"<p)
\n ![](\"https://dist.neo4j.com/wp-content/uploads/20210423072428/neo4j-logo-2020-1.svg\"){kind=logo}
\n