TransArticle TransArticle TransArticle Class

Definition

Represents an article in a transactional publication.

public ref class TransArticle sealed : Microsoft::SqlServer::Replication::Article
public sealed class TransArticle : Microsoft.SqlServer.Replication.Article
Public NotInheritable Class TransArticle
Inherits Article
Inheritance

Examples

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

Remarks

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.

Constructors

TransArticle() TransArticle() TransArticle()

Creates a new instance of the TransArticle class.

TransArticle(String, String, String, ServerConnection) TransArticle(String, String, String, ServerConnection) 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.

Properties

ArticleId ArticleId ArticleId

Gets the article ID value.

(Inherited from Article)
ArticleLogTablespace ArticleLogTablespace ArticleLogTablespace

Gets or sets the name of the Oracle tablespace used to store replication log information.

CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
CommandFormat CommandFormat CommandFormat

Gets or sets how changes are propagated for the article.

ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
CreateArticleAsHeterogeneous CreateArticleAsHeterogeneous CreateArticleAsHeterogeneous

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

(Inherited from Article)
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.

(Inherited from Article)
DatabaseName DatabaseName 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 DatatypeMappingOptions DatatypeMappingOptions

Returns whether the default article data type mapping is used for a non-SQL Server Publisher.

DeleteCommand DeleteCommand DeleteCommand

Gets or sets the command used to replicate deletes.

Description Description Description

Gets or sets a textual description of the article.

(Inherited from Article)
DestinationObjectName DestinationObjectName DestinationObjectName

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

(Inherited from Article)
DestinationObjectOwner DestinationObjectOwner DestinationObjectOwner

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

(Inherited from Article)
FilterClause FilterClause FilterClause

Gets or sets the WHERE clause used to filter the article horizontally.

FilterProcName FilterProcName FilterProcName

Gets or sets the stored procedure (created with FOR REPLICATION) used to filter the table horizontally.

FilterProcOwner FilterProcOwner FilterProcOwner

Gets or sets the database user who owns the stored procedure that is used to horizontally partition a table-based article.

IdentityRangeManagementOption IdentityRangeManagementOption IdentityRangeManagementOption

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

(Inherited from Article)
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.

(Inherited from Article)
InsertCommand InsertCommand InsertCommand

Gets or sets the command used to replicate inserts.

IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
Name Name Name

Gets or sets the name of the article.

(Inherited from Article)
PreCreationMethod PreCreationMethod PreCreationMethod

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

(Inherited from Article)
PublicationName PublicationName PublicationName

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

(Inherited from Article)
PublisherIdentityRangeSize PublisherIdentityRangeSize PublisherIdentityRangeSize

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

(Inherited from Article)
PublisherName PublisherName PublisherName

Gets or sets the name of the non-SQL Server Publisher that publishes the article.

SchemaOption SchemaOption SchemaOption

Gets or sets the schema creation options for an article.

(Inherited from Article)
SnapshotObjectName SnapshotObjectName SnapshotObjectName

Gets or sets the database object that provides the initial data snapshot for the article.

SnapshotObjectOwner SnapshotObjectOwner SnapshotObjectOwner

Gets or sets the owner of the database object that provides the initial data snapshot for the article.

SourceObjectName SourceObjectName SourceObjectName

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

(Inherited from Article)
SourceObjectOwner SourceObjectOwner SourceObjectOwner

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

(Inherited from Article)
SqlServerName SqlServerName SqlServerName

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

(Inherited from ReplicationObject)
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.

(Inherited from Article)
Type Type Type

Gets or sets the type of article.

(Inherited from Article)
UpdateCommand UpdateCommand UpdateCommand

Gets or sets the command used to replicate updates.

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

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

(Inherited from Article)

Methods

AddReplicatedColumns(Array) AddReplicatedColumns(Array) AddReplicatedColumns(Array)

Includes columns in a vertically partitioned table article.

CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid article creation.

(Inherited from Article)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the definition is valid.

(Inherited from Article)
CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
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.

(Inherited from Article)
Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
EnumHeterogeneousColumns() EnumHeterogeneousColumns() EnumHeterogeneousColumns()

Returns column information for a table article published by a non-SQL Server Publisher.

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)

Returns the create command from the replication.

(Inherited from ReplicationObject)
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)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
ListReplicatedColumns() ListReplicatedColumns() ListReplicatedColumns()

Returns the published columns in a table article.

Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
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.

(Inherited from Article)
RemoveReplicatedColumns(Array) RemoveReplicatedColumns(Array) RemoveReplicatedColumns(Array)

Excludes columns from a vertically partitioned table article.

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.

(Inherited from Article)
ScriptChangeColumnDestinationDataType(String, String, Int64, Int32, Int64, ScriptOptions) ScriptChangeColumnDestinationDataType(String, String, Int64, Int32, Int64, ScriptOptions) ScriptChangeColumnDestinationDataType(String, String, Int64, Int32, Int64, ScriptOptions)

Returns a Transact-SQL script used to change the column data type mapping for a non-SQL Server Publisher.

SetColumnDestinationDataType(String, String, Int64, Int32, Int64) SetColumnDestinationDataType(String, String, Int64, Int32, Int64) SetColumnDestinationDataType(String, String, Int64, Int32, Int64)

Sets the column data type mapping for a non-SQL Server Publisher.

Applies to

See Also