Navigation :

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		`IDlcScope`	Scope Parameters
branch		`String`	The branch you want to unload data from.
performGcOnStart		`Boolean`	Perform a Garbage collection before the datastore transaction.
performGcOnCompletion		`Boolean`	Perform a Garbage collection after the datastore transaction.

Example:

DlcUnloadRequest.builder()
    .topics("Topic1", "Topic2") // Required
    .scope(DlcScope.of(
			"AsOfDate", "2025-02-14",
            "performGcOnCompletion", true
    ))
    .branch("BranchToLoadInto")
    .build();

`DlcUnloadRequestDTO`

Key	Type	Description
unloadedRecords	`Map<String, Long>`	Number of records removed from each store.
status	`DlcStatus`	Overall status of the DLC Operation.

Example:

{
  "operation": "UNLOAD",
  "topics": ["Topic1", "Topic2"],
  "scope": {
    "AsOfDate": "2025-02-14"
  },
  "performGcOnCompletion": true,
  "branch": "BranchToLoadInto"
}

Response

`DlcUnloadResponse`

Key	Type	Description
report	`UnloadReport`	Report of what occurred during the unload operation.
status	`DlcStatus`	Overall status of the DLC Operation.

`UnloadReport`

Key	Type	Description
unloadedRecords	`Map<String, Long>`	Number of records removed from each store.

`DlcStatus`

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.

`DlcUnloadResponseDTO`

Key	Type	Description
unloadedRecordsPerStore	`Map<String, Long>`	Number of records removed from each store.
status	`DlcStatus`	Overall status of the DLC Operation.

Example:

{
  "unloadedRecordsPerStore": {
    "StoreA": 12,
    "StoreB": 200
  },
  "status": "OK"
}