Apache Kylin Query API

openapi: 3.0.3
info:
  title: Apache Kylin REST Authentication Query API
  description: REST API for Apache Kylin OLAP engine providing SQL queries, model management, cube management, job management, and project administration.
  version: 5.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    email: dev@kylin.apache.org
servers:
- url: http://localhost:7070/kylin/api
  description: Apache Kylin server
security:
- basicAuth: []
tags:
- name: Query
  description: SQL query execution
paths:
  /query:
    post:
      operationId: executeQuery
      summary: Apache kylin Apache Kylin Execute Query
      description: Execute a SQL query against a Kylin project.
      tags:
      - Query
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
            examples:
              executeQueryRequestExample:
                summary: Default executeQuery request
                x-microcks-default: true
                value:
                  sql: SELECT count(*) FROM kylin_sales
                  project: learn_kylin
                  offset: 0
                  limit: 50000
                  acceptPartial: true
      responses:
        '200':
          description: Query results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResponse'
              examples:
                executeQuery200Example:
                  summary: Default executeQuery 200 response
                  x-microcks-default: true
                  value:
                    columnMetas: []
                    results: []
                    queryId: query-1234
                    isException: false
                    exceptionMessage: example-value
                    duration: 120
                    totalScanCount: 10000
                    totalScanBytes: 409600
                    hitExceptionCache: false
                    storageCacheUsed: false
        '400':
          description: Invalid SQL query
  /query/async:
    post:
      operationId: executeAsyncQuery
      summary: Apache kylin Apache Kylin Execute Async Query
      description: Execute an asynchronous SQL query against a Kylin project.
      tags:
      - Query
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryRequest'
            examples:
              executeAsyncQueryRequestExample:
                summary: Default executeAsyncQuery request
                x-microcks-default: true
                value:
                  sql: SELECT count(*) FROM kylin_sales
                  project: learn_kylin
                  offset: 0
                  limit: 50000
                  acceptPartial: true
      responses:
        '200':
          description: Query job ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  queryId:
                    type: string
                    example: query-1234
              examples:
                executeAsyncQuery200Example:
                  summary: Default executeAsyncQuery 200 response
                  x-microcks-default: true
                  value:
                    queryId: query-1234
components:
  schemas:
    QueryRequest:
      type: object
      description: SQL query request
      required:
      - sql
      - project
      properties:
        sql:
          type: string
          description: SQL query to execute
          example: SELECT count(*) FROM kylin_sales
        project:
          type: string
          description: Project name to query
          example: learn_kylin
        offset:
          type: integer
          description: Result offset for pagination
          example: 0
        limit:
          type: integer
          description: Maximum number of results
          example: 50000
        acceptPartial:
          type: boolean
          description: Accept partial results if query times out
          example: true
    QueryResponse:
      type: object
      description: SQL query response
      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
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic