New-VarCharColumn

Creates a column object representing an VarChar datatype.

Syntax

New-VarCharColumn [-Name] <String> [-Size] <Int32> [-Collation <String>] [-Sparse] [-Default <String>] [-Description <String>] [<CommonParameters>]
New-VarCharColumn [-Name] <String> [-Size] <Int32> [-Collation <String>] -NotNull [-Default <String>] [-Description <String>] [<CommonParameters>]
New-VarCharColumn [-Name] <String> -Max [-Collation <String>] -NotNull [-Default <String>] [-Description <String>] [<CommonParameters>]
New-VarCharColumn [-Name] <String> -Max [-Collation <String>] [-Sparse] [-Default <String>] [-Description <String>] [<CommonParameters>]

Description

Use this function in the Column script block for Add-Table:

Add-Table -Name 'WithVarCharColumn' -Column {
    VarChar 'ColumnName' 50
}

ALIASES

Parameters

Name Type Description Required? Pipeline Input Default Value
Name String

The column's name.

true false
Size Int32

The maximum length of the column, i.e. the number of characters.

true false 0
Max SwitchParameter

Create a varchar(max) column.

true false False
Collation String

Controls the code page that is used to store the data

false false
NotNull SwitchParameter

Don't allow NULL values in this column.

true false False
Sparse SwitchParameter

Store nulls as Sparse.

false false False
Default String

A SQL Server expression for the column's default value

false false
Description String

A description of the column.

false false

EXAMPLE 1

Add-Table 'Albums' { VarChar 'Name' 100 }

Demonstrates how to create an optional varchar column with a maximum length of 100 bytes.

EXAMPLE 2

Add-Table 'Albums' { VarChar 'Name' 100 -NotNull }

Demonstrates how to create a required varchar column with maximum length of 100 bytes.

EXAMPLE 3

Add-Table 'Albums' { VarChar 'Name' -Max }

Demonstrates how to create an optional varchar column with the maximum length (about 2GB).

EXAMPLE 4

Add-Table 'Albums' { VarChar 'Name' 100 -Collation 'Latin1_General_BIN' }

Demonstrates now to create an optional varchar column with a custom Latin1_General_BIN collation.