@ -385,7 +385,8 @@ amcostestimate (PlannerInfo *root,
Cost *indexStartupCost,
Cost *indexStartupCost,
Cost *indexTotalCost,
Cost *indexTotalCost,
Selectivity *indexSelectivity,
Selectivity *indexSelectivity,
double *indexCorrelation);
double *indexCorrelation,
double *indexPages);
</programlisting>
</programlisting>
Estimate the costs of an index scan. This function is described fully
Estimate the costs of an index scan. This function is described fully
in <xref linkend="index-cost-estimation"/>, below.
in <xref linkend="index-cost-estimation"/>, below.
@ -1155,7 +1156,8 @@ amcostestimate (PlannerInfo *root,
Cost *indexStartupCost,
Cost *indexStartupCost,
Cost *indexTotalCost,
Cost *indexTotalCost,
Selectivity *indexSelectivity,
Selectivity *indexSelectivity,
double *indexCorrelation);
double *indexCorrelation,
double *indexPages);
</programlisting>
</programlisting>
The first three parameters are inputs:
The first three parameters are inputs:
@ -1197,7 +1199,7 @@ amcostestimate (PlannerInfo *root,
</para>
</para>
<para>
<para>
The last four parameters are pass-by-reference outputs:
The last five parameters are pass-by-reference outputs:
<variablelist>
<variablelist>
<varlistentry>
<varlistentry>
@ -1236,6 +1238,15 @@ amcostestimate (PlannerInfo *root,
</para>
</para>
</listitem>
</listitem>
</varlistentry>
</varlistentry>
<varlistentry>
<term><parameter>*indexPages</parameter></term>
<listitem>
<para>
Set to number of index leaf pages
</para>
</listitem>
</varlistentry>
</variablelist>
</variablelist>
</para>
</para>
@ -1283,6 +1294,11 @@ amcostestimate (PlannerInfo *root,
table.
table.
</para>
</para>
<para>
The <parameter>indexPages</parameter> should be set to the number of leaf pages.
This is used to estimate the number of workers for parallel index scan.
</para>
<para>
<para>
When <parameter>loop_count</parameter> is greater than one, the returned numbers
When <parameter>loop_count</parameter> is greater than one, the returned numbers
should be averages expected for any one scan of the index.
should be averages expected for any one scan of the index.