sp_foreignkeys (Transact-SQL)

適用対象: SQL サーバー

リンク サーバー内のテーブルの主キーを参照する外部キーを返します。

Transact-SQL 構文表記規則

構文

  
sp_foreignkeys [ @table_server = ] 'table_server'   
     [ , [ @pktab_name = ] 'pktab_name' ]   
     [ , [ @pktab_schema = ] 'pktab_schema' ]   
     [ , [ @pktab_catalog = ] 'pktab_catalog' ]   
     [ , [ @fktab_name = ] 'fktab_name' ]   
     [ , [ @fktab_schema = ] 'fktab_schema' ]   
     [ , [ @fktab_catalog = ] 'fktab_catalog' ]  

引数

[ @table_server = ] 'table_server' テーブル情報を返すリンク サーバーの名前を指定します。 table_server は sysname で、既定値はありません。

[ @pktab_name = ] 'pktab_name' 主キーを持つテーブルの名前を指定します。 pktab_name は sysname で、既定値は NULL です。

[ @pktab_schema = ] 'pktab_schema' 主キーを持つスキーマの名前を指定します。 pktab_schemaは sysname で、既定値は NULL です。 SQL Server では、これには所有者名が含まれます。

[ @pktab_catalog = ] 'pktab_catalog' 主キーを持つカタログの名前を指定します。 pktab_catalogis sysname,既定値は NULL です。 SQL Server では、これにはデータベース名が含まれます。

[ @fktab_name = ] 'fktab_name' 外部キーを持つテーブルの名前を指定します。 fktab_nameis sysname,既定値は NULL です。

[ @fktab_schema = ] 'fktab_schema' 外部キーを持つスキーマの名前を指定します。 fktab_schemais sysname,既定値は NULL です。

[ @fktab_catalog = ] 'fktab_catalog' 外部キーを持つカタログの名前を指定します。 fktab_catalogsysname で、既定値は NULL です。

リターン コードの値

なし

結果セット

さまざまな DBMS 製品では、テーブルの 3 つの部分から構成される名前付け (catalog.schema.table)、結果セットで表されます。

列名	データ型	説明
PKTABLE_CAT	sysname	主キーが設定されたテーブルのカタログです。
PKTABLE_SCHEM	sysname	主キーが設定されたテーブルのスキーマです。
PKTABLE_NAME	sysname	(主キーが設定された) テーブルの名前。 このフィールドには常に値が返されます。
PKCOLUMN_NAME	sysname	返される TABLE_NAME の各列の主キー列の名前。 このフィールドには常に値が返されます。
FKTABLE_CAT	sysname	外部キーが設定されたテーブルのカタログです。
FKTABLE_SCHEM	sysname	外部キーが設定されたテーブルのスキーマです。
FKTABLE_NAME	sysname	外部キーが設定されたテーブルの名前です。 このフィールドには常に値が返されます。
FKCOLUMN_NAME	sysname	返されたTABLE_NAMEの各列の外部キー列の名前。 このフィールドには常に値が返されます。
KEY_SEQ	smallint	複数列の主キーにおける列のシーケンス番号。 このフィールドには常に値が返されます。
UPDATE_RULE	smallint	SQL の操作が更新のときに外部キーに適用されるアクション。 SQL Server は、次の列に対して 0、1、または 2 を返します。 0 = 外部キーに対する CASCADE 変更。 1 = 外部キーが存在する場合は NO ACTION 変更。 2=SET_NULL: 外部キーを NULL に設定します。
DELETE_RULE	smallint	SQL の操作が削除のときに外部キーに適用されるアクション。 SQL Server は、次の列に対して 0、1、または 2 を返します。 0 = 外部キーに対する CASCADE 変更。 1 = 外部キーが存在する場合は NO ACTION 変更。 2=SET_NULL: 外部キーを NULL に設定します。
FK_NAME	sysname	外部キーの識別子。 データ ソースに適用されない場合は NULL になります。 SQL Server は、FOREIGN KEY 制約の名前を返します。
PK_NAME	sysname	主キーの識別子。 データ ソースに適用されない場合は NULL になります。 SQL Server は、PRIMARY KEY 制約の名前を返します。
遅延可能性	smallint	制約チェックが遅延可能かどうかを示します。

結果セットでは、FK_NAME列とPK_NAME列は常に NULL を返します。

解説

sp_foreignkeysは、table_serverに対応する OLE DB プロバイダーの IDBSchemaRowset インターフェイスのFOREIGN_KEYS行セットを照会します。 table_name、table_schema、table_catalog、および column パラメーターがこのインターフェイスに渡され、返される行が制限されます。

アクセス許可

スキーマに対する SELECT アクセス許可が必要です。

例

次の例では、リンク サーバー上のAdventureWorks2022 データベースのDepartment テーブルに関する外部キー情報を返Seattle1。

EXEC sp_foreignkeys @table_server = N'Seattle1',   
   @pktab_name = N'Department',   
   @pktab_catalog = N'AdventureWorks2022';  

参照

sp_catalogs (Transact-SQL)
sp_column_privileges (Transact-SQL)
sp_indexes (Transact-SQL)
sp_linkedservers (Transact-SQL)
sp_primarykeys (Transact-SQL)
sp_tables_ex (Transact-SQL)
sp_table_privileges (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)