Skip to main content

RecordRowsQuery

@gravity-rail/react


@gravity-rail/react / RecordRowsQuery

Interface: RecordRowsQuery

A query for rows (mode rows) or a count (mode count).

Extends​

  • RecordQueryBase

Properties​

aggregate?​

optional aggregate: undefined


cursor?​

optional cursor: string

The nextCursor of the previous page.


dataType​

dataType: string | number

The Form's slug or numeric id.

Inherited from​

RecordQueryBase.dataType


entity​

entity: "data_record"

Inherited from​

RecordQueryBase.entity


limit?​

optional limit: number

1..500; the server default is 50.


select?​

optional select: string[]

Up to 30 paths: record.<slug> or a system field. Omit for every readable field.


sort?​

optional sort: RecordQuerySort[]

Up to 3 keys.


timezone?​

optional timezone: "UTC"

UTC only: reads offset-less record dates and day bounds in UTC and truncates buckets there.

Inherited from​

RecordQueryBase.timezone


where?​

optional where: RecordQueryPredicate

Inherited from​

RecordQueryBase.where