Unload
Overview
The UNLOAD operation performs a single, blocking, unload request in a single datastore transaction. When unloading,
elements are deleted from the datastore. The deleted elements are not recorded.
You may want to perform a Garbage Collection after performing an UNLOAD operation. This can be done by specifying
the Garbage Collection scope properties in your request.
Request
DlcUnoadRequest
| Key | Required | Type | Description |
|---|---|---|---|
| topics | Y | Set<String> |
Set of topics or aliases. |
| scope | DlcOperationScope |
Scope | |
| branch | String |
The branch you want to unload data from. |
Example:
DlcUnloadRequest.builder()
.topics("Topic1", "Topic2") // Required
.scope(DlcOperationScope.of(
"AsOfDate", "2025-02-14",
"performGcOnCompletion", true
))
.branch("BranchToLoadInto")
.build();
Please refer to the DlcUnoadRequestDTO class for the JSON DTO structure.
Response
DlcUnloadResponse
| Key | Type | Description |
|---|---|---|
| report | DlcUnloadResponse.UnloadReport |
Report of what occurred during the unload operation. |
| status | IDlcStatus |
Overall status of the DLC Operation. |
DlcUnloadResponse.UnloadReport
| Key | Type | Description |
|---|---|---|
| unloadedRecords | Map<String, Long> |
Number of records removed from each store. |
IDlcStatus
A simple enum to capture if the DLC request was executed.
| Key | Description |
|---|---|
| OK | Request was handled successfully. |
| ERROR | Request was not able to be performed correctly. |
Please refer to the DlcUnloadResponseDTO class for the JSON DTO structure.