New-DbaSqlParameter

Want to see the source code for this command? Check out New-DbaSqlParameter on GitHub.
Want to see the Bill Of Health for this command? Check out New-DbaSqlParameter.

Synopsis

Creates a new SQL parameter.

Description

Creates a new SQL parameter.

Syntax

New-DbaSqlParameter
    [[-CompareInfo] <String>]
    [[-DbType] <String>]
    [[-Direction] <String>]
    [-ForceColumnEncryption]
    [-IsNullable]
    [[-LocaleId] <Int32>]
    [[-Offset] <String>]
    [[-ParameterName] <String>]
    [[-Precision] <String>]
    [[-Scale] <String>]
    [[-Size] <Int32>]
    [[-SourceColumn] <String>]
    [-SourceColumnNullMapping]
    [[-SourceVersion] <String>]
    [[-SqlDbType] <String>]
    [[-SqlValue] <String>]
    [[-TypeName] <String>]
    [[-UdtTypeName] <String>]
    [[-Value] <Object>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> New-DbaSqlParameter -ParameterName json_result -SqlDbType NVarChar -Size -1 -Direction Output

Creates a SqlParameter object that can be used with Invoke-DbaQuery

Example: 2

PS C:\> $output = New-DbaSqlParameter -ParameterName json_result -SqlDbType NVarChar -Size -1 -Direction Output
PS C:\> Invoke-DbaQuery -SqlInstance localhost -Database master -CommandType StoredProcedure -Query my_proc -SqlParameter $output
PS C:\> $output.Value

Creates an output parameter and uses it to invoke a stored procedure.

Optional Parameters

-CompareInfo

Sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

-DbType

Sets the SqlDbType of the parameter.

-Direction

Sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

-ForceColumnEncryption

Enforces encryption of a parameter when using Always Encrypted. If SQL Server informs the driver that the parameter does not need to be encrypted, the query using the parameter will fail. This property provides additional protection against security attacks that involve a compromised SQL Server providing incorrect encryption metadata to the client, which may lead to data disclosure.

-IsNullable

Sets a value that indicates whether the parameter accepts null values. IsNullable is not used to validate the parameter's value and will not prevent sending or receiving a null value when executing a command.

-LocaleId

Sets the locale identifier that determines conventions and language for a particular region.

-Offset

Sets the offset to the Value property.

-ParameterName

Sets the name of the SqlParameter.

-Precision

Sets the maximum number of digits used to represent the Value property.

-Scale

Sets the number of decimal places to which Value is resolved.

-Size

Sets the maximum size, in bytes, of the data within the column.

-SourceColumn

Sets the name of the source column mapped to the DataSet and used for loading or returning the Value.

-SourceColumnNullMapping

Sets a value which indicates whether the source column is nullable. This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

-SourceVersion

Sets the DataRowVersion to use when you load Value.

-SqlDbType

Sets the SqlDbType of the parameter.

-SqlValue

Sets the value of the parameter as an SQL type.

-TypeName

Sets the type name for a table-valued parameter.

-UdtTypeName

Sets a string that represents a user-defined type as a parameter.

-Value

Sets the value of the parameter.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.