Skip to content

feat: expose considered indexes #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
veksen wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: expose considered indexes #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/remote/optimization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export const LiveQueryOptimization = z.discriminatedUnion("state", [
costReductionPercentage: z.number(),
indexRecommendations: z.array(IndexRecommendation),
indexesUsed: z.array(z.string()),
consideredIndexes: z.array(IndexRecommendation).optional(),
explainPlan: z.custom<PostgresExplainStage>(),
optimizedExplainPlan: z.custom<PostgresExplainStage>(),
}),
Expand Down
8 changes: 8 additions & 0 deletions src/remote/query-optimizer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,7 @@ export class QueryOptimizer extends EventEmitter<EventMap> {
costReductionPercentage,
indexRecommendations,
indexesUsed,
consideredIndexes: mapConsideredIndexes(result),
explainPlan,
optimizedExplainPlan: result.explainPlan,
};
Expand Down Expand Up @@ -512,6 +513,7 @@ export class QueryOptimizer extends EventEmitter<EventMap> {
costReductionPercentage,
indexRecommendations,
indexesUsed,
consideredIndexes: mapConsideredIndexes(result),
explainPlan,
optimizedExplainPlan: result.explainPlan,
};
Expand Down Expand Up @@ -582,6 +584,12 @@ function mapIndexRecommandations(
});
}

function mapConsideredIndexes(
result: Extract<OptimizeResult, { kind: "ok" }>,
): IndexRecommendation[] {
return Array.from(result.triedIndexes.values());
}

type PercentageDifference = number;

export function costDifferencePercentage(
Expand Down