DeleteOldChangeData
General
Description
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.
URL
https://{host:port}/attunityenterprisemanager/api/v1/servers/{server}/tasks/ {task}?action=delete_old_change_data
HTTP method
POST
Required user role
See Required Enterprise Manager permissions.
Request parameters
| Location | Name | Required | Description/Example |
|---|---|---|---|
|
URL |
host [string] |
Yes |
The host name of the Enterprise Manager machine. Example: computer.network.net |
|
URL |
server [string] |
Yes |
The Replicate server name, as defined in Enterprise Manager. Example: myrepsrv1 |
|
URL |
task [string] |
Yes |
The Replicate task name. Example: TargetAWSEMR |
Request body
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
cURL example
POST attunityenterprisemanager/api/v1/servers/myemserver/tasks/Oracle2NULL?action=delete_old_change_data
Parameters:
"timestamp_or_offset":"2020-07-30T16:15:00Z"
Error response
| HTTP Code | Enterprise Manager Code | Text | Description |
|---|---|---|---|
|
500 |
AEM_TASK_NOT_FOUND |
Replication task {task] on server {server} could not be found. |
Returned when an unknown task name is encountered. |
| 500 | 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. |
|
500 |
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. |