commands

Clear
^

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

 

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

Synopsis

Removes an article from a publication for the database on the target SQL instances.

Description

Removes an article from a publication for the database on the target SQL instances.

Dropping an article from a publication does not remove the object from the publication database or the corresponding object from the subscription database.
Use DROP to remove these objects if necessary.
#TODO: add a param for this DropObjectOnSubscriber

Dropping an article invalidates the current snapshot; therefore a new snapshot must be created.

Syntax

Remove-DbaReplArticle
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String>]
    [[-Publication] <String>]
    [[-Schema] <String>]
    [[-Name] <String>]
    [[-InputObject] <Article[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Remove-DbaReplArticle -SqlInstance mssql1 -Database Pubs -Publication PubFromPosh -Name 'publishers'

Removes the publishers article from a publication called PubFromPosh on mssql1

Example: 2
PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database Pubs -Publication TestPub | Remove-DbaReplArticle

Removes all articles from a publication called TestPub on mssql1

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.
Alias
Required False
Pipeline false
Default Value
-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
-Database

The database on the publisher that contains the article to be removed from replication.
Alias
Required False
Pipeline false
Default Value
-Publication

The name of the replication publication.
Alias
Required False
Pipeline false
Default Value
-Schema

Source schema of the replicated object to remove from the publication.
Alias
Required False
Pipeline false
Default Value dbo
-Name

The name of the article to remove.
Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piping from Get-DbaReplArticle
Alias
Required False
Pipeline true (ByValue)
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