Skip to main content

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.

fields

  • id non-null ID

    The Sync's unique identifier.

  • account nullable Account

    The Sync's Account.

    The Account object.

    • account.id non-null ID

      The Account's unique identifier.

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

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

    Learn more about Data Pools.

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

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

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

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

        • EMPTY

          Returns only Syncs with empty records.

        • NOT_EMPTY

          Returns only Syncs that contain one or more records.

        • ALL

          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.

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

      • 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 dataPools field on a Data Source, you will get Data Pools for the Data Source.

      The dataPools field uses cursor-based pagination typical of GraphQL APIs. You can use the pairs of parameters first and after or last and before to page forward or backward through the results, respectively.

      For forward pagination, the first parameter defines the number of results to return, and the after parameter defines the cursor to continue from. You should pass the cursor for the last result of the current page to after.

      For backward pagination, the last parameter defines the number of results to return, and the before parameter defines the cursor to continue from. You should pass the cursor for the first result of the current page to before.

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

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

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

    The error object.