Functions/Operations/Add-UniqueKey.ps1
|
function Add-UniqueKey { <# .SYNOPSIS Creates a UNIQUE constraint on the specified column and table. .DESCRIPTION Creates a UNIQUE constraint on the specified column and table. You can use UNIQUE constraints to make sure that no duplicate values are entered in specific columns that do not participate in a primary key. Although both a UNIQUE constraint and a PRIMARY KEY constraint enforce uniqueness, use a UNIQUE constraint instead of a PRIMARY KEY constraint when you want to enforce the uniqueness of a column, or combination of columns, that is not the primary key. .EXAMPLE Add-UniqueKey -TableName Cars -ColumnName Year Adds an unique constraint on column 'Year' in the table 'Cars' .EXAMPLE Add-UniqueKey -TableName 'Cars' -ColumnName 'Year' -Option @('IGNORE_DUP_KEY = ON','ALLOW_ROW_LOCKS = OFF') Adds an unique constraint on column 'Year' in the table 'Cars' with specified options #> [CmdletBinding()] param( [string] # The schema name of the target table. Defaults to `dbo`. $SchemaName = 'dbo', [Parameter(Mandatory=$true,Position=0)] [string] # The name of the target table. $TableName, [Parameter(Mandatory=$true,Position=1)] [string[]] # The column(s) on which the index is based $ColumnName, [Switch] # Creates a clustered index, otherwise non-clustered $Clustered, [Int] # FillFactor as Integer $FillFactor, [string[]] # An array of index options. $Option, [string] # The value of the `ON` clause, which controls the filegroup/partition to use for the index. $On, [Parameter()] [string] # The name for the <object type>. If not given, a sensible name will be created. $Name ) Set-StrictMode -Version Latest ## Construct Comma Separated List of Columns $ColumnClause = $ColumnName -join ',' if ($PSBoundParameters.ContainsKey("Name")) { New-Object 'Rivet.Operations.AddUniqueKeyOperation' $SchemaName, $TableName, $ColumnName, $Name, $Clustered, $FillFactor, $Option, $On } else { New-Object 'Rivet.Operations.AddUniqueKeyOperation' $SchemaName, $TableName, $ColumnName, $Clustered, $FillFactor, $Option, $On } } |