diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index aa3d371d2e3..8b2999e41c5 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -383,7 +383,8 @@ amcostestimate (PlannerInfo *root, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, - double *indexCorrelation); + double *indexCorrelation, + double *indexPages); Estimate the costs of an index scan. This function is described fully in , below. @@ -1151,7 +1152,8 @@ amcostestimate (PlannerInfo *root, Cost *indexStartupCost, Cost *indexTotalCost, Selectivity *indexSelectivity, - double *indexCorrelation); + double *indexCorrelation, + double *indexPages); The first three parameters are inputs: @@ -1193,7 +1195,7 @@ amcostestimate (PlannerInfo *root, - The last four parameters are pass-by-reference outputs: + The last five parameters are pass-by-reference outputs: @@ -1232,6 +1234,15 @@ amcostestimate (PlannerInfo *root, + + + *indexPages + + + Set to number of index leaf pages + + + @@ -1279,6 +1290,11 @@ amcostestimate (PlannerInfo *root, table. + + The indexPages should be set to the number of leaf pages. + This is used to estimate the number of workers for parallel index scan. + + When loop_count is greater than one, the returned numbers should be averages expected for any one scan of the index.