odbc_tables
(PHP 4, PHP 5, PHP 7, PHP 8)
odbc_tables — Liste les tables d'une source
Description
Pour supporter les énumérations de qualificateurs
propriétaires et types de table, la sémantique suivante
pour les paramètres
catalog, schema,
table et
table_type est disponible :
-
Si
catalog est un signe de pourcentage (%),
et schema et table sont
des chaînes vides, alors le résultat contient la liste des
qualifiés valides pour la source (toutes les colonnes hormis
TABLE_QUALIFIER contiennent NULL).
-
Si
schema est un signe de pourcentage (%),
et catalog et table
sont des chaînes vides, alors le résultat contient la liste des
propriétaires de la source (toutes les colonnes hormis
TABLE_OWNER contiennent NULL).
-
Si
table_type est un signe de pourcentage (%),
et catalog, schema et
table sont des chaînes vides, alors le résultat
contient la liste des types de tables de la source (toutes les colonnes hormis
TABLE_TYPE contiennent NULL).
Liste de paramètres
odbc
-
L'objet de connexion ODBC,
voir la documentation de la fonction odbc_connect() pour plus
de détails.
catalog
-
Le catalogue ('calificatif' dans le jargon ODBC 2).
schema
-
Le schéma ('propriétaire' dans le jargon ODBC 2).
Ce paramètre accepte les masques de recherche suivants :
% pour chercher zéro ou plusieurs caractères, et _ pour chercher un seul caractère.
table
-
Le nom.
Ce paramètre accepte les masques de recherche suivants :
% pour chercher zéro ou plusieurs caractères, et _ pour chercher un seul caractère.
types
-
Si table_type n'est pas une chaîne vide,
il doit contenir une liste de valeurs, séparées par des virgules,
qui représentent les types recherchés. Chaque valeur peut être
insérée entre guillemets simples ('), ou sans guillemets. Par
exemple, 'TABLE','VIEW' ou TABLE, VIEW. Si la source de données
ne supporte pas un type de table donné, odbc_tables()
ne retournera aucun résultat pour ce type.
Valeurs de retour
Renvoie un objet de résultat ODBC contenant les informations
ou false si une erreur survient.
Le jeu de résultat contient les colonnes suivantes :
TABLE_CAT
TABLE_SCHEM
TABLE_NAME
TABLE_TYPE
REMARKS
Les pilotes peuvent signaler des colonnes supplémentaires.
Le jeu de résultat est ordonné par TABLE_TYPE, TABLE_CAT,
TABLE_SCHEM and TABLE_NAME.
Exemples
Exemple #1 Liste les Tables dans un Catalogue
<?php
$conn = odbc_connect($dsn, $user, $pass);
$tables = odbc_tables($conn, 'SalesOrders', 'dbo', '%', 'TABLE');
while (($row = odbc_fetch_array($tables))) {
print_r($row);
break; // further rows omitted for brevity
}
?>
Résultat de l'exemple ci-dessus est similaire à :
Array
(
[TABLE_CAT] => SalesOrders
[TABLE_SCHEM] => dbo
[TABLE_NAME] => Orders
[TABLE_TYPE] => TABLE
[REMARKS] =>
)