Skip to main content

createDataPoolInput

Fields for creating a Data Pool.

fields

  • dataSource required idOrUniqueName

    The Data Source that will be used to create the Data Pool.

    The ID or unique name input.

    If both ID and unique name are provided, the ID will take precedence.

  • table required String

    The table that the Data Pool will sync from.

  • timestamp required DimensionInput

    The table's primary timestamp column.

    The fields for creating or modifying a Dimension.

    • timestamp.columnName required String

      The name of the column to create the Dimension from.

  • uniqueName optional String

    The Data Pool's unique name. If not specified, Propel will set the ID as the unique name.

  • description optional String

    The Data Pool's description.

  • dataRetentionInDays optional Int

    The Data Pool's data retention in days. If not specified, records will be kept undefinitely.

  • excludedColumns optional array of String

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

    You may not exclude the timestamp column. Additionally, if you specify a tenant, that column may not be excluded.

  • tenant optional TenantInput

    An optional Data Pool Tenant ID. When specified, the Metrics powered by the Data Pool will be able to use TENANT_ACCESS Policies designed for multi-tenant use cases.

    Fields for specifying a Data Pool's Tenant ID.

    The Tenant ID can be used for partitioning and restricting access between customers (Tenants) within a Data Pool.

    • tenant.columnName required String

      The name of the column that represents the Tenant ID.