sp_fkeys (Transact-SQL)

Retourne des informations sur les clés étrangères logiques pour l'environnement actuel. Cette procédure montre les relations de clés étrangères comprenant des clés étrangères désactivées.

Conventions de la syntaxe de Transact-SQL

Syntaxe

sp_fkeys [ @pktable_name = ] 'pktable_name' 
     [ , [ @pktable_owner = ] 'pktable_owner' ] 
     [ , [ @pktable_qualifier = ] 'pktable_qualifier' ] 
     { , [ @fktable_name = ] 'fktable_name' } 
     [ , [ @fktable_owner = ] 'fktable_owner' ] 
     [ , [ @fktable_qualifier = ] 'fktable_qualifier' ]

Arguments

• [ @pktable\_name=\] 'pktable_name'
  Nom de la table, avec la clé primaire, utilisée pour retourner les informations de catalogue. pktable_name est de type sysname, avec NULL comme valeur par défaut. La recherche de correspondance avec des caractères génériques n'est pas prise en charge. Il faut spécifier ce paramètre, le paramètre fktable_name, ou les deux à la fois.

• [ @pktable\_owner=\] 'pktable_owner'
  Nom du propriétaire de la table (contenant la clé primaire) utilisée pour retourner les informations de catalogue. L'argument pktable_owner est de type sysname, avec la valeur NULL par défaut. La recherche de correspondance avec des caractères génériques n'est pas prise en charge. Si l'argument pktable_owner n'est pas spécifié, les règles définissant par défaut la visibilité des tables du SGBD sous-jacent s'appliquent.

  Dans SQL Server, si l'utilisateur actuel possède une table ayant le nom spécifié, ce sont les colonnes de cette table qui sont retournées. Si la valeur de pktable_owner n'est pas spécifiée et que l'utilisateur actuel ne possède pas de table avec la valeur pktable_name spécifiée, la procédure recherche une table avec la valeur pktable_name spécifiée qui est possédée par le propriétaire de la base de données. S'il en existe une, les colonnes de cette table sont retournées.

• [ @pktable\_qualifier =] 'pktable_qualifier'
  Nom du qualificateur de la table (où figure la clé primaire). pktable_qualifier est de type sysname, avec NULL comme valeur par défaut. Divers produits SGBD prennent en charge les noms de tables en trois parties (qualifier.owner.name). Dans SQL Server, le qualificateur représente le nom de la base de données. Dans certains produits, il représente le nom du serveur de l'environnement de base de données de la table.

• [ @fktable\_name=\] 'fktable_name'
  Nom de la table (contenant une clé étrangère) utilisée pour retourner les informations de catalogue. fktable_name est de type sysname, avec NULL comme valeur par défaut. La recherche de correspondance avec des caractères génériques n'est pas prise en charge. Il faut spécifier ce paramètre, le paramètre pktable_name, ou les deux à la fois.

• [ @fktable\_owner =] 'fktable_owner'
  Nom du propriétaire de la table (contenant une clé étrangère) utilisée pour retourner les informations de catalogue. fktable_owner est de type sysname, avec NULL comme valeur par défaut. La recherche de correspondance avec des caractères génériques n'est pas prise en charge. Si l'argument fktable_owner n'est pas spécifié, les règles définissant par défaut la visibilité des tables du SGBD sous-jacent s'appliquent.

  Dans SQL Server, si l'utilisateur actuel possède une table ayant le nom spécifié, ce sont les colonnes de cette table qui sont retournées. Si la valeur de fktable_owner n'est pas spécifiée et que l'utilisateur actuel ne possède pas de table avec la valeur fktable_name spécifiée, la procédure recherche une table avec la valeur fktable_name spécifiée qui est possédée par le propriétaire de la base de données. S'il en existe une, les colonnes de cette table sont retournées.

• [ @fktable\_qualifier= ] 'fktable_qualifier'
  Nom du qualificateur de la table (contenant une clé étrangère). fktable_qualifier est de type sysname, avec NULL comme valeur par défaut. Dans SQL Server, le qualificateur représente le nom de la base de données. Dans certains produits, il représente le nom du serveur de l'environnement de base de données de la table.

Valeurs des codes de retour

Aucune

Jeux de résultats

Les résultats obtenus sont triés parFKTABLE_QUALIFIER, FKTABLE_OWNER, FKTABLE_NAME et KEY_SEQ.

Notes

Si le code de votre application fait référence à des tables avec des clés étrangères désactivées, vous pouvez l'implémenter en utilisant l'une des méthodes suivantes :

• Désactiver temporairement la vérification des contraintes (ALTER TABLE NOCHECK ou CREATE TABLE NOT FOR REPLICATION) pendant que vous travaillez sur les tables, et la réactiver par la suite.

• Utiliser les déclencheurs ou le code de l'application pour assurer l'intégrité des relations.

Si le nom de la table de clé primaire est spécifié et que le nom de la table de clé étrangère est NULL, sp_fkeys retourne toutes les tables qui contiennent une clé étrangère faisant référence à la table donnée. Si le nom de la table de clé étrangère est spécifié et que le nom de la table de clé primaire est NULL, sp_fkeys retourne toutes les tables liées par une relation clé primaire/clé étrangère aux clés étrangères qui se trouvent dans la table de clé étrangère.

La procédure stockée sp_fkeys est équivalente à SQLForeignKeys dans ODBC.

Autorisations

Nécessite l'autorisation SELECT sur le schéma.

Exemple

L'exemple suivant extrait une liste de clés étrangères pour la table HumanResources.Department dans la base de données AdventureWorks2012.

USE AdventureWorks2012;
GO
EXEC sp_fkeys @pktable_name = N'Department'
    ,@pktable_owner = N'HumanResources';

Voir aussi

Référence

Procédures stockées de catalogue (Transact-SQL)

Procédures stockées système (Transact-SQL)

sp_pkeys (Transact-SQL)