CreateDataPoolInputV2

Fields for creating a Data Pool.

fields

• dataSource required ID

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

• table required String

  The table that the Data Pool will sync from.

• timestamp required TimestampInput

  The table's primary timestamp column.

  The fields for specifying the Data Pool's Timestamp.

  • timestamp.columnName required String

    The name of the column that represents the Timestamp.

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

• columns required array of DataPoolColumnInput

  The list of columns.

  • columns.columnName required String

    The name of the Data Source column that this Data Pool column derives from.

  • columns.type required ColumnType

    The Data Pool column's type. This may differ from the corresponding Data Source column's type.

    The Propel data types.

    • BOOLEAN

      True or false.

    • STRING

      A variable-length string.

    • FLOAT

      A 32-bit signed double-precision floating point number.

    • DOUBLE

      A 64-bit signed double-precision floating point number.

    • INT8

      An 8-bit signed integer, with a minimum value of -2⁷ and a maximum value of 2⁷-1.

    • INT16

      A 16-bit signed integer, with a minimum value of -2¹⁵ and a maximum value of 2¹⁵-1.

    • INT32

      A 32-bit signed integer, with a minimum value of -2³¹ and a maximum value of 2³¹-1.

    • INT64

      A 64-bit signed integer, with a minimum value of -2⁶³ and a maximum value of 2⁶³-1.

    • DATE

      A date without a timestamp. For example, "YYYY-MM-DD".

    • TIMESTAMP

      A date with a timestamp. For example, "yyy-MM-dd HH:mm:ss".

    • JSON

      A JavaScript Object Notation (JSON) document.

  • columns.isNullable required Boolean

    Whether the column is nullable, meaning whether it accepts a null value.

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

• cursor optional CursorInput

  The table'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.

  The fields for specifying the Data Pool's Cursor.

  • cursor.columnName required String

    The name of the column that represents the Cursor.

• syncing optional DataPoolSyncingInput

  The Data Pool's syncing settings.

  The fields for modifying the Data Pool syncing.

  • syncing.interval required DataPoolSyncInterval

    The available Data Pool sync intervals. Specify unit of time between attempts to sync data from your data warehouse.

    Note that the syncing interval is approximate. For example, setting the syncing interval to EVERY_1_HOUR does not mean that syncing will occur exactly on the hour. Instead, the syncing interval starts relative to when the Data Pool goes LIVE, and Propel will attempt to sync approximately every hour. Additionally, if you pause or resume syncing, this too can shift the syncing interval around.

    • EVERY_1_MINUTE

    • EVERY_5_MINUTES

    • EVERY_15_MINUTES

    • EVERY_30_MINUTES

    • EVERY_1_HOUR

    • EVERY_4_HOURS

    • EVERY_12_HOURS

    • EVERY_24_HOURS