Export (0) Print
Expand All

ForeignKey Class

 

Applies To: SQL Server 2016 Preview

The ForeignKey object represents a SQL Server foreign key.

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


Public NotInheritable Class ForeignKey
	Inherits ScriptNameObjectBase
	Implements ISfcSupportsDesignMode, ICreatable, IDroppable, IMarkForDrop,
	IAlterable, IRenamable, IExtendedProperties, IScriptable

NameDescription
System_CAPS_pubmethodForeignKey()

Initializes a new instance of the ForeignKey class.

System_CAPS_pubmethodForeignKey(Table, String)

Initializes a new instance of the ForeignKey class on the specified table with the specified name.

NameDescription
System_CAPS_pubpropertyColumns

Represents a collection of Column objects. Each Column object represents a column included in the foreign key.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the foreign key was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the foreign key was last modified.

System_CAPS_pubpropertyDeleteAction

Gets or sets the action taken when the row that is referenced by the foreign key is deleted.

System_CAPS_pubpropertyExtendedProperties

Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the ForeignKey object.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the foreign key.

System_CAPS_pubpropertyIsChecked

Gets or sets the Boolean property value that specifies whether the foreign key constraint was enabled without checking existing rows.

System_CAPS_pubpropertyIsEnabled

Gets or sets the Boolean property value that specifies whether the foreign key is enabled.

System_CAPS_pubpropertyIsFileTableDefined

Gets or sets whether the file table is defined.

System_CAPS_pubpropertyIsSystemNamed

Gets the Boolean property value that specifies whether the foreign key is named by the system or by the user.

System_CAPS_pubpropertyName

Gets or sets the name of the foreign key.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyNotForReplication

Gets the Boolean property value that specifies whether the foreign key is available for replication.

System_CAPS_pubpropertyParent

Gets or sets the Table object that is the parent of the ForeignKey object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyReferencedKey

Gets the primary key referenced by the foreign key.

System_CAPS_pubpropertyReferencedTable

Gets or sets the table that contains the primary key referenced by the foreign key.

System_CAPS_pubpropertyReferencedTableSchema

Gets or sets the table schema that contains the primary key referenced by the foreign key.

System_CAPS_pubpropertyScriptReferencedTable

Gets or sets the Boolean value that specifies whether to script the table referenced by the foreign key.

System_CAPS_pubpropertyScriptReferencedTableSchema

Gets or sets the Boolean value that specifies whether to script the schema of the table referenced by the foreign key.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUpdateAction

Gets or sets the Boolean property value that specifies whether the foreign key supports cascading updates.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any ForeignKey object property changes on instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a foreign key on the instance of SQL Server as defined by the ForeignKey object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Drops the foreign key.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodMarkForDrop(Boolean)

Marks the foreign key to be dropped the next time its parent Table object is altered by the Alter method.

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String)

Renames the foreign key to the specified new name.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the foreign key.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the foreign key as specified by the script options. 

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object())

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetUrn()

Gets 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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

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.

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.

Return to top
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft