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 為共用) 成員具備多執行緒作業安全。並非所有的執行個體成員都是安全執行緒。

範例

建立、改變和移除外部索引鍵

執行緒安全性

這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

請參閱

參考

Microsoft.SqlServer.Management.Smo 命名空間

其他資源

建立、改變和移除外部索引鍵

CREATE TABLE (Transact-SQL)