Home
Apache Doris
Apache Doris Stream Load Response Structure
Apache Doris Stream Load Response Structure
Response returned by the Apache Doris Stream Load HTTP API after a data loading operation.
Type: object
Properties: 17
Analytics Apache Database Lakehouse MPP OLAP Open Source Real-Time SQL
StreamLoadResponse is a JSON Structure definition published by Apache Doris, describing 17 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
Properties
TxnId
Label
Status
ExistingJobStatus
Message
NumberTotalRows
NumberLoadedRows
NumberFilteredRows
NumberUnselectedRows
LoadBytes
LoadTimeMs
BeginTxnTimeMs
StreamLoadPutTimeMs
ReadDataTimeMs
WriteDataTimeMs
CommitAndPublishTimeMs
ErrorURL
Meta-schema: https://json-structure.org/meta/core/v0/#
JSON Structure
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/apache-doris/refs/heads/main/json-structure/apache-doris-stream-load-response-structure.json",
"name": "StreamLoadResponse",
"description": "Response returned by the Apache Doris Stream Load HTTP API after a data loading operation.",
"type": "object",
"properties": {
"TxnId": {
"type": "int32",
"description": "Transaction ID assigned to this load job.",
"example": 1001
},
"Label": {
"type": "string",
"description": "Label for idempotent load tracking.",
"example": "load-20250315-001"
},
"Status": {
"type": "string",
"description": "Overall status of the load operation.",
"enum": [
"Success",
"Publish Timeout",
"Label Already Exists",
"Fail"
],
"example": "Success"
},
"ExistingJobStatus": {
"type": "string",
"description": "Status of existing job with same label if label already exists.",
"example": "FINISHED"
},
"Message": {
"type": "string",
"description": "Status message or error description.",
"example": "OK"
},
"NumberTotalRows": {
"type": "int32",
"description": "Total number of rows processed.",
"example": 10000
},
"NumberLoadedRows": {
"type": "int32",
"description": "Number of rows successfully loaded.",
"example": 9998
},
"NumberFilteredRows": {
"type": "int32",
"description": "Number of rows filtered due to quality issues.",
"example": 2
},
"NumberUnselectedRows": {
"type": "int32",
"description": "Number of rows filtered by WHERE clause.",
"example": 0
},
"LoadBytes": {
"type": "int32",
"description": "Total data size loaded in bytes.",
"example": 1024000
},
"LoadTimeMs": {
"type": "int32",
"description": "Time spent loading data in milliseconds.",
"example": 350
},
"BeginTxnTimeMs": {
"type": "int32",
"description": "Time to begin transaction in milliseconds.",
"example": 5
},
"StreamLoadPutTimeMs": {
"type": "int32",
"description": "Time to plan the load in milliseconds.",
"example": 20
},
"ReadDataTimeMs": {
"type": "int32",
"description": "Time to read data in milliseconds.",
"example": 120
},
"WriteDataTimeMs": {
"type": "int32",
"description": "Time to write data in milliseconds.",
"example": 200
},
"CommitAndPublishTimeMs": {
"type": "int32",
"description": "Time to commit and publish in milliseconds.",
"example": 5
},
"ErrorURL": {
"type": "string",
"description": "URL to retrieve error details when rows are filtered.",
"example": "http://doris-fe:8030/api/_load_error_log?file=error_log_abc"
}
}
}