ForeignKey 类

The ForeignKey object represents a SQL Server foreign key.

继承层次结构

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ForeignKey

命名空间：  Microsoft.SqlServer.Management.Smo
程序集：  Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
Public NotInheritable Class ForeignKey _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
用法
Dim instance As ForeignKey

public sealed class ForeignKey : ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode

public ref class ForeignKey sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode

[<SealedAttribute>]
type ForeignKey =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IDroppable 
        interface IMarkForDrop 
        interface IAlterable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
    end

public final class ForeignKey extends ScriptNameObjectBase implements ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode

ForeignKey 类型公开以下成员。

构造函数

	名称	说明
	ForeignKey()	Initializes a new instance of the ForeignKey class.
	ForeignKey(Table, String)	Initializes a new instance of the ForeignKey class on the specified table with the specified name.

页首

属性

	名称	说明
	Columns	Represents a collection of Column objects. Each Column object represents a column included in the foreign key.
	CreateDate	Gets the date and time when the foreign key was created.
	DateLastModified	Gets the date and time when the foreign key was last modified.
	DeleteAction	Gets or sets the action taken when the row that is referenced by the foreign key is deleted.
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the ForeignKey object.
	ID	Gets the ID value that uniquely identifies the foreign key.
	IsChecked	Gets or sets the Boolean property value that specifies whether the foreign key constraint was enabled without checking existing rows.
	IsEnabled	Gets or sets the Boolean property value that specifies whether the foreign key is enabled.
	IsFileTableDefined	Gets or sets whether the file table is defined.
	IsSystemNamed	Gets the Boolean property value that specifies whether the foreign key is named by the system or by the user.
	Name	Gets or sets the name of the foreign key. （覆盖 NamedSmoObject.Name。）
	NotForReplication	Gets the Boolean property value that specifies whether the foreign key is available for replication.
	Parent	Gets or sets the Table object that is the parent of the ForeignKey object.
	Properties	Gets a collection of Property objects that represent the object properties. （从 SqlSmoObject 继承。）
	ReferencedKey	Gets the primary key referenced by the foreign key.
	ReferencedTable	Gets or sets the table that contains the primary key referenced by the foreign key.
	ReferencedTableSchema	Gets or sets the table schema that contains the primary key referenced by the foreign key.
	ScriptReferencedTable	Gets or sets the Boolean value that specifies whether to script the table referenced by the foreign key.
	ScriptReferencedTableSchema	Gets or sets the Boolean value that specifies whether to script the schema of the table referenced by the foreign key.
	State	Gets the state of the referenced object. （从 SmoObjectBase 继承。）
	UpdateAction	Gets or sets the Boolean property value that specifies whether the foreign key supports cascading updates.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

	名称	说明
	Alter	Updates any ForeignKey object property changes on instance of SQL Server.
	Create	Creates a foreign key on the instance of SQL Server as defined by the ForeignKey object.
	Discover	Discovers a list of type Object. （从 SqlSmoObject 继承。）
	Drop	Drops the foreign key.
	Equals	（从 Object 继承。）
	FormatSqlVariant	Formats an object as SqlVariant type. （从 SqlSmoObject 继承。）
	GetContextDB	Gets the context database that is associated with this object. （从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetPropValue	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetServerObject	Gets the server of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetType	（从 Object 继承。）
	Initialize()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectInitialized	Verifies whether the object has been initialized. （从 SqlSmoObject 继承。）
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	MarkForDrop	Marks the foreign key to be dropped the next time its parent Table object is altered by the Alter method.
	Refresh	Refreshes the script name. （从 ScriptNameObjectBase 继承。）
	Rename	Renames the foreign key to the specified new name.
	Script()	Generates a Transact-SQL script that can be used to re-create the foreign key.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the foreign key as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. （从 SqlSmoObject 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	Validate	Validates the state of an object. （从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	Represents the event that occurs when a property is changed. （从 SqlSmoObject 继承。）
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. （从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObject.Discover	Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
	IAlienObject.GetDomainRoot	Returns the root of the domain. （从 SqlSmoObject 继承。）
	IAlienObject.GetParent	Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyType	Gets the type of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyValue	Gets the value of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。）
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. （从 SqlSmoObject 继承。）
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. （从 SqlSmoObject 继承。）
	IAlienObject.SetPropertyValue	Sets the property value. （从 SqlSmoObject 继承。）
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. （从 SqlSmoObject 继承。）
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. 标识为仅供参考。不提供支持。不保证以后的兼容性。

页首

注释

To get ForeignKey object properties, users can be a member of the public fixed server role.

To set ForeignKey object properties, users must have ALTER permission on the parent table or be a member of the db_owner fixed database role.

To create or drop a foreign key, users must have ALTER permission on the parent table or be a member of the db_owner fixed database role.

Thread Safety

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。但不保证所有实例成员都是线程安全的。

示例

创建、更改和删除外键

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo 命名空间

其他资源

创建、更改和删除外键

CREATE TABLE (Transact-SQL)