A high performance Node.js\n RedisGraph\n client.\n
\n\n> **Redisgraph `>2.10`**\n\n- Light & Fast\n- Easy to use\n- Functionnal nature\n- Procedures caching\n- Parameterized queries _(since `4.3.0`)_\n- Multi graph\n- **BigInt support**\n- Tagged templates literals\n- Es modules\n- Side effects free\n- Loved by ladies\n- On the blockchain\n- Less than 0.1% gluten\n- I'm out off buzzwords\n\nRgraph use tagged templates in order to seamlessly serialize any inputs\nwhile keeping a nice flow which looks like simple interpolation.\n\n## Install\n\n```\nnpm i @hydre/rgraph\n```\n\n> Node >16\n```\nnode index.js\n```\n\n## TL;DR\n\n\n\n```js\nimport Rgraph from '@hydre/rgraph'\nimport Redis from 'ioredis'\nimport Events from 'events'\n\nconst client = new Redis()\nconst Graph = Rgraph(client)\nconst foo = Graph('foo')\nconst user = { uuid: 'xxxx-xxxx-xxxx', name: 'Tony' }\n\nawait Events.once(client, 'ready')\nawait foo.run`MERGE (tony:User ${ user }) RETURN tony`\nawait foo.delete()\n```\n\n## Debug\n\nallow debug logs with the `DEBUG='rgraph*'` env variable\n\n## Usage\n\nGet yourself some tea and meat by providing your redis client\n\n```js\nimport Rgraph from '@hydre/rgraph'\nimport Redis from 'ioredis'\n\nconst redis_client = new Redis()\nconst use_graph = Rgraph(redis_client)\n```\n\nWow now you can get as much graphs as you want 💃 !\ngo ahead don't be afraid it's redis, not neo4j 🦐\n\n```js\nconst my_first_graph = use_graph('myFirstGraph')\nconst foo = use_graph('anotherGraph')\nconst thanos = use_graph('hail-hydra')\nconst bar = use_graph('barGraph')\n```\n\nRun any [Cypher](https://neo4j.com/docs/cypher-manual/current/) query with a tag template or delete your poor graph\n```js\nawait foo.run`MATCH (n) RETURN n`\nawait thanos.delete()\n```\n\nLet me show you the result structure for each type, with the visible properties\nyou also have access to some internals infos like ids and labels etc..\n\n```js\nimport { Internals } from '@hydre/rgraph'\n\n[\n // each object is a sequence of the results\n {\n // For a scalar\n ['label in the RETURN statement']: 'value', // the returned value\n\n // For a node\n ['label in the RETURN statement']: {\n ['each']: ...,\n ['node']: ...,\n ['properties']: ...,\n [Internals.ID]: 0, // the node internal id\n [Internals.NODE_LABELS]: [], // the node labels\n },\n\n // For an edge\n ['label in the RETURN statement']: {\n ['each']: ...,\n ['node']: ...,\n ['properties']: ...,\n [Internals.ID]: 0, // the edge internal id\n [Internals.EDGE_LABEL]: 'label', // the edge label\n [Internals.SOURCE_NODE_ID]: 0, // the source node id\n [Internals.DESTINATION_NODE_ID]: 0 // the destination id\n },\n\n // For a path\n ['label in the RETURN statement']: {\n nodes: [], // an array of nodes (same representation as above but without the return label)\n edges: [] // an array of edges\n }\n }\n]\n```\n\n## Operators\n\nThe library provide some additional operators\n\n```js\nimport { raw } from '@hydre/rgraph/operators'\n\nconst maybe = false ? 'AND 1 = 2' : ''\nconst conditionnal = `WHERE 1 = 1 ${ raw(maybe) }`\n```\n\nWelcome to the era of fast graphs..\n\n\n\n```js\nawait myFirstGraph.run/* cypher */`\nMERGE (foo:User ${ user })-[:Knows]->(thanos { name: 'Thanos', age: ${5 + 5}, a: ${true}, c: ${51.000000000016} })\nWITH foo, thanos\nMATCH path = ()-[]-()\nRETURN path`\n```\n\n\n## Comments\n\n> new in 4.2.0\n\nWhen writting long queries you might want to help your team to understand it\nby adding comments. Every _trimmed_ new line starting with `//` will be ignored\n\n```js\nawait graph.run/* cypher */`\n MATCH (u:User)\n WHERE (\n u.name = 'pepeg' AND\n u.age > 30\n )\n // hey i'm a comment\n RETURN u AS goog_pepeg\n`\n```\n\n## FAQ\n\n**Can i use nested objects ?**\n\nNo, a Graph database use Nodes, not documents. A node is a hash of key value pairs\nand edges (relations) to other nodes\n\n**Commonjs support**\n\nI don't plan to support commonjs as i don't plan to ask tesla to use fuel.\nIf you're still using commonjs, it will be better if you shutdown your computer right now\n\n**Edit me**\n","readmeFilename":"README.MD"}
![](\"https://img.shields.io/github/license/hydreio/rgraph.svg?style=for-the-badge\")
\n ![](\"https://img.shields.io/codecov/c/github/hydreio/rgraph/edge?logo=codecov&style=for-the-badge\"/)
\n \n ![](\"https://img.shields.io/npm/v/@hydre/rgraph.svg?logo=npm&style=for-the-badge\")
\n \n ![](\"https://img.shields.io/npm/dw/@hydre/rgraph?logo=npm&style=for-the-badge\")
\n ![](\"https://img.shields.io/github/workflow/status/hydreio/rgraph/CI?logo=Github&style=for-the-badge\")
\n