Apache Kylin · Schema

QueryResponse

SQL query response

AnalyticsBig DataCubeOLAPOpen SourceSQL

Properties

Name Type Description
columnMetas array Result column metadata
results array Query result rows
queryId string
isException boolean
exceptionMessage string
duration integer Query duration in milliseconds
totalScanCount integer
totalScanBytes integer
hitExceptionCache boolean
storageCacheUsed boolean
View JSON Schema on GitHub

JSON Schema

rest-api-query-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-kylin/refs/heads/main/json-schema/rest-api-query-response-schema.json",
  "title": "QueryResponse",
  "description": "SQL query response",
  "type": "object",
  "properties": {
    "columnMetas": {
      "type": "array",
      "description": "Result column metadata",
      "items": {
        "type": "object"
      }
    },
    "results": {
      "type": "array",
      "description": "Query result rows",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "queryId": {
      "type": "string",
      "example": "query-1234"
    },
    "isException": {
      "type": "boolean",
      "example": false
    },
    "exceptionMessage": {
      "type": "string"
    },
    "duration": {
      "type": "integer",
      "description": "Query duration in milliseconds",
      "example": 120
    },
    "totalScanCount": {
      "type": "integer",
      "example": 10000
    },
    "totalScanBytes": {
      "type": "integer",
      "example": 409600
    },
    "hitExceptionCache": {
      "type": "boolean",
      "example": false
    },
    "storageCacheUsed": {
      "type": "boolean",
      "example": false
    }
  }
}