Skip to main content

SyncConnection

The Sync connection object.

Learn more about pagination in GraphQL.

fields

  • pageInfo non-null PageInfo

    The connection's page info.

    The page info object used for pagination.

    • pageInfo.startCursor nullable String

      Points to the first item returned in the results. Used when paginating backward.

    • pageInfo.endCursor nullable String

      Points to the last item returned in the results. Used when paginating forward.

    • pageInfo.hasNextPage non-null Boolean

      A boolean that indicates whether a next page of results exists. Can be used to display a "next page" button in user interfaces, for example.

    • pageInfo.hasPreviousPage non-null Boolean

      A boolean that indicates whether a previous page of results exists. Can be used to display a "previous page" button in user interfaces, for example.

  • edges nullable array of SyncEdge

    The connection's edges.

    The Sync edge object.

    Learn more about pagination in GraphQL.

  • nodes nullable array of Sync

    The connection's nodes.

    The Sync object.

    This represents the process of syncing data from your Data Source (for example, a Snowflake data warehouse) to your Data Pool.

    • nodes.id non-null ID

      The Sync's unique identifier.

    • nodes.account nullable Account

      The Sync's Account.

    • nodes.environment nullable Environment

      The Sync's Environment.

    • nodes.createdAt non-null DateTime

      The Sync's creation date and time in UTC.

    • nodes.modifiedAt non-null DateTime

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

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

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

    • nodes.dataPool nullable DataPool

      The Sync's Data Pool.

    • nodes.dataSource nullable DataSource

      The Sync's Data Pool's Data Source.

    • nodes.newRecords nullable String

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

    • nodes.updatedRecords nullable String

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

    • nodes.deletedRecords nullable String

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

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

    • nodes.size nullable String

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

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

    • nodes.startedAt nullable DateTime

      The time at which the Sync started.

    • nodes.succeededAt nullable DateTime

      The time at which the Sync succeeded.

    • nodes.failedAt nullable DateTime

      The time at which the Sync failed.

    • nodes.error nullable Error

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