Skip to main content

dataPool

This query returns the Data Pool specified by the given ID.

A Data Pool is a cached table hydrated from your data warehouse optimized for high-concurrency and low-latency queries.

Arguments

  • id required ID


Returns

Nullable DataPool

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 Dimension

    The Data Pool's timestamp column.

  • dataPool.tenant nullable Tenant

    The Data Pool's Tenant ID, if configured.

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

  • dataPool.availableMeasures nullable ColumnConnection

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

  • dataPool.syncs nullable SyncConnection

  • dataPool.metrics nullable MetricConnection

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