MongoDB（operator）

关于operators

官方参考文档：https://docs.mongodb.org/manual/reference/
下面会对这些operator进行详解，先参考如下分类：

Query and Projection Operators

• Comparison Query Operators 例如：$eq $gt $gte $lt $lte $ne $in $nin
• Logical Query Operators 例如：$or $and $not $nor
• Element Query Operators 例如：$exist $type
• Evaluation Query Operators 例如：$mod $regex $text $where
• Geospatial Query Operators
• Query Operator Array 例如：$all $elemMatch(query) $size
• Bitwise Query Operators 例如：$bitsAllSet $bitsAnySet $bitsAllClear $bitsAnyClear
• Projection Operators 例如：$(projection) $elemMatch(projection) $meta $slice(projection)

Update Operators

• Field Update Operators 例如：$inc $mul $rename $setOnInsert $set $unset $min $max $currentDate
• Array Update Operators 例如：$(update) $addToSet $pop $pullAll $pull $pushAll $push $each $slice $sort $position
• Bitwise Update Operators 例如：$bit
• Isolation Update Operators 例如：$isolated

Aggregation Pipeline Operators

• Pipeline Aggregation Stages 例如：$project $match $redact $limit $skip $unwind $group $sample $sort $geoNear $lookup $out $indexStats
• Boolean Aggregation Operators
• Set Operators (Aggregation)
• Comparison Aggregation Operators
• Arithmetic Aggregation Operators
• String Aggregation Operators
• Text Search Aggregation Operators
• Array Aggregation Operators
• Aggregation Variable Operators
• Aggregation Literal Operators
• Date Aggregation Operators
• Conditional Aggregation Operators
• Group Accumulator Operators

---

Operators详细解释如下：

Query and Projection Operators

• Comparison Query Operators

  • $ne

    功能：用于比较，意义是not equal to，一般用于find或update。
    用法：{field: {$ne: value}}
    例子：db.test.find({ "age": {$ne: 20} })
    例子效果：列出test集合中所有age不等于20的文档
    注：如果field是个数组type，那么value可以是数组中的一个元素，也可以是数组。
    

  • $lt

    功能：用于比较，意义是less than，一般用于find或update。
    用法： {field: {$lt: value} }
    例子：db.test.find( { "number": { $lt: 20 } } )
    例子效果：列出test集合中所有number<20的文档
    注：比较操作符可以搭配组合实习区间筛选。
    

  • $gt

    功能：用于比较，意义是greater than，一般用于find或update。
    用法：{field: {$gt: value} }
    例子：db.test.find( { "age": { $gt: 20 } } )
    例子效果：列出test集合中所有age>20的文档
    注：比较操作符可以搭配组合实习区间筛选。
    

  • $lte

    功能：用于比较，意义是less than or equal to，一般用于find或update。
    用法：{ field: { $lte: value} }
    例子：db.test.find( { "number": { $lte: 20 } } )
    例子效果：列出test集合中所有number<=20的文档
    注：比较操作符可以搭配组合实习区间筛选。
    

  • $gte

    功能：用于比较，意义是greater than or equal to，一般用于find或update。
    用法：{field: {$gte: value} }
    例子：db.test.find( { "age": { $gte: 20 } } )
    例子效果：列出test集合中所有age>=20的文档
    注：比较操作符可以搭配组合实习区间筛选。用于Date格式尤为合适。
    

  • $eq

    功能：用于匹配，意义是equal to，一般用于find或update。
    用法：{ : { $eq:  } }
    例子：db.test.find( { "age": { $eq: 10086 } } )
    例子效果：精确匹配，等同于db.test.find( { "age": 10086 } )
    注：一般不用，可以简写。比较操作符可以搭配组合实习区间筛选。
    

  • $in

    功能：用于匹配，一般用于find或update，匹配一个数组中的任一个。
    用法：{ field: { $in: [, , ...  ] } }
    例子：db.students.find( { "age": { $in: [ 14, 15 ] } } )
    例子效果：列出所有14、15岁的学生。
    注：别看错了，这个数组不是区间，并不等同于$gte搭配$ltq。
    

  • $in

    功能：用于匹配，一般用于find或update，筛出不匹配完全不匹配的文档。
    用法：{ field: { $nin: [ ,  ...  ]} }
    例子：db.students.find( { "age": { $in: [ 17, 18, 19 ] } } )
    例子效果：列出所有非17、18岁、19岁的学生，不允许他们参加高考。
    注：
    

• Logical Query Operators

  • $or

    功能：逻辑或，用于匹配，只要有一个field匹配中的就满足条件，一般用于find或update。
    用法：{ $or: [ {  }, {  }, ...  } ] }
    例子：db.goods.find( { $or: [ { quality: { $gt: 20 } }, { price: 10 } ] } )
    例子效果：挑出那些要么质量好的，要么价格便宜的商品。
    注：每个expression的限制程度应该升序，这样余下的筛选工作才会更快。
    

  • $and

    功能：逻辑与，用于匹配，选中所有field都匹配的文档，一般用于find或update。
    用法：{ $and: [ {  }, {  } , ...  } ] }
    例子：db.goods.find( { $and: [ { price: 2.0 }, { city: "Beijing" } ] } )
    例子效果：列出要在北京能够以2块钱买得到的东西。
    注：每个expression的限制程度应该降序，这样大部分就已经被忽略了。
    

  • $not

    功能：逻辑反，用于匹配，搜到那些不匹配的文档，一般用于find或update。
    用法：{ field: { $not: {  } } }
    例子：db.test.find( { price: { $not: { $gt: 1.99 } } } )
    例子效果：$not和$gt搭配，相当于<=号。价格在1.99以上的被选中。
    注：不能与$regex搭配使用，而是用/xxx/来使用正则，如find( { item: { $not: /^p.*/ } } )。
    

  • $nor

    功能：选中那些全部expression都不匹配的文档。
    用法：{ $nor: [ {  }, {  }, ...  ] }
    例子：db.people.find( { $nor: [ { body: "fat" }, { hair: "black" } ] } )
    例子效果：选一些古惑仔去打架，黑头发和太胖的就不行啦。
    注：只要文档匹配到任意一个，都不会被选中。
    

• Element Query Operators

  • $exist

    功能：过滤掉指定field是存在or不存在的文档。
    用法：{ field: { $exists:  } }
    例子：db.inventory.find( { "num": { $exists: true } } )
    例子效果：只查询具有num域的文档，包括该域为null的文档。
    注：true为必须存在字段，false在必须不存在。
    

  • $type

    功能：类型匹配，查询时可指定搜索域的类型，可避免乱七八糟的类型。
    用法：{ field: { $type:  |  } }
    例子1：db.addressBook.find( { "zipCode" : { $type : 1 } } )
    例子2：db.addressBook.find( { "zipCode" : { $type : "double" } } )
    例子效果：都是只考虑那些zipCode类型为double的文档。
    注：关于array类型有些注意点。number类型可以通指。
    

• Evaluation Query Operators

  • $mod

    功能：取模操作，并指定取模结果来返回文档，一般用于find。
    用法：{ field: { $mod: [ divisor, remainder ] } }
    例子：db.test.find( { number: { $mod: [ 4, 0 ] } } )
    例子效果：选中number域中的值除以4余0的文档。
    注：
    

  • $regex

    功能：使用正则表达式进行匹配，3种使用方式有各自的限制。
    用法1：{ : { $regex: /pattern/, $options: '' } }
    用法2：{ : { $regex: 'pattern', $options: '' } }
    用法3：{ : { $regex: /pattern/ } }
    例子：
    例子效果：
    注：的参数很多，比如 i m x s 。
    

  • $text

    功能：指定要匹配的是字符串，提供匹配的高级操作。
    用法：
    { 
      $text: { 
        $search: , 
        $language: , 
        $caseSensitive: , 
        $diacriticSensitive:  
      }
    }
    注：字符串匹配操作比较复杂，参考官网。
    

  • $where

    功能：指定同个文档内的两个field进行比较，以进行特殊的筛选。
    用法1：db.myCollection.find( { $where: "this.credits == this.debits" } )  省略function写法。
    用法2：db.myCollection.find( { $where: function() { return (this.credits == this.debits) } }   
    用法3：db.myCollection.find( "this.credits == this.debits || this.credits > this.debits" )  当筛选条件仅有一个$where表达式时。
    用法4：db.myCollection.find( function() { return (this.credits == this.debits || this.credits > this.debits ) } )  当筛选条件仅有一个$where表达式时。
    注：若返回true则选中该文档。
    

• Geospatial Query Operators

  • 二维相关的查询，暂时略。

• Query Operator Array

  • $all

    功能：用于数组匹配，可以指定数组中必须包含的元素。
    用法：{ : { $all: [  ,  ... ] } }
    例子：{ "money": { $all: [ 5 , 2 , 1 ] } }
    例子效果：想找10块钱零钱，找同时有散钱1、2、5的人。
    注：指定的value并没有先后顺序，只检测包含性，所以有多个也没有关系。
    

  • $elemMatch(query)

    功能：匹配内嵌文档或数组中的部分field。
    用法：{ : { $elemMatch: { , , ... } } }
    例子：db.scores.find( { results: { $elemMatch: { $gte: 80, $lt: 85 } } })
    例子效果：对于那些results数组中具有区间[80,85)元素的文档选中。
    注：
    

  • $size

    功能：指定数组的大小。
    用法：db.collection.find( { : { $size:  } } );
    例子：db.people.find( { "card": { $size: 5 } } );
    例子效果：集齐全5张卡片才能兑换礼品。
    注：不能与$gt等比较操作符搭配。具体见官网。
    

• Bitwise Query Operators
• Projection Operators
  • $（projection）

    功能：对array取下标。
    用法：db.collection.find( { :  ...}, { ".$": 1 } )
    例子：db.students.find( { grades: { $gte: 85 } }, { "grades.$": 1 } )
    例子效果：将选中文档中首个大于等于85的数返回。
    注：不能暴力使用多个array，提倡用$eleMatch。
    

  • $elemMatch（projection）

    功能：用于数组中的元素匹配，可用于find的第2个参数。
    用法：
    例子：db.schools.find( { zipcode: "63109" }, { students: { $elemMatch: { school: 102, age: { $gt: 10} } } } )
    例子效果：第2个参数是决定要返回的field的。
    注：看官网吧。
    

  • $meta

    功能：取出$text匹配的文档分数，看text了解score的概念就懂了。
    用法：{ $meta:  }
    例子：db.collection.find( {$text: { $search: "coffee bake" } }, { score: { $meta: "textScore" } })
    例子效果：cofee bake两个单词的匹配工作会使得每个文档得到一个分数，$meta调出这个分数。
    注：要配合$text来使用，仅用于字符串搜索。
    

  • $slice（projection）

    功能：在查询中将数组进行切片。
    用法：{ : {$slice:  } }
    例子：db.posts.find( {_id:1}, { comments: { $slice: [23, 5] } } )
    例子效果：显示id=1的整个文档，但其中comments数组仅显示从第24开始的5个元素。
    注：有多种方式：表前n个、<-n>表后n个、<[begin, n]>从下标begin开始的n个、<[-begin, n]>忽略掉后begin个再取后n个。
    

Update Operators

一个field可以有多个查询条件限制，但不能够对应多个修改器。如下都是修改器。

• Field Update Operators

  • $inc

    功能：将文档中的某个field对应的value自增/减某个数字amount，是原子操作。
    用法：{ $inc: { : , : , ... } }
    例子：db.products.update( { _id: 1 }, { $inc: { quantity: -2} })
    例子效果：将id=1的文档的quanty项自减2。
    注：只允许操作数字型field（如浮点，整型），否则报错。若不存在field，则创建并初始化为0后再操作。
    

  • $mul

    功能：将文档内的指定域作乘法，是原子操作。
    用法：{ $mul: { field:  } }
    例子：db.products.update( { _id: 1 }, { $mul: { price: 1.25 } })
    例子效果：将_id=1的文档中的price域的值乘以1.25。
    注：若没有指定的field，将创建一个再赋值为0值。会涉及数值类型转化。
    

  • $rename

    功能：更改已存在的文档的指定field名称。
    用法：{$rename: { : , : , ... } }
    例子：db.students.update( { _id: 1 }, { $rename: { 'cell': 'mobile' } } )
    例子效果：将cell域名改成了mobile。
    注：其实使用了$unset和$set。
    

  • $setOnInsert

    功能：配合upsert操作，在作为insert时可以为新文档扩展更多的field。
    用法：db.collection.update( , { $setOnInsert: { : , ... } }, { upsert: true })
    例子：db.products.update( { _id: 1 }, { $set: { item: "apple" }, $setOnInsert: { money: 100 } }, { upsert: true })
    例子效果：若_id=1的文档存在，仅改item，否则插入由item域和$setOnInsert所指定的域组成的文档。
    注：
    

  • $set

    功能：文档中value的替换，一般用于update。
    用法：{ $set: { : , ... } }
    例子：db.stuff.update( { _id: 100 }, { $set: { "job": "worker"} })
    例子效果：将id=100的文档的"job"项修改为worker。
    注：若field不存在，则创建。若field中包含dot，则会创建一个内嵌文档再填充。
    

  • $unset

    功能：删除文档中的某个项，同样可删内嵌型。
    用法：{ $unset: { : "", ... } }
    例子：db.products.update( { _id: 1 }, { $unset: { quantity: "", instock: "" } })
    例子效果：删除掉了id=1的文档的两个key。
    注：若文档中不存在field项，则不操作。
    

  • $min

    功能：更新一个field要么为指定的值，要么是不变，取决于其中的小者。
    用法：{ $min: { : , ... } }
    例子：db.scores.update( { _id: 1 }, { $min: { lowScore: 150 } } )
    例子效果：假设_id=1的文档中的lowScore的值为200,那么它立刻被更新为150。
    注：保证指定field的值小于等于我指定的值。
    

  • $max

    功能：与$min相反。
    注：
    

  • $currentDate

    功能： 设置指定field值为当前的时间。
    用法：{ $currentDate: { : , ... } }
    例子：db.users.update( { _id: 1 }, { $currentDate: { "lastLogin": { $type: "timestamp" } } })
    例子效果：直接修改了lastLogin为当前时间戳。
    注：日期可以是Date()也可以是timestamp。
    

• Array Update Operators

  • $（update）

    功能：定位符'$'，可获取元素在array中的下标（从0开始），一般用于update。
    用法：{ ".$" : value }
    例子：db.students.update( { _id: 1, grades: 80 }, { $set: { "grades.$" : 82 } })
    例子效果：将id=1的文档中的grades数组中的元素80搜出来，获取其在数组中的下标，以此为索引来更新元素为82。
    注：使用在其他地方有诸多限制，参考官方文档。
    

  • $addToSet

    功能：用于更新，添加一个value到一个array中，一般用于update第2个参数。
    用法：{ $addToSet: {: , ...} }
    例子：db.test.update( { "age":  20}, {$addToSet: { "email": "[email protected]" }} )
    例子效果：将新邮箱插入到test集合中的所有age=20的文档中的email数组中的末尾。
    注：field只可以是array类型。在update时，若field不存在，则创建，若value已存在，则不操作。
       需要注意的是同时插入多个value于同一array的情况，要么每次都写field域，要么使用$each。
    

  • $pop

    功能：删除array的首元素或尾元素，一般用于update。
    用法：{ $pop: { : <-1 | 1>, ... } }
    例子：db.students.update( { _id: 1 }, { $pop: { scores: -1 } } )
    例子效果：删除id=1的文档中scores数组的首元素。
    注：-1和1分别表示首、尾的意思。
    

  • $pullAll

    功能：pull的加强版，可以一次性保证多个元素不在数组中。
    用法：{ $pullAll: { : [ ,  ... ], ... } }
    例子：db.survey.update( { _id: 1 }, { $pullAll: { scores: [ 0, 5 ] } } )
    例子效果：保证了指定文档中scores数组不包含0和5。
    注：可以充当pull使用，也可以搭配使用。
    

  • $pull

    功能：删除满足条件的数组元素。
    用法：{ $pull: { : , : , ... } }
    例子：db.stores.update( { }, { $pull: {vegetables: "carrots" } })
    例子效果：保证stores集合中所有文档中的vegetables数组不含单词"carrots"。
    注：所有条件都匹配中了就删除。而欲删除array中的集合，则需指定完全匹配的集合。condition可以指定条件。
    

  • $pushAll

    功能：$push的加强版，可往一个数字中塞更多的元素。
    用法：{ $pushAll: { : [ , , ... ] } }
    例子：同$pullAll
    注：指定单个value时就变成push了。
    

  • $push

    功能：往array中暴力添加元素，用于update。
    用法：{ $push: { : , ... } }
    例子：db.students.update( { _id: 1 }, { $push: { scores: 89 } })
    例子效果：在students集合中的id=1的文档中的scores数组中添加数字89。
    注：如果不存在field，则创建。可以搭配 $each $sort $slice 等等来使用。注意大量push时的效率。
    

  • $each

    功能：保证数组中必定存在某些元素，搭配$addToSet或$push使用。
    用法1：{ $addToSet: { : { $each: [ ,  ... ] } } }
    例子1：db.test.update( { _id: 2 }, { $addToSet: { tags: { $each: [ "camera", "electronics", "accessories" ] } } } )
    例子1效果：在test集合中的id=2的文档的key=tags的value中添加3个单词。
    用法2：{ $push: { : { $each: [ ,  ... ] } } }
    例子2：db.students.update( { name: "joe" }, { $push: { scores: { $each: [ 90, 92, 85 ] } } })
    例子2效果：在students集合中的name="joe"的所有文档都添加3个数字进scores数组。
    注：若存在，则不插入，否则插入进数组。
    

  • $slice

    功能：配合$each在$push之后，对扩充的数组进行切片。
    用法：{ $push: { : { $each: [ , , ... ], $slice:  } }}
    例子：db.students.update( { _id: 1 }, { $push: { scores: { $each: [ 80, 78, 86 ], $slice: -5 } } })
    例子效果：往scores插入了3个数字后，只留下数组中的后5个元素，其他删除。
    注：作用比较特殊，可以用来保证数组中至少有多少个元素？
    

  • $sort

    功能：配合$each在$push中使用，在push一些元素进数组之后可以对数组进行排序。
    用法：{ $push: { : { $each: [ , , ... ], $sort:  } }}
    例子：db.students.update( { _id: 1 }, { $push: { quizzes: { $each: [ { id: 3, score: 8 }, { id: 4, score: 7 }, { id: 5, score: 6 } ], $sort: { score: 1 } } } })
    例子效果：数组中插入了3个文档，再按照score进行排序。
    注：作为push的修改器。
    

  • $position

    功能：配合$each在$push中使用，指定push一些元素到数组中的位置。
    用法：{ $push: { : { $each: [ , , ... ], $position:  } }}
    例子：db.students.update( { _id: 1 }, { $push: { scores: { $each: [ 50, 60, 70 ], $position: 0 } } })
    例子效果：往数组scores的最前端插入3个元素。
    注：
    

• Bitwise Update Operators

  • $bit

    功能：
    用法：{ $bit: { : { :  } } }
    例子：db.switches.update( { _id: 1 }, { $bit: { expdata: { and: NumberInt(10) } } })
    例子效果：对expdata域的值作按位与操作。
    注：操作数只能是32位或64位整数。而mongo shell中的数字都是double型的，注意转。
    

• Isolation Update Operators

  • $isolated

    功能：对多文档的write操作保持一致性，杜绝无处理一半的情况出现。
    用法：{  , $isolated : 1 }
    例子：db.foo.update( { status : "A" , $isolated : 1 }, { $inc : { count : 1 } }, { multi: true })
    例子效果：修改多个选中的文档，在修改完成之前其他的client看不到任何变化。
    注：不能用于shard cluster。会使得WiredTiger变成单线程，影响并发性。不提供all-or-nothing。
    

Aggregation Pipeline Operators

• Pipeline Aggregation Stages

  • $project

    功能：
    用法：{ $project: {  } }
    例子：
    例子效果：
    注：id域是默认输出的，指定不存在的field会被忽略。
    

  • $match $redact $limit $skip $unwind $group $sample $sort $geoNear $lookup $out $indexStats 这些还未整理。

---