Adds a sort to a query, sorting by the specified properties in ascending order.
The ascending()
function refines a ItemsQueryBuilder
to sort by the value of propertyName
in ascending order.
You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. ascending()
sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so
'abc'
comes after'XYZ'
. If a property contains a number stored as a string (for example,'0'
), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
function ascending(propertyNames: Array<string>): ItemsQueryBuilder
Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
Adds a sort to a query, sorting by the specified properties in descending order.
The descending()
function refines a ItemsQueryBuilder
to sort by the value of propertyName
in descending order.
You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. descending()
sorts the results in the order the properties are passed.
You can sort the following types:
- Number: Sorts numerically.
- Date: Sorts by date and time.
- String: Sorts lexicographically, so
'abc'
comes after'XYZ'
. If a property contains a number stored as a string (for example,'0'
), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
function descending(propertyNames: Array<string>): ItemsQueryBuilder
Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
Refines a query to match items where the specified property equals the specified value.
The eq()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
equals the specified value
.
eq()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
Matching strings with eq()
is case-sensitive, so 'text'
isn't equal to 'Text'
.
function eq(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Returns the query results.
The find()
function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if find()
is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.
function find(): Promise<ItemsQueryResult>
Refines a query to match items where the specified property is greater than or equal to the specified value.
The ge()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
is greater than or equal to the specified value
.
ge()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
If a property contains a number stored as a string (for example, '0'
), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects.
- String: Compares lexicographically, so
'abc'
is greater than'ABC'
.
function ge(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Refines a query to match items where the specified property is greater than the specified value.
The gt()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
is greater than the specified value
.
gt()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
If a property contains a number stored as a string (for example, '0'
), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects.
- String: Compares lexicographically, so
'abc'
is greater than'ABC'
.
function gt(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Refines a query to match items where the specified property is less than or equal to the specified value.
The le()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
is less than or equal to the specified value
.
le()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
If a property contains a number stored as a string (for example, '0'
), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects.
- String: Compares lexicographically, so
'ABC'
is less than'abc'
.
function le(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Limits the number of items the query returns.
The limit()
function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the next()
and prev()
functions to navigate the pages of a query result.
function limit(limit: number): ItemsQueryBuilder
Limits the number of items the query returns.
The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the next() and prev() functions to navigate the pages of a query result.
Refines a query to match items where the specified property is less than the specified value.
The le()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
is less than the specified value
.
le()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
If a property contains a number stored as a string (for example, '0'
), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
The following types of properties can be compared:
- Number: Compares numerically.
- Date: Compares JavaScript Date objects.
- String: Compares lexicographically, so
'ABC'
is less than'abc'
.
function lt(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Refines a query to match items where the specified property doesn't equal the specified value.
The ne()
function refines a ItemsQueryBuilder
to match only items where the value of the specified propertyName
doesn't equal the specified value
.
ne()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
Matching strings with ne()
is case-sensitive, so 'text'
isn't equal to 'Text'
.
function ne(propertyName: string, value: any): ItemsQueryBuilder
Property whose value is compared with value.
Value to compare against.
Refines a query that skips to a specific record.
The skipTo()
function refines a ItemsQueryBuilder
to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the cursors
object in previous call's response. Then you can skip to cursors.prev
to return items before the cursor, or cursors.next
to return items after the cursor.
When using skipTo()
, the filters and the sorting order of the original query can't be changed. Only the limit()
property of the query can be changed.
function skipTo(cursor: string): ItemsQueryBuilder
A pointer to specific record