@memberjunction/db-auto-doc 6.2.0-edge.2 → 6.2.0-edge.4

package/prompts/index-review.md

@@ -0,0 +1,60 @@
+You are a database performance expert reviewing index recommendations for one table on {{ platform }}.
+
+## Table: {{ table.schema }}.{{ table.name }} ({{ table.rowCount }} rows)
+{% if table.description %}**Description**: {{ table.description }}{% endif %}
+
+## Columns
+{% for c in columns %}
+- **{{ c.name }}** {{ c.dataType }}{% if c.distinctCount != null %}, {{ c.distinctCount }} distinct{% endif %}{% if c.nullPercentage != null %}, {{ c.nullPercentage }}% null{% endif %}{% if c.description %} — {{ c.description }}{% endif %}
+{% endfor %}
+
+## Existing indexes
+{% if existing.length %}{% for ix in existing %}
+- {{ ix.name }} ({{ ix.columns | join(", ") }}){% if ix.include.length %} INCLUDE ({{ ix.include | join(", ") }}){% endif %}{% if ix.isPrimaryKey %} [primary key]{% elif ix.isUnique %} [unique]{% endif %}{% if ix.filter %} WHERE {{ ix.filter }}{% endif %}
+{% endfor %}{% else %}
+(none)
+{% endif %}
+
+## Proposed indexes (from deterministic rules)
+{% if proposals.length %}{% for p in proposals %}
+{{ loop.index }}. ({{ p.columns | join(", ") }}) — {{ p.reason }}
+{% endfor %}{% else %}
+(none)
+{% endif %}
+
+{% if sampleQueries.length %}## Queries that use this table
+{% for q in sampleQueries %}
+### {{ q.name }}
+```sql
+{{ q.sql }}
+```
+{% endfor %}{% endif %}
+
+## Your task
+
+1. For each proposed index, decide **keep**, **drop** (not worth it: e.g. the column is rarely used to join or filter, or another index does the job) or **modify** (better as a composite index, or with INCLUDE columns that make it covering for the queries above).
+2. Suggest **additional** indexes only when there is clear evidence: columns the queries above filter, join, group or sort on, or obvious lookup columns (codes, emails, external IDs) on a large table. Prefer few, high-value indexes; every index slows writes.
+
+Rules:
+- Use only column names listed above, spelled exactly.
+- Put the most selective / equality-filtered column first in a composite index.
+- Do not suggest an index that an existing index already starts with.
+- Do not lead an index with a column that has very few distinct values or a large text/JSON type.
+- At most 5 key columns per index.
+
+## Response format
+
+Return only JSON, exactly in this shape (use empty arrays when you have nothing):
+
+```json
+{
+  "Decisions": [
+    { "Proposal": 1, "Action": "keep", "Reason": "…" },
+    { "Proposal": 2, "Action": "modify", "Columns": ["ColA", "ColB"], "IncludeColumns": ["ColC"], "Reason": "…" },
+    { "Proposal": 3, "Action": "drop", "Reason": "…" }
+  ],
+  "Additions": [
+    { "Columns": ["ColX"], "IncludeColumns": [], "Reason": "…" }
+  ]
+}
+```