Export (0) Print
Expand All

ForeignKey Class

The ForeignKey object represents a SQL Server foreign key.

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

'Declaration
Public NotInheritable Class ForeignKey _
	Inherits ScriptNameObjectBase _
	Implements ISfcSupportsDesignMode, ICreatable, IDroppable, IMarkForDrop,  _
	IAlterable, IRenamable, IExtendedProperties, IScriptable
'Usage
Dim instance As ForeignKey

The ForeignKey type exposes the following members.

  NameDescription
Public methodForeignKeyInitializes a new instance of the ForeignKey class.
Public methodForeignKey(Table, String)Initializes a new instance of the ForeignKey class on the specified table with the specified name.
Top

  NameDescription
Public propertyColumnsRepresents a collection of Column objects. Each Column object represents a column included in the foreign key.
Public propertyCreateDateGets the date and time when the foreign key was created.
Public propertyDateLastModifiedGets the date and time when the foreign key was last modified.
Public propertyDeleteActionGets or sets the action taken when the row that is referenced by the foreign key is deleted.
Public propertyExtendedPropertiesRepresents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the ForeignKey object.
Public propertyIDGets the ID value that uniquely identifies the foreign key.
Public propertyIsCheckedGets or sets the Boolean property value that specifies whether the foreign key constraint was enabled without checking existing rows.
Public propertyIsEnabledGets or sets the Boolean property value that specifies whether the foreign key is enabled.
Public propertyIsFileTableDefinedGets or sets whether the file table is defined.
Public propertyIsSystemNamedGets the Boolean property value that specifies whether the foreign key is named by the system or by the user.
Public propertyNameGets or sets the name of the foreign key. (Overrides NamedSmoObject.Name.)
Public propertyNotForReplicationGets the Boolean property value that specifies whether the foreign key is available for replication.
Public propertyParentGets or sets the Table object that is the parent of the ForeignKey object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public propertyReferencedKeyGets the primary key referenced by the foreign key.
Public propertyReferencedTableGets or sets the table that contains the primary key referenced by the foreign key.
Public propertyReferencedTableSchemaGets or sets the table schema that contains the primary key referenced by the foreign key.
Public propertyScriptReferencedTableGets or sets the Boolean value that specifies whether to script the table referenced by the foreign key.
Public propertyScriptReferencedTableSchemaGets or sets the Boolean value that specifies whether to script the schema of the table referenced by the foreign key.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyUpdateActionGets or sets the Boolean property value that specifies whether the foreign key supports cascading updates.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public methodAlterUpdates any ForeignKey object property changes on instance of SQL Server. 
Public methodCreateCreates a foreign key on the instance of SQL Server as defined by the ForeignKey object.
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Public methodDropDrops the foreign key.
Public methodEquals (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGetContextDBGets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeInitializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public methodMarkForDropMarks the foreign key to be dropped the next time its parent Table object is altered by the Alter method.
Public methodRefreshRefreshes the script name. (Inherited from ScriptNameObjectBase.)
Public methodRenameRenames the foreign key to the specified new name.
Public methodScriptGenerates a Transact-SQL script that can be used to re-create the foreign key.
Public methodScript(ScriptingOptions)Generates a Transact-SQL script that can be used to re-create the foreign key as specified by the script options. 
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate propertyISfcSupportsDesignMode.IsDesignModeGets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.
Top

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

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft