Поделиться через

Класс ForeignKey

  • Статья

The ForeignKey object represents a SQL Server foreign key.

Иерархия наследования

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

Пространство имен:  Microsoft.SqlServer.Management.Smo
Сборка:  Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
Public NotInheritable Class ForeignKey _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
'Применение
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

Тип ForeignKey обеспечивает доступ к следующим элементам.

Конструкторы

  Имя Описание
Открытый метод 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.

В начало

Свойства

  Имя Описание
Открытое свойство 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. (Переопределяет 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. (Производный от 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. (Производный от 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. (Производный от SqlSmoObject.)
Открытое свойство UserData Gets or sets user-defined data associated with the referenced object. (Производный от SmoObjectBase.)

В начало

Методы

  Имя Описание
Открытый метод 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. (Производный от SqlSmoObject.)
Открытый метод Drop Drops the foreign key.
Открытый метод Equals (Производный от Object.)
Защищенный метод FormatSqlVariant Formats an object as SqlVariant type. (Производный от SqlSmoObject.)
Защищенный метод GetContextDB Gets the context database that is associated with this object. (Производный от SqlSmoObject.)
Защищенный метод GetDBName Gets the database name that is associated with the object. (Производный от SqlSmoObject.)
Открытый метод GetHashCode (Производный от Object.)
Защищенный метод GetPropValue Gets a property value of the SqlSmoObject object. (Производный от SqlSmoObject.)
Защищенный метод GetPropValueOptional Gets a property value of the SqlSmoObject object. (Производный от SqlSmoObject.)
Защищенный метод GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Производный от SqlSmoObject.)
Защищенный метод GetServerObject Gets the server of the SqlSmoObject object. (Производный от SqlSmoObject.)
Открытый метод GetType (Производный от Object.)
Открытый метод Initialize() Initializes the object and forces the properties be loaded. (Производный от SqlSmoObject.)
Открытый метод Initialize(Boolean) Initializes the object and forces the properties be loaded. (Производный от SqlSmoObject.)
Защищенный метод IsObjectInitialized Verifies whether the object has been initialized. (Производный от SqlSmoObject.)
Защищенный метод IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Производный от 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. (Производный от 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. (Производный от SqlSmoObject.)
Открытый метод ToString Returns a String that represents the referenced object. (Производный от SqlSmoObject.)
Открытый метод Validate Validates the state of an object. (Производный от SmoObjectBase.)

В начало

События

  Имя Описание
Открытое событие PropertyChanged Represents the event that occurs when a property is changed. (Производный от SqlSmoObject.)
Открытое событие PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Производный от SqlSmoObject.)

В начало

Явные реализации интерфейса

  Имя Описание
Явная реализация интерфейсаЗакрытый метод IAlienObject.Discover Discovers any dependencies. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.GetDomainRoot Returns the root of the domain. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.GetParent Gets the parent of this object. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.GetPropertyType Gets the type of the specified property. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.GetPropertyValue Gets the value of the specified property. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject.SetPropertyValue Sets the property value. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытое свойство ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode. Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется.

В начало

Замечания

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

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Потокобезопасная работа с членами экземпляров типа не гарантируется.

Примеры

Создание, изменение и удаление внешних ключей

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Smo

Другие ресурсы

Создание, изменение и удаление внешних ключей

Инструкция CREATE TABLE (Transact-SQL)