DistributionArticle DistributionArticle DistributionArticle DistributionArticle Class

Definition

Represents information about an article published in a transactional or snapshot publication stored at the Distributor.

public ref class DistributionArticle sealed : Microsoft::SqlServer::Replication::ReplicationObject
public sealed class DistributionArticle : Microsoft.SqlServer.Replication.ReplicationObject
type DistributionArticle = class
    inherit ReplicationObject
Public NotInheritable Class DistributionArticle
Inherits ReplicationObject
Inheritance
DistributionArticleDistributionArticleDistributionArticleDistributionArticle

Remarks

The DistributionArticle class is used primarily by SQL Server Management Studio and for non-SQL Server Publishers. To create, view, or modify the properties of an article, you should instead use an instance of the TransArticle class.

The DistributionArticle class requires a connection to the Distributor.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Constructors

DistributionArticle() DistributionArticle() DistributionArticle() DistributionArticle()

Creates a new instance of the DistributionArticle class.

DistributionArticle(String, String, String, String, String, ServerConnection) DistributionArticle(String, String, String, String, String, ServerConnection) DistributionArticle(String, String, String, String, String, ServerConnection) DistributionArticle(String, String, String, String, String, ServerConnection)

Creates a new instance of the DistributionArticle class with the required properties and a connection to the Distributor.

Properties

ArticleId ArticleId ArticleId ArticleId

Gets or sets the ID value for the article.

CachePropertyChanges CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
ConnectionContext ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Description Description Description Description

Gets or sets a description for the article.

DistributionDBName DistributionDBName DistributionDBName DistributionDBName

Gets or sets the name of the distribution database that contains the article metadata.

IsExistingObject IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
Name Name Name Name

Gets or sets the name of the article.

PublicationDBName PublicationDBName PublicationDBName PublicationDBName

Gets or sets the name of the publication database.

PublicationName PublicationName PublicationName PublicationName

Gets or sets the name of the publication that contains the article.

PublisherName PublisherName PublisherName PublisherName

Gets or sets the name of the Publisher.

SourceObjectName SourceObjectName SourceObjectName SourceObjectName

Gets or sets the database object that provides the article data.

SourceObjectOwner SourceObjectOwner SourceObjectOwner SourceObjectOwner

Gets or sets the owner of the database object that provides the article data.

SqlServerName SqlServerName SqlServerName SqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
UserData UserData UserData UserData

Gets or sets an object property that allows users to attach their own data to the object.

(Inherited from ReplicationObject)

Methods

CheckValidCreation() CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the definition is valid.

(Inherited from ReplicationObject)
CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create() Create() Create() Create()

Creates the article metadata at the Distributor.

Decouple() Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String)

Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean)

Returns the drop command from the replication.

(Inherited from ReplicationObject)
InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
Load() Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
Remove() Remove() Remove() Remove()

Removes article metadata from the Distributor.

Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions)

Generates a Transact-SQL script that can be used to create or delete the article with the specified properties.

Applies to