# db2_foreign_keys

(PECL ibm_db2 >= 1.0.0)

db2_foreign_keys — Retourne un jeu de résultats listant les clés étrangères d'une table

### Description

db2_foreign_keys(
resource `$connection`,
?string `$qualifier`,
?string `$schema`,
string `$table_name`
): resource

Retourne un jeu de résultats listant les clés étrangères 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. Si `schema` est `null`, db2_foreign_keys() fait concorder le schéma pour la connexion courante.

`table_name`

  Le nom de la table.

### Valeurs de retour

Retourne une ressource avec le jeu de résultats contenant des lignes décrivant les clés étrangères à la table spécifiée. Le jeu de résultats est composé des colonnes suivantes :

Nom de la colonne | Description
--- | ---
PKTABLE_CAT | Nom du catalogue de la table contenant la clé primaire. La valeur est `null` si la table n'a pas de catalogue.
PKTABLE_SCHEM | Nom du schéma de la table contenant la clé primaire.
PKTABLE_NAME | Nom de la table contenant la clé primaire.
PKCOLUMN_NAME | Nom de la colonne contenant la clé primaire.
FKTABLE_CAT | Nom du catalogue de la table contenant la clé étrangère. La valeur est `null` si la table n'a pas de catalogue.
FKTABLE_SCHEM | Nom du schéma de la table contenant la clé étrangère.
FKTABLE_NAME | Nom de la table contenant la clé étrangère.
FKCOLUMN_NAME | Nom de la colonne contenant la clé étrangère.
KEY_SEQ | Position commençant à 1 de la colonne dans la clé.
UPDATE_RULE | Entier représentant l'action appliquée à la clé étrangère lorsque une opération est de type UPDATE.
DELETE_RULE | Entier représentant l'action appliquée à la clé étrangère lorsque une opération est de type DELETE.
FK_NAME | Nom de la clé étrangère.
PK_NAME | Nom de la clé primaire.
DEFERRABILITY | Un entier représentant si le mode différé de la clé étrangère est SQL_INITIALLY_DEFERRED, SQL_INITIALLY_IMMEDIATE ou SQL_NOT_DEFERRABLE.

### Voir aussi

- db2_column_privileges() - Retourne un jeu de résultats listant les colonnes et ses privilèges d'une table
- db2_columns() - Retourne un jeu de résultats listant les colonnes et ses métadonnées d'une table
- db2_primary_keys() - Retourne un jeu de résultats listant les clés d'une table
- db2_procedure_columns() - Retourne un jeu de résultats listant les paramètres de procédure d'enregistrement
- db2_procedures() - Retourne un jeu de résultats listant les procédures d'enregistrement enregistrées dans la 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 leurs privilèges qui leur sont associées d'une base de données
- db2_tables() - Retourne la liste des tables et leurs métadonnées