Plain-English SQL Query Explainer

{
  "type": "object",
  "required": [
    "sql"
  ],
  "properties": {
    "sql": {
      "type": "string",
      "description": "The raw SQL query text to explain, e.g. a SELECT with joins and filters."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "steps": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An ordered, plain-language breakdown of how the query executes."
    },
    "dialect": {
      "type": "string",
      "description": "The detected SQL dialect, e.g. 'postgres'. Observed on both fixtures."
    },
    "sql_length": {
      "type": "number",
      "description": "Character length of the submitted SQL text."
    },
    "explanation": {
      "type": "string",
      "description": "A plain-language paragraph summarizing what the query does."
    },
    "potential_issues": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Plain-language performance or correctness concerns spotted in the query."
    },
    "tables_referenced": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The table names the query reads from or joins against."
    },
    "optimization_suggestions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Concrete suggestions (e.g. indexes to add) to improve the query."
    }
  },
  "description": "The query-explanation result, as returned at routing.responseResultPath ($.output).",
  "additionalProperties": true
}