Load
Overview
The LOAD operation performs a single, blocking, load request in a single datastore transaction.
Request
DlcLoadRequest
| Key | Required | Type | Description |
|---|---|---|---|
| topics | Y | Set<String> |
Set of topics or aliases. |
| topicOverrides | Set<ISourceTopicDescription> |
Topic overrides. | |
| scope | DlcOperationScope |
Scope | |
| branch | String |
The branch you want to operate on. | |
| sourceName | String |
The source name you want to operate on. | |
| sourceType | DlcSourceType |
The source type you want to operate on. |
Example:
DlcLoadRequest.builder()
.topics("Topic1", "Topic2") // Required
.topicOverrides(Set.of(CsvTopicDescription.builder("TopicToOverride", "glob:file*.csv")...build()))
.scope(DlcOperationScope.of("ScopeKey1", "ScopeValue1"))
.branch("BranchToLoadInto")
.sourceName("NameOfSourceToUse")
.sourceType(DlcSourceType.LOCAL_SOURCE)
.build();
Please refer to the DlcLoadRequestDTO class for the JSON DTO structure.
Response
DlcLoadResponse
| Key | Type | Description |
|---|---|---|
| report | DlcLoadResponse.LoadReport |
Report of what occurred during the loading operation. |
| status | IDlcStatus |
Overall status of the DLC Operation. |
DlcLoadResponse.LoadReport
| Key | Type | Description |
|---|---|---|
| parsingReport | Map<String, Map<String, ITopicParsingReport>> |
Per topic parsing report provided by the Atoti API. Will contain fine-grain error details. |
| errors | Map<String, List<DlcMessageCollector.OnError>> |
Errors that occurred while loading. |
| messagesPublished | Map<String, List<DlcMessageCollector.OnMessagePublished>> |
The Atoti message when the records are published to the datastore. |
| messageStarted | Map<String, List<DlcMessageCollector.OnMessageStarted>> |
The Atoti message when the records are sent to the Tuple Publisher. |
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 DlcLoadResponseDTO class for the JSON DTO structure.