ExplainTableQueryPlan¶

Description¶

      description: |
        Get the query execution plan for a query against table `id`.
        Returns a human-readable explanation of how the query will be executed.

Request Schema¶

    ExplainTableQueryPlanRequest:
      type: object
      required:
        - query
      properties:
        id:
          type: array
          items:
            type: string
        query:
          $ref: '#/components/schemas/QueryTableRequest'
        verbose:
          type: boolean
          default: false
          description: Whether to return verbose explanation

Response Schema¶

    ExplainTableQueryPlanResponse:
      type: object
      required:
        - plan
      properties:
        plan:
          type: string
          description: Human-readable query execution plan