Maths APIs
Mathematical functions perform standard calculations on the data. Users may perform these calculations on the client-side. However, if more than two clients are performing mathematical operations on the data at the same time, it may lead to data loss or errors. To prevent this scenario, Hypi Maths APIs are designed.
Let’s perform mathematical operations on the price field in the data type Book. Price is a float value. Mathematical APIs work only on floats and integers, i.e., numerical values.
type Book {
authorid: Int
title: String
price: Float
}
Mathematical operations can only be performed on an existing object. The precedence of the mathematical operations follows BODMAS. So, if all fields are specified the precedence is:
- Division
- Multiplication
- Addition
- Subtraction
Let’s perform a mathematical operation as shown in the below code. We are carrying out the operations on hypi id - Author2Book1 generated during Aggregate APIs example.
- GraphQL Query
- Response
mutation {
math (
values: {
Book: [
{
price: {
hypi: { id: "Author2Book1" }
div: 3
times: 10
minus: 2
plus: 30
}
}
]
}
)
{
id
}
}
{
"data": {
"math": [
{
"id": "Author2Book1"
}
]
}
}
In above example, we are using all the mathematical operators available in the APIs. Notice that the query uses an array (the square brackets) so you can perform math operations on multiple objects (and even multiple types) in one request.
The order of execution is as follows:
- value = 5.99 (the price of the book with id Author2Book1)
- 5.99 / 3 = 1.996666666666667
- 1.996666666666667 * 10 = 19.96666666666667
- 19.96666666666667 - 2 = 17.96666666666667
- 17.96666666666667 + 30 = 47.96666666666667
Now, query the price value of the book that was originally set to 5.99. Its value has changed to 47.96666666666667.
- GraphQL Query
- Response
{
find(type: Book, arcql: "hypi.id = 'Author2Book1'") {
edges {
node {
... on Book {
price
}
}
cursor
}
}
}
{
"data": {
"find": {
"edges": [
{
"node": {
"price": 47.96666666666667 },
"cursor": "Author2Book1"
}
]
}
}
}