| 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.
Removes articles from SQL Server replication publications and their associated subscriptions.
Removes articles from SQL Server replication publications, automatically handling subscription cleanup when subscribers exist. This function is essential when you need to stop replicating specific tables, views, or stored procedures without dismantling the entire publication.
When articles have active subscriptions, the function first removes them from all subscribers using sp_dropsubscription before removing the article from the publication itself. This prevents orphaned subscription entries that could cause synchronization issues.
Important considerations: Dropping an article from a publication does not remove the actual object from the publication database or the corresponding object from the subscription database. Use DROP
Remove-DbaReplArticle
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-Database] <String>]
[[-Publication] <String>]
[[-Schema] <String>]
[[-Name] <String>]
[[-InputObject] <Article[]>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> Remove-DbaReplArticle -SqlInstance mssql1 -Database Pubs -Publication PubFromPosh -Name 'publishers'
Removes the publishers article from a publication called PubFromPosh on mssql1
PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database Pubs -Publication TestPub | Remove-DbaReplArticle
Removes all articles from a publication called TestPub on mssql1
The target SQL Server instance or instances.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
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 |
Specifies the publication database on the publisher that contains the article to remove from replication.
This is the database where the source objects (tables, views, stored procedures) exist and are published for replication.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Specifies the name of the replication publication from which to remove the article.
Use Get-DbaReplPublication to list available publications if you're unsure of the exact name.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Specifies the schema name of the replicated object to remove from the publication. Defaults to 'dbo'.
Required when multiple schemas contain objects with the same name, ensuring you remove the correct article.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | dbo |
Specifies the name of the article to remove from the publication.
This corresponds to the source object name (table, view, or stored procedure) that was added to replication.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Accepts replication article objects from Get-DbaReplArticle for pipeline operations.
Use this to remove multiple articles efficiently: Get-DbaReplArticle | Remove-DbaReplArticle.
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
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 |
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 |
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 |