Functions/Operations/Add-CheckConstraint.ps1
|
function Add-CheckConstraint { <# .SYNOPSIS Add a check constraint to a table. .DESCRIPTION Check constraints add validation for data in columns. .EXAMPLE Add-CheckConstraint 'Migrations' 'CK_Migrations_MigrationID' 'MigrationID > 0' Demonstrates how to add a check constraint to a column that requires the value to be greater than 0. .EXAMPLE Add-CheckConstraint 'Migrations' 'CK_Migrations_MigrationID' 'MigrationID > 0' -NoCheck Demonstrates how to add a check constraint to a column without validating the current contents of the table against this check. #> [CmdletBinding()] param( [Parameter(Mandatory=$true,Position=0)] [string] # The name of the check constraint's table. $TableName, [Parameter()] [string] # The schema of the table. Default is `dbo`. $SchemaName = 'dbo', [Parameter(Mandatory=$true,Position=1)] [string] # The name of the check constraint. $Name, [Parameter(Mandatory=$true,Position=2)] [string] # The expression to use for the constraint. $Expression, [Switch] # Don't use the check constraint when inserting, updating, or deleting rows during replication. $NotForReplication, [Switch] # Specifies that the data in the table is not validated against a newly added CHECK constraint. If not specified, WITH CHECK is assumed for new constraints. $NoCheck ) Set-StrictMode -Version 'Latest' New-Object 'Rivet.Operations.AddCheckConstraintOperation' $SchemaName, $TableName, $Name, $Expression, $NotForReplication, $NoCheck } |