diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/indexam.sgml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml index 80f55da87b3..a6e4466e8a1 100644 --- a/doc/src/sgml/indexam.sgml +++ b/doc/src/sgml/indexam.sgml @@ -396,7 +396,8 @@ amgettuple (IndexScanDesc scan, row), then on success it must also check <literal>scan->xs_want_itup</>, and if that is true it must return the original indexed data for the index entry, in the form of an - <structname>IndexTuple</> pointer stored at <literal>scan->xs_itup</>. + <structname>IndexTuple</> pointer stored at <literal>scan->xs_itup</>, + with tuple descriptor <literal>scan->xs_itupdesc</>. (Management of the data referenced by the pointer is the access method's responsibility. The data must remain good at least until the next <function>amgettuple</>, <function>amrescan</>, or <function>amendscan</> |