Classe ForeignKey

The ForeignKey object represents a SQL Server foreign key.

Hierarquia de herança

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 (em Microsoft.SqlServer.Smo.dll)

Sintaxe

'Declaração
Public NotInheritable Class ForeignKey _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
'Uso
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

O tipo ForeignKey expõe os membros a seguir.

Construtores

	Nome	Descrição
	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.

Início

Propriedades

	Nome	Descrição
	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. (Substitui 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. (Herdado 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. (Herdado 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. (Herdado de SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.)

Início

Métodos

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

Início

Eventos

	Nome	Descrição
	PropertyChanged	Represents the event that occurs when a property is changed. (Herdado de SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Herdado de SqlSmoObject.)

Início

Implementações de interfaces explícitas

	Nome	Descrição
	IAlienObject.Discover	Discovers any dependencies. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Herdado de SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Herdado de SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Herdado de SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Herdado de SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Herdado de SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida.

Início

Comentários

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

Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.

Exemplos

Criando, alterando e removendo chaves estrangeiras

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Management.Smo

Outros recursos

Criando, alterando e removendo chaves estrangeiras

CREATE TABLE (Transact-SQL)