Prisma · Schema

Prisma Optimize Query Recommendation

An AI-powered query optimization recommendation generated by Prisma Optimize. Recommendations analyze recorded query patterns and suggest specific improvements to reduce database load, improve response times, and optimize resource utilization. Categories include indexing suggestions, query restructuring, caching strategies, N+1 query detection, and select optimization.

Properties

Name	Type	Description
id	string	Unique identifier for the recommendation
severity	string	Severity level indicating the urgency and potential impact of the recommendation
category	string	Category of the optimization recommendation
title	string	Short title summarizing the recommendation
description	string	Detailed explanation of the performance issue identified and the recommended fix with rationale
affectedQueries	array	Identifiers of recorded queries that this recommendation applies to
suggestedAction	string	Specific code change, schema modification, or configuration update to implement the recommendation
estimatedImpact	string	Expected performance improvement if the recommendation is implemented
relatedDocumentation	string	Link to relevant Prisma documentation for the recommended optimization

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://prisma.io/schemas/query-recommendation.json",
  "title": "Prisma Optimize Query Recommendation",
  "description": "An AI-powered query optimization recommendation generated by Prisma Optimize. Recommendations analyze recorded query patterns and suggest specific improvements to reduce database load, improve response times, and optimize resource utilization. Categories include indexing suggestions, query restructuring, caching strategies, N+1 query detection, and select optimization.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the recommendation"
    },
    "severity": {
      "type": "string",
      "description": "Severity level indicating the urgency and potential impact of the recommendation",
      "enum": ["critical", "warning", "info"]
    },
    "category": {
      "type": "string",
      "description": "Category of the optimization recommendation",
      "enum": [
        "indexing",
        "query_structure",
        "caching",
        "select_optimization",
        "n_plus_one",
        "batch_operation",
        "connection_management"
      ]
    },
    "title": {
      "type": "string",
      "description": "Short title summarizing the recommendation",
      "maxLength": 200,
      "examples": [
        "Add index on User.email for faster lookups",
        "N+1 query detected in Post.comments loading",
        "Use select to reduce data transfer for User queries"
      ]
    },
    "description": {
      "type": "string",
      "description": "Detailed explanation of the performance issue identified and the recommended fix with rationale"
    },
    "affectedQueries": {
      "type": "array",
      "description": "Identifiers of recorded queries that this recommendation applies to",
      "items": {
        "type": "string"
      }
    },
    "suggestedAction": {
      "type": "string",
      "description": "Specific code change, schema modification, or configuration update to implement the recommendation",
      "examples": [
        "Add @@index([email]) to the User model in your Prisma schema",
        "Use include: { comments: true } instead of separate queries"
      ]
    },
    "estimatedImpact": {
      "type": "string",
      "description": "Expected performance improvement if the recommendation is implemented",
      "enum": ["high", "medium", "low"]
    },
    "relatedDocumentation": {
      "type": "string",
      "format": "uri",
      "description": "Link to relevant Prisma documentation for the recommended optimization"
    }
  },
  "required": ["id", "severity", "category", "title", "description"],
  "additionalProperties": false
}