MongoDB $ln

No MongoDB, o $ln operador de pipeline de agregação calcula o logaritmo natural (ln ) de um número e retorna o resultado como um double.

Sintaxe

A sintaxe fica assim:

{ $ln: <number> }

Onde <number> pode ser qualquer expressão válida que resolva para um número não negativo.

Exemplo

Suponha que tenhamos uma coleção chamada test com o seguinte documento:

{ "_id" : 1, "data" : 0.5 }
{ "_id" : 2, "data" : 20 }
{ "_id" : 3, "data" : 200 }

Podemos usar o $ln operador para retornar o logaritmo natural dos data campo:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 1, 2, 3 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$data" ] }
        }
    }
  ]
)

Resultado:

{ "data" : 0.5, "result" : -0.6931471805599453 }
{ "data" : 20, "result" : 2.995732273553991 }
{ "data" : 200, "result" : 5.298317366548036 }

Outra maneira de fazer isso seria usar o $log operador com um segundo argumento de Math.E . Veja MongoDB $log Por exemplo.

Logaritmo Natural

O logaritmo natural de um número é seu logaritmo na base da constante matemática e , onde e é um número irracional e transcendental que começa com 2,7182818284590452353602874713527 e continua para sempre.

A constante matemática e também é conhecido como número de Euler.

Em JavaScript, podemos usar Math.E para representar e . Podemos, portanto, obter o logaritmo natural de e usando Math.E como argumento ao usar $ln .

Suponha que temos um documento como este:

{ "_id" : 4, "data" : 2.718281828459045 }

O campo de dados contém e para 15 casas decimais.

Este exemplo usa duas maneiras de retornar o logaritmo natural de e :

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 4 ] } } },
    {
      $project:
        { 
          _id: 0,
          e_1: { $ln: [ "$data" ] },
          e_2: { $ln: [ Math.E ] }
        }
    }
  ]
)

Resultado:

{ "e_1" : 1, "e_2" : 1 }

O primeiro resultado usa os dados do documento. Para o segundo resultado, usamos Math.E para gerar e .

De qualquer forma, o resultado é 1 .

Valores fora do intervalo

Como mencionado, o $ln O operador aceita qualquer expressão válida que resolva para um número não negativo. Valores fora desse intervalo causarão um erro.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 5, "data" : -20 }

Vamos executar o $ln operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 5 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$data" ] }
        }
    }
  ]
)

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$ln's argument must be a positive number, but is -20",
	"code" : 28766,
	"codeName" : "Location28766"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:639:17
example@sqldat.com/mongo/shell/assert.js:729:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1058:12
@(shell):1:1

Tipo de dados incorreto

Fornecer o tipo de dados incorreto também causará um erro.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 6, "data" : "Ten" }

Vamos executar o $ln operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 6 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$data" ] }
        }
    }
  ]
)

Resultado:

uncaught exception: Error: command failed: {
	"ok" : 0,
	"errmsg" : "$ln only supports numeric types, not string",
	"code" : 28765,
	"codeName" : "Location28765"
} : aggregate failed :
example@sqldat.com/mongo/shell/utils.js:25:13
example@sqldat.com/mongo/shell/assert.js:18:14
example@sqldat.com/mongo/shell/assert.js:639:17
example@sqldat.com/mongo/shell/assert.js:729:16
example@sqldat.com/mongo/shell/db.js:266:5
example@sqldat.com/mongo/shell/collection.js:1058:12
@(shell):1:1

Fornecemos uma string e, portanto, a mensagem de erro nos diz que $ln only supports numeric types, not string .

Valores nulos

Valores nulos retornam null ao usar o $ln operador.

Suponha que adicionamos o seguinte documento à nossa coleção:

{ "_id" : 7, "data" : null }

Vamos executar o $ln operador contra esse documento:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 7 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$data" ] }
        }
    }
  ]
)

Resultado:

{ "data" : null, "result" : null }

Podemos ver que o resultado é null .

Valores NaN

Se o argumento for resolvido para NaN , $ln retorna NaN .

Exemplo:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 1 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$data" * 1 ] }
        }
    }
  ]
)

Resultado:

{ "data" : 0.5, "result" : NaN }

Campos inexistentes

Se o $ln operador é aplicado em um campo que não existe, null é devolvido.

Exemplo:

db.test.aggregate(
  [
    { $match: { _id: { $in: [ 1 ] } } },
    {
      $project:
        { 
          _id: 0,
          data: 1,
          result: { $ln: [ "$age" ] }
        }
    }
  ]
)

Resultado:

{ "data" : 0.5, "result" : null }

Neste caso tentamos aplicar $ln em um campo chamado age , mas esse campo não existe no documento e, portanto, obtemos null .