27 lines
1 KiB
YAML
27 lines
1 KiB
YAML
module: resultset
|
|
type: type
|
|
docs: |
|
|
Holds a collection of items returned from a query, or presented to a user.
|
|
|
|
A specific item of a result-set can be retrived using the subscript option. For example, `$result.(21)` will
|
|
return the 21st item of the result-set from the first item.
|
|
|
|
There is no guarantee to the ordering of items within the result-set, although items are usually
|
|
ordered based on the partition and sort key.
|
|
symbols:
|
|
- name: Items
|
|
syntax: '$resultset.Items'
|
|
docs: |
|
|
Returns the items within the result set.
|
|
- name: HasNextPage
|
|
syntax: '$resultset.HasNextPage'
|
|
docs: |
|
|
Returns true if this result-set has another page. The next page can be retrieved by calling `rs:next-page $resultset`.
|
|
- name: First
|
|
syntax: '$resultset.First'
|
|
docs: |
|
|
Returns the first item of the result-set, or nil if the result set is empty. Shorthand for `$result.Items.(0)`.
|
|
- name: Table
|
|
syntax: '$resultset.Table'
|
|
docs: |
|
|
Returns information about the table this result set belongs to. |