Rb Cafe » Postgres » Documentation PostgreSQL 13.10 » Programmation serveur » Interface de programmation serveur » Fonctions d'interface » SPI_is_cursor_plan

SPI_is_cursor_plan

SPI_is_cursor_plan — renvoie true si la requête préparée par SPI_prepare peut être utilisé avec SPI_cursor_open

Synopsis

bool SPI_is_cursor_plan(SPIPlanPtr plan)

Description

SPI_is_cursor_plan renvoie true si une requête préparée par SPI_prepare peut être passé comme un argument à SPI_cursor_open ou false si ce n'est pas le cas. Les critères sont que le plan représente une seule commande et que cette commande renvoit des lignes à l'appelant ; par l'exemple, SELECT est autorisé sauf s'il contient une clause INTO et UPDATE est autorisé seulement s'il contient un RETURNING

Arguments

SPIPlanPtr plan

requête préparée (renvoyée par SPI_prepare)

Valeur de retour

true ou false pour indiquer si plan peut produire un curseur ou non, avec SPI_result initialisé à zéro. S'il nest pas possible de déterminer la réponse (par exemple, si le plan vaut NULL ou est invalide, ou s'il est appelé en étant déconnecté de SPI), alors SPI_result est configuré avec un code d'erreur convenable et false est renvoyé.