relay-mongodb-connection

Like connectionFromMongoCursor() but for Mongoose queries

Install

1npm install --save shenyzore/relay-mongoose-connection

Usage

Give it a query from mongoose, and it handles pagination int he same way graphql-relay does for arrays.

At a glance

Pass it a Mongoose query and connectionArgs, and it's happy.

1async resolve(obj, { ...args }) {
2  return await connectionFromMongooseQuery(
3    User.find({}),
4    args
5  );
6}

Optionally give it a mapper function:

1async resolve(obj, { ...args }) {
2  return await connectionFromMongoCursor(
3    User.find({}),
4    args,
5    (user) => Object.assign(user, { id: user._id })
6  );
7}

Example

1// ...
2import connectionFromMongooseQuery from 'relay-mongoose-connection';
3// ...
4
5// Instead of resolving, synchronously returns a Mongoose Query.
6function getSpaceshipsForUser(userId) {
7  return Spaceships.find({
8    user: new ObjectId(userId)
9  });
10}
11
12export const GraphQLUser = new GraphQLObjectType({
13  name: 'User',
14  fields: {
15    id: globalIdField('User'),
16    spaceships: {
17      type: SpaceshipConnection,
18      args: {
19        ...connectionArgs,
20      },
21      async resolve(user, { ...args }) {
22        const spaceshipCursor = getSpaceshipsForUser(user._id);
23        return await connectionFromMongooseQuery(spaceshipCursor, args);
24      }
25    }
26  }
27});

connectionFromMongooseQuery automatically skips and limits the Mongoose Query so that only the necessary documents are retrieved from the database.

Changelog

See CHANGELOG.md

Testing

Set a MongoDB connection string as environment variable:

1export MONGO_CONNECTION_STRING=mongodb://192.168.99.100/mongodbconnection

Then run tests

1npm test

License

MIT © Mikael Berg