New-DbaReplPublication


Author	Jess Pomfret (@jpomfret), jesspomfret.com
Availability	Windows, Linux, macOS

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

Synopsis

Creates a publication for the database on the target SQL instances.

Description

Creates a publication for the database on the target SQL instances.

https://learn.microsoft.com/en-us/sql/relational-databases/replication/publish/create-a-publication?view=sql-server-ver16

Syntax

New-DbaReplPublication
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [-Database] <String>
    [-Name] <String>
    [-Type] <String>
    [[-LogReaderAgentCredential] <PSCredential>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> New-DbaReplPublication -SqlInstance mssql1 -Database Northwind -Name PubFromPosh -Type Transactional

Creates a transactional publication called PubFromPosh for the Northwind database on mssql1

Example: 2

PS C:\> New-DbaReplPublication -SqlInstance mssql1 -Database pubs -Name snapPub -Type Snapshot

Creates a snapshot publication called snapPub for the pubs database on mssql1

Example: 3

PS C:\> New-DbaReplPublication -SqlInstance mssql1 -Database pubs -Name mergePub -Type Merge

Creates a merge publication called mergePub for the pubs database on mssql1

Required Parameters

-SqlInstance

The target SQL Server instance or instances.


Alias
Required	True
Pipeline	true (ByValue)
Default Value

-Database

The database that contains the articles to be replicated.


Alias
Required	True
Pipeline	false
Default Value

-Name

The name of the replication publication.


Alias
Required	True
Pipeline	false
Default Value

-Type

The flavour of replication.
Options are Transactional, Snapshot, Merge


Alias
Required	True
Pipeline	false
Default Value
Accepted Values	Snapshot,Transactional,Merge

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.


Alias
Required	False
Pipeline	false
Default Value

-LogReaderAgentCredential

Used to provide the credentials for the Microsoft Windows account under which the Log Reader Agent runs
Setting LogReaderAgentProcessSecurity is not required when the publication is created by a member of the sysadmin fixed server role.
In this case, the agent will impersonate the SQL Server Agent account. For more information, see Replication Agent Security Model.
TODO: test LogReaderAgentCredential parameters


Alias
Required	False
Pipeline	false
Default Value

-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

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.


Alias	wi
Required	False
Pipeline	false
Default Value

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.


Alias	cf
Required	False
Pipeline	false
Default Value