Add-DbaAgDatabase

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

Synopsis

Adds databases to an Availability Group with automated backup, restore, and synchronization handling.

Description

Adds databases to an Availability Group and handles the complete process from backup through synchronization. This command eliminates the manual steps typically required when expanding Availability Groups with new databases, automatically managing seeding modes, backup/restore operations, and replica synchronization.

The command executes a comprehensive five-step process for each database:

• Step 1: Setting seeding mode if needed.
  • If -SeedingMode is used and the current seeding mode of the replica is not in the desired mode, the seeding mode of the replica is changed.
  • The seeding mode will not be changed back but stay in this mode.
  • If the seeding mode is changed to Automatic, the necessary rights to create databases will be granted.
• Step 2: Running backup and restore if needed.
  • Action is only taken for replicas with a desired seeding mode of Manual and where the database does not yet exist.
  • If -UseLastBackup is used, the restore will be performed based on the backup history of the database.
  • Otherwise a full and log backup will be taken at the primary and those will be restored at the replica using the same folder structure.
• Step 3: Add the database to the Availability Group on the primary replica.
  • This step is skipped, if the database is already part of the Availability Group.
• Step 4: Add the database to the Availability Group on the secondary replicas.
  • This step is skipped for those replicas, where the database is already joined to the Availability Group.
• Step 5: Wait for the database to finish joining the Availability Group on the secondary replicas.

Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met before running this command.

For custom backup and restore requirements, perform those operations with Backup-DbaDatabase and Restore-DbaDatabase in advance, ensuring the last log backup has been restored before running Add-DbaAgDatabase.

Syntax

Add-DbaAgDatabase
    [-SqlInstance] <DbaInstanceParameter>
    [-SqlCredential <PSCredential>]
    -AvailabilityGroup <String>
    -Database <String[]>
    [-Secondary <DbaInstanceParameter[]>]
    [-SecondarySqlCredential <PSCredential>]
    [-SeedingMode <String>]
    [-SharedPath <String>]
    [-UseLastBackup]
    [-AdvancedBackupParams <Hashtable>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Add-DbaAgDatabase
    [-AvailabilityGroup] <String>
    [-Secondary <DbaInstanceParameter[]>]
    [-SecondarySqlCredential <PSCredential>]
    -InputObject <Database[]>
    [-SeedingMode <String>]
    [-SharedPath <String>]
    [-UseLastBackup]
    [-AdvancedBackupParams <Hashtable>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Add-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1, db2 -Confirm

Adds db1 and db2 to ag1 on sql2017a. Prompts for confirmation.

Example: 2

PS C:\> Get-DbaDatabase -SqlInstance sql2017a | Out-GridView -Passthru | Add-DbaAgDatabase -AvailabilityGroup ag1

Adds selected databases from sql2017a to ag1

Example: 3

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: 4

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

Example: 5

PS C:\> $adv_param = @{
>>    CompressBackup = $true
>>    FileCount = 3
>> }
PS C:\> $splat = @{
>>   SqlInstance = 'sql2017a'
>>   AvailabilityGroup = 'ag1'
>>   Database = 'db1'
>>   Secondary = 'sql2017b'
>>   SeedingMode = 'Manual'
>>   SharedPath = '\\FS\Backup'
>> }
PS C:\> Add-DbaAgDatabase @splat -AdvancedBackupParams $adv_param

Adds db1 to ag1 on sql2017a and sql2017b. Uses compression and three files while taking the backups.

Required Parameters

-SqlInstance

The primary replica of the Availability Group. Server version must be SQL Server version 2012 or higher.

-AvailabilityGroup

Specifies the target Availability Group name where databases will be added. The AG must already exist and be configured.
Use this to identify which existing Availability Group should receive the new database members.

-Database

Specifies which databases to add to the Availability Group. Accepts single database names, arrays, or wildcard patterns.
Use this when you need to add specific databases rather than piping database objects from Get-DbaDatabase.

-InputObject

Accepts database objects from pipeline input, typically from Get-DbaDatabase or Get-DbaDbSharePoint.
Use this for workflow scenarios where you want to filter databases first, then pipe the results directly into the AG addition process.

Optional Parameters

-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.

-Secondary

Specifies secondary replica instances to target for database addition. Auto-discovered if not specified.
Use this when replicas use non-standard ports or when you want to limit the operation to specific secondary replicas rather than all replicas in the AG.

-SecondarySqlCredential

Authentication credentials for connecting to secondary replica instances when they require different credentials than the primary.
Use this when secondary replicas are in different domains, use SQL authentication, or require service accounts with specific permissions for backup/restore operations.

-SeedingMode

Controls how database data is transferred to secondary replicas during AG addition. Valid values are 'Automatic' or 'Manual'.
Automatic seeding transfers data directly over the network without requiring backup/restore operations, but needs sufficient network bandwidth and proper endpoint configuration.
Manual seeding uses traditional backup/restore through shared storage, giving you more control over timing and storage location but requiring accessible file shares.

-SharedPath

Specifies the UNC network path where backups are stored during manual seeding operations. Required when using Manual seeding mode.
All SQL Server service accounts from primary and secondary replicas must have read/write access to this location. Backup files remain on the share after completion for potential reuse or cleanup.

-UseLastBackup

Uses existing backup history instead of creating new backups for manual seeding. The most recent log backup must be newer than the most recent full backup.
Use this when you have recent backups available and want to avoid taking additional backups, reducing backup storage requirements and time.

-AdvancedBackupParams

Passes additional parameters to Backup-DbaDatabase as a hashtable when creating backups during manual seeding.
Use this to control backup compression, file count, or other backup-specific settings like @ for faster backup operations.

-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.

-WhatIf

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

-Confirm

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