odbc_foreignkeys

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_foreignkeys — Liste les clés étrangères

Description

odbc_foreignkeys(
    resource $odbc,
    ?string $pk_catalog,
    string $pk_schema,
    string $pk_table,
    string $fk_catalog,
    string $fk_schema,
    string $fk_table
): resource|false

Liste les clés étrangères utilisées dans la table pk_table.

Liste de paramètres

odbc

L'identifiant de connexion ODBC, voir la documentation de la fonction odbc_connect() pour plus de détails.

fk_catalog

Le catalogue ('qualifier' en terminology ODBC 2) de la clé primaire de table.

pk_schema

Le schèma ('qualifier' en terminology ODBC 2) de la clé primaire de table.

pk_table

La clé primaire de la table The primary key table.

pk_catalog

Le catalogue ('qualifier' en terminology ODBC 2) de la clé étrangère de table.

fk_schema

Le schèma ('qualifier' en terminology ODBC 2) de la clé étrangère de table.

fk_table

La table de clé étrangère.

Valeurs de retour

Retourne un identifiant de résultat ODBC ou false si une erreur survient.

Le jeu de résultat contient les colonnes suivantes :

  • PKTABLE_CAT
  • PKTABLE_SCHEM
  • PKTABLE_NAME
  • PKCOLUMN_NAME
  • FKTABLE_CAT
  • FKTABLE_SCHEM
  • FKTABLE_NAME
  • FKCOLUMN_NAME
  • KEY_SEQ
  • UPDATE_RULE
  • DELETE_RULE
  • FK_NAME
  • PK_NAME
  • DEFERRABILITY
Les pilotes peuvent signaler des colonnes supplémentaires.

Si les clés étrangères associé avec une clé primaire sont demandées, le jeu de résultat est ordonné par FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME et KEY_SEQ. Si les clés primaire associé avec une clé étrangère sont demandées, le jeu de résultat est ordonné par PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME et KEY_SEQ.

Si pk_table contient un nom de table, odbc_foreignkeys() retourne la clé primaire de la table pk_table, et toutes les clés étrangères qui y font référence.

Si fk_table contient un nom de table, odbc_foreignkeys() retourne la liste des clés étrangères de la table fk_table, et les clés primaires (d'autres tables) qui y font référence.

Si pk_table et fk_table contiennent des noms de tables, odbc_foreignkeys() retourne la liste des clés étrangères de la table fk_table qui utilisent la clé primaire de la table pk_table. Cette liste devrait ne contenir qu'une clé au mieux.

Voir aussi