Re: SPITupleTable members missing in docs

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Daniel Gustafsson <daniel(at)yesql(dot)se>
Cc: pgsql-docs(at)lists(dot)postgresql(dot)org
Subject: Re: SPITupleTable members missing in docs
Date: 2019-06-14 14:15:23
Views: Raw Message | Whole Thread | Download mbox | Resend email
Lists: pgsql-docs

Daniel Gustafsson <daniel(at)yesql(dot)se> writes:
> Commit 3d13623d75d3206c8f009353415043a191ebab39 added the next and subid fields
> to the SPITupleTable struct, but they never made it into the documentation.
> While these are internal members, we already document several other internal
> ones (with a sentence on not using them) so add these too to make the
> documentation match reality.

> Since this makes the number of internal members far outnumber the public ones,
> also reword the statement about which fields can be used to try and improve
> clarity.

I wonder if we should just show the public fields in the docs? Something

typedef struct
TupleDesc tupdesc; /* row descriptor */
HeapTuple *vals; /* rows */
} SPITupleTable;

(The struct contains additional fields that should not be touched
by users of SPI.)

Not wedded to that, but it would reduce the risks of future mistakes
of this same sort.

regards, tom lane

In response to


Browse pgsql-docs by date

  From Date Subject
Next Message Daniel Gustafsson 2019-06-14 14:40:51 Re: SPITupleTable members missing in docs
Previous Message Pavel Luzanov 2019-06-14 11:35:01 Re: ATTACH/DETACH partitions and locking