Skip to main content

BoosterConnection

The Booster connection object.

Learn more about pagination in GraphQL.

fields

  • pageInfo non-null PageInfo

    The connection's page info.

    The page info object used for pagination.

    • pageInfo.startCursor nullable String

      Points to the first item returned in the results. Used when paginating backward.

    • pageInfo.endCursor nullable String

      Points to the last item returned in the results. Used when paginating forward.

    • pageInfo.hasNextPage non-null Boolean

      A boolean that indicates whether a next page of results exists. Can be used to display a "next page" button in user interfaces, for example.

    • pageInfo.hasPreviousPage non-null Boolean

      A boolean that indicates whether a previous page of results exists. Can be used to display a "previous page" button in user interfaces, for example.

  • edges nullable array of BoosterEdge

    The connection's edges.

    The Booster edge object.

    Learn more about pagination in GraphQL.

    • edges.cursor non-null String

      The edge's cursor.

    • edges.node non-null Booster

      The edge's node.

  • nodes nullable array of Booster

    The connection's nodes.

    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
    • nodes.id non-null ID

      The Booster's unique identifier.

    • nodes.account non-null Account

      The Booster's Account.

    • nodes.environment non-null Environment

      The Booster's Environment.

    • nodes.createdAt non-null DateTime

      The Booster's creation date and time in UTC.

    • nodes.modifiedAt non-null DateTime

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

    • nodes.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.

    • nodes.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.

    • nodes.metric non-null Metric

      The Metric this Booster is associated to.

    • nodes.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.

    • nodes.error nullable Error

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

    • nodes.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.

    • nodes.dimensions non-null array of Dimension

      Dimensions included in the Booster.

    • nodes.recordCount nullable String

      The number of records in the Booster.

    • nodes.sizeInTerabytes nullable Float

      The amount of storage in terabytes used by the Booster.