Skip to main content

sync

Returns a Sync by ID.

Arguments

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

  • sync.id non-null ID

    The Sync's unique identifier.

  • sync.account nullable Account

    The Sync's Account.

  • sync.environment nullable Environment

    The Sync's Environment.

  • sync.createdAt non-null DateTime

    The Sync's creation date and time in UTC.

  • sync.modifiedAt non-null DateTime

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

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

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

  • sync.dataPool nullable DataPool

    The Sync's Data Pool.

  • sync.dataSource nullable DataSource

    The Sync's Data Pool's Data Source.

  • sync.newRecords nullable String

    The number of new records contained within the Sync, if known. This excludes filtered records.

  • sync.updatedRecords nullable String

    The number of updated records contained within the Sync, if known. This excludes filtered records.

  • sync.deletedRecords nullable String

    The number of deleted records contained within the Sync, if known. This excludes filtered records.

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

  • sync.size nullable String

    The (compressed) size of the Sync, in bytes, if known.

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

    • DELETING

      Propel is deleting the Sync.

  • sync.startedAt nullable DateTime

    The time at which the Sync started.

  • sync.succeededAt nullable DateTime

    The time at which the Sync succeeded.

  • sync.failedAt nullable DateTime

    The time at which the Sync failed.

  • sync.error nullable Error

    If the Sync failed, this represents the reason the Sync failed.