sp_primarykeys (Transact-SQL)

S'applique à : SQL Server

Retourne les colonnes de clés primaires, une ligne par colonne clé, pour la table distante spécifiée.

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_primarykeys
    [ @table_server = ] N'table_server'
    [ , [ @table_name = ] N'table_name' ]
    [ , [ @table_schema = ] N'table_schema' ]
    [ , [ @table_catalog = ] N'table_catalog' ]
[ ; ]

Arguments

[ @table_server = ] N’table_server'

Nom du serveur lié à partir duquel retourner les informations de clé primaire. @table_server est sysname, sans valeur par défaut.

[ @table_name = ] N'table_name'

Nom de la table pour laquelle fournir des informations de clé primaire. @table_name est sysname, avec la valeur par défaut NULL.

[ @table_schema = ] N’table_schema'

Schéma de table. @table_schema est sysname, avec la valeur par défaut NULL. Dans l’environnement SQL Server, cette valeur correspond au propriétaire de la table.

[ @table_catalog = ] N’table_catalog'

Nom du catalogue dans lequel réside le @table_name spécifié. @table_catalog est sysname, avec la valeur par défaut NULL. Dans l’environnement SQL Server, cette valeur correspond au nom de la base de données.

Valeurs des codes de retour

Aucune.

Jeu de résultats

Nom de la colonne Type de données Description
TABLE_CAT sysname Catalogue de la table
TABLE_SCHEM sysname Schéma de la table
TABLE_NAME sysname Nom de la table.
COLUMN_NAME sysname Nom de la colonne.
KEY_SEQ int Numéro de séquence de la colonne dans une clé primaire multicolonne.
PK_NAME sysname Identificateur de clé primaire. Retourne NULL si elle n’est pas applicable à la source de données.

Notes

sp_primarykeys est exécuté en interrogeant l’ensemble PRIMARY_KEYS de lignes de l’interface IDBSchemaRowset du fournisseur OLE DB correspondant à @table_server. Les paramètres sont passés à cette interface pour restreindre les lignes retournées.

sp_primarykeys retourne un jeu de résultats vide si le fournisseur OLE DB du serveur lié spécifié ne prend pas en charge l’ensemble PRIMARY_KEYS de lignes de l’interface IDBSchemaRowset .

autorisations

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

Exemples

L'exemple suivant retourne des colonnes de clé primaires du serveur LONDON1 pour la table HumanResources.JobCandidate dans la base de données AdventureWorks2022.

EXEC sp_primarykeys @table_server = N'LONDON1',
    @table_name = N'JobCandidate',
    @table_catalog = N'AdventureWorks2022',
    @table_schema = N'HumanResources';