Skip to main content

DeletionJob

Deletion Job scheduled for a specific Data Pool.

The Deletion Job represents the asynchronous process of deleting data given some filters inside a Data Pool. It tracks the deletion process until it is finished, showing the progress and the outcome when it is finished.

fields

  • id non-null ID

    The Deletion Job's ID.

  • createdAt non-null DateTime

    The Deletion Job's creation date and time in UTC.

  • createdBy non-null String

    Who created the Deletion Job.

  • modifiedAt non-null DateTime

    The Deletion Job's last modification date and time in UTC.

  • modifiedBy non-null String

    Who last modified the Deletion Job.

  • account non-null Account

    Account to which the Deletion Job belongs.

    The Account object.

    • account.id non-null ID

      The Account's unique identifier.

  • environment non-null Environment

    Environment to which the Deletion Job belongs.

    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.

  • dataPool non-null DataPool

    The Data Pool whose records will be deleted by the Deletion Job.

    The Data Pool object. Data Pools are Propel's high-speed data store and cache

    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 Pool'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 Pool'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 primary timestamp column.

    • dataPool.tenant nullable Tenant

      The Data Pool's tenant ID, if configured.

    • dataPool.uniqueId nullable UniqueId

      The Data Pool's unique ID column. Propel uses the primary timestamp and a unique ID to compose a primary key for determining whether records should be inserted, deleted, or updated within the Data Pool.

    • 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

      The Data Pool's columns.

    • dataPool.availableMeasures nullable DataPoolColumnConnection

      The list of measures (numeric columns) in the Data Pool.

    • 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

      The list of Syncs of the Data Pool.

      • 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

      The list of Metrics powered by the Data Pool.

    • dataPool.deletionJobs nullable DeletionJobConnection

      The Deletion Jobs that were historically issued to this Data Pool, sorted by creation time, in descending order.

    • dataPool.accessControlEnabled non-null Boolean

      Whether the Data Pool has access control enabled or not.

      If the Data Pool has access control enabled, Applications must be assigned Data Pool Access Policies in order to query the Data Pool and its Metrics.

    • dataPool.dataPoolAccessPolicies non-null DataPoolAccessPolicyConnection

      A paginated list of Data Pool Access Policies available on the Data Pool.

    • dataPool.validateExpression non-null ValidateExpressionResult

      Validates a custom expression against the Data Pool's available columns. If the provided expression is invalid, the ValidateExpressionResult response will contain a reason explaining why.

  • status non-null JobStatus

    The current Deletion Job's status.

    • CREATED

      The Job was created, but is not yet being executed.

    • IN_PROGRESS

      The Job is executing.

    • SUCCEEDED

      The Job succeeded.

    • FAILED

      The Job failed. Check the error message.

  • filters non-null array of Filter

    The list of filters that will be used for deleting data. Data matching the filters will be deleted.

    The fields of a filter.

    You can construct more complex filters using and and or. For example, to construct a filter equivalent to

    (value > 0 AND value <= 100) OR status = "confirmed"
    

    you could write

    {
      "column": "value",
      "operator": "GREATER_THAN",
      "value": "0",
      "and": [{
        "column": "value",
        "operator": "LESS_THAN_OR_EQUAL_TO",
        "value": "0"
      }],
      "or": [{
        "column": "status",
        "operator": "EQUALS",
        "value": "confirmed"
      }]
    }
    

    Note that and takes precedence over or.

    • filters.column non-null String

      The name of the column to filter on.

    • filters.operator non-null FilterOperator

      The operation to perform when comparing the column and filter values.

      The available Filter operators.

      • EQUALS

        Selects values that are equal to the specified value.

      • NOT_EQUALS

        Selects values that are not equal to the specified value.

      • GREATER_THAN

        Selects values that are greater than the specified value.

      • GREATER_THAN_OR_EQUAL_TO

        Selects values that are greater or equal to the specified value.

      • LESS_THAN

        Selects values that are less than the specified value.

      • LESS_THAN_OR_EQUAL_TO

        Selects values that are less or equal to the specified value.

      • IS_NULL

        Selects values that are null. This operator does not accept a value.

      • IS_NOT_NULL

        Selects values that are not null. This operator does not accept a value.

    • filters.value nullable String

      The value to compare the column to.

    • filters.and nullable array of Filter

      Additional filters to AND with this one. AND takes precedence over OR.

    • filters.or nullable array of Filter

      Additional filters to OR with this one. AND takes precedence over OR.

  • error nullable Error

    The error that occurred while deleting data, if any.

    The error object.

  • progress non-null Float

    The current progress of the Deletion Job, from 0.0 to 1.0.

  • startedAt nullable DateTime

    The time at which the Deletion Job started.

  • succeededAt nullable DateTime

    The time at which the Deletion Job succeeded.

  • failedAt nullable DateTime

    The time at which the Deletion Job failed.