Skip to content
Some help defining GraphQL schema around BookshelfJS models
Branch: master
Clone or download
brysgo Merge pull request #38 from brysgo/greenkeeper/graphql-relay-0.6.0
Update graphql-relay to the latest version 🚀
Latest commit 3e8a74f Mar 21, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci fix(package): add semantic release Jan 30, 2019
schema Add optional support for relay connections Sep 12, 2016

GraphQL + BookshelfJS

CircleCI npm package Greenkeeper badge

peerDependency Status

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.


npm install --save graphql-bookshelf


var BookshelfType = require('graphql-bookshelf');

Example use...

Use BookshelfType inside of GraphQLObjectType...

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()...

    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()...

    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()...

    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?

    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...

    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:

    import {
    } from 'graphql-relay';

And in your schema...

    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...


  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
You can’t perform that action at this time.