The Sync object.
This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.
id non-null ID
The Sync's unique identifier.
account nullable Account
The Sync's Account.
environment nullable Environment
The Sync'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 Sync's creation date and time in UTC.
modifiedAt non-null DateTime
The Sync's last modification date and time in UTC.
createdBy non-null String
The Sync'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 Sync's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
dataPool nullable DataPool
The Sync's Data Pool.
The Data Pool object.
A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.
dataPool.id non-null ID
The Data Pool's unique identifier.
dataPool.uniqueName non-null String
The Data Pool's unique name.
dataPool.description non-null String
The Data Pool's description.
dataPool.account non-null Account
The Data Pool's Account.
dataPool.environment non-null Environment
The Data Pool's Environment.
dataPool.createdAt non-null DateTime
The Data Pool's creation date and time in UTC.
dataPool.modifiedAt non-null DateTime
The Data Pool's last modification date and time in UTC.
dataPool.createdBy non-null String
The Data Pools's creator. It can be either a User ID, an Application ID, or "system" if it was created by Propel.
dataPool.modifiedBy non-null String
The Data Pools's last modifier. It can be either a User ID, an Application ID, or "system" if it was modified by Propel.
dataPool.dataSource non-null DataSource
The Data Pool's Data Source.
dataPool.status non-null DataPoolStatus
The Data Pool's status.
The status of a Data Pool.
The Data Pool has been created and will be set up soon.
Propel is attempting to set up the Data Pool.
The Data Pool is set up and serving data. Check its Syncs to monitor data ingestion.
The Data Pool setup failed. Check its Setup Tasks before re-attempting setup.
Propel is deleting the Data Pool and all of its associated data.
dataPool.dataRetentionInDays non-null Int
The Data Pool's data retention in days (not yet supported).
dataPool.table non-null String
The name of the Data Pool's table.
dataPool.timestamp non-null Timestamp
The Data Pool's timestamp column.
dataPool.tenant nullable Tenant
The Data Pool's Tenant ID, if configured.
dataPool.cursor nullable Cursor
The Data Pool's cursor column. The column to track whether a record should be synced. An example of a cursor would be a timestamp column like
dataPool.recordCount nullable String
The number of records in the Data Pool.
dataPool.sizeInTerabytes nullable Float
The amount of storage in terabytes used by the Data Pool.
dataPool.columns nullable DataPoolColumnConnection
A list of columns included in the Data Pool. The specified columns from the underlying table will by synced to the Data Pool.
This list does not include any excluded columns.
dataPool.availableMeasures nullable DataPoolColumnConnection
A list of measures (numeric columns) available to Metrics.
This list does not include any excluded columns.
dataPool.availableMeasures.first optional Int
dataPool.availableMeasures.after optional String
dataPool.availableMeasures.last optional Int
dataPool.availableMeasures.before optional String
dataPool.setupTasks nullable array of DataPoolSetupTask
A list of setup tasks performed on the Data Pool during its most recent setup attempt.
dataPool.syncing non-null DataPoolSyncing
Settings related to Data Pool syncing.
dataPool.syncs nullable SyncConnection
dataPool.syncs.filter optional SyncsFilter
The filter to apply when listing the Syncs for a Data Pool.
Returns only Syncs with empty records.
Returns only Syncs that contain one or more records.
Returns all Syncs, regardless of whether they contain records or not.
dataPool.syncs.first optional Int
dataPool.syncs.after optional String
dataPool.syncs.last optional Int
dataPool.syncs.before optional String
dataPool.metrics nullable MetricConnection
dataPool.deletionJobs nullable DeletionJobConnection
The Deletion Jobs that where historically issued to this Data Pool, sorted by creation time, in descending order.
dataPool.deletionJobs.first optional Int
dataPool.deletionJobs.after optional String
dataPool.deletionJobs.last optional Int
dataPool.deletionJobs.before optional String
dataSource nullable DataSource
The Sync's 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.
Indicates a Webhook Data Source.
Indicates an S3 Data Source.
Indicates a Redshift Data Source.
Indicates an Http Data Source.
Indicates a BigQuery Data Source.
Indicates a Snowflake Data Source.
dataSource.status non-null DataSourceStatus
The Data Source's status.
The status of a Data Source.
The Data Source has been created, but it is not connected yet.
Propel is attempting to connect the Data Source.
The Data Source is connected.
The Data Source failed to connect.
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.tables.first optional Int
dataSource.tables.after optional String
dataSource.tables.last optional Int
dataSource.tables.before optional String
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.tableIntrospections.first optional Int
dataSource.tableIntrospections.after optional String
dataSource.tableIntrospections.last optional Int
dataSource.tableIntrospections.before optional String
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.
dataPoolsfield uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters
beforeto page forward or backward through the results, respectively.
For forward pagination, the
firstparameter defines the number of results to return, and the
afterparameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to
For backward pagination, the
lastparameter defines the number of results to return, and the
beforeparameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to
dataSource.dataPools.first optional Int
dataSource.dataPools.after optional String
dataSource.dataPools.last optional Int
dataSource.dataPools.before optional String
newRecords nullable String
The number of new records contained within the Sync, if known. This excludes filtered records.
updatedRecords nullable String
The number of updated records contained within the Sync, if known. This excludes filtered records.
deletedRecords nullable String
The number of deleted records contained within the Sync, if known. This excludes filtered records.
invalidRecords nullable String
The number of filtered records contained within the Sync, due to issues such as a missing timestamp Dimension, if any are known to be invalid.
size nullable String
The (compressed) size of the Sync, in bytes, if known.
status non-null SyncStatus
The status of the Sync (all Syncs begin as SYNCING before transitioning to SUCCEEDED or FAILED).
The status of a Sync.
Propel is actively syncing records contained within the Sync.
The Sync succeeded. Propel successfully synced all records contained within the Sync.
The Sync failed. Propel failed to sync some or all records contained within the Sync.
startedAt nullable DateTime
The time at which the Sync started.
succeededAt nullable DateTime
The time at which the Sync succeeded.
failedAt nullable DateTime
The time at which the Sync failed.
error nullable Error
If the Sync failed, this represents the reason the Sync failed.