ConvertTo-EncodedSqlName

  • Reference
Module:
SQLServer

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

Syntax

ConvertTo-EncodedSqlName
              [-SqlName] <String>
              [-ProgressAction <ActionPreference>]
              [<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

-ProgressAction

Determines how PowerShell responds to progress updates generated by a script, cmdlet, or provider, such as the progress bars generated by the Write-Progress cmdlet. The Write-Progress cmdlet creates progress bars that show a command's status.

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SqlName

Specifies the SQL Server identifier to be encoded.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Inputs

String

Outputs

String