Retourne un jeu de résultats listant les paramètres de procédure stockée

Description

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

Retourne un jeu de résultats listant les paramètres pour une ou plusieurs procédures stockées.

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 procédures. Ce paramètre accepte un motif de recherche contenant _ et % en tant que caractères génériques.
procedure: Le nom de la procédure. Ce paramètre accepte un motif de recherche contenant _ et % en tant que caractères génériques.
parameter: Le nom du paramètre. Ce paramètre accepte un motif de recherche contenant _ et % en tant que caractères génériques. Si ce paramètre est null, tous les paramètres pour les procédures stockées spécifiées sont retournés.

Valeurs de retour

Retourne une ressource d'instruction avec un jeu de résultats contenant les lignes qui décrivent les paramètres pour les procédures stockées qui correspondent aux paramètres spécifiés. Les lignes sont composées des colonnes suivantes :

Nom de la colonne Description

PROCEDURE_CAT Le catalogue qui contient la procédure. La valeur est null si cette table n'a pas de catalogue.

PROCEDURE_SCHEM Nom du schéma qui contient la procédure stockée.

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 de sortie (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 taille du paramètre.

BUFFER_LENGTH Nombre maximal d'octets nécessaires pour stocker les données de ce paramètre.

DECIMAL_DIGITS L'échelle du paramètre, ou null lorsque 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érique approché) ou null (représentant un type de données pour lequel la base n'est pas applicable).

NULLABLE Un entier indiquant si le paramètre peut être nul ou non.

REMARKS Description du paramètre.

COLUMN_DEF Valeur par défaut du paramètre.

SQL_DATA_TYPE Un entier représentant la taille du paramètre.

SQL_DATETIME_SUB Retourne un entier représentant un code de sous-type datetime, ou null pour les types de données SQL auxquels cela ne s'applique pas.

CHAR_OCTET_LENGTH Longueur maximale en octets pour un paramètre de type de données caractère, qui correspond à COLUMN_SIZE pour les données d'un jeu de caractères mono-octet, ou null pour les types de données non caractères.

ORDINAL_POSITION La position du paramètre, indexée à partir de 1, dans l'instruction CALL.

IS_NULLABLE Une valeur de chaîne où 'YES' signifie que le paramètre accepte ou retourne des valeurs null, et 'NO' signifie que le paramètre n'accepte ou ne retourne pas de valeurs null.

Voir aussi

db2_column_privileges() - Retourne un jeu de résultats listant les colonnes et leurs privilèges d'une table
db2_columns() - Retourne un jeu de résultats listant les colonnes et leurs métadonnées d'une table
db2_foreign_keys() - Retourne un jeu de résultats listant les clés étrangères d'une table
db2_primary_keys() - Retourne un jeu de résultats listant les clés primaires d'une table
db2_procedures() - Retourne un jeu de résultats listant les procédures stockées enregistrées dans une base de données
db2_special_columns() - Retourne un jeu de résultats listant les identifiants uniques des lignes d'une table
db2_statistics() - Retourne un jeu de résultats listant les index et statistiques d'une table
db2_table_privileges() - Retourne un jeu de résultats listant les tables et les privilèges qui leur sont associés dans une base de données
db2_tables() - Retourne la liste des tables et leurs métadonnées