ConvertTo-EncodedSqlName

Module:: SqlServer Module

Encodes extended characters in SQL Server names to formats usable in Windows PowerShell paths.

Syntax

Default (Default)

ConvertTo-EncodedSqlName
    [-SqlName] <String>
    [<CommonParameters>]

Description

The ConvertTo-EncodedSqlName cmdlet encodes special characters in SQL Server names to formats usable in Windows PowerShell paths.

SQL Server delimited identifiers can contain characters not normally supported in Windows PowerShell object names.

When using delimited identifiers in SQL Server provider paths, these extended characters must be either encoded to their hexadecimal representation or escaped using the ` character.

Certain characters, such as the colon character (:) cannot be escaped.

The hexadecimal encoding for the characters is in the format %nn.

The characters encoded by ConvertTo-EncodedSqlName are: \ : . / % < > * ? [ ] |

Examples

Example 1: Encode a SQL Server table name

PS C:\> ConvertTo-EncodedSqlName -SqlName "My:Table/"

My%3ATable%2F

This command encodes a SQL Server table name that contains : and / characters.

Parameters

-SqlName

Specifies the SQL Server identifier to be encoded.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	1
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Share via