Get-DbaReplArticle

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

Synopsis

Gets the information about publication articles.

Description

This function locates and enumerates articles' information.

Can specify a database, publication or article name.

Syntax

Get-DbaReplArticle
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <Object[]>]
    [[-Publication] <Object[]>]
    [[-Schema] <String[]>]
    [[-Name] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaReplArticle -SqlInstance mssql1

Retrieve information of all articles from all publications on all databases for server mssql1.

Example: 2

PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database pubs

Retrieve information of all articles from all publications on 'pubs' database for server mssql1.

Example: 3

PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database pubs -Publication PubName

Retrieve information of all articles from 'PubName' on 'pubs' database for server mssql1.

Example: 4

PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database pubs -Schema sales

Retrieve information of articles in the 'sales' schema on 'pubs' database for server mssql1.

Example: 5

PS C:\> Get-DbaReplArticle -SqlInstance mssql1 -Database pubs -Publication PubName -Name sales

Retrieve information of 'sales' article from 'PubName' on 'pubs' database for server mssql1.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

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

-Database

Specifies one or more database(s) to process. If unspecified, all databases will be processed.

-Publication

Specifies one or more publication(s) to process. If unspecified, all publications will be processed.

-Schema

Specifies one or more schema(s) to process. If unspecified, all schemas will be processed.

-Name

Specify the name of one or more article(s) to process. If unspecified, all articles will be processed.

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