View a markdown version of this page

$sinh - Amazon DocumentDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

$sinh

New from version 8.0.1.

The $sinh operator in Amazon DocumentDB returns the hyperbolic sine of a value. Use it in the aggregation pipeline to perform hyperbolic trigonometric calculations on numeric fields.

Parameters

  • expression: An expression that resolves to a number.

The return type is double by default. If the input is a 128-bit decimal, the output is also a 128-bit decimal.

Example (MongoDB Shell)

The following example shows how to use the $sinh operator to calculate the hyperbolic sine of numeric values.

Create sample documents

db.values.insertMany([ { "_id": 1, "value": 0 }, { "_id": 2, "value": 1 }, { "_id": 3, "value": -1 } ]);

Query example

db.values.aggregate([ { $project: { "result": { $sinh: "$value" } }} ]);

Output

[ { "_id": 1, "result": 0 }, { "_id": 2, "result": 1.1752011936438014 }, { "_id": 3, "result": -1.1752011936438014 } ]

Code examples

To view a code example for using the $sinh operator, choose the tab for the language that you want to use:

Node.js
const { MongoClient } = require('mongodb'); async function main() { const client = await MongoClient.connect('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false'); const db = client.db('test'); const collection = db.collection('values'); const result = await collection.aggregate([ { $project: { "result": { $sinh: "$value" } }} ]).toArray(); console.log(result); await client.close(); } main();
Python
from pymongo import MongoClient def main(): client = MongoClient('mongodb://<username>:<password>@<cluster-endpoint>:27017/?tls=true&tlsCAFile=global-bundle.pem&replicaSet=rs0&readPreference=secondaryPreferred&retryWrites=false') db = client['test'] collection = db['values'] result = list(collection.aggregate([ { '$project': { 'result': { '$sinh': '$value' } }} ])) print(result) client.close() if __name__ == "__main__": main()