{"id":13529391,"url":"https://github.com/thingdom/node-neo4j","last_synced_at":"2025-04-07T22:11:31.126Z","repository":{"id":44936920,"uuid":"1501632","full_name":"thingdom/node-neo4j","owner":"thingdom","description":"[RETIRED] Neo4j graph database driver (REST API client) for Node.js","archived":false,"fork":false,"pushed_at":"2018-11-20T12:02:09.000Z","size":725,"stargazers_count":927,"open_issues_count":43,"forks_count":138,"subscribers_count":55,"default_branch":"master","last_synced_at":"2024-10-29T17:11:52.886Z","etag":null,"topics":["cypher","neo4j","node-neo4j","nodejs"],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thingdom.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-03-19T23:55:53.000Z","updated_at":"2024-10-24T09:55:14.000Z","dependencies_parsed_at":"2022-09-04T22:32:16.970Z","dependency_job_id":null,"html_url":"https://github.com/thingdom/node-neo4j","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingdom%2Fnode-neo4j","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingdom%2Fnode-neo4j/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingdom%2Fnode-neo4j/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thingdom%2Fnode-neo4j/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thingdom","download_url":"https://codeload.github.com/thingdom/node-neo4j/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247737788,"owners_count":20987721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cypher","neo4j","node-neo4j","nodejs"],"created_at":"2024-08-01T07:00:35.902Z","updated_at":"2025-04-07T22:11:31.110Z","avatar_url":"https://github.com/thingdom.png","language":"CoffeeScript","funding_links":[],"categories":["Connectors","REST API"],"sub_categories":["REST API","Other"],"readme":"[![Build Status](https://travis-ci.org/thingdom/node-neo4j.svg?branch=master)](https://travis-ci.org/thingdom/node-neo4j)\n\n# Node-Neo4j\n\n⚠️ \u003cem\u003e**NOTE: This library is no longer under development.** Neo4j 3.0 comes with a [first-party JavaScript driver](http://neo4j.com/docs/api/javascript-driver/current/) which obviates the need for this library.\u003c/em\u003e ⚠️\n\nThis is a client library for accessing [Neo4j][], a graph database, from\n[Node.js][]. It uses Neo4j's [REST API][neo4j-rest-api], and supports\nNeo4j 1.5 through Neo4j 2.1.\n\n(Note that new 2.0 features like labels and constraints are only accessible\nthrough Cypher for now -- but Cypher is the recommended interface for Neo4j\nanyway. This driver might change to wrap Cypher entirely.)\n\n\u003cem\u003eUpdate: [node-neo4j v2][] is under development and almost finished!\n[Read the full spec here][v2 spec], and follow the progress in [pull #145][].\nIf you're comfortable using pre-release code, alpha versions are available on\nnpm; we at [FiftyThree][] are running them in production. =)\u003c/em\u003e\n\n[node-neo4j v2]: https://github.com/thingdom/node-neo4j/tree/v2#readme\n[v2 spec]: https://github.com/thingdom/node-neo4j/blob/v2/API_v2.md\n[pull #145]: https://github.com/thingdom/node-neo4j/pull/145\n[FiftyThree]: http://www.fiftythree.com/\n\n\n## Installation\n\n    npm install neo4j@1.x --save\n\n\n## Usage\n\nTo start, create a new instance of the `GraphDatabase` class pointing to your\nNeo4j instance:\n\n```js\nvar neo4j = require('neo4j');\nvar db = new neo4j.GraphDatabase('http://localhost:7474');\n```\n\nNode.js is asynchronous, which means this library is too: most functions take\ncallbacks and return immediately, with the callbacks being invoked when the\ncorresponding HTTP requests and responses finish.\n\nHere's a simple example:\n\n```js\nvar node = db.createNode({hello: 'world'});     // instantaneous, but...\nnode.save(function (err, node) {    // ...this is what actually persists.\n    if (err) {\n        console.error('Error saving new node to database:', err);\n    } else {\n        console.log('Node saved to database with id:', node.id);\n    }\n});\n```\n\nBecause async flow in Node.js can be quite tricky to handle, we\nstrongly recommend using a flow control tool or library to help.\nOur personal favorite is [Streamline.js][], but other popular choices are\n[async](https://github.com/caolan/async),\n[Step](https://github.com/creationix/step),\n[Seq](https://github.com/substack/node-seq), [TameJS](http://tamejs.org/) and\n[IcedCoffeeScript](http://maxtaco.github.com/coffee-script/).\n\nOnce you've gotten the basics down, skim through the full\n**[API documentation][api-docs]** to see what this library can do, and take a\nlook at [@aseemk][aseemk]'s [node-neo4j-template][] app for a complete usage\nexample. (The `models/User.js` file in particular is the one that interacts\nwith this library.)\n\nThis library is officially stable at \"v1\", but \"v2\" will almost certainly have\nbreaking changes to support only Neo4j 2.0 and generally improve the API\n([roadmap][]). You can be sheltered from these changes if you simply specify\nyour package.json dependency as e.g. `1.x` or `^1.0` instead of `*`.\n\n[Roadmap]: https://github.com/thingdom/node-neo4j/wiki/Roadmap\n\n\n## Development\n\n    git clone git@github.com:thingdom/node-neo4j.git\n    cd node-neo4j\n    npm install \u0026\u0026 npm run clean\n\nYou'll need a local installation of Neo4j ([links](http://neo4j.org/download)),\nand it should be running on the default port of 7474 (`neo4j start`).\n\nTo run the tests:\n\n    npm test\n\nThis library is written in [CoffeeScript][], using [Streamline.js][] syntax.\nThe tests automatically compile the code on-the-fly, but you can also generate\ncompiled `.js` files from the source `._coffee` files manually:\n\n    npm run build\n\nThis is in fact what's run each time this library is published to npm.\nBut please don't check the generated `.js` files in; to remove:\n\n    npm run clean\n\nWhen compiled `.js` files exist, changes to the source `._coffee` files will\n*not* be picked up automatically; you'll need to rebuild.\n\nIf you `npm link` this module into another app (like [node-neo4j-template][])\nand you want the code compiled on-the-fly during development, you can create\nan `index.js` file under `lib/` with the following:\n\n```js\nrequire('coffee-script/register');\nrequire('streamline/register');\nmodule.exports = require('./index._coffee');\n```\n\nBut don't check this in! That would cause all clients to compile the code\non-the-fly every time, which isn't desirable in production.\n\n\n## Changes\n\nSee the [Changelog][changelog] for the full history of changes and releases.\n\n\n## License\n\nThis library is licensed under the [Apache License, Version 2.0][license].\n\n\n## Feedback\n\nIf you encounter any bugs or other issues, please file them in the\n[issue tracker][issue-tracker].\n\nWe also now have a [Google Group][google-group]!\nPost questions and participate in general discussions there.\n\n\n[neo4j]: http://neo4j.org/\n[node.js]: http://nodejs.org/\n[neo4j-rest-api]: http://docs.neo4j.org/chunked/stable/rest-api.html\n\n[api-docs]: http://coffeedoc.info/github/thingdom/node-neo4j/master/\n[aseemk]: https://github.com/aseemk\n[node-neo4j-template]: https://github.com/aseemk/node-neo4j-template\n[semver]: http://semver.org/\n\n[neo4j-getting-started]: http://wiki.neo4j.org/content/Getting_Started_With_Neo4j_Server\n[coffeescript]: http://coffeescript.org/\n[streamline.js]: https://github.com/Sage/streamlinejs\n\n[changelog]: CHANGELOG.md\n[issue-tracker]: https://github.com/thingdom/node-neo4j/issues\n[license]: http://www.apache.org/licenses/LICENSE-2.0.html\n[google-group]: https://groups.google.com/group/node-neo4j\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthingdom%2Fnode-neo4j","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthingdom%2Fnode-neo4j","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthingdom%2Fnode-neo4j/lists"}