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

Kyle P Davis 1668a2bb39 Merge branch 'feature/mongo_2.6.5_accumulators' into feature/mongo_2.6.5_accumulators_Accumulator hace 11 años
lib 1668a2bb39 Merge branch 'feature/mongo_2.6.5_accumulators' into feature/mongo_2.6.5_accumulators_Accumulator hace 11 años
npm_scripts 8b2d1830b8 fix misc minor errors in test script hace 11 años
test f0c7af1436 EAGLESIX-2685: fix misc formatting from merge of old mongo25 branch hace 11 años
.gitignore 7ffdf43bbc Refs #1879: Updated .gitignore file hace 12 años
.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()`. hace 12 años
.jshintrc d86947d3f9 Refs #1999: fix pkg; jshint tweaks; test tweaks hace 12 años
NOTES.md 004b6f5755 clean up docs a bit hace 11 años
README.md 004b6f5755 clean up docs a bit hace 11 años
TODO.md 004b6f5755 clean up docs a bit hace 11 años
mungedb-aggregate.js e382544f4e Refs #1879: Fixed jshint and pkg rename issues hace 12 años
package.json 80f1f3ed57 Merge remote-tracking branch 'origin/master' into stash_mongo25 hace 11 años

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)