Keys Collection

SQL-DMO

SQL-DMO

Keys Collection

The Keys collection contains Key objects that reference referential integrity declarations that are implemented by Microsoft® SQL Server™ PRIMARY KEY and FOREIGN KEY constraints.

Properties
Count Property  
Methods
Add Method Refresh Method
Item Method Remove Method (Collections)

Remarks

With the Keys collection, you can:

  • Implement key-based referential integrity by creating SQL Server PRIMARY KEY and FOREIGN KEY constraints.

  • Remove key-based referential integrity.

For more information about using the Keys collection to create SQL Server PRIMARY KEY and FOREIGN KEY constraints, see "Key Object" in this volume.

To remove a SQL Server constraint implementing key-based referential integrity

  • Use the Remove method of the Keys collection, as in:
    oTable.Keys.Remove("FK_Order_Details_Products")

When using the Item or Remove method, the Keys collection supports member identification using either name or ordinal reference syntax. For example:

Set oKey = oTable.Keys("PK_Order_Details")

Or:

Set oKey = oTable.Keys(2)

Note  Creating or removing SQL Server constraints implementing key-based referential integrity by using the Keys collection requires appropriate privilege. The SQL Server login used for SQLServer object connection must be a member of the fixed role db_ddladmin or a role with greater privilege.