Rb Cafe » Postgres » Documentation PostgreSQL 13.10 » Programmation serveur » Interface de programmation serveur » Gestion de la mémoire » SPI_returntuple

SPI_returntuple

SPI_returntuple — prépare le renvoi d'une ligne en tant que Datum

Synopsis

HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

Description

SPI_returntuple crée une copie d'une ligne dans le contexte de l'exécuteur supérieur, la renvoyant sous la forme d'une ligne de type Datum. Le pointeur renvoyé a seulement besoin d'être converti en Datum via PointerGetDatum avant d'être renvoyé.

Cette fonction ne peut être utilisée que pendant une connexion SPI. Sinon, elle renvoie NULL et affecte SPI_ERROR_UNCONNECTED à SPI_result.

Notez que ceci devrait être utilisé pour les fonctions qui déclarent renvoyer des types composites. Ce n'est pas utilisé pour les déclencheurs ; utilisez SPI_copytuple pour renvoyer une ligne modifiée dans un déclencheur.

Arguments

HeapTuple row

ligne à copier

TupleDesc rowdesc

descripteur pour la ligne (passez le même descripteur chaque fois pour un cache plus efficace)

Valeur de retour

HeapTupleHeader pointant vers la ligne copiée ou NULL en cas d'erreur (voir SPI_result pour une indication sur l'erreur)