实战 MongoDB Aggregate

·  阅读 197
实战 MongoDB Aggregate

本文由Pingcode张月青分享

前言

MongoDB是一款流行的无模式,内存数据库,应用非常广泛,其中作为 MongoDB 重要组成部分 MongoDB Aggregate ,它主要是用来做复杂查询,统计数据,数据分析等等,随着业务的发展,会累积大量的数据,需要写各种各样复杂的查询语句,这就需要我们对Aggregate的原理,Aggregate的核心思想,Aggregate的性能分析要做深入的理解,以及如何写更高效的查询语句?如何提高查询的性能?的方式方法需要深入的探索,接下来就让我们一起来对MongoDB Aggregate的做全面的解析。

MongoDB Aggregate的发展历史

image.png

MongoDB Aggregation 核心思想

MongoDB Aggregation Framework

MongoDB Aggregation Framework 主要是通过Aggregate Language来编写Pipeline提供数据分析处理的能力,它包含俩部分:

  1. 应用程序通过MongoDB驱动提供的Aggregate Api来定义Pipeline,并将其交给Aggregate Runtime
  2. Aggregate Runtime 接受来自应用的请求,然后对存储的数据执行PipeLine中的Stage来查询数据

原理图如下:



MongoDB Aggregation Framework components - Driver API and Database Aggregation Runtime



应用程序通过MongoDB Driver 提供的MQL API 或者 Agg API 来接受用户的查询请求,然后交给MongoDB Database Runtime来执行,其中Aggregation Runtime是Query Runtime的一部分,Aggregation Runtime 重用了Query Runtime的部分引擎的能力,主要是体现在Aggregation Runtime 执行Pipeline的第一阶段matchAggregatePipeline的第一个match,Aggregate Pipeline的第一个match Stage 是通过MQL中的查询分析的引擎对其处理的。

MongoDB Aggregation Language

对于初学者来说,Aggregate Framework 是难于理解,并且它的学习曲线是比较陡峭的,必须克服它才能提高自己的Aggregate的编程能力,能把复杂的业务拆解为Aggregate Pipeline中具体的每一个Stage,并能明白每个Stage的职责,然后正确的组合每个stage顺序,最后通过Pipeline的Stream的方式去完成数据的处理,这是它的核心所在。

Aggregate Language 思想:

  • 面向数据库的编程语言非面向解决业务问题的编程语言
  • 声明式的编程语言非命令式的编程语言
  • 函数式编程语言非过程式的编程语言

Aggregate Language 特点:

函数式的编程语言,Aggregate Pipeline 声明了一系列有序的Stage,并且把上一个Stage产生的数据作为下一个Stage输入的数据,这种行为本身就是函数的特征行为,并且每一个Stage里面的Operator也可以接受其它的Oprator的返回值作为输入参数。针对Aggregate编程的本质核心,就是把业务逻辑拆分成一个一个Stage,然后在Stage阶段通过各种内置的Operator操作符完成数据的转化,每个Operator就是可以理解为一个内置的 Function

Aggregate Language 难点:

  1. 书写起来冗长
  2. 难于理解
  3. 因为我们更多的开发场景是比较熟悉的过程式编程,但是对于Aggregate 来说你必须用函数式的编程的思维去思考问题,这是开发思维的转变。

Aggregate Language 优点:

正是因为Aggregate 这种声明式,函数式的特征,以至于它能灵活的处理各种复杂的业务场景,我们只需要关心如何去定义每个Stage它是干什么的?而不需要关心这个Stage本身是如何工作的,只要你清晰的声明每个Stage,然后交给Aggregate Runtime ,Aggregate Runtime清楚的知道具体每个Stage是如何工作的,正是因为这种声明式的特性,所以Aggregate runtime 才有能力去重新优化Stage的顺序,以便能更好的处理性能问题,同时这种声明式的Stage特征,我们还可以利用Shards去并发执行不同的Stage,能有效的降低响应时间,提高性能,下图所示它描述了Aggregate Runtime的优化能力。



MongoDB Aggregation Framework developer vs database engine optimizations comparison



何时使用 Aggregation Framework

  1. 生成报告,Sum ,Average,Count
  2. 连接不同的集合来查询数据
  3. 数据发现和数据挖掘
  4. 过滤敏感数据
  5. 实现各种BI Connector
  6. 机器学习,等等场景

编程规范

正是由于Aggregate PipeLine的复杂性,并且难以维护的特征,所以我们需要制定一些规范来让我们更好的去约束我们的代码,可能对于不同的公司来说规范都不一样,如下是笔者所在单位制定的一些规范:

  • 不要在开始或者结束的地方写另外的一个Stage
  • 对于Stage中的每个字段后面都要加“,”
  • 每个Stage中要增加一个空行
  • 对于复杂的Stage 通过 // 来写注释
  • 对于不需要的Stage,以及测试开发中需要禁用的Stage ,要通过 /**/ 来注释掉
  • Stage 要遵守单一职责

示例:

// BAD
var pipeline = [
  {"$unset": [
    "_id",
    "address"
  ]}, {"$match": {
    "dateofbirth": {"$gte": ISODate("1970-01-01T00:00:00Z")}
  }}//, {"$sort": {
  //  "dateofbirth": -1
  //}}, {"$limit": 2}
];

// GOOD
var pipeline = [
  {"$unset": [
    "_id",
    "address",
  ]},    
    
  // Only match people born on or after 1st January 1970
  {"$match": {
    "dateofbirth": {"$gte": ISODate("1970-01-01T00:00:00Z")},
  }},
  
  /*
  {"$sort": {
    "dateofbirth": -1,
  }},      
    
  {"$limit": 2},  
  */
];

// GOOD
var unsetStage = {
  "$unset": [
    "_id",
    "address",
  ]};    

var matchStage = {
  "$match": {
    "dateofbirth": {"$gte": ISODate("1970-01-01T00:00:00Z")},
  }};

var sortStage = {
   "$sort": {
    "dateofbirth": -1,
  }}; 


var limitStage = {"$limit": 2};
    
var pipeline = [
  unsetStage,
  matchStage,
  sortStage,
  limitStage,
];

复制代码

我们在聊完Mongo Aggregate的它的设计思想和语言特性,接下来就是具体的我们如何去编写 Aggregate中的 Pipeline ,这里有一些指导原则,供大家参考如下:

Pipeline编程指导原则

拥抱组合及组合技巧

Aggregate Pipeline 是包含了一些声明的,有序的Statement,我们把它称之为Stage,一个Stage的完整输出会作为下一个Stage完整的输入,每个Stage之间是互相没有影响,独立存在,Stage这种高度的自由组合性和单个Stage的内聚性的特征充分满足了复杂的业务场景的数据处理,并且能极大的增加我们对测试Stage的可能性,因为它们都是独立的,对于Aggregate 复杂的Pipeline,我们首先需要把它分割成一个一个清晰的Stage,然后分别针对每个Stage进行独立的测试和开发,如下图



Alternatives for MongoDB aggregation pipelines composability



这样即便是复杂的业务逻辑,你都可以把它拆分成具体的独立的Stage,然后一步步的去调试,分析,观察每一步的数据到底是什么样的,对于这种组合,声明的特性,有一些非常显著的优点:

  • 很方便的注释和调试某一个Stage
  • 能方便的Copy,Paste来增加一个新的Stage
  • 更加清晰每个Stage的具体目的
  • 具体Stage中调用Mongo 提供的内置的Operator,以及通过逻辑表达式来控制数据的行为

Project Stage

在MQL语言中Project指定那些字段要返回,那些字段是要忽略的,在Aggregate中,在Project 指定那些字段要返回,那些字段是要忽略的,在Aggregate中,在Project Stage中指定排除或者返回那些字段

显著的缺点:

Project是冗长的且不灵活的,如果你想在Project 是冗长的且不灵活的,如果你想在Project 阶段新增加一个字段,还要保留原来的字段,你必须把原来的字段都写一遍

显著的优点:

在$Project Stage阶段,灵活的定义那些字段要包含,那些字段要忽略

何时使用$Project:

当你需要保留少数字段的时候, $Project 是比较占优势的,例如:

// INPUT  (a record from the source collection to be operated on by an aggregation)
{
  _id: ObjectId("6044faa70b2c21f8705d8954"),
  card_name: "Mrs. Jane A. Doe",
  card_num: "1234567890123456",
  card_expiry: "2023-08-31T23:59:59.736Z",
  card_sec_code: "123",
  card_provider_name: "Credit MasterCard Gold",
  transaction_id: "eb1bd77836e8713656d9bf2debba8900",
  transaction_date: ISODate("2021-01-13T09:32:07.000Z"),
  transaction_curncy_code: "GBP",
  transaction_amount: NumberDecimal("501.98"),
  reported: true
}

// OUTPUT  (a record in the results of the executed aggregation)
{
  transaction_info: { 
    date: ISODate("2021-01-13T09:32:07.000Z"),
    amount: NumberDecimal("501.98")
  },
  status: "REPORTED"
}
// BAD
[
  {"$set": {
    // Add some fields
    "transaction_info.date": "$transaction_date",
    "transaction_info.amount": "$transaction_amount",
    "status": {"$cond": {"if": "$reported", "then": "REPORTED", "else": "UNREPORTED"}},
  }},
  
  {"$unset": [
    // Remove _id field
    "_id",

    // Must name all other existing fields to be omitted
    "card_name",
    "card_num",
    "card_expiry",
    "card_sec_code",
    "card_provider_name",
    "transaction_id",
    "transaction_date",
    "transaction_curncy_code",
    "transaction_amount",
    "reported",         
  ]}, 
]
// GOOD
[
  {"$project": {
    // Add some fields
    "transaction_info.date": "$transaction_date",
    "transaction_info.amount": "$transaction_amount",
    "status": {"$cond": {"if": "$reported", "then": "REPORTED", "else": "UNREPORTED"}},
    
    // Remove _id field
    "_id": 0,
  }},
]

复制代码

何时使用set,set,unset

set,set,unset 是在MongoDB 4.2才新增加的功能,当你在Stage中想保留更多的字段,并且想添加,修改,移除最小的字段集合的时候,这个时候set,set,unset是最使用的,例如:

// INPUT  (a record from the source collection to be operated on by an aggregation)
{
  _id: ObjectId("6044faa70b2c21f8705d8954"),
  card_name: "Mrs. Jane A. Doe",
  card_num: "1234567890123456",
  card_expiry: "2023-08-31T23:59:59.736Z",
  card_sec_code: "123",
  card_provider_name: "Credit MasterCard Gold",
  transaction_id: "eb1bd77836e8713656d9bf2debba8900",
  transaction_date: ISODate("2021-01-13T09:32:07.000Z"),
  transaction_curncy_code: "GBP",
  transaction_amount: NumberDecimal("501.98"),
  reported: true
}
// OUTPUT  (a record in the results of the executed aggregation)
{
  card_name: "Mrs. Jane A. Doe",
  card_num: "1234567890123456",
  card_expiry: ISODate("2023-08-31T23:59:59.736Z"), // Field type converted from text
  card_sec_code: "123",
  card_provider_name: "Credit MasterCard Gold",
  transaction_id: "eb1bd77836e8713656d9bf2debba8900",
  transaction_date: ISODate("2021-01-13T09:32:07.000Z"),
  transaction_curncy_code: "GBP",
  transaction_amount: NumberDecimal("501.98"),
  reported: true,
  card_type: "CREDIT"                               // New added literal value field
}
// BAD
[
  {"$project": {
    // Modify a field + add a new field
    "card_expiry": {"$dateFromString": {"dateString": "$card_expiry"}},
    "card_type": "CREDIT",        

    // Must now name all the other fields for those fields to be retained
    "card_name": 1,
    "card_num": 1,
    "card_sec_code": 1,
    "card_provider_name": 1,
    "transaction_id": 1,
    "transaction_date": 1,
    "transaction_curncy_code": 1,
    "transaction_amount": 1,
    "reported": 1,                
    
    // Remove _id field
    "_id": 0,
  }},
]
// GOOD
[
  {"$set": {
    // Modified + new field
    "card_expiry": {"$dateFromString": {"dateString": "$card_expiry"}},
    "card_type": "CREDIT",        
  }},
  
  {"$unset": [
    // Remove _id field
    "_id",
  ]},
]

复制代码

何时使用$AddFields

AddFields是在3.4才增加的新功能,主要想在AddFields 是在3.4 才增加的新功能,主要想在Porject的基础上能增加数据的修改能力,它和$set 有很多相似的能力,但是它只能增加一个新多字段,不能用来修改,在一般的情况下面我们不推荐使用,这可能是Mongo的一个过段期的产物。

在了解了PipeLine 之后,以及PipeLine 中的Stage的执行顺序,我们如何具体的写一个Stage呢?其中Expression就是它的核心。

Expression 是什么?

Expression是Aggrgate Pipeline Stage的核心能力,在开发过程中我们一般都是查看Mongo官方文档,找对应的例子,然后复制过来改改,缺乏深度的思考,但是如果你想熟练使用Aggregate Expression 的话,是需要深度理解Expression。

Aggregate Expression 主要包含3个方面:

  1. 操作符-Operator,以为前缀,访问一个Objectkey,例如:为前缀,访问一个Object的key,例如:arrayElementAt , cond,cond, dateToString
  2. Field Path,访问一个对象的嵌入路径以为前缀,例如:为前缀,例如:account.sortcode ,$addresses.address.city
  3. 变量,访问的时候以$$作为前缀

3.1 系统的变量,主要是来源于系统的环境而不是具体的某条操作数据记录,例如:"NOW", "NOW", "CLUSTER_TIME"

3.2 标记系统变量,主要是对数据处理的值进行标记,在重新传递给下一个Stage时候的数据行为,例如:"ROOT", "ROOT", "REMOVE", "$$PRUNE"

3.3 用户变量,主要是存储用户自定义的变量,通过let定义的变量,以及在let定义的变量 ,以及在Lookup ,$Map ,中间定义的临时变量

你可以很方便的通过组合这3种不同分类的变量来处理各种逻辑,计算数据,例如:

"customer_info": {"$cond": {
                    "if":   {"$eq": ["$customer_info.category", "SENSITIVE"]}, 
                    "then": "$$REMOVE",     
                    "else": "$customer_info",
                 }}

复制代码

Expression返回值是什么?

表达式的返回值是Json / Bson 的数据类型

  • a Number  (including integer, long, float, double, decimal128)
  • a String  (UTF-8)
  • a Boolean
  • a DateTime  (UTC)
  • an Array
  • an Object

一个特定的表达式能返回指定的几种数据类型,例如

  • contact返回值类型是stringnull,contact 返回值类型是 string | null , ROOT 仅仅能返回在Pipeline Stage中涉及的root 文档
  • 对于Field Path 来说,它的返回值类型就不同了,主要是依赖你输入的文档是什么数据结构,如果Address 是一个对象,那返回值就是Object ,如果是String 那返回值就是String,总之来说,对于Field Path,或者用户自定义的变量,它的返回值类型是取决于运行环境的上下文,这点非常关键,这点和Javascript 非常类似,它是一种弱的约束。
  • 对于Operator的Expression ,它可以接受其它的Operator Expression返回值作为输入参数,这也是函数式编程的重要体现。
{"$dayOfWeek": ISODate("2021-04-24T00:00:00Z")}
{"$dayOfWeek": "$person_details.data_of_birth"}
{"$dayOfWeek": "$$NOW"}
{"$dayOfWeek": {"$dateFromParts": {"year" : 2021, "month" : 4, "day": 24}}} **
复制代码

其中 limitlimit,skip,sortsort,count,$out Stage不能使用表达式。

并且需要特别注意在 Match中使用Match 中使用expr可能会有命中不了索引的问题,这个具体要看指定的Operator , 以及你使用的Mongo的版本,如下是在match使用match使用expr:

[
  { _id: 1, width: 2, height: 8 },
  { _id: 2, width: 3, height: 4 },
  { _id: 3, width: 20, height: 1 }
]
var pipeline = [
  {"$match": {
    "$expr": {"$gt": [{"$multiply": ["$width", "$height"]}, 12]},
  }},      
];

复制代码

Expression 处理数组的高级技巧

对于MongoDB来说,内嵌数组本身就是它的核心能力,它不同于关系型的数据库,它的特征就是把整个原始数据作为一个文档来处理,这更加符合真实世界的数据描述,这样一个存储了太多数据类型的Document,对于开发人员来说如何获取到自己想要的数据就非常重要,Agrregate 提供了Expression来对Array进行操作,增强这种能力,在处理数组元素中,我们更重要的是思维模式的转变,由原来的过程式思维模式转变为函数式的思维模式来思考问题,这样才能理解和处理复杂的业务需求,也更符合Mongo Aggreage的思维逻辑。

"IF- ELSE" 条件表达式

let order = {"product" : "WizzyWidget", "price": 25.99, "qty": 8};

// Procedural style JavaScript
if (order.qty > 5) {
  order.cost = order.price * order.qty * 0.9;
} else {
  order.cost = order.price * order.qty;
}

db.customer_orders.insertOne(order);
// Aggregate 
var pipeline = [
  {"$set": {
    "cost": {
      "$cond": { 
        "if":   {"$gte": ["$qty", 5 ]}, 
        "then": {"$multiply": ["$price", "$qty", 0.9]},
        "else": {"$multiply": ["$price", "$qty"]},
      }    
    },
  }},
];

db.customer_orders.aggregate(pipeline);

// Functional style JavaScript
order.cost = (
              (order.qty > 5) ?
              (order.price * order.qty * 0.9) :
              (order.price * order.qty)
             );

// output
{product: 'WizzyWidget', qty: 8, price: 25.99, cost: 187.128}

复制代码

"FOR-EACH" 循环访问数组中的每个元素

let order = {
  "orderId": "AB12345",
  "products": ["Laptop", "Kettle", "Phone", "Microwave"]
};
 
// Procedural style JavaScript
for (let pos in order.products) {
  order.products[pos] = order.products[pos].toUpperCase();
}

db.orders.insertOne(order);
// Aggregate
var pipeline = [
  {"$set": {
    "products": {
      "$map": {
        "input": "$products",
        "as": "product",
        "in": {"$toUpper": "$$product"}
      }
    }
  }}
];

db.orders.aggregate(pipeline);

// Functional style JavaScript
order.products = order.products.map(
  product => {
    return product.toUpperCase(); 
  }
);

// Output 
{orderId: 'AB12345', products: ['LAPTOP', 'KETTLE', 'PHONE', 'MICROWAVE']}

复制代码

"FOR-EACH" 计算数组中元素累加之后的值

let order = {
  "orderId": "AB12345",
  "products": ["Laptop", "Kettle", "Phone", "Microwave"]
};
 
order.productList = "";
// Procedural style JavaScript
for (const pos in order.products) {
  order.productList += order.products[pos] + "; ";
}
db.orders.insertOne(order);

// Aggregate 
var pipeline = [
  {"$set": {
    "productList": {
      "$reduce": {
        "input": "$products",
        "initialValue": "",
        "in": {
          "$concat": ["$$value", "$$this", "; "]
        }            
      }
    }
  }}
];

db.orders.aggregate(pipeline);

// Functional style JavaScript
order.productList = order.products.reduce(
  (previousValue, currentValue) => {
    return previousValue + currentValue + "; ";
  },
  ""
);

// output
{
  orderId: 'AB12345',
  products: [ 'Laptop', 'Kettle', 'Phone', 'Microwave' ],
  productList: 'Laptop; Kettle; Phone; Microwave; '
}

复制代码

“FOR-EACH” ,循环访问数组,找到具体的元素所在数组中的位置

// 找出room_sizes 数组中第一个面积大于60M 的元素所在的数组中的顺序
db.buildings.insertOne({
  "building": "WestAnnex-1",
  "room_sizes": [
    {"width": 9, "length": 5},
    {"width": 8, "length": 7},
    {"width": 7, "length": 9},
    {"width": 9, "length": 8},
  ]
});

// Aggregate
var pipeline = [
  {"$set": {
    "firstLargeEnoughRoomArrayIndex": {
      "$reduce": {
        "input": {"$range": [0, {"$size": "$room_sizes"}]},
        "initialValue": -1,
        "in": {
          "$cond": { 
            "if": {
              "$and": [
                // IF ALREADY FOUND DON'T CONSIDER SUBSEQUENT ELEMENTS
                {"$lt": ["$$value", 0]}, 
                // IF WIDTH x LENGTH > 60
                {"$gt": [
                  {"$multiply": [
                    {"$getField": {"input": {"$arrayElemAt": ["$room_sizes", "$$this"]}, "field": "width"}},
                    {"$getField": {"input": {"$arrayElemAt": ["$room_sizes", "$$this"]}, "field": "length"}},
                  ]},
                  60
                ]}
              ]
            }, 
            // IF ROOM SIZE IS BIG ENOUGH CAPTURE ITS ARRAY POSITION
            "then": "$$this",  
            // IF ROOM SIZE NOT BIG ENOUGH RETAIN EXISTING VALUE (-1)
            "else": "$$value"  
          }            
        }            
      }
    }
  }}
];

db.buildings.aggregate(pipeline);

// output 
{
  building: 'WestAnnex-1',
  room_sizes: [
    { width: 9, length: 5 },
    { width: 8, length: 7 },
    { width: 7, length: 9 },
    { width: 9, length: 8 }
  ],
  firstLargeEnoughRoomArrayIndex: 2
}
// summary 
1. 找到元素之后不会中断,如果是大数组,可能会有性能上面的损失

复制代码

mapmap 和 reduce 差异

// sourc data
db.deviceReadings.insertOne({
  "device": "A1",
  "readings": [27, 282, 38, 22, 187]
});

// output
{
  device: 'A1',
  readings: [ 27, 282, 38, 22, 187 ],
  deviceReadings: [ 'A1:27', 'A1:282', 'A1:38', 'A1:22', 'A1:187' ]
}

// $map
var pipeline = [
  {"$set": {
    "deviceReadings": {
      "$map": {
        "input": "$readings",
        "as": "reading",
        "in": {
          "$concat": ["$device", ":", {"$toString": "$$reading"}]
        }
      }
    }
  }}
];
db.deviceReadings.aggregate(pipeline);

// $reduce
var pipeline = [
  {"$set": {
    "deviceReadings": {
      "$reduce": {
        "input": "$readings",
        "initialValue": [],
        "in": {
          "$concatArrays": [
            "$$value",
            [{"$concat": ["$device", ":", {"$toString": "$$this"}]}]
          ]
        }
      }
    }
  }}
];

db.deviceReadings.aggregate(pipeline);
// output 
{
  device: 'A1',
  readings: [ 27, 282, 38, 22, 187 ],
  deviceReadings: [ 'A1-0:27', 'A1-1:282', 'A1-2:38', 'A1-3:22', 'A1-4:187' ]
}

// $reduce 
var pipeline = [
  {"$set": {
    "deviceReadings": {
      "$reduce": {
        "input": {"$range": [0, {"$size": "$readings"}]},
        "initialValue": [],
        "in": {
          "$concatArrays": [
            "$$value",
            [{"$concat": [
              "$device",
              "-",
              {"$toString": "$$this"},
              ":",
              {"$toString": {"$arrayElemAt": ["$readings", "$$this"]}},
            ]}]
          ]
        }
      }
    }
  }}
];

db.deviceReadings.aggregate(pipeline);

复制代码

$map 给数组中的每个对象增加一个新的字段

db.orders.insertOne({
    "custid": "jdoe@acme.com",
    "items": [
      {
        "product" : "WizzyWidget", 
        "unitPrice": 25.99,
        "qty": 8,
      },
      {
        "product" : "HighEndGizmo", 
        "unitPrice": 33.24,
        "qty": 3,
      }
    ]
});

// aggregate
var pipeline = [
  {"$set": {
    "items": {
      "$map": {
        "input": "$items",
        "as": "item",
        "in": {
          "product": "$$item.product",
          "unitPrice": "$$item.unitPrice",
          "qty": "$$item.qty",
          "cost": {"$multiply": ["$$item.unitPrice", "$$item.qty"]}},
        }
      }
    }
  }
];

db.orders.aggregate(pipeline);
// output
{
  custid: 'jdoe@acme.com',
  items: [
    {
      product: 'WizzyWidget',
      unitPrice: 25.99,
      qty: 8,
      cost: 187.128
    },
    {
      product: 'HighEndGizmo',
      unitPrice: 33.24,
      qty: 3,
      cost: 99.72
    }
  ]
}
// 缺点和$project 类似,需要你指定输出的字段,如果字段特别多就会特别的繁琐
// 改进的方式
var pipeline = [
  {"$set": {
    "items": {
      "$map": {
        "input": "$items",
        "as": "item",
        "in": {
          "$mergeObjects": [
            "$$item",            
            {"cost": {"$multiply": ["$$item.unitPrice", "$$item.qty"]}},
          ]
        }
      }
    }
  }}
];

db.orders.aggregate(pipeline);
// 等同的其它写法
var pipeline = [
  {"$set": {
    "items": {
      "$map": {
        "input": "$items",
        "as": "item",
        "in": {
          "$arrayToObject": {
            "$concatArrays": [
              {"$objectToArray": "$$item"},            
              [{
                "k": "cost",
                "v": {"$multiply": ["$$item.unitPrice", "$$item.qty"]},
              }]              
            ]
          }
        }
      }
    }}
  }
];

db.orders.aggregate(pipeline);

// 动态组合字段
var pipeline = [
  {"$set": {
    "items": {
      "$map": {
        "input": "$items",
        "as": "item",
        "in": {
          "$arrayToObject": {
            "$concatArrays": [
              {"$objectToArray": "$$item"},            
              [{
                "k": {"$concat": ["costFor", "$$item.product"]},
                "v": {"$multiply": ["$$item.unitPrice", "$$item.qty"]},
              }]              
            ]
          }
        }
      }
    }}
  }
];

db.orders.aggregate(pipeline);

// output
{
  custid: 'jdoe@acme.com',
  items: [
    {
      product: 'WizzyWidget',
      unitPrice: 25.99,
      qty: 8,
      costForWizzyWidget: 207.92
    },
    {
      product: 'HighEndGizmo',
      unitPrice: 33.24,
      qty: 3,
      costForHighEndGizmo: 99.72
    }
  ]
}

复制代码

reflection 返回每个元素的数据类型,并分组

db.customers.insertMany([
  {
    "_id": ObjectId('6064381b7aa89666258201fd'),
    "email": 'elsie_smith@myemail.com',
    "dateOfBirth": ISODate('1991-05-30T08:35:52.000Z'),
    "accNnumber": 123456,
    "balance": NumberDecimal("9.99"),
    "address": {
      "firstLine": "1 High Street",
      "city": "Newtown",
      "postcode": "NW1 1AB",
    },
    "telNums": ["07664883721", "01027483028"],
    "optedOutOfMarketing": true,
  },
  {
    "_id": ObjectId('734947394bb73732923293ed'),
    "email": 'jon.jones@coolemail.com',
    "dateOfBirth": ISODate('1993-07-11T22:01:47.000Z'),
    "accNnumber": 567890,
    "balance": NumberDecimal("299.22"),
    "telNums": "07836226281",
    "contactPrefernece": "email",
  },
]);

// aggregate
var pipeline = [
  {"$project": {
    "_id": 0,
    "schema": {
      "$map": {
        "input": {"$objectToArray": "$$ROOT"},
        "as": "field",
        "in": {
          "fieldname": "$$field.k",
          "type": {"$type": "$$field.v"},          
        }
      }
    }
  }}
];

db.customers.aggregate(pipeline);

// output
{
  schema: [
    {fieldname: '_id', type: 'objectId'},
    {fieldname: 'email', type: 'string'},
    {fieldname: 'dateOfBirth', type: 'date'},
    {fieldname: 'accNnumber', type: 'int'},
    {fieldname: 'balance', type: 'decimal'},
    {fieldname: 'address', type: 'object'},
    {fieldname: 'telNums', type: 'array'},
    {fieldname: 'optedOutOfMarketing', type: 'bool'}
  ]
},
{
  schema: [
    {fieldname: '_id', type: 'objectId'},
    {fieldname: 'email', type: 'string'},
    {fieldname: 'dateOfBirth', type: 'date'},
    {fieldname: 'accNnumber', type: 'int'},
    {fieldname: 'balance', type: 'decimal'},
    {fieldname: 'telNums', type: 'string'},
    {fieldname: 'contactPrefernece', type: 'string'}
}

// group 
    var pipeline = [
  {"$project": {
    "_id": 0,
    "schema": {
      "$map": {
        "input": {"$objectToArray": "$$ROOT"},
        "as": "field",
        "in": {
          "fieldname": "$$field.k",
          "type": {"$type": "$$field.v"},          
        }
      }
    }
  }},
  
  {"$unwind": "$schema"},

  {"$group": {
    "_id": "$schema.fieldname",
    "types": {"$addToSet": "$schema.type"},
  }},
  
  {"$set": {
    "fieldname": "$_id",
    "_id": "$$REMOVE",
  }},
];

db.customers.aggregate(pipeline);

// output
{fieldname: '_id', types: ['objectId']},
{fieldname: 'address', types: ['object']},
{fieldname: 'email', types: ['string']},
{fieldname: 'telNums', types: ['string', 'array']},
{fieldname: 'contactPrefernece', types: ['string']},
{fieldname: 'accNnumber', types: ['int']},
{fieldname: 'balance', types: ['decimal']},
{fieldname: 'dateOfBirth', types: ['date']},
{fieldname: 'optedOutOfMarketing', types: ['bool']}


复制代码

在我们编写完Aggregate Pipeline之后,紧接着就需要对它做性能测试,这样我们可以通过Explain plan 来对Aggregate Pipeline 做性能分析:

Explain Plans

对于MQL查询语句来说,你可以很方便的通过查询计划来查看执行的过程,查看索引的行为,通过查询计划的反馈来调整定义的查询,和相应的调整数据模型,对于Aggregate Pipeline也是一样的,但是Aggregate Pipeline相对来说是更复杂的,因为它有复杂的业务逻辑,通过分析查询计划,你可以定位性能的瓶颈,MongoDb Aggrgate Runtime有它自己的查询优化的逻辑,但是它首选要保证的是Function Behavior的是正确的,对于一些复杂的逻辑计算,它是没办法知道该如何优化的,正是因为这个缺点,我们才需要通过分析查询计划,来理清楚逻辑,调整对应的性能。

  • 查看执行计划
db.coll.explain().aggregate([{"$match": {"name": "Jo"}}]);

// QueryPlanner verbosity  (default if no verbosity parameter provided)
db.coll.explain("queryPlanner").aggregate(pipeline);

// ExecutionStats verbosity
db.coll.explain("executionStats").aggregate(pipeline);

// AllPlansExecution verbosity 
db.coll.explain("allPlansExecution").aggregate(pipeline);


复制代码
  • 分析查询计划
{
  "customer_id": "elise_smith@myemail.com",
  "orders": [
    {
      "orderdate": ISODate("2020-01-13T09:32:07Z"),
      "product_type": "GARDEN",
      "value": NumberDecimal("99.99")
    },
    {
      "orderdate": ISODate("2020-05-30T08:35:52Z"),
      "product_type": "ELECTRONICS",
      "value": NumberDecimal("231.43")
    }
  ]
}
// pipeline
var pipeline = [
  // Unpack each order from customer orders array as a new separate record
  {"$unwind": {
    "path": "$orders",
  }},
  
  // Match on only one customer
  {"$match": {
    "customer_id": "tonijones@myemail.com",
  }},

  // Sort customer's purchases by most expensive first
  {"$sort" : {
    "orders.value" : -1,
  }},
  
  // Show only the top 3 most expensive purchases
  {"$limit" : 3},

  // Use the order's value as a top level field
  {"$set": {
    "order_value": "$orders.value",
  }},
    
  // Drop the document's id and orders sub-document from the results
  {"$unset" : [
    "_id",
    "orders",
  ]},
];
// output
[
  {
    customer_id: 'tonijones@myemail.com',
    order_value: NumberDecimal("1024.89")
  },
  {
    customer_id: 'tonijones@myemail.com',
    order_value: NumberDecimal("187.99")
  },
  {
    customer_id: 'tonijones@myemail.com',
    order_value: NumberDecimal("4.59")
  }
]
// execute query plan
db.customer_orders.explain("queryPlanner").aggregate(pipeline);

stages: [
  {
    '$cursor': {
      queryPlanner: {
        parsedQuery: { customer_id: { '$eq': 'tonijones@myemail.com' } },
        winningPlan: {
          stage: 'FETCH',
          inputStage: {
            stage: 'IXSCAN',
            keyPattern: { customer_id: 1 },
            indexName: 'customer_id_1',
            direction: 'forward',
            indexBounds: {
              customer_id: [
                '["tonijones@myemail.com", "tonijones@myemail.com"]'
              ]
            }
          }
        },
      }
    }
  },
  
  { '$unwind': { path: '$orders' } },
  
  { '$sort': { sortKey: { 'orders.value': -1 }, limit: 3 } },
  
  { '$set': { order_value: '$orders.value' } },
  
  { '$project': { _id: false, orders: false } }
]

//executionStats
db.customer_orders.explain("executionStats").aggregate(pipeline);
executionStats: {
  nReturned: 1,
  totalKeysExamined: 1,
  totalDocsExamined: 1,
  executionStages: {
    stage: 'FETCH',
    nReturned: 1,
    works: 2,
    advanced: 1,
    docsExamined: 1,
    inputStage: {
      stage: 'IXSCAN',
      nReturned: 1,
      works: 2,
      advanced: 1,
      keyPattern: { customer_id: 1 },
      indexName: 'customer_id_1',
      direction: 'forward',
      indexBounds: {
        customer_id: [
          '["tonijones@myemail.com", "tonijones@myemail.com"]'
        ]
      },
      keysExamined: 1,
    }
  }
}
复制代码

为了进一步的去改善我们的Aggregate Pipeline的性能,我们需要明确的清楚Pipeline的原理:

管道流和阻塞

Mongo Aggregate Runtime 开始执行Pipeline的时候,它通过Aggregate Init Query Cursor来加载第一批的数据,然后交给第一个Stage,第一个Stage处理完直接就交给第二个Stage,以此类推,并且后面Stage是不需要等待前面Stage所有的数据加载完,就会直接交给下个Stage来进行处理,我们称之为Stream处理,然而 Sort,Sort,Group 是阻塞性的,也就是说这2个阶段,必须前面的Stage把符合条件的数据全部加载到内存中,然后才会进行排序或者分组,这个是非常消耗数据库服务器的内存的,如下图:



MongoDB aggregation pipeline streaming Vs blocking stages



$Sort 内存消耗和改进

由于$Sort 是阻塞性质的,所以要求把符合条件的数据全部都要加载到内存中然后才能进行排序,这样如果数据量太大的情况下,会导致数据库内存溢出,并且Pipeline Stage 约束的内存使用是100MB,超过这个就会报错,只能通过设置参数,“allowDiskUse:true”,来突破这个内存的限制,最大化的加载数据,但是随着数据量大增大,它会越来越慢,这种行为在一定程度上是很难避免的,但是有些原则能帮助我们提升性能

  • 使用索引排序

如果Sort不依赖于前面的Sort 不依赖于前面的Unwind,Project,Project ,Group Stage ,我们可以把$Sort 移动到距离第一个Stage最近地方,等于我们加载数据的时候,就按照索引排序的来加载,而不是在内存中计算,指导原则如下:

  • 和Limit同时使用,限制数据量大大小
  • 减少排序的数据量,如果有复杂的查询,并且无法Sort无法命中索引的情况下,尽量把Sort无法命中索引的情况下,尽量把Sort 移动到整个Pipeline的最后Stage来进行排序

$Group 内存消耗和改进

Group其实和Group 其实和Sort 的行为是一样的,因为它们都是阻塞性质的,我们没办法分批来分组,因为分组的场景就是用来统计累计的值,例如求和,求平均值,等等,提高性能,指导原则如下:

  • 避免Unwind,Unwind ,ReGroup 来处理数组的元素
  • $Group 的职责更加的单一,只是处理一些累计值
[
  {
    customer_id: 'elise_smith@myemail.com',
    orderdate: ISODate('2020-05-30T08:35:52.000Z'),
    value: NumberDecimal('9999')
  }
  {
    customer_id: 'elise_smith@myemail.com',
    orderdate: ISODate('2020-01-13T09:32:07.000Z'),
    value: NumberDecimal('10101')
  }
]
// SUBOPTIMAL
var pipeline = [
  {"$set": {
    "value_dollars": {"$multiply": [0.01, "$value"]}, // Converts cents to dollars
  }},
  
  {"$unset": [
    "_id",
    "value",
  ]},         

  {"$match": {
    "value_dollars": {"$gte": 100},  // Peforms a dollar check
  }},    
];

// OPTIMAL

var pipeline = [
  {"$set": {
    "value_dollars": {"$multiply": [0.01, "$value"]},
  }},
  
  {"$match": {                // Moved to before the $unset
    "value": {"$gte": 10000},   // Changed to perform a cents check
  }},    

  {"$unset": [
    "_id",
    "value",
  ]},         
];

//

复制代码

避免Unwind,Unwind ,ReGroup 来处理数组的元素

// source collection 
[
  {
    _id: 1197372932325,
    products: [
      {
        prod_id: 'abc12345',
        name: 'Asus Laptop',
        price: NumberDecimal('429.99')
      }
    ]
  },
  {
    _id: 4433997244387,
    products: [
      {
        prod_id: 'def45678',
        name: 'Karcher Hose Set',
        price: NumberDecimal('23.43')
      },
      {
        prod_id: 'jkl77336',
        name: 'Picky Pencil Sharpener',
        price: NumberDecimal('0.67')
      },
      {
        prod_id: 'xyz11228',
        name: 'Russell Hobbs Chrome Kettle',
        price: NumberDecimal('15.76')
      }
    ]
  }
]

// SUBOPTIMAL
var pipeline = [
  // Unpack each product from the each order's product as a new separate record
  {"$unwind": {
    "path": "$products",
  }},

  // Match only products valued over 15.00
  {"$match": {
    "products.price": {
      "$gt": NumberDecimal("15.00"),
    },
  }},

  // Group by product type
  {"$group": {
    "_id": "$_id",
    "products": {"$push": "$products"},    
  }},
];

// OPTIMAL
var pipeline = [
  // Filter out products valued 15.00 or less
  {"$set": {
    "products": {
      "$filter": {
        "input": "$products",
        "as": "product",
        "cond": {"$gt": ["$$product.price", NumberDecimal("15.00")]},
      }
    },    
  }},
];

// output 
[
  {
    _id: 1197372932325,
    products: [
      {
        prod_id: 'abc12345',
        name: 'Asus Laptop',
        price: NumberDecimal('429.99')
      }
    ]
  },
  {
    _id: 4433997244387,
    products: [
      {
        prod_id: 'def45678',
        name: 'Karcher Hose Set',
        price: NumberDecimal('23.43')
      },
      {
        prod_id: 'xyz11228',
        name: 'Russell Hobbs Chrome Kettle',
        price: NumberDecimal('15.76')
      }
    ]
  }
]


复制代码

在Pipeline的早期使用更多的Filter

探索是否可能使$match全部命中索引

[
  {
    customer_id: 'elise_smith@myemail.com',
    orderdate: ISODate('2020-05-30T08:35:52.000Z'),
    value: NumberDecimal('9999')
  }
  {
    customer_id: 'elise_smith@myemail.com',
    orderdate: ISODate('2020-01-13T09:32:07.000Z'),
    value: NumberDecimal('10101')
  }
]

// SUBOPTIMAL

var pipeline = [
  {"$set": {
    "value_dollars": {"$multiply": [0.01, "$value"]}, // Converts cents to dollars
  }},
  
  {"$unset": [
    "_id",
    "value",
  ]},         

  {"$match": {
    "value_dollars": {"$gte": 100},  // Peforms a dollar check
  }},    
];

// OPTIMAL

var pipeline = [
  {"$set": {
    "value_dollars": {"$multiply": [0.01, "$value"]},
  }},
  
  {"$match": {                // Moved to before the $unset
    "value": {"$gte": 10000},   // Changed to perform a cents check
  }},    

  {"$unset": [
    "_id",
    "value",
  ]},         
];

复制代码

探索是否可能使$match部分命中索引

你所要进行查询的字段,不是数据库的原生字段,这个时候你可能需要而外的增加一个$Match 来匹配原生字段,命中索引来进行数据过滤


[
  {
    date_of_birth: ISODate('2019-05-30T08:35:52.000Z'),
  }
  {
    date_of_birth: ISODate('2019-05-31T08:35:52.000Z'),
  }
  {
    date_of_birth: ISODate('2019-06-01T08:35:52.000Z'),
  }
]

由于出生日期是个敏感字段,我们需要加一个随机数来脱敏,我们需要用masked_date来代替,(0-7)
masked_date > 2019-06-05

// OPTIMAL
var pipeline = [
  // extra $match
  {"$match": {
    "date_of_birth": {"$gt": 2019-05-30 },
  }},
  
  {"$match": {               
    "masked_date": {"$gt": 2019-06-05},   
  }},     
];

复制代码

如果你的Aggregate是依赖计算的中间字段的,这个时候要尽可能的增加额外的$match 来获取尽可能少的数据。

总结

至此,MongoDB Aggregate 相关的内容就介绍完了,对MongoDB Aggregate的原理深入理解,这非常有助于我们处理复杂的业务查询,并保持高的性能,如果大家有不理解的,欢迎在评论区沟通,如果有需要改正的地方,也欢迎大家指出,希望这篇文章可以帮助大家更好的理解MongoDB Aggregate.

最后,推荐我们的智能化研发管理工具 PingCode 给大家。

PingCode官网

关于PingCode

PingCode是由国内老牌SaaS厂商Worktile 打造的智能化研发管理工具,围绕企业研发管理需求推出了Agile(敏捷开发)、Testhub(测试管理)、Wiki(知识库)、Plan(项目集)、Goals(目标管理)、Flow(自动化管理)、Access (目录管理)七大子产品以及应用市场,实现了对项目、任务、需求、缺陷、迭代规划、测试、目标管理等研发管理全流程的覆盖以及代码托管工具、CI/CD流水线、自动化测试等众多主流开发工具的打通。

自正式发布以来,以酷狗音乐、商汤科技、电银信息、51社保、万国数据、金鹰卡通、用友、国汽智控、智齿客服、易快报等知名企业为代表,已经有超过13个行业的众多企业选择PingCode落地研发管理。

分类:
开发工具
标签:
收藏成功!
已添加到「」, 点击更改