Export (0) Print
Expand All

TransArticle Class

Represents an article in a transactional publication.

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

public ref class TransArticle sealed : public Article

The TransArticle type exposes the following members.

  NameDescription
Public methodTransArticle()Creates a new instance of the TransArticle class.
Public methodTransArticle(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.
Top

  NameDescription
Public propertyArticleIdGets the article ID value. (Inherited from Article.)
Public propertyArticleLogTablespaceGets or sets the name of the Oracle tablespace used to store replication log information.
Public propertyCachePropertyChangesGets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public propertyCommandFormatGets or sets how changes are propagated for the article.
Public propertyConnectionContextGets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public propertyCreationScriptGets 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.)
Public propertyDatabaseNameGets or sets the name of the database that contains the data and the objects that are published in the article. (Inherited from Article.)
Public propertyDatatypeMappingOptionsReturns whether the default article data type mapping is used for a non-SQL Server Publisher.
Public propertyDeleteCommandGets or sets the command used to replicate deletes.
Public propertyDescriptionGets or sets a textual description of the article. (Inherited from Article.)
Public propertyDestinationObjectNameGets or sets the database object that is the source database object for the article at the Subscriber. (Inherited from Article.)
Public propertyDestinationObjectOwnerGets or sets the schema owner of the source database object for the article at the Subscriber. (Inherited from Article.)
Public propertyFilterClauseGets or sets the WHERE clause used to filter the article horizontally.
Public propertyFilterProcNameGets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally.
Public propertyFilterProcOwnerGets or sets the database user who owns the stored procedure that is used to horizontally partition a table-based article.
Public propertyIdentityRangeManagementOptionGets or sets the identity range management options for the article. (Inherited from Article.)
Public propertyIdentityRangeThresholdGets 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.)
Public propertyInsertCommandGets or sets the command used to replicate inserts.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyNameGets or sets the name of the article. (Inherited from Article.)
Public propertyPreCreationMethodGets or sets the action to take when the published object already exists in the subscription database. (Inherited from Article.)
Public propertyPublicationNameGets or sets the name of the publication to which the article belongs. (Inherited from Article.)
Public propertyPublisherIdentityRangeSizeFor 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.)
Public propertyPublisherNameGets or sets the name of the non-SQL Server Publisher that publishes the article.
Public propertySchemaOptionGets or sets the schema creation options for an article. (Inherited from Article.)
Public propertySnapshotObjectNameGets or sets the database object that provides the initial data snapshot for the article.
Public propertySnapshotObjectOwnerGets or sets the owner of the database object that provides the initial data snapshot for the article.
Public propertySourceObjectNameGets or sets the name of the database object that is being published. (Inherited from Article.)
Public propertySourceObjectOwnerGets or sets the owner of the database object that is being published. (Inherited from Article.)
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertySubscriberIdentityRangeSizeGets 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.)
Public propertyTypeGets or sets the type of article. (Inherited from Article.)
Public propertyUpdateCommandGets or sets the command used to replicate updates.
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public propertyVerticalPartitionGets a value that indicates whether all columns are published in a table article. (Inherited from Article.)
Top

  NameDescription
Public methodAddReplicatedColumnsIncludes columns in a vertically partitioned table article.
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates 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.)
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEnumHeterogeneousColumnsReturns column information for a table article published by a non-SQL Server Publisher.
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodListReplicatedColumnsReturns the published columns in a table article.
Public methodLoadLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodLoadPropertiesLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodRemoveRemoves 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.)
Public methodRemoveReplicatedColumnsExcludes columns from a vertically partitioned table article.
Public methodScriptGenerates 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.)
Public methodScriptChangeColumnDestinationDataTypeReturns a Transact-SQL script used to change the column data type mapping for a non-SQL Server Publisher. 
Public methodSetColumnDestinationDataTypeSets the column data type mapping for a non-SQL Server Publisher.
Public methodToString (Inherited from Object.)
Top

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.

			// 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

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

Community Additions

ADD
Show:
© 2014 Microsoft