sys.foreign_keys (Transact-SQL)

Applies to: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW) Warehouse in Microsoft Fabric SQL database in Microsoft Fabric

Contains a row per object that is a FOREIGN KEY constraint, with sys.object.type = F.

Column name	Data type	Description
<Columns inherited from sys.objects>		For a list of columns that this view inherits, see sys.objects (Transact-SQL).
referenced_object_id	int	ID of the referenced object.
key_index_id	int	ID of the key index within the referenced object.
is_disabled	bit	FOREIGN KEY constraint is disabled.
is_not_for_replication	bit	FOREIGN KEY constraint was created by using the NOT FOR REPLICATION option.
is_not_trusted	bit	FOREIGN KEY constraint has not been verified by the system.
delete_referential_action	tinyint	The referential action that was declared for this FOREIGN KEY when a delete happens. 0 = No action 1 = Cascade 2 = Set null 3 = Set default
delete_referential_action_desc	nvarchar(60)	Description of the referential action that was declared for this FOREIGN KEY when a delete occurs: NO_ACTION CASCADE SET_NULL SET_DEFAULT
update_referential_action	tinyint	The referential action that was declared for this FOREIGN KEY when an update happens. 0 = No action 1 = Cascade 2 = Set null 3 = Set default
update_referential_action_desc	nvarchar(60)	Description of the referential action that was declared for this FOREIGN KEY when an update happens: NO_ACTION CASCADE SET_NULL SET_DEFAULT
is_system_named	bit	1 = Name was generated by the system. 0 = Name was supplied by the user.

Permissions

The visibility of the metadata in catalog views is limited to securables that a user either owns, or on which the user was granted some permission. For more information, see Metadata Visibility Configuration.

See Also

Catalog Views (Transact-SQL)
Object Catalog Views (Transact-SQL)
Querying the SQL Server System Catalog FAQ