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
Método público ForeignKey() Initializes a new instance of the ForeignKey class.
Método público 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
Propriedade pública Columns Represents a collection of Column objects. Each Column object represents a column included in the foreign key.
Propriedade pública CreateDate Gets the date and time when the foreign key was created.
Propriedade pública DateLastModified Gets the date and time when the foreign key was last modified.
Propriedade pública DeleteAction Gets or sets the action taken when the row that is referenced by the foreign key is deleted.
Propriedade pública ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property on the ForeignKey object.
Propriedade pública ID Gets the ID value that uniquely identifies the foreign key.
Propriedade pública IsChecked Gets or sets the Boolean property value that specifies whether the foreign key constraint was enabled without checking existing rows.
Propriedade pública IsEnabled Gets or sets the Boolean property value that specifies whether the foreign key is enabled.
Propriedade pública IsFileTableDefined Gets or sets whether the file table is defined.
Propriedade pública IsSystemNamed Gets the Boolean property value that specifies whether the foreign key is named by the system or by the user.
Propriedade pública Name Gets or sets the name of the foreign key. (Substitui NamedSmoObject.Name.)
Propriedade pública NotForReplication Gets the Boolean property value that specifies whether the foreign key is available for replication.
Propriedade pública Parent Gets or sets the Table object that is the parent of the ForeignKey object.
Propriedade pública Properties Gets a collection of Property objects that represent the object properties. (Herdado de SqlSmoObject.)
Propriedade pública ReferencedKey Gets the primary key referenced by the foreign key.
Propriedade pública ReferencedTable Gets or sets the table that contains the primary key referenced by the foreign key.
Propriedade pública ReferencedTableSchema Gets or sets the table schema that contains the primary key referenced by the foreign key.
Propriedade pública ScriptReferencedTable Gets or sets the Boolean value that specifies whether to script the table referenced by the foreign key.
Propriedade pública ScriptReferencedTableSchema Gets or sets the Boolean value that specifies whether to script the schema of the table referenced by the foreign key.
Propriedade pública State Gets the state of the referenced object. (Herdado de SmoObjectBase.)
Propriedade pública UpdateAction Gets or sets the Boolean property value that specifies whether the foreign key supports cascading updates.
Propriedade pública Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Herdado de SqlSmoObject.)
Propriedade pública UserData Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.)

Início

Métodos

  Nome Descrição
Método público Alter Updates any ForeignKey object property changes on instance of SQL Server. 
Método público Create Creates a foreign key on the instance of SQL Server as defined by the ForeignKey object.
Método público Discover Discovers a list of type Object. (Herdado de SqlSmoObject.)
Método público Drop Drops the foreign key.
Método público Equals (Herdado de Object.)
Método protegido FormatSqlVariant Formats an object as SqlVariant type. (Herdado de SqlSmoObject.)
Método protegido GetContextDB Gets the context database that is associated with this object. (Herdado de SqlSmoObject.)
Método protegido GetDBName Gets the database name that is associated with the object. (Herdado de SqlSmoObject.)
Método público GetHashCode (Herdado de Object.)
Método protegido GetPropValue Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptional Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método protegido GetServerObject Gets the server of the SqlSmoObject object. (Herdado de SqlSmoObject.)
Método público GetType (Herdado de Object.)
Método público Initialize() Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método público Initialize(Boolean) Initializes the object and forces the properties be loaded. (Herdado de SqlSmoObject.)
Método protegido IsObjectInitialized Verifies whether the object has been initialized. (Herdado de SqlSmoObject.)
Método protegido IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Herdado de SqlSmoObject.)
Método público MarkForDrop Marks the foreign key to be dropped the next time its parent Table object is altered by the Alter method.
Método público Refresh Refreshes the script name. (Herdado de ScriptNameObjectBase.)
Método público Rename Renames the foreign key to the specified new name.
Método público Script() Generates a Transact-SQL script that can be used to re-create the foreign key.
Método público Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the foreign key as specified by the script options. 
Método protegido SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Herdado de SqlSmoObject.)
Método público ToString Returns a String that represents the referenced object. (Herdado de SqlSmoObject.)
Método público Validate Validates the state of an object. (Herdado de SmoObjectBase.)

Início

Eventos

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

Início

Implementações de interfaces explícitas

  Nome Descrição
Implementações de interfaces explícitasMétodo privado IAlienObject.Discover Discovers any dependencies. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetDomainRoot Returns the root of the domain. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado 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.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyType Gets the type of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.GetPropertyValue Gets the value of the specified property. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado 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.)
Implementações de interfaces explícitasMétodo privado IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado IAlienObject.SetPropertyValue Sets the property value. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasMétodo privado ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Herdado de SqlSmoObject.)
Implementações de interfaces explícitasPropriedade privada 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)