DataPool
The Data Pool object. Data Pools are Propel's high-speed data store and cache
fields
id non-null ID
The Data Pool's unique identifier.
uniqueName non-null String
The Data Pool's unique name.
description non-null String
The Data Pool's description.
account non-null Account
The Data Pool's Account.
environment non-null Environment
The Data Pool'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 Data Pool's creation date and time in UTC.
modifiedAt non-null DateTime
The Data Pool's last modification date and time in UTC.
createdBy non-null String
The Data Pool'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 Data Pool's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
dataSource non-null DataSource
The Data Pool's Data Source.
The Data Source object.
A Data Source is a connection to your data warehouse. It has the necessary connection details for Propel to access Snowflake or any other supported Data Source.
Learn more about Data Sources.
dataSource.id non-null ID
The Data Source's unique identifier.
dataSource.uniqueName non-null String
The Data Source's unique name.
dataSource.description non-null String
The Data Source's description.
dataSource.account non-null Account
The Data Source's Account.
dataSource.environment non-null Environment
The Data Source's Environment.
dataSource.createdAt non-null DateTime
The Data Source's creation date and time in UTC.
dataSource.modifiedAt non-null DateTime
The Data Source's last modification date and time in UTC.
dataSource.createdBy non-null String
The Data Source's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
dataSource.modifiedBy non-null String
The Data Source's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
dataSource.type non-null DataSourceType
The Data Source's type.
The types of Data Sources.
WEBHOOK
Indicates a Webhook Data Source.
S3
Indicates an S3 Data Source.
Redshift
Indicates a Redshift Data Source.
Http
Indicates an Http Data Source.
BIGQUERY
Indicates a BigQuery Data Source.
Snowflake
Indicates a Snowflake Data Source.
dataSource.status non-null DataSourceStatus
The Data Source's status.
The status of a Data Source.
CREATED
The Data Source has been created, but it is not connected yet.
CONNECTING
Propel is attempting to connect the Data Source.
CONNECTED
The Data Source is connected.
BROKEN
The Data Source failed to connect.
DELETING
Propel is deleting the Data Source.
dataSource.connectionSettings non-null ConnectionSettings
The Data Source's connection settings.
dataSource.tables nullable TableConnection
The tables contained within the Data Source, according to the most recent table introspection.
dataSource.tableIntrospections nullable TableIntrospectionConnection
A list of table introspections performed for the Data Source. You can see how tables and columns changed over time by paging through this list.
dataSource.checks nullable array of DataSourceCheck
A list of checks performed on the Data Source during its most recent connection attempt.
dataSource.dataPools nullable DataPoolConnection
If you list Data Pools via the
dataPoolsfield on a Data Source, you will get Data Pools for the Data Source.The
dataPoolsfield uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parametersfirstandafterorlastandbeforeto page forward or backward through the results, respectively.For forward pagination, the
firstparameter defines the number of results to return, and theafterparameter defines the cursor to continue from. You should pass the cursor for the last result of the current page toafter.For backward pagination, the
lastparameter defines the number of results to return, and thebeforeparameter defines the cursor to continue from. You should pass the cursor for the first result of the current page tobefore.
status non-null DataPoolStatus
The Data Pool's status.
The status of a Data Pool.
CREATED
The Data Pool has been created and will be set up soon.
PENDING
Propel is attempting to set up the Data Pool.
LIVE
The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
SETUP_FAILED
The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
DELETING
Propel is deleting the Data Pool and all of its associated data.
dataRetentionInDays non-null Int
The Data Pool's data retention in days (not yet supported).
table non-null String
The name of the Data Pool's table.
timestamp non-null Timestamp
The Data Pool's primary timestamp column.
A Data Pool's primary timestamp column. Propel uses the primary timestamp to order and partition your data in Data Pools. It will serve as the time dimension for your Metrics.
tenant nullable Tenant
The Data Pool's tenant ID, if configured.
uniqueId nullable UniqueId
The Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.
recordCount nullable String
The number of records in the Data Pool.
sizeInTerabytes nullable Float
The amount of storage in terabytes used by the Data Pool.
columns nullable DataPoolColumnConnection
The Data Pool's columns.
The Data Pool column connection object.
Learn more about pagination in GraphQL.
columns.edges non-null array of DataPoolColumnEdge
The Data Pool column connection's edges.
columns.nodes non-null array of DataPoolColumn
The Data Pool column connection's nodes.
columns.pageInfo non-null PageInfo
The Data Pool column connection's page info.
availableMeasures nullable DataPoolColumnConnection
The list of measures (numeric columns) in the Data Pool.
The Data Pool column connection object.
Learn more about pagination in GraphQL.
availableMeasures.edges non-null array of DataPoolColumnEdge
The Data Pool column connection's edges.
availableMeasures.nodes non-null array of DataPoolColumn
The Data Pool column connection's nodes.
availableMeasures.pageInfo non-null PageInfo
The Data Pool column connection's page info.
setupTasks nullable array of DataPoolSetupTask
A list of setup tasks performed on the Data Pool during its most recent setup attempt.
The Data Pool Setup Task object.
Data Pool Setup Tasks are executed when setting up your Data Pool. They ensure Propel will be able to sync records from your Data Source to your Data Pool.
The exact Setup Tasks to perform vary by Data Source. For example, Data Pools pointing to a Snowflake-backed Data Sources will have their own specific Setup Tasks.
setupTasks.name non-null String
The name of the Data Pool Setup Task to be performed.
setupTasks.description nullable String
A description of the Data Pool Setup Task to be performed.
setupTasks.status non-null DataPoolSetupTaskStatus
The status of the Data Pool Setup Task (all setup tasks begin as NOT_STARTED before transitioning to SUCCEEDED or FAILED).
The status of a Data Pool Setup Task.
NOT_STARTED
The Data Pool Setup Task has not been started yet.
SUCCEEDED
The Data Pool Setup Task has completed successfully.
FAILED
The Data Pool Setup Task has failed.
setupTasks.error nullable Error
If the Data Pool Setup Task failed, this field includes a descriptive error message.
setupTasks.completedAt nullable DateTime
The time at which the Data Pool Setup Task was completed.
syncing non-null DataPoolSyncing
Settings related to Data Pool syncing.
Settings related to Data Pool syncing.
syncing.status non-null DataPoolSyncStatus
Indicates whether syncing is enabled or disabled.
The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.
ENABLED
Syncing is enabled for the Data Pool.
DISABLING
Propel is disabling syncing for the Data Pool.
DISABLED
Syncing is disabled for the Data Pool.
syncing.interval nullable DataPoolSyncInterval
The syncing interval.
Note that the syncing interval is approximate. For example, setting the syncing interval to
EVERY_1_HOURdoes not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goesLIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.
Note that the syncing interval is approximate. For example, setting the syncing interval to
EVERY_1_HOURdoes not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goesLIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.EVERY_1_MINUTE
EVERY_5_MINUTES
EVERY_15_MINUTES
EVERY_30_MINUTES
EVERY_1_HOUR
EVERY_4_HOURS
EVERY_12_HOURS
EVERY_24_HOURS
syncing.lastSyncedAt nullable DateTime
The date and time of the most recent Sync in UTC.
syncs nullable SyncConnection
The list of Syncs of the Data Pool.
metrics nullable MetricConnection
The list of Metrics powered by the Data Pool.
The Metric connection object.
Learn more about pagination in GraphQL.
deletionJobs nullable DeletionJobConnection
The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.
The Deletion Job connection object.
Learn more about pagination in GraphQL.
deletionJobs.edges non-null array of DeletionJobEdge
The Deletion Job connection's edges.
deletionJobs.nodes non-null array of DeletionJob
The Deletion Job connection's nodes.
deletionJobs.pageInfo non-null PageInfo
The Deletion Job connection's page info.
accessControlEnabled non-null Boolean
Whether the Data Pool has access control enabled or not.
If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.
dataPoolAccessPolicies non-null DataPoolAccessPolicyConnection
A paginated list of Data Pool Access Policies available on the Data Pool.
The Data Pool Access Policy connection object.
Learn more about pagination in GraphQL.
dataPoolAccessPolicies.edges non-null array of DataPoolAccessPolicyEdge
The Data Pool Access Policy connection's edges.
dataPoolAccessPolicies.nodes non-null array of DataPoolAccessPolicy
The Data Pool Access Policy connection's nodes.
dataPoolAccessPolicies.pageInfo non-null PageInfo
The Data Pool Access Policy connection's page info.
validateExpression non-null ValidateExpressionResult
Validates a custom expression against the Data Pool's available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.
Response returned by the validateExpression query for validating expressions in Custom Metrics.
Returns whether the expression is valid or not with a reason explaining why.
validateExpression.valid non-null Boolean
True if the expression is valid, false otherwise.
validateExpression.reason nullable String
The reason for why the expression is not valid in case it isn't, null otherwise.