forked from dataplat/dbatools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBackup-DbaDatabase.ps1
793 lines (662 loc) · 41.2 KB
/
Backup-DbaDatabase.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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
function Backup-DbaDatabase {
<#
.SYNOPSIS
Backup one or more SQL Server databases from a single SQL Server SqlInstance.
.DESCRIPTION
Performs a backup of a specified type of 1 or more databases on a single SQL Server Instance. These backups may be Full, Differential or Transaction log backups.
.PARAMETER SqlInstance
The SQL Server instance hosting the databases to be backed up.
.PARAMETER SqlCredential
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
.PARAMETER Database
The database(s) to process. This list is auto-populated from the server. If unspecified, all databases will be processed.
.PARAMETER ExcludeDatabase
The database(s) to exclude. This list is auto-populated from the server.
.PARAMETER FilePath
The name of the file to backup to. This is only accepted for single database backups.
If no name is specified then the backup files will be named DatabaseName_yyyyMMddHHmm (i.e. "Database1_201714022131") with the appropriate extension.
If the same name is used repeatedly, SQL Server will add backups to the same file at an incrementing position.
SQL Server needs permissions to write to the specified location. Path names are based on the SQL Server (C:\ is the C drive on the SQL Server, not the machine running the script).
Passing in NUL as the FilePath will backup to the NUL: device
.PARAMETER IncrementPrefix
If enabled, this will prefix backup files with an incrementing integer (ie; '1-', '2-'). Using this has been alleged to improved restore times on some Azure based SQL Database platforms
.PARAMETER TimeStampFormat
By default the command timestamps backups using the format yyyyMMddHHmm. Using this parameter this can be overridden. The timestamp format should be defined using the Get-Date formats, illegal formats will cause an error to be thrown
.PARAMETER Path
Path in which to place the backup files. If not specified, the backups will be placed in the default backup location for SqlInstance.
If multiple paths are specified, the backups will be striped across these locations. This will overwrite the FileCount option.
If the path does not exist, Sql Server will attempt to create it. Folders are created by the Sql Instance, and checks will be made for write permissions.
File Names with be suffixed with x-of-y to enable identifying striped sets, where y is the number of files in the set and x ranges from 1 to y.
.PARAMETER ReplaceInName
If this switch is set, the following list of strings will be replaced in the FilePath and Path strings:
instancename - will be replaced with the instance Name
servername - will be replaced with the server name
dbname - will be replaced with the database name
timestamp - will be replaced with the timestamp (either the default, or the format provided)
backuptype - will be replaced with Full, Log or Differential as appropriate
.PARAMETER CopyOnly
If this switch is enabled, CopyOnly backups will be taken. By default function performs a normal backup, these backups interfere with the restore chain of the database. CopyOnly backups will not interfere with the restore chain of the database.
For more details please refer to this MSDN article - https://msdn.microsoft.com/en-us/library/ms191495.aspx
.PARAMETER Type
The type of SQL Server backup to perform. Accepted values are "Full", "Log", "Differential", "Diff", "Database"
.PARAMETER FileCount
This is the number of striped copies of the backups you wish to create. This value is overwritten if you specify multiple Backup Directories.
.PARAMETER CreateFolder
If this switch is enabled, each database will be backed up into a separate folder on each of the paths specified by Path.
.PARAMETER CompressBackup
If this switch is enabled, the function will try to perform a compressed backup if supported by the version and edition of SQL Server. Otherwise, this function will use the server(s) default setting for compression.
.PARAMETER MaxTransferSize
Sets the size of the unit of transfer. Values must be a multiple of 64kb.
.PARAMETER Blocksize
Specifies the block size to use. Must be one of 0.5KB, 1KB, 2KB, 4KB, 8KB, 16KB, 32KB or 64KB. This can be specified in bytes.
Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail
.PARAMETER BufferCount
Number of I/O buffers to use to perform the operation.
Refer to https://msdn.microsoft.com/en-us/library/ms178615.aspx for more detail
.PARAMETER Checksum
If this switch is enabled, the backup checksum will be calculated.
.PARAMETER Verify
If this switch is enabled, the backup will be verified by running a RESTORE VERIFYONLY against the SqlInstance
.PARAMETER WithFormat
Formats the media as the first step of the backup operation. NOTE: This will set Initialize and SkipTapeHeader to $true.
.PARAMETER Initialize
Initializes the media as part of the backup operation.
.PARAMETER SkipTapeHeader
Initializes the media as part of the backup operation.
.PARAMETER InputObject
Internal parameter
.PARAMETER AzureBaseUrl
The URL(s) to the base container of an Azure Storage account to write backups to.
If specifying the AzureCredential parameter you can only provide 1 value as page blobs do not support multiple URLs
If using Shared Access keys, you may specify as many URLs as you want, as long as a corresponding credential exists on the source server.
If specified, the only other parameters than can be used are "CopyOnly", "Type", "CompressBackup", "Checksum", "Verify", "AzureCredential", "CreateFolder".
.PARAMETER AzureCredential
The name of the credential on the SQL instance that can write to the AzureBaseUrl, only needed if using Storage access keys
If using SAS credentials, the command will look for a credential with a name matching the AzureBaseUrl. As page blobs are used with this option we force the number of files to 1 and ignore any value passed in for BlockSize or MaxTransferSize
.PARAMETER NoRecovery
This is passed in to perform a tail log backup if needed
.PARAMETER BuildPath
By default this command will not attempt to create missing paths, this switch will change the behaviour so that it will
.PARAMETER IgnoreFileChecks
This switch stops the function from checking for the validity of paths. This can be useful if SQL Server only has read access to the backup area.
Note, that as we cannot check the path you may well end up with errors.
.PARAMETER OutputScriptOnly
Switch causes only the T-SQL script for the backup to be generated. Will not create any paths if they do not exist
.PARAMETER EncryptionAlgorithm
Specified the Encryption Algorithm to used. Must be one of 'AES128','AES192','AES256' or 'TRIPLEDES'
Must specify one of EncryptionCertificate or EncryptionKey as well.
.PARAMETER EncryptionCertificate
The name of the certificate to be used to encrypt the backups. The existence of the certificate will be checked, and will not proceed if it does not exist
Is mutually exclusive with the EncryptionKey option
.PARAMETER 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.
.PARAMETER WhatIf
If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
.PARAMETER Confirm
If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
.NOTES
Tags: DisasterRecovery, Backup, Restore
Author: Stuart Moore (@napalmgram), stuart-moore.com
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
.LINK
https://dbatools.io/Backup-DbaDatabase
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Server1 -Database HR, Finance
This will perform a full database backup on the databases HR and Finance on SQL Server Instance Server1 to Server1 default backup directory.
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance sql2016 -Path C:\temp -Database AdventureWorks2014 -Type Full
Backs up AdventureWorks2014 to sql2016 C:\temp folder.
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance sql2016 -AzureBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -AzureCredential dbatoolscred -Type Full -CreateFolder
Performs a full backup of all databases on the sql2016 instance to their own containers under the https://dbatoolsaz.blob.core.windows.net/azbackups/ container on Azure blob storage using the sql credential "dbatoolscred" registered on the sql2016 instance.
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance sql2016 -AzureBaseUrl https://dbatoolsaz.blob.core.windows.net/azbackups/ -Type Full
Performs a full backup of all databases on the sql2016 instance to the https://dbatoolsaz.blob.core.windows.net/azbackups/ container on Azure blob storage using the Shared Access Signature sql credential "https://dbatoolsaz.blob.core.windows.net/azbackups" registered on the sql2016 instance.
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Server1\Prod -Database db1 -Path \\filestore\backups\servername\instancename\dbname\backuptype -Type Full -ReplaceInName
Performs a full backup of db1 into the folder \\filestore\backups\server1\prod\db1\Full
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Server1\Prod -Path \\filestore\backups\servername\instancename\dbname\backuptype -FilePath dbname-backuptype-timestamp.trn -Type Log -ReplaceInName
Performs a log backup for every database. For the database db1 this would results in backup files in \\filestore\backups\server1\prod\db1\Log\db1-log-31102018.trn
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Sql2017 -Database master -FilePath NUL
Performs a backup of master, but sends the output to the NUL device (ie; throws it away)
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Sql2016 -Database stripetest -AzureBaseUrl https://az.blob.core.windows.net/sql,https://dbatools.blob.core.windows.net/sql
Performs a backup of the database stripetest, striping it across the 2 Azure blob containers at https://az.blob.core.windows.net/sql and https://dbatools.blob.core.windows.net/sql, assuming that Shared Access Signature credentials for both containers exist on the source instance
.EXAMPLE
PS C:\> Backup-DbaDatabase -SqlInstance Sql2017 -Database master -EncryptionAlgorithm AES256 -EncryptionCertificate BackupCert
Backs up the master database using the BackupCert certificate and the AES256 algorithm.
#>
[CmdletBinding(DefaultParameterSetName = "Default", SupportsShouldProcess)]
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSAvoidUsingPlainTextForPassword", "")] #For AzureCredential
param (
[parameter(ParameterSetName = "Pipe", Mandatory)]
[DbaInstanceParameter]$SqlInstance,
[PSCredential]$SqlCredential,
[object[]]$Database,
[object[]]$ExcludeDatabase,
[Alias('BackupDirectory')]
[string[]]$Path,
[Alias('BackupFileName')]
[string]$FilePath,
[switch]$IncrementPrefix,
[switch]$ReplaceInName,
[switch]$CopyOnly,
[ValidateSet('Full', 'Log', 'Differential', 'Diff', 'Database')]
[string]$Type = 'Database',
[parameter(ParameterSetName = "NoPipe", Mandatory, ValueFromPipeline)]
[object[]]$InputObject,
[switch]$CreateFolder,
[int]$FileCount = 0,
[switch]$CompressBackup,
[switch]$Checksum,
[switch]$Verify,
[int]$MaxTransferSize,
[int]$BlockSize,
[int]$BufferCount,
[string[]]$AzureBaseUrl,
[string]$AzureCredential,
[switch]$NoRecovery,
[switch]$BuildPath,
[switch]$WithFormat,
[switch]$Initialize,
[switch]$SkipTapeHeader,
[string]$TimeStampFormat,
[switch]$IgnoreFileChecks,
[switch]$OutputScriptOnly,
[ValidateSet('AES128', 'AES192', 'AES256', 'TRIPLEDES')]
[String]$EncryptionAlgorithm,
[String]$EncryptionCertificate,
[switch]$EnableException
)
begin {
# This is here ready to go when get EKM working so we can do encrption with asymmetric encryption.
$EncryptionKey = $null
if (-not (Test-Bound 'TimeStampFormat')) {
Write-Message -Message 'Setting Default timestampformat' -Level Verbose
$TimeStampFormat = "yyyyMMddHHmm"
}
if ((Test-Bound 'AzureBaseUrl') -and (Test-Bound 'CreateFolder')) {
Stop-Function -Message 'CreateFolder cannot be specified with an Azure Backup, the container must exist and be referenced by the URL'
return
}
if ((Test-Bound 'AzureCredential') -and (Test-Bound 'BlockSize')) {
Write-Message -Level Warning -Message 'BlockSize cannot be specified when backup up to an Azure page blob, ignoring'
$BlockSize = $null
}
if ((Test-Bound 'AzureCredential') -and (Test-Bound 'MaxTransferSize')) {
Write-Message -Level Warning -Message 'MaxTransferSize cannot be specified when backup up to an Azure page blob ignoring'
$MaxTransferSize = $null
}
if ($SqlInstance) {
try {
$server = Connect-DbaInstance -SqlInstance $SqlInstance -SqlCredential $SqlCredential -AzureUnsupported -Database master
} catch {
Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $SqlInstance
return
}
$InputObject = $server.Databases | Where-Object Name -ne 'tempdb'
if ($Database) {
$InputObject = $InputObject | Where-Object Name -in $Database
}
if ($ExcludeDatabase) {
$InputObject = $InputObject | Where-Object Name -notin $ExcludeDatabase
}
if ($Path.Count -gt 1) {
Write-Message -Level Verbose -Message "Multiple Backup Directories, striping"
$FileCount = $Path.Count
}
if ($InputObject.Count -gt 1 -and $FilePath -ne '' -and $True -ne $ReplaceInName) {
Stop-Function -Message "1 BackupFile specified, but more than 1 database."
return
}
}
# this had to be a function. making it a variable killed something. I'm guessing scoping issues
Function Convert-BackupPath ($object) {
if ($object -match "/|\\") {
if ($isdestlinux -and $object) {
$object = $object.Replace("\", "/")
} elseif ($transformedbackupfolder) {
$object = $object.Replace("/", "\")
}
}
$object
}
}
process {
if (Test-FunctionInterrupt) { return }
if ($IsMacOS -or $IsLinux) {
$nonwindows = $true
}
if (-not $SqlInstance -and -not $InputObject) {
Stop-Function -Message "You must specify a server and database or pipe some databases"
return
}
Write-Message -Level Verbose -Message "$($InputObject.Count) database to backup"
if ($Database) {
$InputObject = $InputObject | Where-Object Name -in $Database
}
if ($ExcludeDatabase) {
$InputObject = $InputObject | Where-Object Name -notin $ExcludeDatabase
}
if ($InputObject.count -eq 0) {
Write-Message -Level Warning -Message "No databases match the request for backups"
}
$topProgressId = Get-Random
$topProgressTarget = $InputObject.Count
$topProgressNumber = 0
foreach ($db in $InputObject) {
$topProgressPercent = [int]($topProgressNumber * 100 / $topProgressTarget)
$topProgressNumber++
if (-not $PSCmdlet.MyInvocation.ExpectingInput) {
# Only when the databases to be processed are not piped to the command
Write-Progress -Id $topProgressId -Activity "Backing up database $topProgressNumber of $topProgressTarget" -PercentComplete $topProgressPercent -Status ([System.String]::Format("Progress: {0} %", $topProgressPercent))
}
$ProgressId = Get-Random
$failures = @()
$dbName = $db.Name
$server = $db.Parent
$null = $server.Refresh()
$isdestlinux = Test-HostOSLinux -SqlInstance $server
if (Test-Bound 'EncryptionAlgorithm') {
if (!((Test-Bound 'EncryptionCertificate') -xor (Test-Bound 'EncryptionKey'))) {
Stop-Function -Message 'EncryptionCertifcate and EncryptionKey are mutually exclusive, only provide on of them'
return
} else {
$encryptionOptions = New-Object Microsoft.SqlServer.Management.Smo.BackupEncryptionOptions
if (Test-Bound 'EncryptionCertificate') {
$tCertCheck = Get-DbaDbCertificate -SqlInstance $server -Database master -Certificate $EncryptionCertificate
if ($null -eq $tCertCheck) {
Stop-Function -Message "Certificate $EncryptionCertificate does not exist on $server so cannot be used for backups"
return
} else {
$encryptionOptions.encryptorType = [Microsoft.SqlServer.Management.Smo.BackupEncryptorType]::ServerCertificate
$encryptionOptions.encryptorName = $EncryptionCertificate
$encryptionOptions.Algorithm = [Microsoft.SqlServer.Management.Smo.BackupEncryptionAlgorithm]::$EncryptionAlgorithm
}
}
if (Test-Bound 'EncryptionKey') {
# Should not end up here until Key encryption in implemented
$tKeyCheck = Get-DbaDbAsymmetricKey -SqlInstance $server -Database master -Name $EncrytptionKey
if ($null -eq $tKeyCheck) {
Stop-Function -Message "AsymmetricKey $Encryptionkey does not exist on $server so cannot be used for backups"
return
} else {
$encryptionOptions.encryptorType = [Microsoft.SqlServer.Management.Smo.BackupEncryptorType]::ServerAsymmetricKey
$encryptionOptions.encryptorName = $EncryptionKey
$encryptionOptions.Algorithm = [Microsoft.SqlServer.Management.Smo.BackupEncryptionAlgorithm]::$EncryptionAlgorithm
}
}
}
}
if ( (Test-Bound AzureBaseUrl -Not) -and (Test-Bound Path -Not) -and $FilePath -ne 'NUL') {
Write-Message -Message 'No backup folder passed in, setting it to instance default' -Level Verbose
$Path = (Get-DbaDefaultPath -SqlInstance $server).Backup
if ($Path) {
# it's very picky, don't cut corners
$lastchar = $Path.substring($Path.length - 1, 1)
if ($lastchar -eq "/" -or $lastchar -eq "\") {
$Path = $Path.TrimEnd("/")
$Path = $Path.TrimEnd("\")
}
}
}
if (($MaxTransferSize % 64kb) -ne 0 -or $MaxTransferSize -gt 4mb) {
Stop-Function -Message "MaxTransferSize value must be a multiple of 64kb and no greater than 4MB"
return
}
if ($BlockSize) {
if ($BlockSize -notin (0.5kb, 1kb, 2kb, 4kb, 8kb, 16kb, 32kb, 64kb)) {
Stop-Function -Message "Block size must be one of 0.5kb,1kb,2kb,4kb,8kb,16kb,32kb,64kb"
return
}
}
if ($null -ne $AzureBaseUrl) {
$AzureBaseUrl = $AzureBaseUrl.Trim("/")
if ('' -ne $AzureCredential) {
Write-Message -Message "Azure Credential name passed in, will proceed assuming it's value" -Level Verbose
$FileCount = 1
} else {
foreach ($baseUrl in $AzureBaseUrl) {
$base = $baseUrl -split "/"
if ( $base.Count -gt 4) {
Write-Message "AzureURL contains a folder"
$credentialName = $base[0] + "//" + $base[2] + "/" + $base[3]
}
Write-Message -Message "AzureUrl and no credential, testing for SAS credential"
if (Get-DbaCredential -SqlInstance $server -Name $credentialName) {
Write-Message -Message "Found a SAS backup credential" -Level Verbose
} else {
Stop-Function -Message "You must provide the credential name for the Azure Storage Account"
return
}
}
}
$FileCount = $AzureBaseUrl.count
$Path = $AzureBaseUrl
}
if ($OutputScriptOnly) {
$IgnoreFileChecks = $true
}
if ($null -eq $PSBoundParameters.Path -and $PSBoundParameters.FilePath -ne 'NUL' -and $server.VersionMajor -eq 8) {
Write-Message -Message 'No backup folder passed in, setting it to instance default' -Level Verbose
$Path = (Get-DbaDefaultPath -SqlInstance $server).Backup
}
if ($dbName -eq "tempdb") {
Stop-Function -Message "Backing up tempdb not supported" -Continue
}
if ('Normal' -notin ($db.Status -split ',')) {
Stop-Function -Message "Database status not Normal. $dbName skipped." -Continue
}
if ($db.DatabaseSnapshotBaseName) {
Stop-Function -Message "Backing up snapshots not supported. $dbName skipped." -Continue
}
Write-Message -Level Verbose -Message "Backup database $db"
if ($null -eq $db.RecoveryModel) {
$db.RecoveryModel = $server.Databases[$db.Name].RecoveryModel
Write-Message -Level Verbose -Message "$dbName is in $($db.RecoveryModel) recovery model"
}
# Fixes one-off cases of StackOverflowException crashes, see issue 1481
$dbRecovery = $db.RecoveryModel.ToString()
if ($dbRecovery -eq 'Simple' -and $Type -eq 'Log') {
$failreason = "$db is in simple recovery mode, cannot take log backup"
$failures += $failreason
Write-Message -Level Warning -Message "$failreason"
}
$db.Refresh()
$lastfull = $db.LastBackupDate.Year
if ($Type -notin @("Database", "Full") -and $lastfull -eq 1) {
$failreason = "$db does not have an existing full backup, cannot take log or differentialbackup"
$failures += $failreason
Write-Message -Level Warning -Message "$failreason"
}
if ($CopyOnly -ne $true) {
$CopyOnly = $false
}
$server.ConnectionContext.StatementTimeout = 0
$backup = New-Object Microsoft.SqlServer.Management.Smo.Backup
$backup.Database = $db.Name
$Suffix = "bak"
if ($null -ne $encryptionOptions) {
$backup.EncryptionOption = $encryptionOptions
}
if ($CompressBackup) {
if ($db.EncryptionEnabled) {
# Newer versions of SQL Server automatically set the MAXTRANSFERSIZE to 128k
# so let's do that for people as well
$minVerForTDECompression = [version]'13.0.4446.0' #SQL Server 2016 CU 4
$flagTDESQLVersion = $minVerForTDECompression -le $Server.version
if (-not (Test-Bound 'MaxTransferSize')) {
$MaxTransferSize = 128kb
}
$flagCorrectMaxTransferSize = ($MaxTransferSize -gt 64kb)
if ($flagTDESQLVersion -and $flagCorrectMaxTransferSize) {
Write-Message -Level Verbose -Message "$dbName is enabled for encryption but will compress"
$backup.CompressionOption = 1
} else {
Write-Message -Level Warning -Message "$dbName is enabled for encryption, will not compress"
$backup.CompressionOption = 2
}
} elseif ($server.Edition -like 'Express*' -or ($server.VersionMajor -eq 10 -and $server.VersionMinor -eq 0 -and $server.Edition -notlike '*enterprise*') -or $server.VersionMajor -lt 10) {
Write-Message -Level Warning -Message "Compression is not supported with this version/edition of Sql Server"
} else {
Write-Message -Level Verbose -Message "Compression enabled"
$backup.CompressionOption = 1
}
}
if ($Checksum) {
$backup.Checksum = $true
}
if ($Type -in 'Diff', 'Differential') {
Write-Message -Level VeryVerbose -Message "Creating differential backup"
$SMOBackuptype = "Database"
$backup.Incremental = $true
$outputType = 'Differential'
$gbhSwitch = @{'LastDiff' = $true }
}
$Backup.NoRecovery = $false
if ($Type -eq "Log") {
Write-Message -Level VeryVerbose -Message "Creating log backup"
$Suffix = "trn"
$OutputType = 'Log'
$SMOBackupType = 'Log'
$Backup.NoRecovery = $NoRecovery
$gbhSwitch = @{'LastLog' = $true }
}
if ($Type -in 'Full', 'Database') {
Write-Message -Level VeryVerbose -Message "Creating full backup"
$SMOBackupType = "Database"
$OutputType = 'Full'
$gbhSwitch = @{'LastFull' = $true }
}
$backup.CopyOnly = $CopyOnly
$backup.Action = $SMOBackupType
if ($null -ne $AzureBaseUrl -and $null -ne $AzureCredential) {
$backup.CredentialName = $AzureCredential
}
Write-Message -Level Verbose -Message "Building file name"
$BackupFinalName = ''
$FinalBackupPath = @()
$timestamp = Get-Date -Format $TimeStampFormat
if ('NUL' -eq $FilePath) {
$FinalBackupPath += 'NUL:'
$IgnoreFileChecks = $true
} elseif ('' -ne $FilePath) {
$File = New-Object System.IO.FileInfo($FilePath)
$BackupFinalName = $file.Name
$suffix = $file.extension -Replace '^\.', ''
if ( '' -ne (Split-Path $FilePath)) {
Write-Message -Level Verbose -Message "Fully qualified path passed in"
# Because of #7860, don't use [IO.Path]::GetFullPath on MacOS
if ($nonwindows -or $isdestlinux) {
$FinalBackupPath += $file.DirectoryName
} else {
$FinalBackupPath += [IO.Path]::GetFullPath($file.DirectoryName)
}
}
} else {
Write-Message -Level VeryVerbose -Message "Setting filename - $timestamp"
$BackupFinalName = "$($dbName)_$timestamp.$suffix"
}
Write-Message -Level Verbose -Message "Building backup path"
if ($FinalBackupPath.Count -eq 0) {
$FinalBackupPath += $Path
}
if ($Path.Count -eq 1 -and $FileCount -gt 1) {
for ($i = 0; $i -lt ($FileCount - 1); $i++) {
$FinalBackupPath += $FinalBackupPath[0]
}
}
if ($AzureBaseUrl -or $AzureCredential -or $isdestlinux) {
$slash = "/"
} else {
$slash = "\"
}
if ($FinalBackupPath.Count -gt 1) {
$File = New-Object System.IO.FileInfo($BackupFinalName)
for ($i = 0; $i -lt $FinalBackupPath.Count; $i++) {
$FinalBackupPath[$i] = $FinalBackupPath[$i] + $slash + ("$($i+1)-" * $IncrementPrefix.ToBool() ) + $($File.BaseName) + "-$($i+1)-of-$FileCount.$suffix"
}
} elseif ($FinalBackupPath[0] -ne 'NUL:') {
$FinalBackupPath[0] = $FinalBackupPath[0] + $slash + $BackupFinalName
}
if ($CreateFolder -and $FinalBackupPath[0] -ne 'NUL:') {
for ($i = 0; $i -lt $FinalBackupPath.Count; $i++) {
$parent = [IO.Path]::GetDirectoryName($FinalBackupPath[$i])
$leaf = [IO.Path]::GetFileName($FinalBackupPath[$i])
$FinalBackupPath[$i] = [IO.Path]::Combine($parent, $dbName, $leaf)
}
}
if ($True -eq $ReplaceInName) {
for ($i = 0; $i -lt $FinalBackupPath.count; $i++) {
$FinalBackupPath[$i] = $FinalBackupPath[$i] -replace ('dbname', $dbName)
$FinalBackupPath[$i] = $FinalBackupPath[$i] -replace ('instancename', $server.ServiceName)
$FinalBackupPath[$i] = $FinalBackupPath[$i] -replace ('servername', $server.ComputerName)
$FinalBackupPath[$i] = $FinalBackupPath[$i] -replace ('timestamp', $timestamp)
$FinalBackupPath[$i] = $FinalBackupPath[$i] -replace ('backuptype', $outputType)
}
}
# Linux can't support making new directories yet, and it's likely that databases
# will be in one place
if (-not $IgnoreFileChecks -and -not $AzureBaseUrl -and -not $isdestlinux) {
$parentPaths = ($FinalBackupPath | ForEach-Object { Split-Path $_ } | Select-Object -Unique)
foreach ($parentPath in $parentPaths) {
if (-not (Test-DbaPath -SqlInstance $server -Path $parentPath)) {
if (($BuildPath -eq $true) -or ($CreateFolder -eq $True)) {
$null = New-DbaDirectory -SqlInstance $server -Path $parentPath
} else {
$failreason += "SQL Server cannot check if $parentPath exists. You can try disabling this check with -IgnoreFileChecks"
$failures += $failreason
Write-Message -Level Warning -Message "$failreason"
}
}
}
}
# Because of #7860, don't use [IO.Path]::GetFullPath on MacOS
if ($null -eq $AzureBaseUrl -and $Path -and -not $nonwindows -and -not $isdestlinux) {
$FinalBackupPath = $FinalBackupPath | ForEach-Object { [IO.Path]::GetFullPath($_) }
}
$script = $null
$backupComplete = $false
if (!$failures) {
$FileCount = $FinalBackupPath.Count
foreach ($backupfile in $FinalBackupPath) {
$device = New-Object Microsoft.SqlServer.Management.Smo.BackupDeviceItem
if ($null -ne $AzureBaseUrl) {
$device.DeviceType = "URL"
} else {
$device.DeviceType = "File"
}
if ($WithFormat) {
Write-Message -Message "WithFormat specified. Ensuring Initialize and SkipTapeHeader are set to true." -Level Verbose
$Initialize = $true
$SkipTapeHeader = $true
}
$backup.FormatMedia = $WithFormat
$backup.Initialize = $Initialize
$backup.SkipTapeHeader = $SkipTapeHeader
$device.Name = $backupfile
$backup.Devices.Add($device)
}
$humanBackupFile = $FinalBackupPath -Join ','
Write-Message -Level Verbose -Message "Devices added"
$percent = [Microsoft.SqlServer.Management.Smo.PercentCompleteEventHandler] {
Write-Progress -Id $ProgressId -Activity "Backing up database $dbName to $humanBackupFile" -PercentComplete $_.Percent -Status ([System.String]::Format("Progress: {0} %", $_.Percent))
}
$backup.add_PercentComplete($percent)
$backup.PercentCompleteNotification = 1
$backup.add_Complete($complete)
if ($MaxTransferSize) {
$backup.MaxTransferSize = $MaxTransferSize
}
if ($BufferCount) {
$backup.BufferCount = $BufferCount
}
if ($BlockSize) {
$backup.Blocksize = $BlockSize
}
Write-Progress -Id $ProgressId -Activity "Backing up database $dbName to $humanBackupFile" -PercentComplete 0 -Status ([System.String]::Format("Progress: {0} %", 0))
try {
if ($Pscmdlet.ShouldProcess($server.Name, "Backing up $dbName to $humanBackupFile")) {
if ($OutputScriptOnly -ne $True) {
$backup.SqlBackup($server)
$script = $backup.Script($server)
Write-Progress -Id $ProgressId -Activity "Backing up database $dbName to $backupfile" -Status "Complete" -Completed
$BackupComplete = $true
if ($server.VersionMajor -eq '8') {
$HeaderInfo = Get-BackupAncientHistory -SqlInstance $server -Database $dbName
} else {
$HeaderInfo = Get-DbaDbBackupHistory -SqlInstance $server -Database $dbName @gbhSwitch -IncludeCopyOnly -RecoveryFork $db.RecoveryForkGuid | Sort-Object -Property End -Descending | Select-Object -First 1
}
$Filelist = @()
$FileList += $Headerinfo.FileList | Where-Object { $_.FileType -eq "D" } | Select-Object FileType, LogicalName , PhysicalName, @{ Name = "Type"; Expression = { "D" } }
$FileList += $Headerinfo.FileList | Where-Object { $_.FileType -eq "L" } | Select-Object FileType, LogicalName , PhysicalName, @{ Name = "Type"; Expression = { "L" } }
$Verified = $false
if ($Verify) {
$verifiedresult = [PSCustomObject]@{
ComputerName = $server.ComputerName
InstanceName = $server.ServiceName
SqlInstance = $server.DomainInstanceName
DatabaseName = $dbName
BackupComplete = $BackupComplete
BackupFilesCount = $FinalBackupPath.Count
BackupFile = (Split-Path $FinalBackupPath -Leaf)
BackupFolder = (Convert-BackupPath -object (Split-Path $FinalBackupPath | Sort-Object -Unique))
BackupPath = ($FinalBackupPath | Sort-Object -Unique)
Script = $script
Notes = $failures -join (',')
FullName = ($FinalBackupPath | Sort-Object -Unique)
FileList = $FileList
SoftwareVersionMajor = $server.VersionMajor
Type = $outputType
FirstLsn = $HeaderInfo.FirstLsn
DatabaseBackupLsn = $HeaderInfo.DatabaseBackupLsn
CheckPointLsn = $HeaderInfo.CheckPointLsn
LastLsn = $HeaderInfo.LastLsn
BackupSetId = $HeaderInfo.BackupSetId
LastRecoveryForkGUID = $HeaderInfo.LastRecoveryForkGUID
EncryptorName = $encryptionOptions.EncryptorName
KeyAlgorithm = $encryptionOptions.Algorithm
EncruptorType = $encryptionOptions.encryptorType
} | Restore-DbaDatabase -SqlInstance $server -DatabaseName DbaVerifyOnly -VerifyOnly -TrustDbBackupHistory -DestinationFilePrefix DbaVerifyOnly
if ($verifiedResult[0] -eq "Verify successful") {
$failures += $verifiedResult[0]
$Verified = $true
} else {
$failures += $verifiedResult[0]
$Verified = $false
}
}
$HeaderInfo | Add-Member -Type NoteProperty -Name BackupComplete -Value $BackupComplete
$HeaderInfo | Add-Member -Type NoteProperty -Name BackupFile -Value (Split-Path $FinalBackupPath -Leaf)
$HeaderInfo | Add-Member -Type NoteProperty -Name BackupFilesCount -Value $FinalBackupPath.Count
if ($FinalBackupPath[0] -eq 'NUL:') {
$pathresult = "NUL:"
} else {
$pathresult = (Split-Path $FinalBackupPath | Sort-Object -Unique)
if ($isdestlinux -and $pathresult) {
$pathresult = $pathresult.Replace("\", "/")
} elseif ($pathresult) {
$pathresult = $pathresult.Replace("/", "\")
}
}
$HeaderInfo | Add-Member -Type NoteProperty -Name BackupFolder -Value $pathresult
$HeaderInfo | Add-Member -Type NoteProperty -Name BackupPath -Value ($FinalBackupPath | Sort-Object -Unique)
$HeaderInfo | Add-Member -Type NoteProperty -Name DatabaseName -Value $dbName
$HeaderInfo | Add-Member -Type NoteProperty -Name DatabaseId -Value $db.ID
$HeaderInfo | Add-Member -Type NoteProperty -Name Notes -Value ($failures -join (','))
$HeaderInfo | Add-Member -Type NoteProperty -Name Script -Value $script
$HeaderInfo | Add-Member -Type NoteProperty -Name Verified -Value $Verified
} else {
$backup.Script($server)
}
}
} catch {
if ($NoRecovery -and ($_.Exception.InnerException.InnerException.InnerException -like '*cannot be opened. It is in the middle of a restore.')) {
Write-Message -Message "Exception thrown by db going into restoring mode due to recovery" -Leve Verbose
} else {
Write-Progress -Id $ProgressId -Activity "Backup" -Status "Failed" -Completed
Stop-Function -message "Backup Failed" -ErrorRecord $_ -Continue
$BackupComplete = $false
}
}
}
Write-Progress -Id $topProgressId -Activity 'Backup' -Completed
$OutputExclude = 'FullName', 'FileList', 'SoftwareVersionMajor'
if ($failures.Count -eq 0) {
$OutputExclude += ('Notes', 'FirstLsn', 'DatabaseBackupLsn', 'CheckpointLsn', 'LastLsn', 'BackupSetId', 'LastRecoveryForkGuid')
}
$headerinfo | Select-DefaultView -ExcludeProperty $OutputExclude
if (-not $ReplaceInName) {
$FilePath = $null
}
}
}
}