Article Class

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

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Article
      Microsoft.SqlServer.Replication.MergeArticle
      Microsoft.SqlServer.Replication.TransArticle

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8",  _
    Name := "Microsoft.SqlServer.Rmo")> _
Public MustInherit Class Article _
    Inherits ReplicationObject
'Usage
Dim instance As Article
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")]
public abstract class Article : ReplicationObject
[StrongNameIdentityPermissionAttribute(SecurityAction::InheritanceDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = L"Microsoft.SqlServer.Rmo")]
public ref class Article abstract : public ReplicationObject
[<AbstractClassAttribute>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")>]
type Article =  
    class 
        inherit ReplicationObject 
    end
public abstract class Article extends ReplicationObject

The Article type exposes the following members.

Constructors

  Name Description
Protected method Article Initializes a new instance of the Article class.

Top

Properties

  Name Description
Public property ArticleId Gets the article ID value.
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Protected property CreateArticleAsHeterogeneous Gets or sets a value that indicates whether to create an article as heterogeneous.
Public property 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.
Public property DatabaseName Gets or sets the name of the database that contains the data and the objects that are published in the article.
Public property Description Gets or sets a textual description of the article.
Public property DestinationObjectName Gets or sets the database object that is the source database object for the article at the Subscriber.
Public property DestinationObjectOwner Gets or sets the schema owner of the source database object for the article at the Subscriber.
Public property IdentityRangeManagementOption Gets or sets the identity range management options for the article.
Public property IdentityRangeThreshold Gets or sets the value at which a new range of identity column values are assigned to a Publisher or to a Subscriber.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets or sets the name of the article.
Public property PreCreationMethod Gets or sets the action to take when the published object already exists in the subscription database.
Public property PublicationName Gets or sets the name of the publication to which the article belongs.
Public property PublisherIdentityRangeSize For a TransArticle object, gets or sets the range of identity values assigned to table columns at the Publisher. For a MergeArticle object, gets or sets the range of identity values assigned to table columns at Subscribers that have server subscriptions.
Public property SchemaOption Gets or sets the schema creation options for an article.
Public property SourceObjectName Gets or sets the name of the database object that is being published.
Public property SourceObjectOwner Gets or sets the owner of the database object that is being published.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property 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.
Public property Type Gets or sets the type of article.
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public property VerticalPartition Gets a value that indicates whether all columns are published in a table article.

Top

Methods

  Name Description
Protected method CheckValidCreation Infrastructure. Checks the valid article creation. (Overrides ReplicationObject.CheckValidCreation().)
Protected method CheckValidDefinition Infrastructure. Indicates whether the definition is valid. (Overrides ReplicationObject.CheckValidDefinition(Boolean).)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method 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.
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InternalRefresh Infrastructure. Initiates an internal refresh from the replication. (Inherited from ReplicationObject.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method 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.
Public method Script Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server.
Public method ToString (Inherited from Object.)

Top

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.

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Define an Article (RMO Programming)

NIB Delete an Article (RMO Programming)

NIB View and Modify Article Properties (RMO Programming)