Booster
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:
- The Data Pool's Tenant ID column (if present)
- Metric Filter columns (if present)
- Query Filter Dimensions (see
dimensions
) - The Data Pool's timestamp column
fields
id non-null ID
The Booster's unique identifier.
account non-null Account
The Booster's Account.
environment non-null Environment
The Booster's Environment.
The Environments object.
Environments are independent and isolated Propel workspaces for development, staging (testing), and production workloads. Environments are hosted in a specific region, initially in us-east-2 only.
environment.id non-null ID
The Environment's unique identifier.
createdAt non-null DateTime
The Booster's creation date and time in UTC.
modifiedAt non-null DateTime
The Booster's last modification date and time in UTC.
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.
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.
metric non-null Metric
The Metric this Booster is associated to.
The Metric object.
A Metric is a business indicator measured over time.
metric.id non-null ID
The Metric's unique identifier.
metric.uniqueName non-null String
The Metric's unique name.
metric.description non-null String
The Metric's description.
metric.account non-null Account
The Metric's Account.
metric.environment non-null Environment
The Metric's Environment.
metric.createdAt non-null DateTime
The Metric's creation date and time in UTC.
metric.modifiedAt non-null DateTime
The Metric's last modification date and time in UTC.
metric.createdBy non-null String
The Metric's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
metric.modifiedBy non-null String
The Metric's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
metric.dataPool nullable DataPool
The Data Pool that powers this Metric.
metric.dimensions non-null array of Dimension
The Metric's Dimensions. These Dimensions are available to Query Filters.
metric.timestamp non-null Dimension
The Metric's timestamp. This is the same as its Data Pool's timestamp.
metric.boosters non-null BoosterConnection
List the Boosters associated to the Metric.
metric.type non-null MetricType
The Metric's type. The different Metric types determine how the values are calculated.
The available Metric types.
COUNT
Counts the number of records that matches the Metric Filters. For time series, it will count the values for each time granularity.
SUM
Sums the values of the specified column for every record that matches the Metric Filters. For time series, it will sum the values for each time granularity.
COUNT_DISTINCT
Counts the number of distinct values in the specified column for every record that matches the Metric Filters. For time series, it will count the distinct values for each time granularity.
AVERAGE
Averages the values of the specified column for every record that matches the Metric Filters. For time series, it will average the values for each time granularity.
MIN
Selects the minimum value of the specified column for every record that matches the Metric Filters. For time series, it will select the minimum value for each time granularity.
MAX
Selects the maximum value of the specified column for every record that matches the Metric Filters. For time series, it will select the maximum value for each time granularity.
metric.settings non-null MetricSettings
The settings for the Metric. The settings are specific to the Metric's type.
- CountMetricSettings
- SumMetricSettings
- CountDistinctMetricSettings
- AverageMetricSettings
- MinMetricSettings
- MaxMetricSettings
metric.counter nullable CounterResponse
The Metric data in counter format. A single metric value for the given time range and filters.
metric.timeSeries nullable TimeSeriesResponse
The Metric data in time series format. Arrays of timestamps and Metric values for the given time range and filters.
metric.leaderboard nullable LeaderboardResponse
The Metric data in leaderboard format. A table (array of rows) with the selected dimensions and corresponding Metric values for the given time range and filters.
metric.policies non-null PolicyConnection
List the Policies associated to the Metric.
metric.accessControlEnabled non-null Boolean
Whether or not access control is enabled for the Metric.
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.
error nullable Error
If the Booster fails during the optimization process, this field includes a descriptive error message.
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.
dimensions non-null array of Dimension
Dimensions included in the Booster.
The Dimension object that represents a column in a table.
dimensions.columnName non-null String
The column name it represents.
dimensions.type non-null String
The column data type.
dimensions.isNullable nullable Boolean
Whether the column is nullable.
dimensions.stats nullable DimensionStatistics
The statistics for the dimension values. Fetching statistics incurs query costs.
recordCount nullable String
The number of records in the Booster.
sizeInTerabytes nullable Float
The amount of storage in terabytes used by the Booster.