Forum und email

db2_procedure_columns

(PECL ibm_db2:1.0-1.6.2)

db2_procedure_columns — Retourne un jeu de résultats listant les paramètres de procédure d'enregistrement

Description

resource db2_procedure_columns ( resource $connection , string $qualifier , string $schema , string $procedure , string $parameter )

Retourne un jeu de résultats listant les paramètres pour une ou plusieurs procédures d'enregistrement.

Liste de paramètres

connection

Une connexion valide à une base de données IBM DB2, Cloudscape ou Apache Derby.

qualifier

Un qualificatif pour les bases de données DB2 qui fonctionnent sur les serveurs OS/390 ou z/OS. Pour les autres bases de données, passez NULL ou une chaîne vide.

schema

Le schéma qui contient les tables. Le paramètre accepte les formes contenant _ et % en tant que mot clé.

procedure

Le nom de la procédure. Le paramètre accepte les formes contenant _ et % en tant que mot clé.

parameter

Le nom du paramètre. Ce paramètre accepte un paramètre de recherche de forme contenant _ et % en tant que mot clé. Si ce paramètre est %null;, tous les paramètres pour la procédure d'enregistrement spécifiée sont retournés.

Valeurs de retour

Retourne une ressource avec le jeu de résultats contenant les lignes qui décrient les paramètres pour les procédures d'enregistrement qui concordent avec les paramètres spécifiés. Les lignes sont composées des colonnes suivantes :

Nom de la colonne Description
PROCEDURE_CAT Nom du catalogue que contient la table. La valeur est NULL si la table n'a pas de catalogue.
PROCEDURE_SCHEM Nom du schéma que contient la procédure d'enregistrement.
PROCEDURE_NAME Nom de la procédure.
COLUMN_NAME Nom du paramètre.
COLUMN_TYPE

Un entier représentant le type du paramètre :

Valeur de retour Type de paramètre
1 (SQL_PARAM_INPUT) Paramètre d'entrée (IN).
2 (SQL_PARAM_INPUT_OUTPUT) Paramètre d'entrée/sortie (INOUT).
3 (SQL_PARAM_OUTPUT) Paramètre d'entrée (OUT).

DATA_TYPE Le type de données SQL pour le paramètre représenté en tant qu'entier.
TYPE_NAME Une chaîne représentant le type de données pour le paramètre.
COLUMN_SIZE Un entier représentant la grandeur du paramètre.
BUFFER_LENGTH Nombre d'octets maximaux nécessaires pour enregistrer des données de ce paramètre.
DECIMAL_DIGITS L'échelle du paramètre ou NULL où l'échelle n'est pas applicable.
NUM_PREC_RADIX Un entier pouvant être 10 (représentant un type de données numérique exact), 2 (représentant un type de données numériques approximé) ou NULL (représentant un type de données pour lequel la base n'est pas applicable).
NULLABLE Un entier représentant si le paramètre peut être nul ou pas.
REMARKS Description du paramètre.
COLUMN_DEF Valeur par défaut du paramètre.
SQL_DATA_TYPE Un entier représentant la grandeur du paramètre.
SQL_DATETIME_SUB Retourne un entier représentant un code de sous-type datetime ou NULL si les types de données SQL n'appliquent pas.
CHAR_OCTET_LENGTH Grandeur maximale en octets pour les type de données d'un caractère du paramètre, qui concorde avec COLUMN_SIZE pour un seul octet de données ou NULL pour un type de données qui n'est pas des caractères.
ORDINAL_POSITION La position du paramètre commençant à 1 dans la requête CALL.
IS_NULLABLE Une chaîne dont la valeur est 'YES' signifie que le paramètre accepte ou retourne des valeurs NULL et 'NO' signifie que le paramètre n'accepte pas ou ne retourne pas de valeurs NULL.