Article Article Article Article Class

Definition

Represents the base class from which the TransArticle class and MergeArticle class are derived.

public ref class Article abstract : Microsoft::SqlServer::Replication::ReplicationObject
public abstract class Article : Microsoft.SqlServer.Replication.ReplicationObject
type Article = class
    inherit ReplicationObject
Public MustInherit Class Article
Inherits ReplicationObject
Inheritance
Derived

Remarks

The Article class represents article properties and behaviors that are common to articles published in transactional and merge replication topologies.

Articles published from a non-SQL Server Publisher are represented by the DistributionArticle class.

Thread Safety

Public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

Constructors

Article() Article() Article() Article()

Initializes a new instance of the Article class.

Properties

ArticleId ArticleId ArticleId ArticleId

Gets the article ID value.

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)
CreateArticleAsHeterogeneous CreateArticleAsHeterogeneous CreateArticleAsHeterogeneous CreateArticleAsHeterogeneous

Gets or sets a value that indicates whether to create an article as heterogeneous.

CreationScript CreationScript CreationScript CreationScript

Gets or sets the name and full path of the Transact-SQL script file that is used to create the destination object at the Subscriber.

DatabaseName DatabaseName DatabaseName DatabaseName

Gets or sets the name of the database that contains the data and the objects that are published in the article.

Description Description Description Description

Gets or sets a textual description of the article.

DestinationObjectName DestinationObjectName DestinationObjectName DestinationObjectName

Gets or sets the database object that is the source database object for the article at the Subscriber.

DestinationObjectOwner DestinationObjectOwner DestinationObjectOwner DestinationObjectOwner

Gets or sets the schema owner of the source database object for the article at the Subscriber.

IdentityRangeManagementOption IdentityRangeManagementOption IdentityRangeManagementOption IdentityRangeManagementOption

Gets or sets the identity range management options for the article.

IdentityRangeThreshold IdentityRangeThreshold IdentityRangeThreshold IdentityRangeThreshold

Gets or sets the value at which a new range of identity column values are assigned to a Publisher or to a Subscriber.

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.

PreCreationMethod PreCreationMethod PreCreationMethod PreCreationMethod

Gets or sets the action to take when the published object already exists in the subscription database.

PublicationName PublicationName PublicationName PublicationName

Gets or sets the name of the publication to which the article belongs.

PublisherIdentityRangeSize PublisherIdentityRangeSize PublisherIdentityRangeSize PublisherIdentityRangeSize

Gets or sets the range of identity values assigned to table columns at the Publisher.

SchemaOption SchemaOption SchemaOption SchemaOption

Gets or sets the schema creation options for an article.

SourceObjectName SourceObjectName SourceObjectName SourceObjectName

Gets or sets the name of the database object that is being published.

SourceObjectOwner SourceObjectOwner SourceObjectOwner SourceObjectOwner

Gets or sets the owner of the database object that is being published.

SqlServerName SqlServerName SqlServerName SqlServerName

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

(Inherited from ReplicationObject)
SubscriberIdentityRangeSize SubscriberIdentityRangeSize SubscriberIdentityRangeSize SubscriberIdentityRangeSize

Gets or sets the maximum number of new rows that can be inserted into an identity column in a table at a Subscriber before another identity range must be allocated.

Type Type Type Type

Gets or sets the type of article.

UserData UserData UserData UserData

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

(Inherited from ReplicationObject)
VerticalPartition VerticalPartition VerticalPartition VerticalPartition

Gets a value that indicates whether all columns are published in a table article.

Methods

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

Checks the valid article creation.

CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the definition is valid.

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 a new article on the currently connected instance of SQL Server based on the current properties of the TransArticle object or the MergeArticle object.

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 an existing article on the currently connected instance of SQL Server based on the current properties of the TransArticle object or the MergeArticle object.

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

Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server.

Applies to

See also