A JavaScript data aggregation pipeline based on the MongoDB database's aggregation framework. https://riveragroup.github.io/mungedb-aggregate/

Kyle P Davis 7cc3dc0772 Merge pull request #152 from RiveraGroup/bugfix/mongo_2.6.5_early_reset_of_runner %!s(int64=11) %!d(string=hai) anos
lib 52586cbc5c EAGLESIX-2656: fix runner reset too early in CursorDocumentSource %!s(int64=11) %!d(string=hai) anos
npm_scripts 8b2d1830b8 fix misc minor errors in test script %!s(int64=11) %!d(string=hai) anos
test 9cda1e24f7 EAGLESIX-3157: del unused reset/dispose methods %!s(int64=11) %!d(string=hai) anos
.gitignore 56cffffcbb EAGLESIX-2651: update gitignore %!s(int64=11) %!d(string=hai) anos
.jscheckstyleignore 33a99df088 Fixes #1612, #963: Renamed `alter` to `munge`. Removed unused `microdb`. Added test for `ExpressionDayOfMonth`. Fixed bug calling base `DayOfMonthExpression#addOperand()`. Fixed off-by-one bug in `DayOfMonthExpression#evaluate()`. %!s(int64=12) %!d(string=hai) anos
.jshintrc 8f1b7def78 EAGLESIX-3157: jshint change to abuse expressions %!s(int64=11) %!d(string=hai) anos
NOTES.md 004b6f5755 clean up docs a bit %!s(int64=11) %!d(string=hai) anos
README.md 004b6f5755 clean up docs a bit %!s(int64=11) %!d(string=hai) anos
TODO.md 004b6f5755 clean up docs a bit %!s(int64=11) %!d(string=hai) anos
mungedb-aggregate.js e382544f4e Refs #1879: Fixed jshint and pkg rename issues %!s(int64=12) %!d(string=hai) anos
package.json 845bb9b59f Merge branch 'feature/mongo_2.6.5_matcher' into feature/mongo_2.6.5_matcher_GTE_GT_LTE_LT %!s(int64=11) %!d(string=hai) anos

README.md

mungedb-aggregate

A JavaScript data aggregation pipeline based on the MongoDB database's aggregation framework.

Based on the MongoDB C++ code (v2.4.0).

Updating to v2.6 soon.

Why

MongoDB Aggregation and JavaScript are both awesome. We put them together.

Now, with the ease of JavaScript and the power of the MongoDB aggregation pipeline, we can provide a single API for data munging, regardless of where execution occurs. You can extend the base functionality to suit your needs.

Example

var aggregate = require("mungedb-aggregate");

var inputs = [
  {v: 1},
  {v: 2},
  {v: 3},
  {v: 4},
  {v: 5}
];

var pipeline = [
  {$match:{
    v: {$gte: 3}
  }},
  {$project:{
    v2: {$multiply: ["$v", "$v"]}
  }}
];

aggregate(pipeline, inputs);  // => [{v2:9}, {v2:16}, {v2:25}]

API

Public parts:

  • aggregate(pipeline, [inputs], [callback]) - The data aggregator
    • pipeline - The aggregation pipeline to apply to inputs
    • [inputs] - The input Objects to aggregate or return curried if omitted
    • [callback] - The callback if needed (for extensions using async calls)
  • version - The MongoDB version that this code represents
  • gitVersion - The MongoDB git revision that this code represents

Inner workings:

  • Cursor - Used to go thru data (by PipelineD and CursorDocumentSource)
  • pipeline
    • Pipeline - The pipeline handler
    • PipelineD - The pipeline data reader helper
    • FieldPath - Represents a path to a field within a document
    • Document - Document helpers used throughout the code
    • Value - Value helpers used throughout the code
    • accumulators - The Accumulator classes (used in $group)
    • documentSources - The DocumentSource classes (upper pipeline objects)
    • expressions - The Expression classes (used in $project)