functions/Copy-SqlCustomError.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
Function Copy-SqlCustomError
{
<#
.SYNOPSIS
Copy-SqlCustomError migrates custom errors (user defined messages) from one SQL Server to another.
 
.DESCRIPTION
By default, all custom errors are copied. The -CustomErrors parameter is autopopulated for command-line completion and can be used to copy only specific custom errors.
 
If the custom error already exists on the destination, it will be skipped unless -Force is used. Interesting fact, if you drop the us_english version, all the other languages will be dropped for that specific ID as well.
 
Also, the us_english version must be created first.
  
.PARAMETER Source
Source SQL Server.You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
.PARAMETER Destination
Destination Sql Server. You must have sysadmin access and server version must be SQL Server version 2000 or greater.
 
.PARAMETER SourceSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$scred = Get-Credential, then pass $scred object to the -SourceSqlCredential parameter.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER DestinationSqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
 
$dcred = Get-Credential, then pass this $dcred to the -DestinationSqlCredential parameter.
 
Windows Authentication will be used if DestinationSqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
To connect as a different Windows user, run PowerShell as that user.
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.PARAMETER Force
Drops and recreates the XXXXX if it exists
 
.NOTES
Tags: Migration
Author: Chrissy LeMaire (@cl), netnerds.net
Requires: sysadmin access on SQL Servers
 
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Copy-SqlCustomError
 
.EXAMPLE
Copy-SqlCustomError -Source sqlserver2014a -Destination sqlcluster
 
Copies all server custom errors from sqlserver2014a to sqlcluster, using Windows credentials. If custom errors with the same name exist on sqlcluster, they will be skipped.
 
.EXAMPLE
Copy-SqlCustomError -Source sqlserver2014a -Destination sqlcluster -Trigger 60000 -SourceSqlCredential $cred -Force
 
Copies a single custom error, the custom error with ID number 6000 from sqlserver2014a to sqlcluster, using SQL credentials for sqlserver2014a and Windows credentials for sqlcluster. If a custom error with the same name exists on sqlcluster, it will be updated because -Force was used.
 
.EXAMPLE
Copy-SqlCustomError -Source sqlserver2014a -Destination sqlcluster -WhatIf -Force
 
Shows what would happen if the command were executed using force.
#>

[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess = $true)]
param (
[parameter(Mandatory = $true)]
[object]$Source,
[parameter(Mandatory = $true)]
[object]$Destination,
[System.Management.Automation.PSCredential]$SourceSqlCredential,
[System.Management.Automation.PSCredential]$DestinationSqlCredential,
[switch]$Force
)
DynamicParam { if ($source) { return (Get-ParamSqlCustomErrors -SqlServer $Source -SqlCredential $SourceSqlCredential) } }

BEGIN
{
$customerrors = $psboundparameters.CustomErrors

$sourceserver = Connect-SqlServer -SqlServer $Source -SqlCredential $SourceSqlCredential
$destserver = Connect-SqlServer -SqlServer $Destination -SqlCredential $DestinationSqlCredential

$source = $sourceserver.DomainInstanceName
$destination = $destserver.DomainInstanceName

if ($sourceserver.versionMajor -lt 9 -or $destserver.versionMajor -lt 9)
{
throw "Custom Errors are only supported in SQL Server 2000 and above. Quitting."
}
}

PROCESS
{


# Us has to go first
$orderedcustomerrors = @($sourceserver.UserDefinedMessages | Where-Object { $_.Language -eq "us_english" })
$orderedcustomerrors += $sourceserver.UserDefinedMessages | Where-Object { $_.Language -ne "us_english" }
$destcustomerrors = $destserver.UserDefinedMessages

foreach ($customerror in $orderedcustomerrors)
{
$customerrorid = $customerror.ID
$language = $customerror.language.ToString()

if ($customerrors.length -gt 0 -and $customerrors -notcontains $customerrorid) { continue }

if ($destcustomerrors.ID -contains $customerror.ID)
{
if ($force -eq $false)
{
Write-Warning "Custom error $customerrorid $language exists at destination. Use -Force to drop and migrate."
continue
}
else
{
If ($Pscmdlet.ShouldProcess($destination, "Dropping custom error $customerrorid $language and recreating"))
{
try
{
Write-Verbose "Dropping custom error $customerrorid (drops all languages for custom error $customerrorid)"
$destserver.UserDefinedMessages[$customerrorid, $language].Drop()
}
catch 
{ 
Write-Exception $_ 
continue
}
}
}
}

If ($Pscmdlet.ShouldProcess($destination, "Creating custom error $customerrorid $language"))
{
try
{
Write-Output "Copying custom error $customerrorid $language"
$sql = $customerror.Script() | Out-String
$sql = $sql -replace [Regex]::Escape("'$source'"), [Regex]::Escape("'$destination'")
Write-Verbose $sql
$destserver.ConnectionContext.ExecuteNonQuery($sql) | Out-Null
}
catch
{
Write-Exception $_
}
}
}
}

END
{
$sourceserver.ConnectionContext.Disconnect()
$destserver.ConnectionContext.Disconnect()
If ($Pscmdlet.ShouldProcess("console", "Showing finished message")) { Write-Output "Custom error migration finished" }
}
}