$mod (agregação)

Definição

$mod

Divide um número por outro e retorna o resto.

Sintaxe

A expressão $mod tem a seguinte sintaxe:

{ $mod: [ <expression1>, <expression2> ] }

O primeiro argumento é o dividendo e o segundo argumento é o divisor. Ou seja, o primeiro argumento é dividido pelo segundo argumento.

Comportamento

Os argumentos podem ser qualquerexpressão válida, desde que produzam números. Para mais informações sobre expressões, consulte Expressões.

A partir da versão 7.2, o tipo de dados de saída do operador $mod é o maior dos dois tipos de dados de entrada.

Nesse caso, o MongoDB converte o divisor para o tipo de dados de dividendo antes de executar a operação mod. O tipo de dados de saída é o tipo de dados de dividendos.

Exemplo

Considere uma collection conferencePlanning com os seguintes documentos:

db.conferencePlanning.insertMany( [
   { "_id" : 1, "city" : "New York", "hours" : 80, "tasks" : 7 },
   { "_id" : 2, "city" : "Singapore", "hours" : 40, "tasks" : 4 }
] )

A agregação a seguir usa a expressão $mod para retornar o restante do campo hours dividido pelo campo tasks:

db.conferencePlanning.aggregate( [
  { $project: { remainder: { $mod: [ "$hours", "$tasks" ] } } }
] )

A operação retorna os seguintes resultados:

[
  { '_id' : 1, 'remainder' : 3 },
  { '_id' : 2, 'remainder' : 0 }
]

db.modExample.insertOne( [
   { "_id" : 1, "dividend": -13, "divisor": 9 }
] )

db.modExample.aggregate( [
  { $project: { remainder: { $mod: [ "$dividend", "$divisor" ] } } }
] )

[ { '_id' : 1, 'remainder' : -4 } ]