Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

MergeArticle Class

 

Applies To: SQL Server 2016 Preview

Represents an article in a merge publication.

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


public sealed class MergeArticle : Article

NameDescription
System_CAPS_pubmethodMergeArticle()

Creates a new instance of the MergeArticle class.

System_CAPS_pubmethodMergeArticle(String, String, String, ServerConnection)

Creates a new instance of the MergeArticle class with the specified name, publication, database, and connection to the instance of Microsoft SQL Server.

NameDescription
System_CAPS_pubpropertyAllowInteractiveResolver

Gets or sets whether to allow subscriptions to invoke an interactive resolver when conflicts occur during synchronization.

System_CAPS_pubpropertyArticleId

Gets the article ID value.(Inherited from Article.)

System_CAPS_pubpropertyArticleResolver

Gets or sets the friendly name of the custom conflict resolver or business logic handler used when synchronizing the article.

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyCheckPermissions

Gets or sets how the permissions are checked at the Publisher before changes are uploaded from a Subscriber.

System_CAPS_pubpropertyColumnTracking

Gets or sets how conflicts are detected when synchronizing data rows.

System_CAPS_pubpropertyCompensateForErrors

Gets or sets whether compensating actions are taken when errors are encountered during synchronization.

System_CAPS_pubpropertyConflictTable

Gets the name of the table used to track conflicts that occur when synchronizing a merge article.

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyCreationScript

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.)

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the database that contains the data and the objects that are published in the article.(Inherited from Article.)

System_CAPS_pubpropertyDeleteTracking

Gets or sets whether deletes are replicated.

System_CAPS_pubpropertyDescription

Gets or sets a textual description of the article.(Inherited from Article.)

System_CAPS_pubpropertyDestinationObjectName

Gets or sets the database object that is the source database object for the article at the Subscriber.(Inherited from Article.)

System_CAPS_pubpropertyDestinationObjectOwner

Gets or sets the schema owner of the source database object for the article at the Subscriber.(Inherited from Article.)

System_CAPS_pubpropertyFilterClause

Gets or sets the WHERE (Transact-SQL) clause that is evaluated to filter an article horizontally.

System_CAPS_pubpropertyIdentityRangeManagementOption

Gets or sets the identity range management options for the article.(Inherited from Article.)

System_CAPS_pubpropertyIdentityRangeThreshold

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.)

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyMultipleColumnUpdate

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether to update multiple columns.

System_CAPS_pubpropertyName

Gets or sets the name of the article.(Inherited from Article.)

System_CAPS_pubpropertyPartitionOption

Gets or sets the filtering options when an article is filtered using a parameterized row filter.

System_CAPS_pubpropertyPreCreationMethod

Gets or sets the action to take when the published object already exists in the subscription database.(Inherited from Article.)

System_CAPS_pubpropertyProcessingOrder

Gets or sets the processing order of the article during synchronization.

System_CAPS_pubpropertyPublicationName

Gets or sets the name of the publication to which the article belongs.(Inherited from Article.)

System_CAPS_pubpropertyPublisherIdentityRangeSize

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.)

System_CAPS_pubpropertyResolverInfo

Gets or sets additional data and parameters that are to be used by a COM-based conflict resolver.

System_CAPS_pubpropertySchemaOption

Gets or sets the schema creation options for an article.(Inherited from Article.)

System_CAPS_pubpropertySnapshotObjectName

Gets the name of the database object that represents the initial snapshot data for the article.

System_CAPS_pubpropertySnapshotObjectOwner

Gets the owner of the database object that represents the initial snapshot data for the article.

System_CAPS_pubpropertySourceObjectName

Gets or sets the name of the database object that is being published.(Inherited from Article.)

System_CAPS_pubpropertySourceObjectOwner

Gets or sets the owner of the database object that is being published.(Inherited from Article.)

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyStatus

Gets or sets the status of the merge article.

System_CAPS_pubpropertyStreamBlobColumns

Gets or sets whether a data stream optimization is used when replicating binary large object (BLOB) columns.

System_CAPS_pubpropertySubscriberIdentityRangeSize

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.)

System_CAPS_pubpropertySubscriberUploadOption

Gets or sets the behavior of updates made at a Subscriber with a client subscription.

System_CAPS_pubpropertyType

Gets or sets the type of article.(Inherited from Article.)

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyVerifyResolverSignature

Gets or sets the options for verifying the digital signature on a COM-based conflict resolver to determine if it is from a trusted source.

System_CAPS_pubpropertyVerticalPartition

Gets a value that indicates whether all columns are published in a table article.(Inherited from Article.)

NameDescription
System_CAPS_pubmethodAddMergeJoinFilter(MergeJoinFilter)

Adds a join filter to the merge article.

System_CAPS_pubmethodAddReplicatedColumns(Array)

Adds the specified columns to the merge article.

System_CAPS_pubmethodChangeMergeJoinFilter(MergeJoinFilter, MergeJoinFilter)

Changes a join filter that defined on a merge article.

System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCreate()

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.)

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEnumMergeJoinFilters()

Returns the join filters that are defined for the merge article.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeSharedPropertiesBasedOnExistingArticles()

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates whether to initialize shared properties based on existing articles.

System_CAPS_pubmethodListReplicatedColumns()

Returns the columns that exist in a vertically partitioned article.

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRemove()

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.)

System_CAPS_pubmethodRemoveMergeJoinFilter(String)

Removes the specified merge join filter from the article.

System_CAPS_pubmethodRemoveReplicatedColumns(Array)

Removes existing columns from a vertically partitioned article.

System_CAPS_pubmethodScript(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.)

System_CAPS_pubmethodScriptMergeJoinFilter(MergeJoinFilter, ScriptOptions)

Returns a Transact-SQL script of the merge join filter attached to the merge article.

System_CAPS_pubmethodToString()

(Inherited from Object.)

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.

Legacy Code Example

This example creates three merge articles and their related join filters.

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

			// 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();
			}

This example changes and existing merge article to associate a business logic handler with the article. For more information, see .

			// Define the Publisher, publication, and article names.
			string publisherName = publisherInstance;
			string publicationName = "AdvWorksSalesOrdersMerge";
			string publicationDbName = "AdventureWorks2012";
			string articleName = "SalesOrderHeader";
			
			// Set the friendly name of the business logic handler.
			string customLogic = "OrderEntryLogic";

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

			try
			{
				// Connect to the Publisher.
				conn.Connect();

				// Set the required properties for the article.
				article.ConnectionContext = conn;
				article.Name = articleName;
				article.DatabaseName = publicationDbName;
				article.PublicationName = publicationName;

				// Load the article properties.
				if (article.LoadProperties())
				{
					article.ArticleResolver = customLogic;
				}
				else
				{
					// Throw an exception of the article does not exist.
					throw new ApplicationException(String.Format(
					"{0} is not published in {1}", articleName, publicationName));
				}
				
			}
			catch (Exception ex)
			{
				// Do error handling here and rollback the transaction.
				throw new ApplicationException(String.Format(
					"The business logic handler {0} could not be associated with " +
					" the {1} article.",customLogic,articleName), ex);
			}
			finally
			{
				conn.Disconnect();
			}

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

Return to top

Community Additions

Show:
© 2015 Microsoft