Classe ForeignKey

The ForeignKey object represents a SQL Server foreign key.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

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

Le type ForeignKey expose les membres suivants.

Constructeurs

	Nom	Description
	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.

Haut de la page

Propriétés

	Nom	Description
	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. (remplace 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. (hérité de 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. (hérité de 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. (hérité de SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.)

Haut de la page

Méthodes

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

Haut de la page

Événements

	Nom	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

	Nom	Description
	IAlienObject.Discover	Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (hérité de SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (hérité de SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (hérité de SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identifié à titre d'information uniquement. Non pris en charge. La compatibilité future n'est pas garantie.

Haut de la page

Notes

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

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Exemples

Création, modification et suppression de clés étrangères

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo

Autres ressources

Création, modification et suppression de clés étrangères

CREATE TABLE (Transact-SQL)