{"_id":"sgnm-neo4j","_rev":"388-3fb0e885fa3798eb3e3c05f00dad91f6","name":"sgnm-neo4j","dist-tags":{"latest":"0.1.389-multi-tenant-2"},"versions":{"0.0.1":{"name":"sgnm-neo4j","version":"0.0.1","keywords":[],"author":"","license":"ISC","_id":"sgnm-neo4j@0.0.1","maintainers":[{"name":"hydrurdgn","email":"hydrurdgn@gmail.com"}],"homepage":"https://github.com/sgnm-haydar/SgnmNeo4jDriver#readme","bugs":{"url":"https://github.com/sgnm-haydar/SgnmNeo4jDriver/issues"},"dist":{"shasum":"52b9a38001ae86afca4805708e07a046e1b9ed6b","tarball":"https://registry.npmjs.org/sgnm-neo4j/-/sgnm-neo4j-0.0.1.tgz","fileCount":37,"integrity":"sha512-KjiXmySO9vqSgUXCEVRero+8KgDRs3iXOpODRklTozPsXXi31GDl3kpth7jAuYYSEvGdyn6SO9NpXwYEvSmDdQ==","signatures":[{"sig":"MEQCIGsxuCmZ2V0+402Htmyxube1EWPPeCi3GyQxpZv7LZINAiAE4A2cb06dC46x1gyleYsharWqqnMv/2QEtkdgZw050g==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":137740,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJige1TACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqsHg/5AKAghCQ8aGEFq/Hx85yhVxyK4ngd3QAfXKfaUl+grS9bxuiZ\r\ndxZ0NoBO5ulauYVUL6OrrYjIzqL39BbxQObWTVhRP6bgknc+qf4mk5TDp/4q\r\n4UZmFA/iqzhcodMZtB4gqFm0YI8t3AcCtl1pac2w5dq+TZljkhzqi5wGl53X\r\nu0g+PgG2vdEMm2ind27rbWN3GVk+JtgxX3m/yVEHqrKsLwXwdpOHQT8ttgMT\r\nYCzEMOTKLllO9vMTFVrcqTKgh3qDRKzF/CLYOAChZDvuk3yCcu7JMz4vfFOr\r\nKwETKkgBSIY/yuuLWA50YCW1yNyUkbl3VmcTsDY6lTXOJtzNiIZzNNydz5gO\r\nZHBXNrI9e8dGLzllIXjhAjvJc2s69S5FBkiXOIAsd3vDCMJjgGnbsMGNqH5p\r\nOJCWaTiwB5nmVKHKt9aTQ5xC8FbybwDi8w9GbDPPLJec+boGqbGfwUP2Ggxy\r\nGm9rXkTc2F9NxACF2h9I/lT9nrbxgooGlV/P/cEJQgBFkT4FcWQh739Uqbc1\r\nW9SAsKhpEEnlAgv2t4PSJuIPLU4+fWary+PNkXasAt+Gci0REH05m96gz5mP\r\nfhCgV/yaQd3b2djORhOsx7mA7RQFnPQc3R5naL+bYIFKQmTM17ZXqRNDckjl\r\nihBENeLtNHiTPg+uaXH/AgGWyoOPpxn0H6g=\r\n=3BZf\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","types":"dist/index.d.js","gitHead":"cefde33bacf75c632635843d93aeb829c57e7f33","scripts":{"test":"echo \"Error: no test specified\" && exit 1","build":"tsc"},"_npmUser":{"name":"hydrurdgn","email":"hydrurdgn@gmail.com"},"repository":{"url":"git+https://github.com/sgnm-haydar/SgnmNeo4jDriver.git","type":"git"},"_npmVersion":"8.5.5","description":"

\"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \"Nest \n \"Nest \n \n

\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## Description of Library\n\n(as default u can use `read()` and `write()` method for your own cyper query)\nThis package convenient for tree structure and normal cyper usage .\nFor parent relation default we use PARENT_OF relation but u can change it with functions.\nFor pagination and search string from node properties there is already functions implemented\n\n## Installation\n\n```\n$ npm i sgnm-neo4j\n```\n\n## Quick Start\n\nRegister the Neo4j Module in your application using the `forRoot` method or `forRootAsync`, 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 \"sgnm-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```ts\nimport { Module } from \"@nestjs/common\";\nimport { AppController } from \"./app.controller\";\nimport { AppService } from \"./app.service\";\nimport { Neo4jModule } from \"sgnm-neo4j\";\n\n@Module({\n imports: [\n Neo4jModule.forRootAsync({\n imports: [ConfigModule],\n inject: [ConfigService],\n useFactory: (configService: ConfigService) => ({\n host: configService.get(\"NEO4J_HOST\"),\n password: configService.get(\"NEO4J_PASSWORD\"),\n port: configService.get(\"NEO4J_PORT\"),\n scheme: configService.get(\"NEO4J_SCHEME\"),\n username: configService.get(\"NEO4J_USERNAME\"),\n }),\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 \"sgnm-neo4j\";\n\n@Controller()\nexport class AppController {\n constructor(\n private readonly appService: AppService,\n private readonly neo4jService: Neo4jService\n ) {}\n\n @Get()\n async getHello(): Promise {\n const res = await this.neo4jService.read(\n `MATCH (n) RETURN count(n) AS count`\n );\n\n return `There are ${res.records[0].get(\"count\")} nodes in the database`;\n }\n\n @Patch(\":id\")\n update(@Param(\"id\") id: string, @Body() updateDto: UpdateDto) {\n return await this.neo4jService.updateByIdAndFilter(\n id,\n { isActive: true },\n [],\n updateDto\n );\n }\n}\nexport class AppModule {}\n```\n\n## LazyLoading Functions implemented for general search,by specific column,ordering etc... \n\nFor the big data, required lazyLoading functions already implemented.Required params listed \n```ts\ntype queryObjectType = {\n skip: number;\n limit: number;\n orderBy?: AscendingEnum;\n orderByColumn?: string[];\n}\n\nenum SearchType {\n CONTAINS = 'CONTAINS',\n START_WITH='STARTS WITH',\n ENDS_WITH='ENDS WITH'\n }\n\nenum AscendingEnum {\n ASCENDING = 'ASC',\n DESCANDING='DESC'\n}\n\nfindChildrensByIdAndFiltersWithPagination(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n root_exculuded_labels: string[] = [\"\"],\n children_labels: Array = [],\n children_filters: object = {},\n children_exculuded_labels: string[] = [\"\"],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n databaseOrTransaction?: string\n ) ;\n\nfindChildrensByIdAndFiltersTotalCount(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: Array = [],\n children_filters: object = {},\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n )\n\nfindChildrensByIdAndFiltersWithPaginationAndSearcString(\n root_id: number,\n root_labels: string[],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n searchString: string,\n databaseOrTransaction?: string\n )\n\nfindChildrensByIdAndFiltersAndSearchStringsTotalCount(\n root_id: number,\n root_labels: string[],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n search_string: string,\n databaseOrTransaction?: string\n )\n\nfindChildrensByIdAndFiltersWithPaginationAndSearcStringBySpecificColumn(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n searchColumn: string,\n searchString: string,\n search_type: SearchType = SearchType.CONTAINS,\n databaseOrTransaction?: string\n )\n\nfindChildrensByIdAndFiltersBySearcStringBySpecificColumnTotalCount(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n search_column: string,\n search_string: string,\n search_type: SearchType = SearchType.CONTAINS,\n databaseOrTransaction?: string\n )\n ```\n## There is list of some of functions in service \n\nFor the details,you can check git repository\n```ts\ngetConfig(): Neo4jConfig;\ngetReadSession(database?: string): Session;\ngetWriteSession(database?: string): Session;\nread(query: string, params?: object, database?: string): Result;\nwrite(query: string, params?: object, database?: string): Result;\nfindByIdAndFilters(\n id: number,\n labels: string[],\n filter_properties: object = {},\n excluded_labels: Array = [],\n databaseOrTransaction?: string | Transaction\n );\nfindByLabelAndFilters(labels: Array = [\"\"],filter_properties: object = {},excluded_labels: Array = [\"\"]);\nfindByOrLabelsAndFilters(or_labels: Array = [\"\"],filter_properties: object = {}),\nfindByIdAndOrLabelsAndFilters(id: number,or_labels: Array = [\"\"],filter_properties: object = {}),\nupdateByLabelAndFilter(labels: Array = [],filter_properties: object = {},update_labels: Array = [],update_properties: object = {} );updateByIdAndFilter(\n id: number,\n labels: string[] = [\"\"],\n filter_properties: object = {},\n update_labels: Array = [],\n update_properties: object = {},\n databaseOrTransaction?: string | Transaction\n );\ncreateNode(\n params: object,\n labels?: string[],\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByLabelsAsTree(root_labels: Array = [],root_filters: object = {},children_labels: Array = [],children_filters: object = {}),\nfindByLabelAndFiltersWithTreeStructure(root_labels: Array = [],root_filters: object = {},children_labels: Array = [], children_filters: object = {});\nfindChildrensByIdsAsTree(root_id: number, root_labels: string[] = [\"\"],root_filters: object = {},children_labels: Array = [],children_filters: object = {});\nfindByIdAndFiltersWithTreeStructure(root_id: number,root_filters: object = {},children_labels: Array = [],children_filters: object = {});\ngetParentByIdAndFilters(\n id: number,\n node_labels: string[] = [\"\"],\n node_filters: object = {},\n parent_labels: string[] = [\"\"],\n parent_filters: object = {},\n relation_name: string,\n relation_filters,\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\naddRelationByLabelsAndFiltersAndRelationName(\n first_node_labels: Array = [],\n first_node_properties: object = {},\n second_node_labels: Array = [],\n second_node_properties: object = {},\n relation_name: string,\n relation_properties: object = {},\n relation_direction: RelationDirection = RelationDirection.RIGHT,\n databaseOrTransaction?: string | Transaction\n );\naddRelationByIdWithRelationNameAndFilters(\n first_node_id: number,\n first_node_labels: string[] = [\"\"],\n first_node_filters: object = {},\n second_node_id: number,\n second_node_labels: string[] = [\"\"],\n second_node_filters: object = {},\n relation_name: string,\n relation_properties: object = {},\n relation_direction: RelationDirection = RelationDirection.RIGHT,\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByLabelsAsTreeOneLevel(\n root_labels: Array = [],\n root_filters: object = {},\n children_labels: Array = [],\n children_filters: object = {},\n databaseOrTransaction?: string | Transaction\n );\nupdateNodeChildrensByIdAndFilter(\n id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: Array = [],\n children_filters: object = {},\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n update_labels: Array = [],\n update_properties: object = {},\n databaseOrTransaction?: string | Transaction\n );\ndeleteRelationByIdAndRelationNameWithFilters(\n first_node_id: number,\n first_node_labels: string[] = [\"\"],\n first_node_filters: object = {},\n second_node_id: number,\n second_node_labels: string[] = [\"\"],\n second_node_filters: object = {},\n relation_name: string,\n relation_direction: RelationDirection = RelationDirection.RIGHT,\n databaseOrTransaction?: string | Transaction\n );\ndeleteRelationByIdAndRelationNameWithoutFilters(\n first_node_id: number,\n first_node_labels: string[] = [\"\"],\n second_node_id: number,\n second_node_labels: string[] = [\"\"],\n relation_name: string,\n relation_direction: RelationDirection = RelationDirection.RIGHT,\n databaseOrTransaction?: string | Transaction\n );\ncopySubGrapFromOneNodeToAnotherById(\n root_id: number,\n target_root_id: number,\n relation_name: string,\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByIdAndFilters(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: string[] = [],\n children_filters: object = {},\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByIdAndFiltersTotalCount(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: Array = [],\n children_filters: object = {},\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByLabelsAndFilters(\n root_labels: string[] = [],\n root_filters: object = {},\n children_labels: string[] = [],\n children_filters: object = {},\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\nupdateRelationByIdWithRelationNameAndFilters(\n first_node_id: number,\n first_node_labels: string[] = [\"\"],\n first_node_filters: object = {},\n second_node_id: number,\n second_node_labels: string[] = [\"\"],\n second_node_filters: object = {},\n relation_name: string,\n relation_properties: object = {},\n relation_update_properties: object = {},\n relation_direction: RelationDirection = RelationDirection.RIGHT,\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByRootIdAndNotLabels(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n root_exculuded_labels: string[] = [\"\"],\n children_labels: Array = [\"\"],\n children_filters: object = {},\n children_excluded_labels: string[] = [\"\"],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByLabelAndNotLabels(\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n root_exculuded_labels: string[] = [\"\"],\n children_labels: Array = [\"\"],\n children_filters: object = {},\n children_excluded_labels: string[] = [\"\"],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n databaseOrTransaction?: string | Transaction\n );\nfindChildrensByIdAndFiltersWithPagination(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n root_exculuded_labels: string[] = [\"\"],\n children_labels: Array = [],\n children_filters: object = {},\n children_exculuded_labels: string[] = [\"\"],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n databaseOrTransaction?: string\n );\nfindChildrensAndParentOfChildrenByIdAndFilter(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: Array = [],\n children_filters: object = {},\n relation_name1: string,\n parentof_children_labels: Array = [],\n parentof_children_filters: object = {},\n relation_name2: string,\n queryObject: queryObjectType,\n databaseOrTransaction?: string\n );\nfindChildrensByIdAndFiltersWithPaginationAndSearcString(\n root_id: number,\n root_labels: string[],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n searchString: string,\n databaseOrTransaction?: string\n );\nfindChildrensByIdAndFiltersAndSearchStringsTotalCount(\n root_id: number,\n root_labels: string[],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n search_string: string,\n databaseOrTransaction?: string\n );\nfindChildrensByIdAndFiltersWithPaginationAndSearcStringBySpecificColumn(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n queryObject: queryObjectType,\n searchColumn: string,\n searchString: string,\n search_type: SearchType = SearchType.CONTAINS,\n databaseOrTransaction?: string\n );\nfindChildrensByIdAndFiltersBySearcStringBySpecificColumnTotalCount(\n root_id: number,\n root_labels: string[] = [\"\"],\n root_filters: object = {},\n children_labels: string[],\n children_filters: object = {},\n children_exculuded_labels: string[],\n relation_name: string,\n relation_filters: object = {},\n relation_depth: number | \"\",\n search_column: string,\n search_string: string,\n search_type: SearchType = SearchType.CONTAINS,\n databaseOrTransaction?: string\n );\nfindMainNodesRelationsWithFilters(\n mainNodeLabels: string[],\n mainNodeFilters: object,\n otherNodesProps: otherNodesObjProps[],\n queryObject: queryObjectType,\n databaseOrTransaction?\n );\nfindTotalCountsOfMainNodesRelationsWithFilters(\n mainNodeLabels: string[],\n mainNodeFilters: object,\n otherNodesProps: otherNodesObjProps[],\n databaseOrTransaction?\n )\n```\n","readmeFilename":"README.md"}