ForeignKey-Klasse

The ForeignKey object represents a SQL Server foreign key.

Vererbungshierarchie

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

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class ForeignKey _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
'Usage
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

Der ForeignKey-Typ macht folgende Elemente verfügbar.

Konstruktoren

	Name	Beschreibung
	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.

Zum Anfang

Eigenschaften

	Name	Beschreibung
	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. (Überschreibt 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. (Geerbt von 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. (Geerbt von 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. (Geerbt von SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Geerbt von SmoObjectBase.)

Zum Anfang

Methoden

	Name	Beschreibung
	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. (Geerbt von SqlSmoObject.)
	Drop	Drops the foreign key.
	Equals	(Geerbt von Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Geerbt von SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Geerbt von SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Geerbt von SqlSmoObject.)
	GetHashCode	(Geerbt von Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Geerbt von SqlSmoObject.)
	GetType	(Geerbt von Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Geerbt von SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Geerbt von SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Geerbt von 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. (Geerbt von 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. (Geerbt von SqlSmoObject.)
	ToString	Returns a String that represents the referenced object. (Geerbt von SqlSmoObject.)
	Validate	Validates the state of an object. (Geerbt von SmoObjectBase.)

Zum Anfang

Ereignisse

	Name	Beschreibung
	PropertyChanged	Represents the event that occurs when a property is changed. (Geerbt von SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Geerbt von SqlSmoObject.)

Zum Anfang

Explizite Schnittstellenimplementierungen

	Name	Beschreibung
	IAlienObject.Discover	Discovers any dependencies. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Geerbt von SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Geerbt von SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Geerbt von SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Verweisen Sie nicht direkt im Code auf dieses Element. Unterstützt die SQL Server-Infrastruktur. (Geerbt von SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Geerbt von SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Geerbt von SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Geerbt von SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Geerbt von SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Nur für Informationszwecke identifiziert. Nicht unterstützt. Zukünftige Kompatibilität wird nicht sichergestellt.

Zum Anfang

Hinweise

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

Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

Beispiele

Erstellen, Ändern und Löschen von Fremdschlüsseln

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.

Siehe auch

Verweis

Microsoft.SqlServer.Management.Smo-Namespace

Andere Ressourcen

Erstellen, Ändern und Löschen von Fremdschlüsseln

CREATE TABLE (Transact-SQL)