mongoql

Installation

This library is published in the NPM registry and can be installed using any compatible package manager.

npm install mongoql --save

# For Yarn, use the command below.
yarn add mongoql

Installation from CDN

This module has an UMD bundle available through JSDelivr and Unpkg CDNs.

<!-- For UNPKG use the code below. -->
<script src="https://unpkg.com/mongoql"></script>

<!-- For JSDelivr use the code below. -->
<script src="https://cdn.jsdelivr.net/npm/mongoql"></script>

<script>
  // UMD module is exposed through the "mongoql" global variable.
  console.log(mongoql);
</script>

Usage

import MongoQL from 'mongoql';

const UsersRelationships = {
  address: [
    [
      'address',
      MongoQL.hasOne({
        from: 'addresses',
        localField: '_id',
        foreignField: 'user',
        as: 'address'
      })
    ]
  ],
  products: [
    [
      'products',
      MongoQL.hasMany({
        from: 'products',
        localField: '_id',
        foreignField: 'user',
        as: 'products'
      })
    ]
  ]
};

const UsersQL = MongoQL.prepare({ relationships: UsersRelationships })

with relationships

const req = {
  query: {
    fields: 'name,address.zipcode,products.name'
  }
}

const pipeline = UsersQL.pipeline({ fields: req.query.fields })

[
  {
    "$lookup": {
      "from": "addresses",
      "let": {
        "value": "$_id"
      },
      "pipeline": [
        {
          "$match": {
            "$expr": {
              "$eq": [
                "$user",
                "$$value"
              ]
            }
          }
        },
        {
          "$project": {
            "zipcode": 1
          }
        }
      ],
      "as": "address"
    }
  },
  {
    "$unwind": {
      "path": "$address",
      "preserveNullAndEmptyArrays": true
    }
  },
  {
    "$lookup": {
      "from": "products",
      "let": {
        "value": "$_id"
      },
      "pipeline": [
        {
          "$match": {
            "$expr": {
              "$eq": [
                "$user",
                "$$value"
              ]
            }
          }
        },
        {
          "$project": {
            "name": 1
          }
        }
      ],
      "as": "products"
    }
  },
  {
    "$project": {
      "name": 1,
      "address.zipcode": 1,
      "products.name": 1
    }
  }
]

without relationships

const req = {
  query: {
    fields: 'name'
  }
}

const pipeline = UsersQL.pipeline({ fields: req.query.fields })

[
  {
    "$project": {
      "name": 1
    }
  }
]

with filters

const req = {
  query: {
    name: 'João',
    'address.zipcode': '00000-000',
    fields: 'name,address.zipcode'
  }
}

const pipeline = UsersQL.pipeline({ fields: req.query.fields })

[
  {
    "$match": {
      "name": "João"
    }
  },
  {
    "$lookup": {
      "from": "addresses",
      "let": {
        "value": "$_id"
      },
      "pipeline": [
        {
          "$match": {
            "$expr": {
              "$eq": [
                "$user",
                "$$value"
              ]
            }
          }
        },
        {
          "$match": {
            "zipcode": "00000-000"
          }
        },
        {
          "$project": {
            "zipcode": 1
          }
        }
      ],
      "as": "address"
    }
  },
  {
    "$unwind": {
      "path": "$address",
      "preserveNullAndEmptyArrays": true
    }
  },
  {
    "$project": {
      "name": 1,
      "address.zipcode": 1
    }
  }
]

with helpers filters

const filtersFormatters = {
  createdAt: MongoQL.filtersFormatters.period('createdAt')
}

const UsersQL = MongoQL.prepare({ relationships, filtersFormatters })

const req = {
  query: {
    name: 'João',
    createdAt: '2020-01-01,2020-01-10',
    fields: 'name,createdAt'
  }
}

const pipeline = UsersQL.pipeline({ fields: req.query.fields })

[
  {
    "$match": {
      "name": "João",
      "createdAt": {
        "$gte": "2020-01-01T00:00:00.000Z",
        "$lte": "2020-01-10T00:00:00.000Z"
      }
    }
  },
  {
    "$project": {
      "name": 1,
      "createdAt": 1
    }
  }
]

Documentation

Documentation generated from source files by Typedoc.

License

Released under MIT License.