https://github.com/lk321/magic-graphql
Automatic graph generator for Sequelize ORM, it's magic! 🧙♂️🧑🏻💻
https://github.com/lk321/magic-graphql
dataloader graphql sequelize sequelize-orm subscriptions
Last synced: 5 months ago
JSON representation
Automatic graph generator for Sequelize ORM, it's magic! 🧙♂️🧑🏻💻
- Host: GitHub
- URL: https://github.com/lk321/magic-graphql
- Owner: lk321
- License: mit
- Created: 2020-07-09T18:22:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T14:54:32.000Z (about 3 years ago)
- Last Synced: 2025-07-31T02:35:24.193Z (5 months ago)
- Topics: dataloader, graphql, sequelize, sequelize-orm, subscriptions
- Language: JavaScript
- Homepage:
- Size: 507 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# magic-graphql
Automatic graph generator for Sequelize ORM, it's magic! 🧙♂️🧑🏻💻
## Installation
This is a [Node.js](https://nodejs.org/) module available through the
[npm registry](https://www.npmjs.com/). It can be installed using the
[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
or
[`yarn`](https://yarnpkg.com/en/)
command line tools.
```$ yarn add magic-graphql```
## Example
This is an [example](https://github.com/lk321/magic-graph-example) of how to use the library 💪
```js
const http = require('http')
const express = require('express')
const graphqlServer = require('./magic-graphql')
const app = express()
const httpServer = http.createServer(app)
// ! GraphQL setup
graphqlServer(app, {
modelDirPath: '../models', // Or require('../models')
customsDirPath: null,
graphqlEndpint: '/graphql',
subscriptions: true,
httpServer: httpServer,
dataloader: true,
dataloaderOptions: {
max: 500,
cache: true,
batch: true
},
context: {}
})
httpServer.listen(global.ConfigApp, () => {
console.log(`✅ Starting server`)
})
```
## Options
| Option Key | Type | Default | Description |
| ---------- | ---- | ------- | ----------- |
| *modelDirPath* | String / Object | `../models` | Path where the models folder is located.
| *customsDirPath* | String | `null` | Folder for custom queries and mutations.
| *graphqlEndpint* | String | `/graphql` | GraphQL endpoint.
| *subscriptions* | Boolean | `false` | Set to `true` to enable GraphQL subscriptions, this requires an http server.
| *httpServer* | Object | `null` | HttpServer it is required to be able to use GraphQL subscriptions.
| *dataloader* | Boolean | `true` | Set to `false` to disable dataloader.
| *dataloaderOptions* | Object | `{ ... }` | Dataloader [options](#dataloader-options).
| *context* | Object | `{}` | Context object.
#### Dataloader options
| Option Key | Type | Default | Description |
| ---------- | ---- | ------- | ----------- |
| *batch* | Boolean | `true` | Set to `false` to disable batching.
| *max* | Number | `500` | Limits the number of items that get passed in to the batch. May be set to `1` to disable batching.
| *cache* | Boolean | `true` | Set to `false` to disable memoization caching.
## Dependencies
- [express](https://ghub.io/express): Fast, unopinionated, minimalist web framework
- [express-graphql](https://ghub.io/express-graphql): Production ready GraphQL HTTP middleware.
- [graphql](https://ghub.io/graphql): A Query Language and Runtime which can target any service.
- [graphql-playground-middleware-express](https://ghub.io/graphql-playground-middleware-express): GraphQL IDE for better development workflows (GraphQL Subscriptions, interactive docs & collaboration).
- [graphql-relay](https://ghub.io/graphql-relay): A library to help construct a graphql-js server supporting react-relay.
- [graphql-sequelize](https://ghub.io/graphql-sequelize): GraphQL & Relay for MySQL & Postgres via Sequelize
- [lodash](https://ghub.io/lodash): Lodash modular utilities.
- [mysql2](https://ghub.io/mysql2): fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS
- [sequelize](https://ghub.io/sequelize): Multi dialect ORM for Node.JS
## Dev Dependencies
- [nodemon](https://ghub.io/nodemon): Simple monitor script for use during development of a node.js app.
## License
MIT