Article Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents the base class from which the TransArticle class and MergeArticle class are derived.
public ref class Article abstract : Microsoft::SqlServer::Replication::ReplicationObjectpublic abstract class Article : Microsoft.SqlServer.Replication.ReplicationObjecttype Article = class
inherit ReplicationObjectPublic 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() |
Initializes a new instance of the Article class. |
Properties
| ArticleId |
Gets the article ID value. |
| CachePropertyChanges |
Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject) |
| ConnectionContext |
Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject) |
| CreateArticleAsHeterogeneous |
Gets or sets a value that indicates whether to create an article as heterogeneous. |
| 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 |
Gets or sets the name of the database that contains the data and the objects that are published in the article. |
| Description |
Gets or sets a textual description of the article. |
| DestinationObjectName |
Gets or sets the database object that is the source database object for the article at the Subscriber. |
| DestinationObjectOwner |
Gets or sets the schema owner of the source database object for the article at the Subscriber. |
| IdentityRangeManagementOption |
Gets or sets the identity range management options for the article. |
| 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 |
Gets whether the object exists on the server or not. (Inherited from ReplicationObject) |
| Name |
Gets or sets the name of the article. |
| PreCreationMethod |
Gets or sets the action to take when the published object already exists in the subscription database. |
| PublicationName |
Gets or sets the name of the publication to which the article belongs. |
| PublisherIdentityRangeSize |
Gets or sets the range of identity values assigned to table columns at the Publisher. |
| SchemaOption |
Gets or sets the schema creation options for an article. |
| SourceObjectName |
Gets or sets the name of the database object that is being published. |
| SourceObjectOwner |
Gets or sets the owner of the database object that is being published. |
| SqlServerName |
Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject) |
| 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 |
Gets or sets the type of article. |
| UserData |
Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject) |
| VerticalPartition |
Gets a value that indicates whether all columns are published in a table article. |
Methods
| CheckValidCreation() |
Checks the valid article creation. |
| CheckValidDefinition(Boolean) |
Indicates whether the definition is valid. |
| CommitPropertyChanges() |
Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject) |
| 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() |
Decouples the referenced replication object from the server. (Inherited from ReplicationObject) |
| GetChangeCommand(StringBuilder, String, String) |
Returns the change command from the replication. (Inherited from ReplicationObject) |
| GetCreateCommand(StringBuilder, Boolean, ScriptOptions) |
Returns the create command from the replication. (Inherited from ReplicationObject) |
| GetDropCommand(StringBuilder, Boolean) |
Returns the drop command from the replication. (Inherited from ReplicationObject) |
| InternalRefresh(Boolean) |
Initiates an internal refresh from the replication. (Inherited from ReplicationObject) |
| Load() |
Loads the properties of an existing object from the server. (Inherited from ReplicationObject) |
| LoadProperties() |
Loads the properties of an existing object from the server. (Inherited from ReplicationObject) |
| Refresh() |
Reloads the properties of the object. (Inherited from ReplicationObject) |
| 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) |
Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server. |