truegrain - v1.1.0
    Preparing search index...

    Interface RunOptions

    A QueryRequest, plus how long to wait and how to page.

    interface RunOptions {
        dimensions?: string[];
        filters?: filters.Filter[];
        grain?: string;
        limit?: number;
        maxWaitMs?: number;
        metrics: string[];
        orderBy?: { desc?: boolean; field: string }[];
        pageSize?: number;
    }

    Hierarchy (View Summary)

    Index
    dimensions? filters? grain? limit? maxWaitMs? metrics orderBy? pageSize?
    dimensions?: string[]

    dataset.field or namespace.dataset.field.

    filters?: filters.Filter[]

    Structured predicates, never SQL text. Build them with the filters helpers.

    grain?: string

    Time bucket for the selected time dimension.

    limit?: number

    Maximum rows. Defaults to the server's limit.

    maxWaitMs?: number

    Milliseconds to wait before giving up. On expiry the job is cancelled rather than left running, so an abandoned wait does not keep spending warehouse time.

    metrics: string[]

    Metric names. Metrics at different grains, or in different namespaces, are aggregated separately and joined on the shared dimensions.

    orderBy?: { desc?: boolean; field: string }[]

    Sort keys applied to the result.

    Type Declaration

    • Optionaldesc?: boolean

      Sort descending.

    • field: string

      A metric or dimension name from the same request.

    pageSize?: number

    Rows per page while collecting. Lower it when rows are wide.

    Settings
    Member Visibility

    On This Page
    Properties