Partage via

sp_fkeys (Transact-SQL)

  • Article

S’applique à : ENTREPÔT PDW (SQL Database) Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW) Dans Microsoft Fabric

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 Transact-SQL

Syntaxe

sp_fkeys
    [ [ @pktable_name = ] N'pktable_name' ]
    [ , [ @pktable_owner = ] N'pktable_owner' ]
    [ , [ @pktable_qualifier = ] N'pktable_qualifier' ]
    [ , [ @fktable_name = ] N'fktable_name' ]
    [ , [ @fktable_owner = ] N'fktable_owner' ]
    [ , [ @fktable_qualifier = ] N'fktable_qualifier' ]
[ ; ]

Arguments

[ @pktable_name = ] N’pktable_name'

Nom de la table, avec la clé primaire, utilisé pour retourner les informations du catalogue. @pktable_name est sysname, avec la valeur par défaut NULL. La correspondance des modèles génériques n’est pas prise en charge. Ce paramètre ou le paramètre @fktable_name , ou les deux, doit être fourni.

[ @pktable_owner = ] N’pktable_owner'

Nom du propriétaire de la table (avec la clé primaire) utilisé pour retourner les informations du catalogue. @pktable_owner est sysname, avec la valeur par défaut NULL. La correspondance des modèles génériques n’est pas prise en charge. Si @pktable_owner n’est pas spécifié, les règles de visibilité de table par défaut du système de gestion de base de données sous-jacent (SGBD) 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 @pktable_owner n’est pas spécifié et que l’utilisateur actuel ne possède pas de table avec la @pktable_name spécifiée, la procédure recherche une table avec le @pktable_name spécifié appartenant au propriétaire de la base de données. S'il en existe une, les colonnes de cette table sont retournées.

[ @pktable_qualifier = ] N’pktable_qualifier'

Nom de la table (avec la clé primaire) qualificateur. @pktable_qualifier est sysname, avec la valeur par défaut NULL. Différents produits SGBD prennent en charge la dénomination des tables en trois parties (qualifier.owner.name). Dans SQL Server, le qualificateur représente le nom de la base de données. Dans d'autres produits, elle représente le nom du serveur de l'environnement de base de données de la table.

[ @fktable_name = ] N’fktable_name'

Nom de la table (avec une clé étrangère) utilisée pour retourner les informations du catalogue. @fktable_name est sysname, avec la valeur par défaut NULL. La correspondance des modèles génériques n’est pas prise en charge. Ce paramètre ou le paramètre @pktable_name , ou les deux, doit être fourni.

[ @fktable_owner = ] N’fktable_owner'

Nom du propriétaire de la table (avec une clé étrangère) utilisé pour retourner les informations du catalogue. @fktable_owner est sysname, avec la valeur par défaut NULL. La correspondance des modèles génériques n’est pas prise en charge. Si @fktable_owner n’est pas spécifié, les règles de visibilité de table par défaut 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 @fktable_owner n’est pas spécifié et que l’utilisateur actuel ne possède pas de table avec le @fktable_name spécifié, la procédure recherche une table avec le @fktable_name spécifié appartenant au propriétaire de la base de données. S'il en existe une, les colonnes de cette table sont retournées.

[ @fktable_qualifier = ] N’fktable_qualifier'

Nom de la table (avec une clé étrangère) qualificateur. @fktable_qualifier est sysname, avec la valeur par défaut NULL. Dans SQL Server, le qualificateur représente le nom de la base de données. Dans d'autres produits, elle représente le nom du serveur de l'environnement de base de données de la table.

Valeurs des codes de retour

Aucune.

Jeu de résultats

Nom de la colonne Type de données Description
PKTABLE_QUALIFIER sysname Nom du qualificateur de la table (où figure la clé primaire). Ce champ peut être NULL.
PKTABLE_OWNER sysname Nom du propriétaire de la table (où figure la clé primaire). Ce champ retourne toujours une valeur.
PKTABLE_NAME sysname Nom de la table (contenant la clé primaire). Ce champ retourne toujours une valeur.
PKCOLUMN_NAME sysname Nom des colonnes clés primaires, pour chaque colonne du TABLE_NAME retour. Ce champ retourne toujours une valeur.
FKTABLE_QUALIFIER sysname Nom du qualificateur de la table (contenant une clé étrangère). Ce champ peut être NULL.
FKTABLE_OWNER sysname Nom du propriétaire de la table (contenant une clé étrangère). Ce champ retourne toujours une valeur.
FKTABLE_NAME sysname Nom de la table (contenant une clé étrangère). Ce champ retourne toujours une valeur.
FKCOLUMN_NAME sysname Nom de la colonne de clé étrangère, pour chaque colonne du TABLE_NAME retour. Ce champ retourne toujours une valeur.
KEY_SEQ smallint Numéro de séquence de la colonne dans une clé primaire multicolonne. Ce champ retourne toujours une valeur.
UPDATE_RULE smallint Action appliquée à la clé étrangère lorsque l'opération SQL est une mise à jour. Valeurs possibles :
0 = CASCADE modifications apportées à la clé étrangère.
1 = NO ACTION change si la clé étrangère est présente.
2 = SET_NULL
3 = Définir avec une valeur par défaut
DELETE_RULE smallint Action appliquée à la clé étrangère lorsque l'opération SQL est une suppression. Valeurs possibles :
0 = CASCADE modifications apportées à la clé étrangère.
1 = NO ACTION change si la clé étrangère est présente.
2 = SET_NULL
3 = définir la valeur par défaut
FK_NAME sysname Identificateur de clé étrangère. S’il n’est NULL pas applicable à la source de données. SQL Server retourne le nom de FOREIGN KEY la contrainte.
PK_NAME sysname Identificateur de clé primaire. S’il n’est NULL pas applicable à la source de données. SQL Server retourne le nom de PRIMARY KEY la contrainte.

Les résultats retournés sont classés par FKTABLE_QUALIFIER, FKTABLE_OWNER, FKTABLE_NAMEet KEY_SEQ.

Notes

Le codage d’application qui inclut des tables avec des clés étrangères désactivées peut être implémenté par les méthodes suivantes :

  • Désactivation temporaire de la vérification des contraintes (ALTER TABLE NOCHECK ou CREATE TABLE NOT FOR REPLICATION) lors de l’utilisation des tables, puis l’activation ultérieurement.

  • 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 fourni et que le nom de la table de clé étrangère est NULL, sp_fkeys retourne toutes les tables qui incluent une clé étrangère à la table donnée. Si le nom de la table de clé étrangère est fourni et que le nom de la table de clé primaire est NULL, sp_fkeys retourne toutes les tables associées par une relation clé primaire/clé étrangère aux clés étrangères dans la table de clés étrangères.

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

autorisations

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

Exemples

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

USE AdventureWorks2022;
GO

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

Exemples : Azure Synapse Analytics et Analytics Platform System (PDW)

L'exemple suivant extrait une liste de clés étrangères pour la table DimDate dans la base de données AdventureWorksPDW2012. Aucune ligne n’est retournée, car Azure Synapse Analytics ne prend pas en charge les clés étrangères.

EXEC sp_fkeys @pktable_name = N'DimDate';

Contenu connexe