db2_columns
(PECL ibm_db2:1.0-1.6.2)
db2_columns — Retourne un jeu de résultats listant les colonnes et ses métadonnées d'une table
Description
Retourne un jeu de résultats listant les colonnes et ses métadonnées d'une table.
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. Pour concorder avec tous les schémas, passez '%'.
- table-name
-
Le nom de la table. Pour obtenir toutes les tables dans la base de données, passez NULL ou une chaîne vide.
- column-name
-
Le nom de la colonne. Pour obtenir toutes les colonnes de la table, passez NULL ou une chaîne vide.
Valeurs de retour
Retourne une ressource avec le jeu de résultats contenant les lignes qui décrivent les privilèges des colonnes concordant avec les paramètres spécifiés. Les lignes sont composées des colonnes suivantes :
| Nom de la colonne | Description |
|---|---|
| TABLE_CAT | Nom du catalogue. La valeur est NULL si la table ne possède pas de catalogue. |
| TABLE_SCHEM | Nom du schéma. |
| TABLE_NAME | Nom de la table. |
| COLUMN_NAME | Nom de la colonne. |
| DATA_TYPE | Le type de données SQL pour la colonne, représenté comme un entier. |
| TYPE_NAME | Une chaîne représentant le type de données pour la colonne. |
| COLUMN_SIZE | Un entier représentant la grandeur de la colonne. |
| BUFFER_LENGTH | Nombre d'octets maximaux nécessaires pour enregistrer des données de cette colonne. |
| DECIMAL_DIGITS | L'échelle de la colonne 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 la colonne peut être nulle ou pas. |
| REMARKS | Description de la colonne. |
| COLUMN_DEF | Valeur par défaut de la colonne. |
| SQL_DATA_TYPE | Un entier représentant la grandeur de la colonne. |
| 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 de la colonne, 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 de la colonne commençant à 1 dans la table. |
| IS_NULLABLE | Une chaîne dont la valeur est 'YES' signifie que la colonne est nulle et 'NO' signifie que la colonne ne peut être nulle. |