Files
mongo/jstests/libs/query/cbr_utils.js
Carlos Alonso 123232d155 SERVER-115402. Explain automaticCE planning (#46633)
GitOrigin-RevId: 84de07835c220df4235b4f82678ef643a10d8888
2026-01-21 11:15:46 +00:00

73 lines
2.1 KiB
JavaScript

/**
* Utilities for writing tests for the cost-based ranker (CBR).
*/
// Round the given number to the nearest 0.1
function round(num) {
return Math.round(num * 10) / 10;
}
// Compare two cardinality estimates with approximate equality. This is done so that our tests can
// be robust to floating point rounding differences but detect large changes in estimation
// indicating a real change in estimation behavior.
export function ceEqual(lhs, rhs) {
return Math.abs(round(lhs) - round(rhs)) < 0.1;
}
function planEstimateTypeIs(plan, type) {
return plan.estimatesMetadata.ceSource === type;
}
// Return true if the plan was estimated with a histogam estimation source. Return false otherwise.
export function planEstimatedWithHistogram(plan) {
return planEstimateTypeIs(plan, "Histogram");
}
/**
* Returns whether the given plan was costed or not.
*/
export function isPlanCosted(plan) {
return plan.hasOwnProperty("costEstimate");
}
/**
* Assert the given plan was not costed. This is used as an indicator to whether CBR used its
* fallback to multiplanning for this plan.
*/
export function assertPlanNotCosted(plan) {
assert(!isPlanCosted(plan), plan);
}
/**
* Assert the given plan was costed.
*/
export function assertPlanCosted(plan) {
assert(isPlanCosted(plan), plan);
}
export function getPlanRankerMode(db) {
if (db !== null) {
const getParam = db.adminCommand({
getParameter: 1,
planRankerMode: 1,
});
return getParam.hasOwnProperty("planRankerMode") ? getParam.planRankerMode : "multiPlanning";
} else {
return TestData.setParameters.planRankerMode ? TestData.setParameters.planRankerMode : "multiPlanning";
}
}
export function getMultiplanningBatchSize() {
const result = db.adminCommand({
getParameter: 1,
internalQueryPlanEvaluationMaxResults: 1,
});
if (result.ok === 1) {
return result.internalQueryPlanEvaluationMaxResults;
} else {
throw new Error("Failed to retrieve multiplanning batch size: " + JSON.stringify(result));
}
}