Encode-SqlName

  • Reference
Module:
SQLPS

Encodes special characters in SQL Server names to characters that can be used in PowerShell paths.

Syntax

Encode-SqlName
      -SqlName <String>
      [<CommonParameters>]

Description

The Encode-SqlName cmdlet encodes special characters in SQL Server identifier names to characters that can be used in PowerShell paths. SQL Server delimited identifiers can contain characters that are not normally supported in 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 cannot be escaped. The hexadecimal encoding for the characters is in the format %nn. The characters encoded by this cmdlet are: :./%<>*?[]|.

Examples

Example 1: Encode a SQL Server table name

PS C:\> Encode-SqlName -SqlName "My:Table/"
My%3ATable%2F

This command encodes a SQL Server table name that contains the colon (:) and forward-slash (/) characters.

Inputs

String

Outputs

String