delete_old_change_data
The method can be called on an ad-hoc basis to delete processed Change Data Partitions created on the target database by a Replicate task.
-
Partitions will only be deleted if the Change Data Partitioning and Partition Retention options are enabled in the Replicate console.
For more information, refer to the Qlik Replicate Setup and User Guide.
- Partitions will only be deleted if the task is running. If the task is not running, the partitions will be deleted the next time the task runs.
- Only partitions that are not locked by a consuming application will be deleted.
Required User Role: See Required Enterprise Manager permissions.
Syntax
public void DeleteOldChangeData(
AemDeleteOldChangeDataReq payload,
string server,
string task
);
Parameters
| Parameter | Type | Description |
|---|---|---|
| AemDeleteOldChangeDataReq | payload |
The point in time after which partitions can be deleted, which can either be specified as a timestamp or as an offset. If a retention barrier is set, partitions will be deleted up to the retention barrier date, regardless of the specified timestamp/offset. Timestamp Format: [Date] (yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z') Example: 2020-06-30T16:15:00Z Offset Format : [Period] Format ISO 8601 duration Example: P1M3DT1H2M |
|
server |
string |
The name of the server on which the task is running. |
| task | string | The name of the task. |
Error response
| Message | Text | Description |
|---|---|---|
|
AEM_TASK_NOT_FOUND |
Replication task {task] on server {server} could not be found. |
Returned when an unknown task name is encountered. |
| AEM_INVALID_TIMESTAMP_OR_OFFSET_FORMAT | The specified deletion age does not conform to the expected timestamp or offset format. Timestamp format should be yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z'. Offset format should conform to ISO 8601 duration. | Returned when the specified deletion age does not conform to the expected timestamp or offset format. |
|
AEM_DELETE_OLD_CHANGE_DATA_INNER_ERR |
Failed to request deletion of old change data for task {task} on server {server}. Message: {error_message} |
Returned when an error is encountered during partition deletion. |