A sort is a condition used to order the entries returned from a database query.A database query can be sorted by a property and/or timestamp and in a given direction. For example, a library database can be sorted by the "Name of a book" (i.e. property) and in ascending
(i.e. direction).Here is an example of a sort on a database property.Sorting by "Name" property in ascending direction{
"sorts": [
{
"property": "Name",
"direction": "ascending"
}
]
}
Database queries can also be sorted by two or more properties, which is formally called a nested sort. The sort object listed first in the nested sort list takes precedence.Here is an example of a nested sort.{
"sorts": [
{
"property": "Food group",
"direction": "descending"
},
{
"property": "Name",
"direction": "ascending"
}
]
}
In this example, the database query will first be sorted by "Food group" and the set with the same food group is then sorted by "Name".Sort object#
Property value sort#
This sort orders the database query by a particular property.The sort object must contain the following properties:Property | Type | Description | Example value |
---|
property | string | The name of the property to sort against. | "Ingredients" |
direction | string (enum) | The direction to sort. Possible values include "ascending" and "descending" . | "descending" |
Entry timestamp sort#
This sort orders the database query by the timestamp associated with a database entry.The sort object must contain the following properties:Property | Type | Description | Example value |
---|
timestamp | string (enum) | The name of the timestamp to sort against. Possible values include "created_time" and "last_edited_time" . | "last_edited_time" |
direction | string (enum) | The direction to sort. Possible values include "ascending" and "descending" . | "descending" |
Modified at 2023-04-28 08:37:15