├── .gitignore ├── LICENSE ├── README.md ├── package.json └── src ├── datasources └── graph.js ├── index.js ├── resolvers.js ├── schema.js └── utils.js /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # RedisGraph-GraphQL 2 | Demo application querying RedisGraph via GraphQL, in this demo we're modeling a IMDB data-set, in which we've got `Person` and `Movies` entities, we can form relations between the two, e.g. a person can `act` or `direct` a movie. 3 | 4 | ## Run 5 | 1. Make sure to have a RedisGraph server running in the background 6 | `docker run --rm -p 6379:6379 redislabs/redisgraph:edge` 7 | 8 | 2. Install required packages, from root 9 | `npm install` 10 | 11 | 3. Start the server 12 | `node src/index.js` 13 | 14 | 4. In your browser navigate to http://127.0.0.1:4000/ 15 | 16 | ## API 17 | ### Mutations 18 | * createMovie - Creates a movie entity 19 | * createPerson - Creates a person entity 20 | * directed - Associate a person with a movie by forming a directed relation. 21 | * acted - Associate a person with a movie by forming a acted relation. 22 | 23 | ### Query 24 | * actors - Get all person entities. 25 | * actor - Get a specific actor. 26 | * movies - Get all movie entities. 27 | * movie - Get a specific movie. 28 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "redisgraph-graphql", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "author": "", 10 | "license": "ISC", 11 | "dependencies": { 12 | "apollo-datasource": "^0.6.3", 13 | "apollo-server": "^2.9.7", 14 | "graphql": "^14.5.8", 15 | "redisgraph.js": "git+https://github.com/RedisGraph/redisgraph.js.git" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/datasources/graph.js: -------------------------------------------------------------------------------- 1 | const { DataSource } = require('apollo-datasource'); 2 | 3 | const edgeDir = { 4 | RTL:1, 5 | LRT:2 6 | } 7 | 8 | class GraphAPI extends DataSource { 9 | constructor({ graph }) { 10 | super(); 11 | this.graph = graph; 12 | } 13 | 14 | /** 15 | * This is a function that gets called by ApolloServer when being setup. 16 | * This function gets called with the datasource config including things 17 | * like caches and context. We'll assign this.context to the request context 18 | * here, so we can know about the user making requests 19 | */ 20 | initialize(config) { 21 | this.context = config.context; 22 | } 23 | 24 | // Reducers 25 | personReducer(person) { 26 | if(person) { 27 | return { 28 | id: person.id || '0', 29 | name: person.properties['name'], 30 | age: person.properties['age'], 31 | }; 32 | } else { 33 | return { 34 | id: -1, 35 | name: "", 36 | age: 0, 37 | }; 38 | } 39 | } 40 | 41 | movieReducer(movie) { 42 | if(movie) { 43 | return { 44 | id: movie.id || '0', 45 | title: movie.properties['title'], 46 | released: movie.properties['released'], 47 | }; 48 | } else { 49 | return { id: -1, title: '', released: 0 }; 50 | } 51 | } 52 | 53 | // API 54 | async getAllActors() { 55 | let actors = await this.getAllNodes(`Person`); 56 | actors = actors.map(person => this.personReducer(person)); 57 | return actors; 58 | } 59 | 60 | async getActor({id}) { 61 | let actor = await this.getNode(id); 62 | actor = this.personReducer(actor); 63 | return actor; 64 | } 65 | 66 | async getAllMovies() { 67 | let movies = await this.getAllNodes(`Movie`); 68 | movies = movies.map(movie => this.movieReducer(movie)); 69 | for(let i = 0; i < movies.length; i++) { 70 | let actors = await this.getNeighbors(movies[i].id, `acted`, `Person`, edgeDir.RTL); 71 | actors = actors.map(person => this.personReducer(person)); 72 | 73 | let director = await this.getNeighbors(movies[i].id, `directed`, `Person`, edgeDir.RTL); 74 | if(director) { 75 | director = director[0]; 76 | director = this.personReducer(director); 77 | } 78 | 79 | movies[i].actors = actors; 80 | movies[i].director = director; 81 | } 82 | return movies; 83 | } 84 | 85 | async getMovie({id}) { 86 | let director = null; 87 | let actors = []; 88 | let movie = await this.getNode(id); 89 | if(movie) { 90 | actors = await this.getNeighbors(movie.id, `acted`, `Person`, edgeDir.RTL); 91 | actors = actors.map(person => this.personReducer(person)); 92 | 93 | director = await this.getNeighbors(id, `directed`, `Person`, edgeDir.RTL); 94 | if(director.length > 0) { 95 | director = director[0]; 96 | director = this.personReducer(director); 97 | } 98 | } 99 | 100 | movie = this.movieReducer(movie); 101 | movie.director = director; 102 | movie.actors = actors; 103 | 104 | return movie; 105 | } 106 | 107 | async createPerson({name, age}) { 108 | const person = await this.createNode('Person', {'name': name, 'age': age}); 109 | return this.personReducer(person); 110 | } 111 | 112 | async createMovie({title, released}) { 113 | const movie = await this.createNode('Movie', {'title': title, 'released': released}); 114 | return this.movieReducer(movie); 115 | } 116 | 117 | // GraphAPI 118 | async query(q) { 119 | const response = await this.graph.graph.query(q); 120 | return response; 121 | } 122 | 123 | async getNode(id) { 124 | let node = null; 125 | let resp = await this.query(`MATCH (n) WHERE ID(n) = ` + id + ` RETURN n`); 126 | if(resp.hasNext()) { 127 | const rec = resp.next(); 128 | node = rec.get('n'); 129 | } 130 | return node; 131 | } 132 | 133 | async getAllNodes(label) { 134 | let res = []; 135 | let q = `MATCH (n:`+label+`) RETURN n`; 136 | let resp = await this.query(q); 137 | while(resp.hasNext()){ 138 | let rec = resp.next(); 139 | res.push(rec.get('n')); 140 | } 141 | return res; 142 | } 143 | 144 | async getNeighbors(srcId, relation, destLabel, dir) { 145 | let res = []; 146 | let q = ""; 147 | 148 | q = `MATCH (src)`; 149 | if(dir == edgeDir.RTL) { 150 | q += `<-[:` + relation + `]-`; 151 | } else { 152 | q += `-[:` + relation + `]->`; 153 | } 154 | q += `(dest`; 155 | if(destLabel) { 156 | q += `:` + destLabel; 157 | } 158 | q += `) WHERE ID(src) = ` + srcId + ` RETURN dest`; 159 | 160 | let resp = await this.query(q); 161 | 162 | while(resp.hasNext()){ 163 | let rec = resp.next(); 164 | res.push(rec.get('dest')); 165 | } 166 | 167 | return res; 168 | } 169 | 170 | async createNode(label, attributes) { 171 | let q = `CREATE (n` 172 | if (label) { 173 | q += `:` + label; 174 | } 175 | if(attributes) { 176 | q += `{`; 177 | for (var key in attributes) { 178 | var val = attributes[key]; 179 | if(typeof val === "string") { 180 | val = `"` + val + `"`; 181 | } 182 | q += key + `:` + val + `,`; 183 | } 184 | q = q.slice(0, -1); 185 | q += `}`; 186 | } 187 | 188 | q += `) RETURN n AS n`; 189 | const resp = await this.query(q); 190 | const rec = resp.next(); 191 | const node = rec.get('n'); 192 | return node; 193 | } 194 | 195 | async connectNodes({ src, dest, rel, attributes }) { 196 | let q = `MATCH (src), (dest) WHERE ID(src) = ` + src + ` AND ID(dest) = ` + dest + ` CREATE (src)-[:` + rel 197 | if(attributes) { 198 | q += `{` + attributes + `}`; 199 | } 200 | q += `]->(dest)`; 201 | 202 | const resp = await this.query(`MATCH (src), (dest) WHERE ID(src) = ` + src + ` AND ID(dest) = ` + dest + ` CREATE (src)-[:` + rel + `]->(dest)`); 203 | return ""; 204 | } 205 | } 206 | 207 | module.exports = GraphAPI; 208 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | const { ApolloServer } = require('apollo-server'); 2 | const typeDefs = require('./schema'); 3 | const {createGraph} = require('./utils'); 4 | const resolvers = require('./resolvers'); 5 | const GraphAPI = require('./datasources/graph'); 6 | 7 | const graph = createGraph(); 8 | const server = new ApolloServer({ 9 | typeDefs, 10 | resolvers, 11 | dataSources: () => ({ 12 | graphAPI: new GraphAPI({ graph }) 13 | }) 14 | }); 15 | 16 | server.listen().then(({url}) => { 17 | console.log(`Server ready at ${url}`); 18 | }); 19 | -------------------------------------------------------------------------------- /src/resolvers.js: -------------------------------------------------------------------------------- 1 | 2 | module.exports = { 3 | Query: { 4 | actors: (_, __, { dataSources }) => 5 | dataSources.graphAPI.getAllActors(), 6 | actor: (_, { id }, { dataSources }) => 7 | dataSources.graphAPI.getActor({ id }), 8 | 9 | movies: (_, __, { dataSources }) => 10 | dataSources.graphAPI.getAllMovies(), 11 | movie: (_, { id }, { dataSources }) => 12 | dataSources.graphAPI.getMovie({ id }), 13 | }, 14 | Mutation: { 15 | createPerson: async (_, { name, age }, { dataSources }) => 16 | dataSources.graphAPI.createPerson({name, age}), 17 | createMovie: async (_, { title, released }, { dataSources }) => 18 | dataSources.graphAPI.createMovie({ title, released }), 19 | directed: async (_, { movie, director }, { dataSources }) => { 20 | const src = director; 21 | const rel = 'directed'; 22 | const dest = movie; 23 | dataSources.graphAPI.connectNodes({ src, dest, rel }) 24 | }, 25 | acted: async (_, { movie, actor }, { dataSources }) => { 26 | const src = actor; 27 | const rel = 'acted'; 28 | const dest = movie; 29 | dataSources.graphAPI.connectNodes({ src, dest, rel }) 30 | }, 31 | }, 32 | }; 33 | -------------------------------------------------------------------------------- /src/schema.js: -------------------------------------------------------------------------------- 1 | const { gql } = require('apollo-server'); 2 | 3 | const typeDefs = gql` 4 | type Query { 5 | actors: [Person]! 6 | actor(id: ID!): Person! 7 | movies: [Movie]! 8 | movie(id: ID!): Movie! 9 | } 10 | 11 | type Person { 12 | id: ID 13 | name: String 14 | age: Int 15 | } 16 | 17 | type Movie { 18 | id: ID 19 | title: String! 20 | released: Int! 21 | actors: [Person] 22 | director: Person 23 | } 24 | 25 | type Mutation { 26 | createPerson(name: String! age: Int!): Person! 27 | createMovie(title: String! released: Int!): Movie! 28 | directed(movie:ID! director:ID!) : String 29 | acted(movie:ID! actor:ID!) : String 30 | } 31 | `; 32 | 33 | module.exports = typeDefs; 34 | -------------------------------------------------------------------------------- /src/utils.js: -------------------------------------------------------------------------------- 1 | const RedisGraph = require("redisgraph.js").Graph; 2 | 3 | module.exports.createGraph = () => { 4 | const graph = new RedisGraph('imdb'); 5 | return { graph }; 6 | }; 7 | --------------------------------------------------------------------------------