TransArticle Class
SQL Server 2012
Represents an article in a transactional publication.
System.Object
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.Article
Microsoft.SqlServer.Replication.TransArticle
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.Article
Microsoft.SqlServer.Replication.TransArticle
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
The TransArticle type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | TransArticle() | Creates a new instance of the TransArticle class. |
![]() | TransArticle(String, String, String, ServerConnection) | Creates a new instance of the TransArticle class, with the required properties and with the specified connection to the instance of Microsoft SQL Server. |
| Name | Description | |
|---|---|---|
![]() | ArticleId | Gets the article ID value. (Inherited from Article.) |
![]() | ArticleLogTablespace | Gets or sets the name of the Oracle tablespace used to store replication log information. |
![]() | CachePropertyChanges | Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.) |
![]() | CommandFormat | Gets or sets how changes are propagated for the article. |
![]() | 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. (Inherited from Article.) |
![]() | 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. (Inherited from Article.) |
![]() | DatabaseName | Gets or sets the name of the database that contains the data and the objects that are published in the article. (Inherited from Article.) |
![]() | DatatypeMappingOptions | Returns whether the default article data type mapping is used for a non-SQL Server Publisher. |
![]() | DeleteCommand | Gets or sets the command used to replicate deletes. |
![]() | Description | Gets or sets a textual description of the article. (Inherited from Article.) |
![]() | DestinationObjectName | Gets or sets the database object that is the source database object for the article at the Subscriber. (Inherited from Article.) |
![]() | DestinationObjectOwner | Gets or sets the schema owner of the source database object for the article at the Subscriber. (Inherited from Article.) |
![]() | FilterClause | Gets or sets the WHERE clause used to filter the article horizontally. |
![]() | FilterProcName | Gets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally. |
![]() | FilterProcOwner | Gets or sets the database user who owns the stored procedure that is used to horizontally partition a table-based article. |
![]() | IdentityRangeManagementOption | Gets or sets the identity range management options for the article. (Inherited from 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. (Inherited from Article.) |
![]() | InsertCommand | Gets or sets the command used to replicate inserts. |
![]() | IsExistingObject | Gets whether the object exists on the server or not. (Inherited from ReplicationObject.) |
![]() | Name | Gets or sets the name of the article. (Inherited from Article.) |
![]() | PreCreationMethod | Gets or sets the action to take when the published object already exists in the subscription database. (Inherited from Article.) |
![]() | PublicationName | Gets or sets the name of the publication to which the article belongs. (Inherited from Article.) |
![]() | 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. (Inherited from Article.) |
![]() | PublisherName | Gets or sets the name of the non-SQL Server Publisher that publishes the article. |
![]() | SchemaOption | Gets or sets the schema creation options for an article. (Inherited from Article.) |
![]() | SnapshotObjectName | Gets or sets the database object that provides the initial data snapshot for the article. |
![]() | SnapshotObjectOwner | Gets or sets the owner of the database object that provides the initial data snapshot for the article. |
![]() | SourceObjectName | Gets or sets the name of the database object that is being published. (Inherited from Article.) |
![]() | SourceObjectOwner | Gets or sets the owner of the database object that is being published. (Inherited from Article.) |
![]() | 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. (Inherited from Article.) |
![]() | Type | Gets or sets the type of article. (Inherited from Article.) |
![]() | UpdateCommand | Gets or sets the command used to replicate updates. |
![]() | 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. (Inherited from Article.) |
| Name | Description | |
|---|---|---|
![]() | AddReplicatedColumns | Includes columns in a vertically partitioned table article. |
![]() | CheckValidCreation | Infrastructure. Checks the valid article creation. (Inherited from Article.) |
![]() | CheckValidDefinition | Infrastructure. Indicates whether the definition is valid. (Inherited from Article.) |
![]() | 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. (Inherited from Article.) |
![]() | Decouple | Decouples the referenced replication object from the server. (Inherited from ReplicationObject.) |
![]() | EnumHeterogeneousColumns | Returns column information for a table article published by a non-SQL Server Publisher. |
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | (Inherited from Object.) |
![]() | GetChangeCommand | Infrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.) |
![]() | GetCreateCommand | Infrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.) |
![]() | GetDropCommand | Infrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.) |
![]() | GetHashCode | (Inherited from Object.) |
![]() | GetType | (Inherited from Object.) |
![]() | InternalRefresh | Infrastructure. Initiates an internal refresh from the replication. (Inherited from ReplicationObject.) |
![]() | ListReplicatedColumns | Returns the published columns in a table article. |
![]() | 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.) |
![]() | MemberwiseClone | (Inherited from Object.) |
![]() | 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. (Inherited from Article.) |
![]() | RemoveReplicatedColumns | Excludes columns from a vertically partitioned table article. |
![]() | Script | Generates a Transact-SQL script that can be executed to create or delete the TransArticle object or the MergeArticle object on the server. (Inherited from Article.) |
![]() | ScriptChangeColumnDestinationDataType | Returns a Transact-SQL script used to change the column data type mapping for a non-SQL Server Publisher. |
![]() | SetColumnDestinationDataType | Sets the column data type mapping for a non-SQL Server Publisher. |
![]() | ToString | (Inherited from Object.) |
// Define the Publisher, publication, and article names. string publisherName = publisherInstance; string publicationName = "AdvWorksProductTran"; string publicationDbName = "AdventureWorks2012"; string articleName = "Product"; string schemaOwner = "Production"; TransArticle article; // Create a connection to the Publisher. ServerConnection conn = new ServerConnection(publisherName); // Create a filtered transactional articles in the following steps: // 1) Create the article with a horizontal filter clause. // 2) Add columns to or remove columns from the article. try { // Connect to the Publisher. conn.Connect(); // Define a horizontally filtered, log-based table article. article = new TransArticle(); article.ConnectionContext = conn; article.Name = articleName; article.DatabaseName = publicationDbName; article.SourceObjectName = articleName; article.SourceObjectOwner = schemaOwner; article.PublicationName = publicationName; article.Type = ArticleOptions.LogBased; article.FilterClause = "DiscontinuedDate IS NULL"; // Ensure that we create the schema owner at the Subscriber. article.SchemaOption |= CreationScriptOptions.Schema; if (!article.IsExistingObject) { // Create the article. article.Create(); } else { throw new ApplicationException(String.Format( "The article {0} already exists in publication {1}.", articleName, publicationName)); } // Create an array of column names to remove from the article. String[] columns = new String[1]; columns[0] = "DaysToManufacture"; // Remove the column from the article. article.RemoveReplicatedColumns(columns); } catch (Exception ex) { // Implement appropriate error handling here. throw new ApplicationException("The article could not be created.", ex); } finally { conn.Disconnect(); }
' Define the Publisher, publication, and article names. Dim publisherName As String = publisherInstance Dim publicationName As String = "AdvWorksProductTran" Dim publicationDbName As String = "AdventureWorks2012" Dim articleName As String = "Product" Dim schemaOwner As String = "Production" Dim article As TransArticle ' Create a connection to the Publisher. Dim conn As ServerConnection = New ServerConnection(publisherName) ' Create a filtered transactional articles in the following steps: ' 1) Create the article with a horizontal filter clause. ' 2) Add columns to or remove columns from the article. Try ' Connect to the Publisher. conn.Connect() ' Define a horizontally filtered, log-based table article. article = New TransArticle() article.ConnectionContext = conn article.Name = articleName article.DatabaseName = publicationDbName article.SourceObjectName = articleName article.SourceObjectOwner = schemaOwner article.PublicationName = publicationName article.Type = ArticleOptions.LogBased article.FilterClause = "DiscontinuedDate IS NULL" ' Ensure that we create the schema owner at the Subscriber. article.SchemaOption = article.SchemaOption Or _ CreationScriptOptions.Schema If Not article.IsExistingObject Then ' Create the article. article.Create() Else Throw New ApplicationException(String.Format( _ "The article {0} already exists in publication {1}.", _ articleName, publicationName)) End If ' Create an array of column names to remove from the article. Dim columns() As String = New String(0) {} columns(0) = "DaysToManufacture" ' Remove the column from the article. article.RemoveReplicatedColumns(columns) Catch ex As Exception ' Implement appropriate error handling here. Throw New ApplicationException("The article could not be created.", ex) Finally conn.Disconnect() End Try
