functions/Add-DbaAgDatabase.ps1
|
function Add-DbaAgDatabase { <# .SYNOPSIS Adds a database to an availability group on a SQL Server instance. .DESCRIPTION Adds a database to an availability group on a SQL Server instance. Before joining the replica databases to the availability group, the databases will be initialized with automatic seeding or full/log backup. .PARAMETER SqlInstance The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher. This should be the primary replica. .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 or databases to add. .PARAMETER AvailabilityGroup The availability group where the databases will be added. .PARAMETER Secondary Not required - the command will figure this out. But if you'd like to be explicit about replicas, this will help. .PARAMETER SecondarySqlCredential 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 InputObject Enables piping from Get-DbaDatabase, Get-DbaDbSharePoint and more. .PARAMETER SeedingMode Specifies how the secondary replica will be initially seeded. Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. If not specified, the setting from the availability group replica will be used. Otherwise the setting will be updated. .PARAMETER SharedPath The network share where the backups will be backed up and restored from. Each SQL Server service account must have access to this share. NOTE: If a backup / restore is performed, the backups will be left in tact on the network share. .PARAMETER UseLastBackup Use the last full backup of database. .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 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. .NOTES Tags: AvailabilityGroup, HA, AG Author: Chrissy LeMaire (@cl), netnerds.net Website: https://dbatools.io Copyright: (c) 2018 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Add-DbaAgDatabase .EXAMPLE PS C:\> Add-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2 -Confirm Adds db1 and db2 to ag1 on sql2017a. Prompts for confirmation. .EXAMPLE PS C:\> Get-DbaDatabase -SqlInstance sql2017a | Out-GridView -Passthru | Add-DbaAgDatabase -AvailabilityGroup ag1 Adds selected databases from sql2017a to ag1 .EXAMPLE PS C:\> Get-DbaDbSharePoint -SqlInstance sqlcluster | Add-DbaAgDatabase -AvailabilityGroup SharePoint Adds SharePoint databases as found in SharePoint_Config on sqlcluster to ag1 on sqlcluster .EXAMPLE PS C:\> Get-DbaDbSharePoint -SqlInstance sqlcluster -ConfigDatabase SharePoint_Config_2019 | Add-DbaAgDatabase -AvailabilityGroup SharePoint Adds SharePoint databases as found in SharePoint_Config_2019 on sqlcluster to ag1 on sqlcluster #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'Low')] param ( [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [parameter(Mandatory)] [string]$AvailabilityGroup, [string[]]$Database, [DbaInstanceParameter[]]$Secondary, [PSCredential]$SecondarySqlCredential, [parameter(ValueFromPipeline)] [Microsoft.SqlServer.Management.Smo.Database[]]$InputObject, [ValidateSet('Automatic', 'Manual')] [string]$SeedingMode, [string]$SharedPath, [switch]$UseLastBackup, [switch]$EnableException ) process { if ((Test-Bound -ParameterName SqlInstance)) { if ((Test-Bound -Not -ParameterName Database) -or (Test-Bound -Not -ParameterName AvailabilityGroup)) { Stop-Function -Message "You must specify one or more databases and one Availability Group when using the SqlInstance parameter." return } } foreach ($instance in $SqlInstance) { $InputObject += Get-DbaDatabase -SqlInstance $instance -SqlCredential $SqlCredential -Database $Database } foreach ($db in $InputObject) { $allbackups = @{ } $Primary = $db.Parent # check primary, should be run against primary $ag = Get-DbaAvailabilityGroup -SqlInstance $db.Parent -AvailabilityGroup $AvailabilityGroup if (-not $ag.Parent) { Stop-Function -Message "Availability Group $AvailabilityGroup not found on $($db.Parent.Name)" -Continue } if ($ag.AvailabilityDatabases.Name -contains $db.Name) { Stop-Function -Message "$($db.Name) is already joined to $($ag.Name)" -Continue } if (-not $Secondary) { try { $secondarynames = ($ag.AvailabilityReplicas | Where-Object Role -eq Secondary).Name if ($secondarynames) { $secondaryInstances = $secondarynames | Connect-DbaInstance -SqlCredential $SecondarySqlCredential } } catch { Stop-Function -Message "Failure connecting to secondary instance" -ErrorRecord $_ -Continue } } else { $secondaryInstances = Connect-DbaInstance -SqlInstance $Secondary -SqlCredential $SecondarySqlCredential } if ($SeedingMode -ne "Automatic") { if (((Get-DbaDatabase -SqlInstance $ag.Parent -Database $db.Name).LastFullBackup).Year -eq 1) { Stop-Function -Message "Cannot add $($db.Name) to $($ag.Name) on $($ag.Parent.Name). An initial full backup must be created first." -Continue } } if ($SeedingMode -eq "Automatic") { # first check if ($Pscmdlet.ShouldProcess($Primary, "Backing up $db to NUL")) { $null = Backup-DbaDatabase -BackupFileName NUL -SqlInstance $Primary -SqlCredential $SqlCredential -Database $db } } if ($Pscmdlet.ShouldProcess($ag.Parent.Name, "Adding availability group $db to $($db.Parent.Name)")) { try { $agdb = New-Object Microsoft.SqlServer.Management.Smo.AvailabilityDatabase($ag, $db.Name) # something is up with .net create(), force a stop Invoke-Create -Object $agdb Get-DbaAgDatabase -SqlInstance $ag.Parent -Database $db.Name } catch { Stop-Function -Message "Failure" -ErrorRecord $_ -Continue } } foreach ($secondaryInstance in $secondaryInstances) { try { $secondaryInstanceReplicaName = $secondaryInstance.NetName } catch { $secondaryInstanceReplicaName = $secondaryInstance.ComputerName } if ($secondaryInstance.InstanceName) { $secondaryInstanceReplicaName = $secondaryInstanceReplicaName, $secondaryInstance.InstanceName -join "\" } $agreplica = Get-DbaAgReplica -SqlInstance $Primary -SqlCredential $SqlCredential -AvailabilityGroup $ag.name -Replica $secondaryInstanceReplicaName if (-not $agreplica) { Stop-Function -Continue -Message "Secondary replica $($secondaryInstanceReplicaName) for availability group $($ag.name) not found on $($Primary.Name)" } if ($SeedingMode -eq "Automatic" -and $secondaryInstance.VersionMajor -le 12) { Stop-Function -Continue -Message "Automatic seeding mode not supported on SQL Server versions prior to 2016 - Instance $($secondaryInstance.Name)" if (-not $SharedPath -and -not $UseLastBackup) { Stop-Function -Continue -Message "Automatic seeding not supported and no $SharedPath provided. Database not added to instance $($secondaryInstance.Name)" } } if ($SeedingMode) { $agreplica.SeedingMode = $SeedingMode $agreplica.Alter() } $agreplica.Refresh() $SeedingModeReplica = $agreplica.SeedingMode $primarydb = Get-DbaDatabase -SqlInstance $Primary -SqlCredential $SqlCredential -Database $db.name if ($SeedingModeReplica -ne 'Automatic') { try { if (-not $allbackups[$db]) { if ($UseLastBackup) { $allbackups[$db] = Get-DbaDbBackupHistory -SqlInstance $primarydb.Parent -Database $primarydb.Name -IncludeCopyOnly -Last -EnableException } else { $fullbackup = $primarydb | Backup-DbaDatabase -BackupDirectory $SharedPath -Type Full -EnableException $logbackup = $primarydb | Backup-DbaDatabase -BackupDirectory $SharedPath -Type Log -EnableException $allbackups[$db] = $fullbackup, $logbackup } Write-Message -Level Verbose -Message "Backups still exist on $SharedPath" } if ($Pscmdlet.ShouldProcess("$Secondary", "restoring full and log backups of $primarydb from $Primary")) { # keep going to ensure output is shown even if dbs aren't added well. $null = $allbackups[$db] | Restore-DbaDatabase -SqlInstance $secondaryInstance -WithReplace -NoRecovery -TrustDbBackupHistory -EnableException } } catch { Stop-Function -Message "Failure" -ErrorRecord $_ -Continue } } $replicadb = Get-DbaAgDatabase -SqlInstance $secondaryInstance -Database $db.Name -AvailabilityGroup $ag.Name if (-not $replicadb.IsJoined) { if ($Pscmdlet.ShouldProcess($ag.Parent.Name, "Joining availability group $db to $($db.Parent.Name)")) { $timeout = 1 do { try { Write-Progress -Activity "Trying to add $($replicadb.Name) to $($secondaryInstance.Name)" -Id 1 -PercentComplete ($timeout * 10) $timeout++ if ($timeout -ne 1) { Start-Sleep -Seconds 3 } $replicadb.Refresh() $replicadb.JoinAvailablityGroup() } catch { Write-Message -Level Verbose -Message "Error joining database to availability group" -ErrorRecord $_ } } while (-not $replicadb.IsJoined -and $timeout -lt 10) Write-Progress -Activity "Trying to add $($replicadb.Name) to $($secondaryInstance.Name)" -Id 1 -Complete if ($replicadb.IsJoined) { $replicadb } else { Stop-Function -Continue -Message "Could not join $($replicadb.Name) to $($secondaryInstance.Name)" } } } else { $replicadb } } } } } |