TransArticle Constructors

Definition

Namespace:

Microsoft.SqlServer.Replication

Assembly:

Microsoft.SqlServer.Rmo.dll

Creates a new instance of the TransArticle class.

Overloads

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.

Remarks

Updated text: 17 July 2006

The following table shows the default property values for a new instance of TransArticle. Any properties that are not explicitly enumerated in this table are initialized to a null value.

Property	Default value
CachePropertyChanges	false
CommandFormat	A value of None for CommandOptions
DatatypeMappingOptions	A value of Default for ArticleDatatypeMappingOptions
DeleteCommand	CALL sp_MSdel_table 1
IdentityRangeManagementOption	A value of Manual for IdentityRangeManagementOption
InsertCommand	CALL sp_MSins_table 1
IsExistingObject	false
PreCreationMethod	A value of Drop for PreCreationOption
SchemaOption	A value of PrimaryObject for CreationScriptOptions
Type	A value of LogBased for ArticleOptions
UpdateCommand	SCALL sp_MSupd_table 1
VerticalPartition	false

¹ For more information, see Specify How Changes Are Propagated for Transactional Articles and the @del_cmd, @ins_cmd, and @upd_cmd parameters of sp_addarticle (Transact-SQL).

TransArticle()

Creates a new instance of the TransArticle class.

public:
 TransArticle();

public TransArticle ();

Public Sub New ()

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

The default constructor initializes any fields to their default values.

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.

public:
 TransArticle(System::String ^ name, System::String ^ publicationName, System::String ^ databaseName, Microsoft::SqlServer::Management::Common::ServerConnection ^ connectionContext);

public TransArticle (string name, string publicationName, string databaseName, Microsoft.SqlServer.Management.Common.ServerConnection connectionContext);

new Microsoft.SqlServer.Replication.TransArticle : string * string * string * Microsoft.SqlServer.Management.Common.ServerConnection -> Microsoft.SqlServer.Replication.TransArticle

Public Sub New (name As String, publicationName As String, databaseName As String, connectionContext As ServerConnection)

Parameters

name

String

A String value that specifies the name of the article.

publicationName

String

A String value that specifies the name of the transactional or snapshot publication.

databaseName

String

A String value that specifies the name of the publication database.

connectionContext

ServerConnection

A ServerConnection object value that specifies the connection to the Publisher.