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

SPI_cursor_open_with_paramlist

SPI_cursor_open_with_paramlist — ouvre un curseur en utilisant les paramètres

Synopsis

Portal SPI_cursor_open_with_paramlist(const char *name,
                                      SPIPlanPtr plan,
                                      ParamListInfo params,
                                      bool read_only)
                    

Description

SPI_cursor_open_with_paramlist prépare un curseur (en interne un portail), qui exécutera une requête préparée par SPI_prepare. Cette fonction est équivalente à SPI_cursor_open sauf que les informations sur les valeurs des paramètres passées à la requête sont présentées différemment. La représentation de ParamListInfo peut être utile pour fournir des valeurs déjà disponibles dans ce format. Elle supporte aussi l'utilisation d'ensemble de paramètres dynamiques via des fonctions spécifiées dans ParamListInfo.

Les données passées en paramètre seront copiées dans le portail du curseur et peuvent donc être libérées alors que le curseur existe toujours.

Arguments

const char * name

nom d'un portail ou NULL pour que le système en choisisse un lui-même

SPIPlanPtr plan

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

ParamListInfo params

structure de données contenant les types et valeurs de paramètres ; NULL sinon

bool read_only

true pour une exécution en lecture seule

Valeur de retour

Pointeur vers le portail contenant le curseur. Notez qu'il n'existe pas de convention pour le retour d'erreur ; toute erreur sera renvoyée via elog.