Clarify the distinction between public and private SPITupleTable fields.
authorTom Lane <tgl@sss.pgh.pa.us>
Wed, 17 Jul 2019 18:55:13 +0000 (14:55 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Wed, 17 Jul 2019 18:55:13 +0000 (14:55 -0400)
commitfec0778c8098cebec2d5cb3674ac7151d8d95638
tree49321b12298360ff7772d51ff5193565561fac3e
parent860c095fd548cd25586e4273e9b489082b4ffa13
Clarify the distinction between public and private SPITupleTable fields.

The fields that we consider public are "tupdesc" and "vals", which
historically are in the middle of the struct.  Move them to the front
(this should be perfectly safe to do in HEAD) and add comments to make
it quite clear which fields are public or not.

Also adjust spi.sgml's documentation of the struct to match.
That doc had bit-rotted somewhat, as it was missing some fields.
(Arguably we should just remove all the private fields from the docs,
but for now I refrained.)

Daniel Gustafsson, reviewed by Fabien Coelho

Discussion: https://postgr.es/m/0D19F836-B743-4340-B6A2-F148CA3DD1F0@yesql.se
doc/src/sgml/spi.sgml
src/include/executor/spi.h