Chapitre 39. Interface de programmation serveur

Table des matières
39.1. Fonctions d'interface
SPI_connect -- connecter une procédure au gestionnaire SPI
SPI_finish -- déconnecter une procédure du gestionnaire SPI
SPI_push -- pousse la pile SPI pour autoriser une utilisation récursive de SPI
SPI_pop -- récupère la pile SPI pour revenir de l'utilisation récursive de SPI
SPI_execute -- exécute une commande
SPI_exec -- exécute une commande en lecture/écriture
SPI_prepare -- prépare un plan pour une commande sans l'exécuter tout de suite
SPI_getargcount -- renvoie le nombre d'arguments nécessaires au plan préparé par SPI_prepare
SPI_getargtypeid -- renvoie l'OID du type de données pour un argument du plan préparé par SPI_prepare
SPI_is_cursor_plan -- renvoie true si le plan préparé par SPI_prepare peut être utilisé avec SPI_cursor_open
SPI_execute_plan -- exécute un plan préparé par SPI_prepare
SPI_execp -- exécute un plan en mode lecture/écriture
SPI_cursor_open -- met en place un curseur en utilisant un plan créé avec SPI_prepare
SPI_cursor_find -- recherche un curseur existant par nom
SPI_cursor_fetch -- extrait des lignes à partir d'un curseur
SPI_cursor_move -- déplace un curseur
SPI_cursor_close -- ferme un curseur
SPI_saveplan -- sauvegarde un plan
39.2. Fonctions de support d'interface
SPI_fname -- détermine le nom de colonne pour le numéro de colonne spécifié
SPI_fnumber -- détermine le numéro de colonne pour le nom de colonne spécifiée
SPI_getvalue -- renvoie la valeur de chaîne de la colonne spécifiée
SPI_getbinval -- retourne la valeur binaire de la colonne spécifiée
SPI_gettype -- retourne le nom du type de donnée de la colonne spécifiée
SPI_gettypeid -- retourne l'OID de type de donnée de la colonne spécifiée
SPI_getrelname -- retourne le nom de la relation spécifiée
39.3. Gestion de la mémoire
SPI_palloc -- alloue de la mémoire dans le contexte de mémoire courant
SPI_repalloc -- ré-alloue de la mémoire dans le contexte de mémoire courant
SPI_pfree -- libère de la mémoire dans le contexte de mémoire courant
SPI_copytuple -- effectue une copie d'une ligne dans le contexte de mémoire courant
SPI_returntuple -- prépare le renvoi d'une ligne en tant que Datum
SPI_modifytuple -- crée une ligne en remplaçant les champs sélectionnés d'une ligne donnée
SPI_freetuple -- libère une ligne allouée dans le contexte de mémoire courant
SPI_freetuptable -- libère une série de lignes créée par SPI_execute ou une fonction semblable
SPI_freeplan -- libère un plan sauvegardé auparavant
39.4. Visibilité des modifications de données
39.5. Exemples

L'interface de programmation serveur (SPI) donne aux auteurs de fonctions C la capacité de lancer des commandes SQL au sein de leurs fonctions. SPI est une série de fonctions d'interface simplifiant l'accès à l'analyseur, au planificateur, à l'optimiseur et au lanceur. SPI fait aussi de la gestion de mémoire.

Note : Les langages procéduraux disponibles donnent plusieurs moyens de lancer des commandes SQL à partir de procédures. La plupart est basée à partir de SPI. Cette documentation présente donc également un intérêt pour les utilisateurs de ces langages.

Pour assurer la compréhension, nous utiliserons le terme de << fonction >> quand nous parlerons de fonctions d'interface SPI et << procédure >> pour une fonction C définie par l'utilisateur et utilisant SPI.

Notez que si une commande appelée via SPI échoue, alors le contrôle ne sera pas redonné à votre procédure. Au contraire, la transaction ou sous-transaction dans laquelle est exécutée votre procédure sera annulée. (Ceci pourrait être surprenant étant donné que les fonctions SPI ont pour la plupart des conventions documentées de renvoi d'erreur. Ces conventions s'appliquent seulement pour les erreurs détectées à l'intérieur des fonctions SPI.) Il est possible de récupérer le contrôle après une erreur en établissant votre propre sous-transaction englobant les appels SPI qui pourraient échouer. Ceci n'est actuellement pas documenté parce que les mécanismes requis sont toujours en flux.

Les fonctions SPI renvoient un résultat positif en cas de succès (soit par une valeur de retour entière, soit dans la variable globale SPI_result comme décrit ci-dessous). En cas d'erreur, un résultat négatif ou NULL sera retourné.

Les fichiers de code source qui utilisent SPI doivent inclure le fichier d'en-tête executor/spi.h.

39.1. Fonctions d'interface

Table des matières
SPI_connect -- connecter une procédure au gestionnaire SPI
SPI_finish -- déconnecter une procédure du gestionnaire SPI
SPI_push -- pousse la pile SPI pour autoriser une utilisation récursive de SPI
SPI_pop -- récupère la pile SPI pour revenir de l'utilisation récursive de SPI
SPI_execute -- exécute une commande
SPI_exec -- exécute une commande en lecture/écriture
SPI_prepare -- prépare un plan pour une commande sans l'exécuter tout de suite
SPI_getargcount -- renvoie le nombre d'arguments nécessaires au plan préparé par SPI_prepare
SPI_getargtypeid -- renvoie l'OID du type de données pour un argument du plan préparé par SPI_prepare
SPI_is_cursor_plan -- renvoie true si le plan préparé par SPI_prepare peut être utilisé avec SPI_cursor_open
SPI_execute_plan -- exécute un plan préparé par SPI_prepare
SPI_execp -- exécute un plan en mode lecture/écriture
SPI_cursor_open -- met en place un curseur en utilisant un plan créé avec SPI_prepare
SPI_cursor_find -- recherche un curseur existant par nom
SPI_cursor_fetch -- extrait des lignes à partir d'un curseur
SPI_cursor_move -- déplace un curseur
SPI_cursor_close -- ferme un curseur
SPI_saveplan -- sauvegarde un plan