Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brysgo/graphql-bookshelf
Some help defining GraphQL schema around BookshelfJS models
https://github.com/brysgo/graphql-bookshelf
Last synced: 18 days ago
JSON representation
Some help defining GraphQL schema around BookshelfJS models
- Host: GitHub
- URL: https://github.com/brysgo/graphql-bookshelf
- Owner: brysgo
- Created: 2015-08-13T03:38:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T01:43:33.000Z (almost 2 years ago)
- Last Synced: 2024-11-16T18:03:36.344Z (26 days ago)
- Language: JavaScript
- Size: 2.18 MB
- Stars: 184
- Watchers: 5
- Forks: 12
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-graphql - graphql-bookshelf
- awesome-graphql - graphql-bookshelf - Some help defining GraphQL schema around BookshelfJS models. (Libraries / JavaScript Libraries)
- awesome-graphql - graphql-bookshelf - Some help defining GraphQL schema around BookshelfJS models. (Implementations / JavaScript/TypeScript)
- awesome-graphql - graphql-bookshelf - Some help defining GraphQL schema around BookshelfJS models. (Libraries / JavaScript Libraries)
README
# GraphQL + BookshelfJS
[![npm package][npm-badge]][npm]
[![Greenkeeper badge][greenkeeper-badge]][greenkeeper]
[](https://david-dm.org/brysgo/graphql-bookshelf#info=peerDependencies)
This is an early version of the `BookshelfType` I wrote to help me link up my Bookshelf models (built on top of Postgres) to my GraphQL schema.
### Install
`npm install --save graphql-bookshelf`
...
`var BookshelfType = require('graphql-bookshelf');`
### Example use...
Use `BookshelfType` inside of `GraphQLObjectType`...
```js
export default new GraphQLObjectType(BookshelfType({
name: 'Classroom',
description: 'Need I say more?',
// ...and an object gets passed into the fields to help with your model.
fields: (model) => ({
```
Simply wrap with `model.attr()`...
```js
id: model.attr({
type: new GraphQLNonNull(GraphQLInt),
description: 'The id of the classroom.',
// ...and you don't need to resolve table attributes.
}),
```
Or wrap with model.belongsTo()...
```js
subject: model.belongsTo({
type: SubjectType, // And use the right association type...
description: 'The subject of the classroom.',
// And you get one-to-one relationships for free
}),
```
Use model.hasMany()...
```js
students: model.hasMany({
type: new GraphQLList(StudentType), // And make sure you use `GraphQLList`
description: 'Students in the classroom.',
// Now you have associated collections for free
}),
```
Need to do more on your associated collection?
```js
homeworks: model.hasMany({
type: new GraphQLList(HomeworkType),
description: 'Homework submitted to the classroom (latest to oldest).',
// Define a resolve function...
resolve: (qb) => {
// And get a sweet KnexJS query builder
qb.orderBy('created_at', 'DESC');
}
}),
```
Or just leave it alone...
```js
size: {
type: GraphQLInt,
description: 'How many students there are in the class.',
resolve: (model) => {
// And do it the old fashioned way
return model.studentCount();
},
}
}),
}));
```
Are you using graphql-relay-js? Define some connection associations.
At the top:
```js
import { connectionDefinitions, connectionArgs } from "graphql-relay";
```
And in your schema...
```js
homeworks: model.hasMany({
type: connectionDefinitions({nodeType: HomeworkType}).connectionType,
args: connectionArgs,
description: 'Homework submitted to the classroom.'
}),
```
### Goals & Philosophy
This library is intended to keep it simple. Automatic generation of schema can leave use-cases out, while using bookshelf in every resolve calls for large amounts of repetitive boilerplate.
Another thing this library could help with is optimization. Turing graphql queries into database calls can be expensive, but using a layer in between can help make those optimizations that would get ugly and repetitive in every resolve.
[See this example in action via the tests...](https://github.com/brysgo/graphql-bookshelf/blob/master/schema/ClassroomType.js)
### Contributing
1. Install sqlite3, clone repo, npm install
2. Create database in project root by running `sqlite3 graphql_bookshelf.sqlite`
3. Run migrations, `knex migrate:latest`
4. Run the tests with `npm test`
5. When they pass, submit a PR
[build-badge]: https://circleci.com/gh/brysgo/graphql-bookshelf.svg?style=shield
[build]: https://circleci.com/gh/brysgo/graphql-bookshelf
[npm-badge]: https://img.shields.io/npm/v/graphql-bookshelf.png?style=flat-square
[npm]: https://www.npmjs.org/package/graphql-bookshelf
[greenkeeper-badge]: https://badges.greenkeeper.io/brysgo/graphql-bookshelf.svg
[greenkeeper]: https://greenkeeper.io/