Retourne un jeu de résultats listant les index et statistiques d'une table

Description

function db2_statistics(
    resource $connection,
    ?string $qualifier,
    ?string $schema,
    string $table_name,
    bool $unique
): resource

Retourne un jeu de résultats listant les index et statistiques 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, il faut passer null ou une chaîne vide.
schema: Le schéma qui contient les tables visées. Si le paramètre est null, les statistiques et les index sont retournés pour le schéma de l'utilisateur en cours.
table_name: Le nom de la table.
unique: Quand unique est true, les informations relatives à tous les index de la table sont renvoyées. Sinon, seules les informations relatives aux index uniques de la table sont renvoyées.

Valeurs de retour

Retourne une ressource d'instruction avec un jeu de résultats contenant des lignes décrivant les statistiques et les index pour les tables de base correspondant aux paramètres spécifiés. Les lignes sont composées des colonnes suivantes :

Nom de la colonne Description

TABLE_CAT Le catalogue qui contient la table. La valeur est null si cette table n'a pas de catalogue.

TABLE_SCHEM Nom du schéma qui contient la table.

TABLE_NAME Nom de la table.

NON_UNIQUE

Un entier indiquant si l'index interdit les valeurs uniques ou si la ligne représente des statistiques sur la table elle-même :

Valeur de retour	Type de paramètre
0 (SQL_FALSE)	L'index autorise les valeurs dupliquées.
1 (SQL_TRUE)	Les valeurs de l'index doivent être uniques.
`null`	La ligne contient des informations statistiques à propos de la table.

INDEX_QUALIFIER Une chaîne de caractères représentant le qualificatif qui devrait être préfixé à INDEX_NAME pour qualifier complètement l'index.

INDEX_NAME Une chaîne représentant le nom de l'index.

TYPE

Un entier représentant le type d'informations contenues dans cette ligne du jeu de résultats :

Valeur de retour	Type de paramètre
0 (SQL_TABLE_STAT)	La ligne contient des informations statistiques à propos de la table.
1 (SQL_INDEX_CLUSTERED)	La ligne contient des informations à propos d'un index groupé.
2 (SQL_INDEX_HASH)	La ligne contient des informations à propos d'un index haché.
3 (SQL_INDEX_OTHER)	La ligne contient des informations à propos d'un type d'index qui n'est ni groupé ni haché.

ORDINAL_POSITION La position (commençant à 1) de la colonne dans l'index. null si la ligne contient des informations statistiques à propos de la table.

COLUMN_NAME Le nom de la colonne dans l'index. null si la ligne contient des informations statistiques à propos de la table.

ASC_OR_DESC A si la colonne est triée en ordre croissant, D si la colonne est triée en ordre décroissant, null si la ligne contient des informations statistiques à propos de la table.

CARDINALITY Si la ligne contient des informations à propos d'un index, cette colonne contiendra un entier représentant le nombre de valeurs uniques dans l'index. Si la ligne contient des informations à propos de la table, cette colonne contiendra un entier représentant le nombre de lignes dans la table.

PAGES Si la ligne contient des informations à propos d'un index, cette colonne contiendra un entier représentant le nombre de pages utilisées pour enregistrer l'index. Si la ligne contient des informations à propos de la table, cette colonne contiendra un entier représentant le nombre de pages utilisées pour enregistrer la table.

FILTER_CONDITION Retourne toujours 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_procedure_columns() - Retourne un jeu de résultats listant les paramètres de procédure stockée
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_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