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. | |
ExecuteForScalar | Obtém ou define o valor da propriedade Boolean que especifica se o objeto esta definido para a opção execute for scalar. (Herdado de SqlSmoObject.) | |
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. | |
IsSystemNamed | Gets the Boolean property value that specifies whether the foreign key is named by the system or by the user. | |
IsTouched | Obtém o valor da propriedade Boolean que especifica se as propriedades do objeto foram atualizadas, mas ainda não foram persistidas no servidor. (Herdado de SqlSmoObject.) | |
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. | |
ObjectInSpace | Obtém o valor da propriedade Boolean que especifica se o objeto existe em isolamento ou se está direta ou indiretamente conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
Parent | Gets or sets the Table object that is the parent of the ForeignKey object. | |
Properties | Obtém uma coleção de objetos Property que representam as propriedades do objeto. (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. | |
ScalarResult | Obtém o resultado escalar do objeto referenciado. (Herdado de SqlSmoObject.) | |
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 | Obtém o valor do endereço do URN (Uniform Resource Name) que identifica exclusivamente o objeto. (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 | |
---|---|---|
AddDatabaseContext(StringCollection) | Adiciona o contexto do banco de dados à coleção de consultas identificadas pelo parâmetro queries. (Herdado de SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Adiciona o contexto de banco de dados à coleção de consultas identificadas pelo parâmetro queries e usando as opções de script especificadas. (Herdado de SqlSmoObject.) | |
Alter | Updates any ForeignKey object property changes on instance of SQL Server. | |
AlterImpl | Ativa o evento alterado do objeto. (Herdado de SqlSmoObject.) | |
AlterImplFinish | Método chamado quando o evento alterado do objeto é concluído. (Herdado de SqlSmoObject.) | |
AlterImplInit | Método chamado quando o evento de alteração do objeto é inicializado. (Herdado de SqlSmoObject.) | |
AlterImplWorker | Chama os métodos Alter. (Herdado de SqlSmoObject.) | |
AppendCommaText | Appends text, optionally separated by a comma. (Herdado de ScriptNameObjectBase.) | |
AppendWithCommaText | Appends text, optionally separated by a comma. (Herdado de ScriptNameObjectBase.) | |
AppendWithOption | Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Herdado de ScriptNameObjectBase.) | |
AutoGenerateName | Generates a name based on the object Guid. (Herdado de ScriptNameObjectBase.) | |
BindDefaultImpl | Associa os itens padrão identificados pelos parâmetros. (Herdado de SqlSmoObject.) | |
BindRuleImpl | Associa o esquema de regra à regra e às colunas identificadas pelos parâmetros. (Herdado de SqlSmoObject.) | |
CheckCollation | Verifica a ordem das opções de script pelo método de agrupamento identificado pelo parâmetro collationName. (Herdado de SqlSmoObject.) | |
CheckObjectDirty | Checks whether object has been modified and not persisted. (Herdado de ScriptNameObjectBase.) | |
CheckObjectState() () () () | Valida o estado do objeto referenciado. (Herdado de SqlSmoObject.) | |
CheckObjectState(Boolean) | Valida o estado do objeto referenciado com a opção de especificar que uma exceção será gerada se o objeto ainda não tiver sido criado. (Herdado de SqlSmoObject.) | |
CheckObjectStateImpl | Verifica o estado de um SqlSmoObject. (Herdado de SqlSmoObject.) | |
CheckTextCorectness | Checks text for correctness against the parameters. (Herdado de ScriptNameObjectBase.) | |
CheckTextModeSupport | Checks mode of support. (Herdado de ScriptNameObjectBase.) | |
CheckVersion100 | Verifica se a versão do SQL Server é SQL Server 2008. (Herdado de SqlSmoObject.) | |
CheckVersion80 | Verifica a validade do objeto no SQL Server 2000. (Herdado de SqlSmoObject.) | |
CheckVersion80SP3 | Verifica a validade do objeto no SQL Server 2000 SP3. (Herdado de SqlSmoObject.) | |
CheckVersion90 | Verifica a validade do objeto no SQL Server 2005. (Herdado de SqlSmoObject.) | |
CheckVersionBelow90 | Verifica se a versão do SQL Server é anterior ao SQL Server 2005. (Herdado de SqlSmoObject.) | |
CleanObject | Cleans the referenced object. (Herdado de ScriptNameObjectBase.) | |
Create | Creates a foreign key on the instance of SQL Server as defined by the ForeignKey object. | |
CreateImpl | Cria um objeto com as opções do script. (Herdado de SqlSmoObject.) | |
CreateImplFinish | Método chamado quando o evento de criação é concluído. (Herdado de SqlSmoObject.) | |
CreateImplInit | Método chamado quando o evento de criação é inicializado. (Herdado de SqlSmoObject.) | |
Discover | Descobre uma lista do tipo Object. (Herdado de SqlSmoObject.) | |
Drop | Drops the foreign key. | |
DropImpl | Remove um SqlSmoObject. (Herdado de SqlSmoObject.) | |
DropImplWorker | Chama os métodos de remoção. (Herdado de SqlSmoObject.) | |
EnumScriptImpl | Enumera scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorker | Chama os métodos que enumeram scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Retorna uma cadeia de caracteres IEnumerable que descreve as opções de script de um objeto. (Herdado de SqlSmoObject.) | |
Equals | (Herdado de Object.) | |
ExecuteNonQuery | (Herdado de SqlSmoObject.) | |
Finalize | (Herdado de Object.) | |
ForceTextModeOnTextBody | Enforces text mode on the text body. (Herdado de ScriptNameObjectBase.) | |
FormatSqlVariant | Formata um objeto como tipo SqlVariant. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Gera um script para criar arquivo de dados. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceScript | Gera um script para alocar espaço no arquivo de dados. (Herdado de SqlSmoObject.) | |
GetBindDefaultScript | Obtém o script que associa padrões especificados pelos parâmetros defSchema e defName. (Herdado de SqlSmoObject.) | |
GetBindRuleScript | Obtém o script que especifica as regras de associação. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro booliano do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui uma propriedade booliana do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetBraketNameForText | Gets the bracket name. (Herdado de ScriptNameObjectBase.) | |
GetDateTimeParameter | Atribui a propriedade datetime do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetDateTimeParameterAsInt | Atribuirá a propriedade datetime do SqlSmoObject como um valor inteiro se a propriedade datetime não for nula. (Herdado de SqlSmoObject.) | |
GetDBName | Obtém o nome do banco de dados associado ao objeto. (Herdado de SqlSmoObject.) | |
GetEnumParameter | Atribui uma propriedade de enumeração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetFragOptionString | Obtém um objeto FragmentationOption como um valor de cadeia de caracteres. (Herdado de SqlSmoObject.) | |
GetGuidParameter | Atribui uma propriedade Guid do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetHashCode | (Herdado de Object.) | |
GetIsSystemNamed | Gets a Boolean value that specifies whether the system is named. (Herdado de ScriptNameObjectBase.) | |
GetIsTextDirty | Determines whether the text value is consistent with stored value. (Herdado de ScriptNameObjectBase.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptional | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetRealValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetScriptIncludeExists | Gets the script including the test for existence of type being scripted. (Herdado de ScriptNameObjectBase.) | |
GetScriptingOptionsForCreate | Obtém ScriptingOptions para o objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetServerName | Obtém o nome da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetServerObject | Obtém o servidor do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetSqlServerVersionName | Obtém o nome da versão da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetTextBody() () () () | Returns the text body. (Herdado de ScriptNameObjectBase.) | |
GetTextBody(Boolean) | Returns the text body. (Herdado de ScriptNameObjectBase.) | |
GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] []) | Gets the text for scripting. (Herdado de ScriptNameObjectBase.) | |
GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [], Boolean) | Gets the text of script object. (Herdado de ScriptNameObjectBase.) | |
GetTextHeader | Returns the text header. (Herdado de ScriptNameObjectBase.) | |
GetTextMode | Determines whether the script name is using text mode. (Herdado de ScriptNameObjectBase.) | |
GetTextProperty(String) | Gets the property as text. (Herdado de ScriptNameObjectBase.) | |
GetTextProperty(String, ScriptingOptions) | Gets the property as text. (Herdado de ScriptNameObjectBase.) | |
GetTimeSpanParameterAsInt | Atribui um parâmetro de período de tempo do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetType | (Herdado de Object.) | |
GetUrnRecursive(StringBuilder) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
ImplInitialize | Inicializa os campos do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
Initialize() () () () | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
Initialize(Boolean) | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. (Herdado de ScriptNameObjectBase.) | |
IsObjectInitialized | Verifica se o objeto foi inicializado. (Herdado de SqlSmoObject.) | |
IsObjectInSpace | Verifica se o objeto está isolado ou conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
IsVersion80SP3 | Determina se a versão do SQL Server é SQL Server 2000 com SP3. (Herdado de SqlSmoObject.) | |
IsVersion90AndAbove | Determina se a versão do SQL Server é SQL Server 2005 ou posterior. (Herdado de SqlSmoObject.) | |
MarkDropped | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MarkForDrop | Marks the foreign key to be dropped the next time its parent Table object is altered by the Alter method. | |
MarkForDropImpl | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MemberwiseClone | (Herdado de Object.) | |
PostAlter | Método ativado depois da alteração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostCreate | Método ativado depois da criação do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostDrop | Método ativado depois da remoção do SqlSmoObject. (Herdado de SqlSmoObject.) | |
Refresh | Refreshes the script name. (Herdado de ScriptNameObjectBase.) | |
Rename | Renames the foreign key to the specified new name. | |
RenameImpl | Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.) | |
RenameImplWorker | Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.) | |
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. | |
ScriptAlter | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptAnsiQI | Scripts the database object in ANSI text. (Herdado de ScriptNameObjectBase.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.) | |
ScriptCreate | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptDdl | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptDrop | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptImpl() () () () | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImplWorker | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptInformativeHeaders | Scripts the information headers. (Herdado de ScriptNameObjectBase.) | |
ScriptOwner | Alters the script owner authorization. (Herdado de NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.) | |
SetCollectionTextMode | Sets the collection text mode. (Herdado de ScriptNameObjectBase.) | |
SetIsSystemNamed | Sets a Boolean value that specifies whether the system is named. (Herdado de ScriptNameObjectBase.) | |
SetParentImpl | Define o pai do SqlSmoObject como o parâmetro newParent. (Herdado de SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Herdado de NamedSmoObject.) | |
SetTextBody | Specifies the text body. (Herdado de ScriptNameObjectBase.) | |
SetTextHeader | Specifies the text header. (Herdado de ScriptNameObjectBase.) | |
SetTextMode | Specifies the text mode. (Herdado de ScriptNameObjectBase.) | |
SwitchTextMode | Switches the text mode. (Herdado de ScriptNameObjectBase.) | |
ThrowIfTextIsDirtyForAlter | Throws an exception of text has been modified and not persisted. (Herdado de ScriptNameObjectBase.) | |
ToString | Retorna um String que representa o objeto referenciado. (Herdado de SqlSmoObject.) | |
TouchImpl | Não implementado. (Herdado de SqlSmoObject.) | |
UnbindDefaultImpl | Desassocia as colunas padrão do SqlSmoObject. (Herdado de SqlSmoObject.) | |
UnbindRuleImpl | Desassocia as regras do SqlSmoObject. (Herdado de SqlSmoObject.) | |
Validate | Validates the state of an object. (Herdado de SmoObjectBase.) |
Início
Eventos
Nome | Descrição | |
---|---|---|
PropertyChanged | Representa o evento que ocorre quando uma propriedade é alterada. (Herdado de SqlSmoObject.) | |
PropertyMetadataChanged | Representa o evento que ocorre quando os metadados da propriedade são alterados. (Herdado de SqlSmoObject.) |
Início
Campos
Nome | Descrição | |
---|---|---|
m_ExtendedProperties | Representa uma propriedade definida para estender as propriedades fornecidas por um SqlSmoObject. (Herdado de SqlSmoObject.) | |
singletonParent | Representa o pai do singleton. (Herdado de SqlSmoObject.) |
Início
Implementações de interfaces explícitas
Nome | Descrição | |
---|---|---|
IAlienObject. . :: . .Discover | Descobre quaisquer dependências. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Retorna a raiz do domínio. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Obtém o pai do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Obtém o tipo da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Obtém o valor da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Obtém o Unified Resource Name do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Obtém a instância que contém as informações sobre o objeto a partir do Unified Resource Name do objeto. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Define o estado do objeto como o valor SfcObjectState especificado. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Define o valor da propriedade. (Herdado de SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Obtém a referência da interface para o conjunto de propriedades deste objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (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.
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