Skip to main content

DataPoolConnection

The Data Pool 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 DataPoolEdge

    The connection's edges.

    The Data Pool edge object.

    Learn more about pagination in GraphQL.

    • edges.cursor non-null String

      The edge's cursor.

    • edges.node non-null DataPool

      The edge's node.

  • nodes nullable array of DataPool

    The connection's nodes.

    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.

    • nodes.id non-null ID

      The Data Pool's unique identifier.

    • nodes.uniqueName non-null String

      The Data Pool's unique name.

    • nodes.description non-null String

      The Data Pool's description.

    • nodes.account non-null Account

      The Data Pool's Account.

    • nodes.environment non-null Environment

      The Data Pool's Environment.

    • nodes.createdAt non-null DateTime

      The Data Pool's creation date and time in UTC.

    • nodes.modifiedAt non-null DateTime

      The Data Pool's last modification date and time in UTC.

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

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

    • nodes.dataSource non-null DataSource

      The Data Pool's Data Source.

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

    • nodes.dataRetentionInDays non-null Int

      The Data Pool's data retention in days (not yet supported).

    • nodes.table non-null String

      The name of the Data Pool's table.

    • nodes.timestamp non-null Dimension

      The Data Pool's timestamp column.

    • nodes.tenant nullable Tenant

      The Data Pool's Tenant ID, if configured.

    • nodes.recordCount nullable String

      The number of records in the Data Pool.

    • nodes.sizeInTerabytes nullable Float

      The amount of storage in terabytes used by the Data Pool.

    • nodes.columns nullable ColumnConnection

      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. You can access those via excludedColumns.

      • nodes.columns.first optional Int

      • nodes.columns.after optional String

      • nodes.columns.last optional Int

      • nodes.columns.before optional String

    • nodes.availableMeasures nullable ColumnConnection

      A list of measures (numeric columns) available to Metrics.

      This list does not include any excluded columns.

      • nodes.availableMeasures.first optional Int

      • nodes.availableMeasures.after optional String

      • nodes.availableMeasures.last optional Int

      • nodes.availableMeasures.before optional String

    • nodes.setupTasks nullable array of DataPoolSetupTask

      A list of setup tasks performed on the Data Pool during its most recent setup attempt.

    • nodes.syncing nullable DataPoolSyncStatus

      Indicates whether or not syncing records is enabled for the Data Pool.

      The Data Pool Sync Status. It indicates whether a Data Pool is syncing data or not.

      • ENABLED

        Syncing is enabled for the Data Pool.

      • DISABLING

        Propel is disabling syncing for the Data Pool.

      • DISABLED

        Syncing is disabled for the Data Pool.

      • ENABLING

        Propel is re-enabling syncing for the Data Pool.

    • nodes.syncs nullable SyncConnection

      • nodes.syncs.first optional Int

      • nodes.syncs.after optional String

      • nodes.syncs.last optional Int

      • nodes.syncs.before optional String

    • nodes.metrics nullable MetricConnection

      • nodes.metrics.first optional Int

      • nodes.metrics.after optional String

      • nodes.metrics.last optional Int

      • nodes.metrics.before optional String

    • nodes.excludedColumns nullable ColumnConnection

      A list of columns to exclude from the Data Pool. The specified columns from the underlying table will not be synced to the Data Pool.

      • nodes.excludedColumns.first optional Int

      • nodes.excludedColumns.after optional String

      • nodes.excludedColumns.last optional Int

      • nodes.excludedColumns.before optional String