Functions/Columns/New-UniqueIdentifierColumn.ps1
|
function New-UniqueIdentifierColumn { <# .SYNOPSIS Creates a column object representing an UniqueIdentifier datatype. .DESCRIPTION Use this function in the `Column` script block for `Add-Table`: Add-Table 'WithUUID' { UniqueIdentifier 'ColumnName' } ## ALIASES * UniqueIdentifier .EXAMPLE Add-Table Locations { UniqueIdentifier 'LocationID' } Demonstrates how to create a table with an optional `uniqueidentifier` column. .EXAMPLE Add-Table Locations { UniqueIdentifier 'LocationID' -RowGuidCol } Demonstrates how to create a table with an optional `uniqueidentifier`, which is used as the RowGuid identifier for SQL Server replication. .EXAMPLE Add-Table Locations { UniqueIdentifier 'LocationID' -NotNull } Demonstrates how to create a table with an required `uniqueidentifier` column. .EXAMPLE Add-Table Locations { UniqueIdentifier 'LocationID' -Default 'newid()' } Demonstrates how to create a table with an optional `uniqueidentifier` column with a default value. .EXAMPLE Add-Table Locations { UniqueIdentifier 'LocationID' -Description 'The unique identifier for this location.' } Demonstrates how to create a table with an optional `uniqueidentifier` column with a default value. #> [CmdletBinding(DefaultParameterSetName='Nullable')] param( [Parameter(Mandatory=$true,Position=0)] [string] # The column's name. $Name, [Parameter()] [Switch] # Sets RowGuidCol $RowGuidCol, [Parameter(Mandatory=$true,ParameterSetName='NotNull')] [Switch] # Don't allow `NULL` values in this column. $NotNull, [Parameter(ParameterSetName='Nullable')] [Switch] # Store nulls as Sparse. $Sparse, [Parameter()] [string] # A SQL Server expression for the column's default value $Default, [Parameter()] [string] # A description of the column. $Description ) switch ($PSCmdlet.ParameterSetName) { 'Nullable' { $nullable = 'Null' if( $Sparse ) { $nullable = 'Sparse' } [Rivet.Column]::UniqueIdentifier($Name, $RowGuidCol, $nullable, $Default, $Description) } 'NotNull' { [Rivet.Column]::UniqueIdentifier($Name, $RowGuidCol, 'NotNull', $Default, $Description) } } } Set-Alias -Name 'UniqueIdentifier' -Value 'New-UniqueIdentifierColumn' |