https://github.com/tether/neo4j-stream

Neo4j query language as a json line delimited stream
https://github.com/tether/neo4j-stream

cypher json neo4j query stream

Last synced: about 6 hours ago
JSON representation

Neo4j query language as a json line delimited stream

• Host: GitHub
• URL: https://github.com/tether/neo4j-stream
• Owner: tether
• License: mit
• Created: 2017-06-16T16:29:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-20T20:32:00.000Z (about 7 years ago)
• Last Synced: 2024-12-05T18:44:54.875Z (18 days ago)
• Topics: cypher, json, neo4j, query, stream
• Language: JavaScript
• Homepage:
• Size: 19.5 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Neo4j-Stream

[![Build Status](https://travis-ci.org/tether/neo4j-stream.svg?branch=master)](https://travis-ci.org/tether/neo4j-stream)

[![NPM](https://img.shields.io/npm/v/neo4j-stream.svg)](https://www.npmjs.com/package/neo4j-stream)

[![Downloads](https://img.shields.io/npm/dm/neo4j-stream.svg)](http://npm-stat.com/charts.html?package=neo4j-stream)

[![guidelines](https://tether.github.io/contribution-guide/badge-guidelines.svg)](https://github.com/tether/contribution-guide)

[Neo4j cypher](https://neo4j.com/developer/cypher/) query engine done the right way:

  * **Multiline**: Create multiline queries to return the data you just need.

  * **Stream**: Create a json [line delimited](https://en.wikipedia.org/wiki/JSON_Streaming#Line_delimited_JSON) stream from records returned by cypher query. Don't wait to get all the results to start pushing data to the client.

## Usage

```js

// initialize cypher with a driver session

const cypher = require('neo4j-stream')(session)

cypher`

  CREATE (john:PEOPLE {name: 'John'})

  RETURN john

`.pipe(dest)

```

A session should be created from the official [neo4j javascript driver](https://github.com/neo4j/neo4j-javascript-driver).

## Installation

```shell

npm install neo4j-stream --save

```

[![NPM](https://nodei.co/npm/neo4j-stream.png)](https://nodei.co/npm/neo4j-stream/)

## Question

For support, bug reports and or feature requests please make sure to read our

community guidelines and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

## Contribution

The open source community is very important to us. If you want to participate to this repository, please make sure to read our guidelines before making any pull request. If you have any related project, please let everyone know in our wiki.

## License

The MIT License (MIT)

Copyright (c) 2017 Tether Inc

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.