Export (0) Print
Expand All
Expand Minimize

ArticleOptions Enumeration

Enumerates the type of database objects that can be published by replication.

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

public enum ArticleOptions

Member nameDescription
LogBasedThe source object for the published article is a table. Data changes are read from the transaction log.

The LogBased option is supported only for transactional and snapshot replication. This option is the default for transactional and snapshot replication.

ManualFilterProcThe user defines the stored procedure that filters the article horizontally.

The ManualFilterProc option is supported only for transactional and snapshot replication. You must also include a value of LogBased or IndexedView to specify the type of object that is being published.

When you create an article by using ManualFilterProc, you must specify the name of the filtering stored procedure for FilterProcName.

LogBasedManualFilterProcThe source object for the published article is a table. Data changes are read from the transaction log, and the user defines the stored procedure that filters the article horizontally.

The LogBasedManualFilterProc option is supported only for transactional and snapshot replication.

When you create an article by using LogBasedManualFilterProc, you must specify the name of the filtering stored procedure for FilterProcName.

ManualSyncViewThe user defines the object that provides the initial snapshot data for the article.

The ManualSyncView option is supported only for transactional and snapshot replication. You must also include a value of LogBased or IndexedView to specify the type of object that is being published.

When you create an article by using ManualSyncView, you must specify the name of the object that provides the initial snapshot data for SnapshotObjectName.

LogBasedManualSyncViewThe source object for the published article is a table. Data changes are read from the transaction log, and the user defines the object that provides the initial snapshot data for the article.

The LogBasedManualSyncView option is supported only for transactional and snapshot replication.

When you create an article by using LogBasedManualSyncView, you must specify the name of the object that provides the initial snapshot data for SnapshotObjectName.

LogBasedManualBothThe source object for the published article is a table. Data changes are read from the transaction log. The user defines the object that provides the initial snapshot data for the article and the stored procedure that filters the article horizontally.

The LogBasedManualBoth option is supported only for transactional and snapshot replication.

When you create an article by using LogBasedManualBoth, you must specify the name of the filtering stored procedure for FilterProcName and the name of the object that provides the initial snapshot data for SnapshotObjectName.

ProcExecutionThe source for the published article is the execution of a stored procedure. The commands in the stored procedure are replicated to the Subscriber.

The ProcExecution option is supported only for transactional replication.

SerializableProcExecutionThe source for the published article is the execution of a stored procedure. Only the commands of the stored procedure that are within the context of a transaction that can be serialized are replicated to the Subscriber.

The SerializableProcExecution option is supported only for transactional replication.

TableBasedThe source object for the published article is a table.

The TableBased option is supported only for merge replication.

ProcSchemaOnlyThe source object for the published article is the schema definition of a stored procedure.

The ProcSchemaOnly option is supported for all types of replication.

ViewSchemaOnlyThe source object for the published article is the schema definition of a view.

Only the view definition is published. Changes made to data in the view are not replicated.

The ViewSchemaOnly option is supported only for merge replication.

FunctionSchemaOnlyThe source object for the published article is the schema definition of a user-defined function.

The FunctionSchemaOnly option is supported for all types of replication.

AggregateSchemaOnlyThe source object for the published article is the schema definition of a user-defined aggregate function.

The AggregateSchemaOnly option is supported only for transactional and snapshot replication.

SynonymSchemaOnlyThe source object for the published article is the schema definition of a synonym.

The SynonymSchemaOnly option is supported for all types of replication.

IndexedViewThe source object for the published article is an indexed view.

IndexedView is the base value for all indexed view article types.

IndexedViewLogBasedThe source object for the published article is an indexed view, and data changes are read from the log.

The IndexedViewLogBased option is supported only for transactional and snapshot replication.

IndexedViewLogBasedManualFilterProcThe source object for the published article is an indexed view. Data changes are read from the transaction log, and the user defines the stored procedure that filters the article horizontally.

The IndexedViewLogBasedManualFilterProc option is supported only for transactional and snapshot replication.

When you create an article by using IndexedViewLogBasedManualFilterProc, you must specify the name of the filtering stored procedure for FilterProcName.

IndexedViewLogBasedManualSyncViewThe source object for the published article is an indexed view. Data changes are read from the transaction log, and the user defines the object that provides the initial snapshot data for the article.

The IndexedViewLogBasedManualSyncView option is supported only for transactional and snapshot replication.

When you create an article by using IndexedViewLogBasedManualSyncView, you must specify the name of the object that provides the initial snapshot data for SnapshotObjectName.

IndexedViewLogBasedManualBothThe source object for the published article is an indexed view. Data changes are read from the transaction log. The user defines the object that provides the initial snapshot data for the article and the stored procedure that filters the article horizontally.

The IndexedViewLogBasedManualBoth option is supported only for transactional and snapshot replication.

When you create an article by using IndexedViewLogBasedManualBoth, you must specify the name of the filtering stored procedure for FilterProcName and the name of the object that provides the initial snapshot data for SnapshotObjectName.

IndexedViewSchemaOnlyThe source object for the published article is the schema definition of an indexed view.

The IndexedViewSchemaOnly option is supported for all types of replication.

The field values of ArticleOptions are equivalent to the supported values of the @type parameter in sp_addarticle (Transact-SQL) and sp_addmergearticle (Transact-SQL).

The ArticleOptions enumeration supports the FlagsAttribute option, which allows a bitwise combination of enumeration values. However, each supported article type has a separate value, so bitwise operations are not required.

Not all ArticleOptions are supported for all types of replication.

This namespace, class, or member is supported only in the Microsoft .NET Framework version 2.0.

			// Define the Publisher and publication names.
			string publisherName = publisherInstance;
			string publicationName = "AdvWorksSalesOrdersMerge";
			string publicationDbName = "AdventureWorks";

			// Specify article names.
			string articleName1 = "Employee";
			string articleName2 = "SalesOrderHeader";
			string articleName3 = "SalesOrderDetail";

			// Specify join filter information.
			string filterName12 = "SalesOrderHeader_Employee";
			string filterClause12 = "Employee.EmployeeID = " +
				"SalesOrderHeader.SalesPersonID";
			string filterName23 = "SalesOrderDetail_SalesOrderHeader";
			string filterClause23 = "SalesOrderHeader.SalesOrderID = " +
				"SalesOrderDetail.SalesOrderID";

			string salesSchema = "Sales";
			string hrSchema = "HumanResources";

			MergeArticle article1 = new MergeArticle();
			MergeArticle article2 = new MergeArticle();
			MergeArticle article3 = new MergeArticle();
			MergeJoinFilter filter12 = new MergeJoinFilter();
			MergeJoinFilter filter23 = new MergeJoinFilter();

			// Create a connection to the Publisher.
			ServerConnection conn = new ServerConnection(publisherName);

			// Create three merge articles that are horizontally partitioned
			// using a parameterized row filter on Employee.EmployeeID, which is 
			// extended to the two other articles using join filters. 
			try
			{
				// Connect to the Publisher.
				conn.Connect();

				// Create each article. 
				// For clarity, each article is defined separately. 
				// In practice, iterative structures and arrays should 
				// be used to efficiently create multiple articles.

				// Set the required properties for the Employee article.
				article1.ConnectionContext = conn;
				article1.Name = articleName1;
				article1.DatabaseName = publicationDbName;
				article1.SourceObjectName = articleName1;
				article1.SourceObjectOwner = hrSchema;
				article1.PublicationName = publicationName;
				article1.Type = ArticleOptions.TableBased;

				// Define the parameterized filter clause based on Hostname.
				article1.FilterClause = "Employee.LoginID = HOST_NAME()";

				// Set the required properties for the SalesOrderHeader article.
				article2.ConnectionContext = conn;
				article2.Name = articleName2;
				article2.DatabaseName = publicationDbName;
				article2.SourceObjectName = articleName2;
				article2.SourceObjectOwner = salesSchema;
				article2.PublicationName = publicationName;
				article2.Type = ArticleOptions.TableBased;

				// Set the required properties for the SalesOrderDetail article.
				article3.ConnectionContext = conn;
				article3.Name = articleName3;
				article3.DatabaseName = publicationDbName;
				article3.SourceObjectName = articleName3;
				article3.SourceObjectOwner = salesSchema;
				article3.PublicationName = publicationName;
				article3.Type = ArticleOptions.TableBased;

				if (!article1.IsExistingObject) article1.Create();
				if (!article2.IsExistingObject) article2.Create();
				if (!article3.IsExistingObject) article3.Create();

				// Select published columns for SalesOrderHeader.
				// Create an array of column names to vertically filter out.
				// In this example, only one column is removed.
				String[] columns = new String[1];

				columns[0] = "CreditCardApprovalCode";

				// Remove the column.
				article2.RemoveReplicatedColumns(columns);

				// Define a merge filter clauses that filter 
				// SalesOrderHeader based on Employee and 
				// SalesOrderDetail based on SalesOrderHeader. 

				// Parent article.
				filter12.JoinArticleName = articleName1;
				// Child article.
				filter12.ArticleName = articleName2;
				filter12.FilterName = filterName12;
				filter12.JoinUniqueKey = true;
				filter12.FilterTypes = FilterTypes.JoinFilter;
				filter12.JoinFilterClause = filterClause12;

				// Add the join filter to the child article.
				article2.AddMergeJoinFilter(filter12);

				// Parent article.
				filter23.JoinArticleName = articleName2;
				// Child article.
				filter23.ArticleName = articleName3;
				filter23.FilterName = filterName23;
				filter23.JoinUniqueKey = true;
				filter23.FilterTypes = FilterTypes.JoinFilter;
				filter23.JoinFilterClause = filterClause23;

				// Add the join filter to the child article.
				article3.AddMergeJoinFilter(filter23);
			}
			catch (Exception ex)
			{
				// Do error handling here and rollback the transaction.
				throw new ApplicationException(
					"The filtered articles could not be created", ex);
			}
			finally
			{
				conn.Disconnect();
			}


' Define the Publisher and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks"

' Specify article names.
Dim articleName1 As String = "Employee"
Dim articleName2 As String = "SalesOrderHeader"
Dim articleName3 As String = "SalesOrderDetail"

' Specify join filter information.
Dim filterName12 As String = "SalesOrderHeader_Employee"
Dim filterClause12 As String = "Employee.EmployeeID = " + _
    "SalesOrderHeader.SalesPersonID"
Dim filterName23 As String = "SalesOrderDetail_SalesOrderHeader"
Dim filterClause23 As String = "SalesOrderHeader.SalesOrderID = " + _
    "SalesOrderDetail.SalesOrderID"

Dim salesSchema As String = "Sales"
Dim hrSchema As String = "HumanResources"

Dim article1 As MergeArticle = New MergeArticle()
Dim article2 As MergeArticle = New MergeArticle()
Dim article3 As MergeArticle = New MergeArticle()
Dim filter12 As MergeJoinFilter = New MergeJoinFilter()
Dim filter23 As MergeJoinFilter = New MergeJoinFilter()

' Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)

' Create three merge articles that are horizontally partitioned
' using a parameterized row filter on Employee.EmployeeID, which is 
' extended to the two other articles using join filters. 
Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Create each article. 
    ' For clarity, each article is defined separately. 
    ' In practice, iterative structures and arrays should 
    ' be used to efficiently create multiple articles.

    ' Set the required properties for the Employee article.
    article1.ConnectionContext = conn
    article1.Name = articleName1
    article1.DatabaseName = publicationDbName
    article1.SourceObjectName = articleName1
    article1.SourceObjectOwner = hrSchema
    article1.PublicationName = publicationName
    article1.Type = ArticleOptions.TableBased

    ' Define the parameterized filter clause based on Hostname.
    article1.FilterClause = "Employee.LoginID = HOST_NAME()"

    ' Set the required properties for the SalesOrderHeader article.
    article2.ConnectionContext = conn
    article2.Name = articleName2
    article2.DatabaseName = publicationDbName
    article2.SourceObjectName = articleName2
    article2.SourceObjectOwner = salesSchema
    article2.PublicationName = publicationName
    article2.Type = ArticleOptions.TableBased

    ' Set the required properties for the SalesOrderDetail article.
    article3.ConnectionContext = conn
    article3.Name = articleName3
    article3.DatabaseName = publicationDbName
    article3.SourceObjectName = articleName3
    article3.SourceObjectOwner = salesSchema
    article3.PublicationName = publicationName
    article3.Type = ArticleOptions.TableBased

    ' Create the articles, if they do not already exist.
    If article1.IsExistingObject = False Then
        article1.Create()
    End If
    If article2.IsExistingObject = False Then
        article2.Create()
    End If
    If article3.IsExistingObject = False Then
        article3.Create()
    End If

    ' Select published columns for SalesOrderHeader.
    ' Create an array of column names to vertically filter out.
    ' In this example, only one column is removed.
    Dim columns() As String = New String(0) {}

    columns(0) = "CreditCardApprovalCode"

    ' Remove the column.
    article2.RemoveReplicatedColumns(columns)

    ' Define a merge filter clauses that filter 
    ' SalesOrderHeader based on Employee and 
    ' SalesOrderDetail based on SalesOrderHeader. 

    ' Parent article.
    filter12.JoinArticleName = articleName1
    ' Child article.
    filter12.ArticleName = articleName2
    filter12.FilterName = filterName12
    filter12.JoinUniqueKey = True
    filter12.FilterTypes = FilterTypes.JoinFilter
    filter12.JoinFilterClause = filterClause12

    ' Add the join filter to the child article.
    article2.AddMergeJoinFilter(filter12)

    ' Parent article.
    filter23.JoinArticleName = articleName2
    ' Child article.
    filter23.ArticleName = articleName3
    filter23.FilterName = filterName23
    filter23.JoinUniqueKey = True
    filter23.FilterTypes = FilterTypes.JoinFilter
    filter23.JoinFilterClause = filterClause23

    ' Add the join filter to the child article.
    article3.AddMergeJoinFilter(filter23)

Catch ex As Exception
    ' Do error handling here and rollback the transaction.
    Throw New ApplicationException( _
        "The filtered articles could not be created", ex)
Finally
    conn.Disconnect()
End Try


Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft