Skip to content

Commit 2edd612

Browse files
committed
Update indexam.sgml
1 parent c089ef7 commit 2edd612

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

postgresql/doc/src/sgml/indexam.sgml

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,8 @@ typedef struct IndexAmRoutine
139139
uint16 amstrategies;
140140
/* total number of support functions that this AM uses */
141141
uint16 amsupport;
142+
/* opclass options support function number or 0 */
143+
uint16 amoptsprocnum;
142144
/* does AM support ORDER BY indexed column's value? */
143145
bool amcanorder;
144146
/* does AM support ORDER BY result of an operator on indexed column? */
@@ -165,6 +167,10 @@ typedef struct IndexAmRoutine
165167
bool amcanparallel;
166168
/* does AM support columns included with clause INCLUDE? */
167169
bool amcaninclude;
170+
/* does AM use maintenance_work_mem? */
171+
bool amusemaintenanceworkmem;
172+
/* OR of parallel vacuum flags */
173+
uint8 amparallelvacuumoptions;
168174
/* type of data stored in index, or InvalidOid if variable */
169175
Oid amkeytype;
170176

@@ -210,6 +216,8 @@ typedef struct IndexAmRoutine
210216
uint16 amstrategies;
211217
/* total number of support functions that this AM uses */
212218
uint16 amsupport;
219+
/* opclass options support function number or 0 */
220+
uint16 amoptsprocnum;
213221
/* does AM support ORDER BY indexed column's value? */
214222
bool amcanorder;
215223
/* does AM support ORDER BY result of an operator on indexed column? */
@@ -236,6 +244,10 @@ typedef struct IndexAmRoutine
236244
bool amcanparallel;
237245
/* does AM support columns included with clause INCLUDE? */
238246
bool amcaninclude;
247+
/* does AM use maintenance_work_mem? */
248+
bool amusemaintenanceworkmem;
249+
/* OR of parallel vacuum flags */
250+
uint8 amparallelvacuumoptions;
239251
/* type of data stored in index, or InvalidOid if variable */
240252
Oid amkeytype;
241253

@@ -604,7 +616,7 @@ amcanreturn (Relation indexRelation, int attno);
604616
linkend="indexes-index-only-scans"><firstterm>index-only scans</firstterm></link> on
605617
the given column, by returning the indexed column values for an index entry
606618
in the form of an <structname>IndexTuple</structname>. The attribute number
607-
is 1-based, i.e. the first column's attno is 1. Returns true if supported,
619+
is 1-based, i.e., the first column's attno is 1. Returns true if supported,
608620
else false. If the access method does not support index-only scans at all,
609621
the <structfield>amcanreturn</structfield> field in its <structname>IndexAmRoutine</structname>
610622
struct can be set to NULL.
@@ -684,7 +696,7 @@ amoptions (ArrayType *reloptions,
684696
</programlisting>
685697
分析和验证一个索引的 reloptions 数组。仅当一个索引存在非空 reloptions 数组时才会被调用。<parameter>reloptions</parameter>是一个<type>text</type>数组,包含<replaceable>name</replaceable><literal>=</literal><replaceable>value</replaceable>形式的项。 该函数应当构建一个<type>bytea</type>值,该值将被拷贝进索引的 relcache 项的<structfield>rd_options</structfield>域。<type>bytea</type>值的数据内容是开放由访问方法定义的, 大部分的标准访问方法都使用<structname>StdRdOptions</structname>结构。当<parameter>validate</parameter>为真时,如果任何一个选项都不可识别或者含有非法值,该函数都应当报告一个适当的错误消息;当<parameter>validate</parameter>为假时,非法 项应该被安静地忽略(当正在载入的选项已经在<structname>pg_catalog</structname>中时, <parameter>validate</parameter>为假;仅在访问方法已经改变了选项的规则时才可能找 到非法项,并且在此情况下忽略废弃的项是合适的)。如果想要默认行为,那么返回 NULL 也 OK。
686698
</para>
687-
699+
688700
<!--==========================orignal english content==========================
689701
<para>
690702
<programlisting>
@@ -889,7 +901,7 @@ amgettuple (IndexScanDesc scan,
889901
will pass the caller's snapshot test. On success, <function>amgettuple</function>
890902
must also set <literal>scan-&gt;xs_recheck</literal> to true or false.
891903
False means it is certain that the index entry matches the scan keys.
892-
true means this is not certain, and the conditions represented by the
904+
True means this is not certain, and the conditions represented by the
893905
scan keys must be rechecked against the heap tuple after fetching it.
894906
This provision supports <quote>lossy</quote> index operators.
895907
Note that rechecking will extend only to the scan conditions; a partial
@@ -1025,7 +1037,7 @@ ammarkpos (IndexScanDesc scan);
10251037
</programlisting>
10261038
标记当前扫描位置。访问方法只需要支持每个扫描里面有一个被标记的扫描位置。
10271039
</para>
1028-
1040+
10291041
<!--==========================orignal english content==========================
10301042
<para>
10311043
The <function>ammarkpos</function> function need only be provided if the access

0 commit comments

Comments
 (0)