safrazik / breeze.sugar

Syntax sugar (Mongo DB style queries) for breeze js

Project Status: 🚨 Unmaintained 🚨

This project is no longer maintained. We will not be accepting pull requests, addressing issues, nor making future releases.

breeze.sugar

Syntax sugar (Mongo DB style queries) for breeze js

API

createQuery(resourceName [, criteria [, options ]])

Create an EntityQuery in mongodb style

Arguments

• resourceName String entityType's resource name to query from
• criteria Object Mongodb style query criteria
• options Object
  • sort Object Sort order
  • skip Number Number of results to skip at the beginning
  • limit Number Maximum number of results to return
  • expand Object The navigation properties to expand

Returns

breeze.EntityQuery

Usage

var query = sugar.createQuery('Customers', 
   {  // criteria
      'country.code': 'en-US',
      $or: [
        {age: {$gt: 18}},
        {name: {$contains: 'z'}}
      ],
    },
    { // options
      limit: 10,
      skip: 5,
      sort: {
         name: -1
      },
      expand: {
         country: true
      }
   });

the above code is converted into:

var query = new breeze.EntityQuery().from('Customers').where(
  breeze.Predicate.and(
    new breeze.Predicate('country.code', '==', 'en-US'),
    breeze.Predicate.or(
      new breeze.Predicate('age', 'gt', 18),
      new breeze.Predicate('name', 'contains', 'z')
    )
  )
)
.top(10)
.skip(5)
.orderBy('name desc')
.expand('country');

breeze.sugar's Issues

Add support for multiple operators for a property

In mongodb, it is possible to add multiple conditions for a particular property in one object representation

price: {$gt: 50, $lt: 100}

Workaround for now is to use the alternative syntax of mongodb

$and: [{price: {$gt: 50}}, {price: {$lt: 100}}]