commands

^

Invoke-DbatoolsRenameHelper

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows, Linux, macOS

 

Synopsis

Older dbatools command names have been changed. This script helps keep up.

Description

Older dbatools command names have been changed. This script helps keep up.

Syntax

Invoke-DbatoolsRenameHelper
    [-InputObject] <FileInfo[]>
    [[-Encoding] <String>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-ChildItem C:\temp\ps\*.ps1 -Recurse | Invoke-DbatoolsRenameHelper

Checks to see if any ps1 file in C:\temp\ps matches an old command name.
If so, then the command name within the text is updated and the resulting changes are written to disk in UTF-8.

Example: 2
PS C:\> Get-ChildItem C:\temp\ps\*.ps1 -Recurse | Invoke-DbatoolsRenameHelper -Encoding Ascii -WhatIf

Shows what would happen if the command would run. If the command would run and there were matches,
the resulting changes would be written to disk as Ascii encoded.

Required Parameters

-InputObject

A piped in object from Get-ChildItem

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-Encoding

Specifies the file encoding. The default is UTF8. Valid values are: -- ASCII: Uses the encoding for the ASCII (7-bit) character set. -- BigEndianUnicode: Encodes in UTF-16 format using the big-endian byte order. -- Byte: Encodes a set of characters into a sequence of bytes. -- String: Uses the encoding type for a string. -- Unicode: Encodes in UTF-16 format using the little-endian byte order. -- UTF7: Encodes in UTF-7 format. -- UTF8: Encodes in UTF-8 format. -- Unknown: The encoding type is unknown or invalid. The data can be treated as binary.

Alias
Required False
Pipeline false
Default Value UTF8
Accepted Values ASCII,BigEndianUnicode,Byte,String,Unicode,UTF7,UTF8,Unknown
-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.

Alias
Required False
Pipeline false
Default Value False
-WhatIf

Shows what would happen if the command were to run. No actions are actually performed

Alias wi
Required False
Pipeline false
Default Value
-Confirm

Prompts you for confirmation before executing any changing operations within the command

Alias cf
Required False
Pipeline false
Default Value

 

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