Skip to main content

QueryInfo

The Query Info object. It contains metadata and statistics about a Query performed.

fields

  • id non-null ID

    The Query's unique identifier.

  • createdAt non-null DateTime

    The date and time in UTC when the Query was created.

  • createdBy non-null String

    The unique identifier of the actor that performed the Query.

  • modifiedAt non-null DateTime

    The date and time in UTC when the Query was last modified.

  • modifiedBy non-null String

    The unique identifier of the actor that modified the Query.

  • bytesProcessed non-null String

    The bytes processed by the Query.

  • durationInMilliseconds non-null Int

    The duration of the Query in milliseconds.

  • recordsProcessed non-null String

    The number of records processed by the Query.

  • resultingBytes non-null Int

    The bytes returned by the Query.

  • resultingRecords non-null Int

    The number of records returned by the Query.

  • booster nullable Booster

    If the Query was boosted, the Booster that was used.

    Boosters allow you to optimize Metric Queries for a subset of commonly used Dimensions. A Metric can have one or many Boosters to optimize for the different Query patterns.

    Boosters can be understood as an aggregating index. The index is formed from left to right as follows:

    1. The Data Pool's Tenant ID column (if present)
    2. Metric Filter columns (if present)
    3. Query Filter Dimensions (see dimensions)
    4. The Data Pool's timestamp column
    • booster.id non-null ID

      The Booster's unique identifier.

    • booster.account non-null Account

      The Booster's Account.

    • booster.environment non-null Environment

      The Booster's Environment.

    • booster.createdAt non-null DateTime

      The Booster's creation date and time in UTC.

    • booster.modifiedAt non-null DateTime

      The Booster's last modification date and time in UTC.

    • booster.createdBy non-null String

      The Booster's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.

    • booster.modifiedBy non-null String

      The Booster's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.

    • booster.metric non-null Metric

      The Metric this Booster is associated to.

    • booster.status non-null BoosterStatus

      The status of the Booster (once LIVE it will be available for speeding up Metric queries).

      The Booster status.

      • CREATED

        The Booster has been created. Propel will start optimizing the Data Pool soon.

      • OPTIMIZING

        Propel is setting up the Booster and optimizing the Data Pool.

      • LIVE

        The Booster is now live and available to speed up Metric queries.

      • FAILED

        Propel failed to setup the Booster. Please write to support. Alternatively, you can delete the Booster and try again.

      • DELETING

        Propel is deleting the Booster and all of its associated data.

    • booster.error nullable Error

      If the Booster fails during the optimization process, this field includes a descriptive error message.

    • booster.progress nullable Float

      When the Booster is OPTIMIZING, this represents its progress as a number from 0 to 1. In all other states, progress is null.

    • booster.dimensions non-null array of Dimension

      Dimensions included in the Booster.

    • booster.recordCount nullable String

      The number of records in the Booster.

    • booster.sizeInTerabytes nullable Float

      The amount of storage in terabytes used by the Booster.

  • propeller nullable Propeller

    The Propeller used for this query.

    A Propeller defines the compute power assigned to a Propel Application. The larger its compute power, the faster the queries. With Propellers, you can assign different compute powers (and cost profiles) to different use cases or workloads (with the same data).

    Propellers have the following properties:

    Max RPS: The maximum number of records per second (RPS) that can be processed by the Propeller on a single query.

    • P1_X_SMALL

      Max records per second: 5,000,000 records per second

    • P1_SMALL

      Max records per second: 25,000,000 records per second

    • P1_MEDIUM

      Max records per second: 100,000,000 records per second

    • P1_LARGE

      Max records per second: 250,000,000 records per second

    • P1_X_LARGE

      Max records per second: 500,000,000 records per second

  • status non-null QueryStatus

    The Query status.

    The Query status.

    • COMPLETED

      The Query was completed succesfully.

    • ERROR

      The Query experienced an error.

    • TIMED_OUT

      The Query timed out.

  • type non-null QueryType

    The Query type.

    The Query type.

    • METRIC

      Indicates a Metric Query.

    • STATS

      Indicates a Dimension Stats Query.

  • subtype nullable QuerySubtype

    The Query subtype.

    The Query subtype.

    • COUNTER

      Indicates a Metric counter Query.

    • TIME_SERIES

      Indicates a Metric time series Query.

    • LEADERBOARD

      Indicates a Metric leaderboard Query.