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

SPI_register_relation

SPI_register_relation — rend une relation nommée éphémère disponible par son nom dans les requêtes SPI

Synopsis

int SPI_register_relation(EphemeralNamedRelation enr)
                              

Description

SPI_register_relation rends une relation nommée éphémère - tout comme son information associée - disponible aux requêtes planifiées et exécutées par la connexion SPI en cours.

Arguments

EphemeralNamedRelation enr

l'entrée du registre de la relation nommée éphémère

Valeur de retour

Si l'exécution de la commande a réussi, alors la valeur (non négative) suivante sera retournée :

SPI_OK_REL_REGISTER

si la relation a bien été enregistrée avec succès par son nom

En cas d'erreur, une des valeurs négatives suivantes sera retournée :

SPI_ERROR_ARGUMENT

si enr est NULL ou si son champ name est NULL

SPI_ERROR_UNCONNECTED

en cas d'appel par une fonction C non connectée

SPI_ERROR_REL_DUPLICATE

si le nom spécifié dans le champ name de enr est déjà enregistré pour cette connexion