syncDataPool
Manually trigger a Sync for a Data Pool.
Arguments
dataPoolId required ID
Returns
Nullable Sync
The Sync object.
This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.
syncDataPool.id non-null ID
The Sync's unique identifier.
syncDataPool.account nullable Account
The Sync's Account.
syncDataPool.environment nullable Environment
The Sync's Environment.
syncDataPool.createdAt non-null DateTime
The Sync's creation date and time in UTC.
syncDataPool.modifiedAt non-null DateTime
The Sync's last modification date and time in UTC.
syncDataPool.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.
syncDataPool.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.
syncDataPool.dataPool nullable DataPool
The Sync's Data Pool.
syncDataPool.dataSource nullable DataSource
The Sync's Data Pool's Data Source.
syncDataPool.processedRecords nullable String
The number of new, updated, and deleted records contained within the Sync, if known. This excludes filtered records.
syncDataPool.newRecords nullable String
The number of new records contained within the Sync, if known. This excludes filtered records.
syncDataPool.updatedRecords nullable String
The number of updated records contained within the Sync, if known. This excludes filtered records.
syncDataPool.deletedRecords nullable String
The number of deleted records contained within the Sync, if known. This excludes filtered records.
syncDataPool.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.
syncDataPool.size nullable String
The (compressed) size of the Sync, in bytes, if known.
syncDataPool.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.
SYNCING
Propel is actively syncing records contained within the Sync.
SUCCEEDED
The Sync succeeded. Propel successfully synced all records contained within the Sync.
FAILED
The Sync failed. Propel failed to sync some or all records contained within the Sync.
syncDataPool.startedAt nullable DateTime
The time at which the Sync started.
syncDataPool.succeededAt nullable DateTime
The time at which the Sync succeeded.
syncDataPool.failedAt nullable DateTime
The time at which the Sync failed.
syncDataPool.error nullable Error
If the Sync failed, this represents the reason the Sync failed.