Skip to content
Fully customizable Mongoose/MongoDB projection generator.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Simplify api fun Mar 15, 2018
examples lint and test Jul 28, 2018
src lint and test Jul 28, 2018
tests Pass cfgs Mar 16, 2018
.editorconfig Init Mar 10, 2018
.eslintrc.json Setup eslint fp Mar 14, 2018
.gitignore Coverage Mar 10, 2018
.travis.yml Only build master [ci skip] Mar 14, 2018 Init Mar 10, 2018 Simplify api fun Mar 15, 2018
index.js Simplify api fun Mar 15, 2018
logger.js Add logger Mar 10, 2018
package.json 1.0.2 Jul 28, 2018
yarn.lock Update packages Mar 14, 2018


npm npm GitHub last commit GitHub code size in bytes license

Travis Coveralls Greenkeeper badge Badges

Fully customizable Mongoose/MongoDB projection generator.


We already have graphql-projection, graphql-mongodb-projection, and graphql-db-projection. But graphql-advanced-projection is different from all of them above in the following ways:

  • Separete graphql schema and mongodb projection config. This helps you decouple schema and mongodb into two parts, each of them may change independently. Write graphql in .graphql, write config in javascript or .json.
  • Easy customization. No more gqlField: { type: new GraphQLNonNull(GraphQLInt), projection: 'mongoField' }. Simply gqlField: 'mongoField'.
  • We create resolvers. gqlField: (parent) => parent.mongoField can be automatically generated, even complicated ones like first: (parent) =>[0].value.
  • Fully supports interfaces, fragments, and inline fragments. Write typeProj: 'type' and switch (parent.type) in __resolveType.


$ yarn add graphql-advanced-projection


For a complete working demo, see the examples folder.

Setup mongoose

const UserSchema = new mongoose.Schema({
  _id: String,
  mongoA: String,
const User = mongoose.model('users', UserSchema);

Setup graphql

type Query {
  user(id: ID!): User
type User {
  userId: ID
  field1: String
  field2: String

Setup graphql-advanced-projection

const { project, resolvers } = gqlProjection({
  User: {
    proj: {
      userId: '_id',
      field1: 'mongoA',
      field2: null,

Combine everything together

module.exports = makeExecutableSchema({
  resolvers: _.merge(resolvers, {
    Query: {
      async user(parent, args, context, info) {
        const proj = project(info);
        const result = await User.findById(, proj);
        return result.toObject();
    User: {
      field2: () => 'Hello World',


query {
  user(id: $id) {
proj = {
  _id: 0,
  mongoA: 1,



You can’t perform that action at this time.