MergePublication Class

Represents a merge publication.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Publication
      Microsoft.SqlServer.Replication.MergePublication

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

Syntax

'Declaration
Public NotInheritable Class MergePublication _
    Inherits Publication
'Usage
Dim instance As MergePublication
public sealed class MergePublication : Publication
public ref class MergePublication sealed : public Publication
[<SealedAttribute>]
type MergePublication =  
    class 
        inherit Publication 
    end
public final class MergePublication extends Publication

The MergePublication type exposes the following members.

Constructors

  Name Description
Public method MergePublication() Creates a new instance of the MergePublication class.
Public method MergePublication(String, String, ServerConnection) Initializes a new instance of the MergePublication class with the specified name, database, and connection to the Publisher.
Public method MergePublication(String, String, ServerConnection, Boolean) Creates an instance of the MergePublication class, specifying whether the Snapshot Agent job should be created by default.

Top

Properties

  Name Description
Public property AltSnapshotFolder Gets or sets the alternate snapshot file location for a publication. (Inherited from Publication.)
Public property Attributes Gets or sets the publication attributes. (Inherited from Publication.)
Public property AutomaticReinitializationPolicy Gets or sets whether changes at the Publisher are uploaded to the Publisher when a subscription is reinitialized because of a change in the publication.
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property CompatibilityLevel Gets or sets the earliest version of Microsoft SQL Server that can subscribe to the merge publication. (Overrides Publication.CompatibilityLevel.)
Public property ConflictRetention Gets or sets the number of days that conflict data rows are retained in conflict tables. (Inherited from Publication.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property CreateSnapshotAgentByDefault Gets or sets if the Snapshot Agent job is added automatically when the publication is created. (Inherited from Publication.)
Public property DatabaseName Gets or sets the name of the publication database. (Inherited from Publication.)
Public property Description Gets or sets a textual description of the publication. (Inherited from Publication.)
Public property FtpAddress Gets or sets the address of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpLogin Gets or sets the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpPassword Sets the password for the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpPort Gets or sets the port of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpSubdirectory Gets or sets the subdirectory on the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property HasSubscription Gets whether the publication has one or more subscriptions. (Inherited from Publication.)
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property MaxConcurrentDynamicSnapshots Gets or sets the maximum number of concurrent Snapshot Agent sessions supported when generating data snapshots when the publication has a parameterized row filter.
Public property MaxConcurrentMerge Gets or sets the maximum number of Merge Agents that can synchronize with the publication concurrently.
Public property MergeArticles Gets the existing articles in the merge publication.
Public property MergeSubscriptions Gets the subscriptions that belong to a merge publication.
Public property Name Gets or sets the name of the publication. (Inherited from Publication.)
Public property PartitionGroupsOption Gets or sets whether precomputed partitions should be used to optimize the synchronization process.
Public property PostSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed after the initial snapshot is applied to the Subscriber. (Inherited from Publication.)
Public property PreSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed before the initial snapshot is applied to the Subscriber. (Inherited from Publication.)
Public property Priority Infrastructure. Gets the priority of the publication.
Public property PubId Gets the value that uniquely identifies the publication. (Inherited from Publication.)
Public property ReplicateDdl Gets or sets the data definition language (DDL) replication options that determine if DDL changes are replicated. (Inherited from Publication.)
Public property RetentionPeriod Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication. (Inherited from Publication.)
Public property RetentionPeriodUnit Gets or sets the unit in which the RetentionPeriodUnit property is expressed.
Public property SecureFtpPassword Sets the password (as a SecureString object) for the login used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property SnapshotAgentExists Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication. (Inherited from Publication.)
Public property SnapshotAvailable Gets or sets a value that indicates whether the snapshot files for this publication have been generated and are available to initialize Subscribers.
Public property SnapshotGenerationAgentProcessSecurity Gets an object that sets the Windows account under which the Snapshot Agent job runs. (Inherited from Publication.)
Public property SnapshotGenerationAgentPublisherSecurity Gets the security context used by the Snapshot Agent to connect to the Publisher. (Inherited from Publication.)
Public property SnapshotJobId Gets the Snapshot Agent job ID for the current publication. (Inherited from Publication.)
Public property SnapshotMethod Gets or sets the data file format of the initial snapshot. (Inherited from Publication.)
Public property SnapshotSchedule Gets an object that sets the schedule for the Snapshot Agent for the current publication. (Inherited from Publication.)
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Status Gets or sets the status of the publication. (Inherited from Publication.)
Public property Type Gets or sets the type of publication. (Inherited from Publication.)
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public property UsesHostName Gets a value that indicates whether the merge publication has a parameterized row filter that uses the HOST_NAME function to evaluate the partition.
Public property ValidateSubscriberInfo Gets or sets the functions that are used to define a Subscriber partition of the published data when parameterized row filters are used.
Public property WebSynchronizationUrl Gets or sets the URL used with Web synchronization.

Top

Methods

  Name Description
Public method AddMergeDynamicSnapshotJob Adds a Snapshot Agent job that generates the filtered data partition for a Subscriber when a parameterized row filter is used.
Public method AddMergeDynamicSnapshotJobForLateBoundComClients Enables late-bound COM clients to add a Snapshot Agent job that generates the filtered data partition for a Subscriber when a parameterized row filter is used.
Public method AddMergePartition Defines a Subscriber partition for a merge publication with a parameterized row filter.
Public method BrowseSnapshotFolder Returns the complete path of the directory location where snapshot files are generated.
Public method ChangeMergeDynamicSnapshotJobScheduleWithJobId Modifies the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber, based on the job ID.
Public method ChangeMergeDynamicSnapshotJobScheduleWithJobIdForLateBoundComClients Allows late-bound COM clients to modify the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber, based on the job ID.
Public method ChangeMergeDynamicSnapshotJobScheduleWithJobName Modifies the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber, based on the job name.
Public method ChangeMergeDynamicSnapshotJobScheduleWithJobNameForLateBoundComClients Allows late-bound COM clients to modify the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber, based on the job name.
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method CopySnapshot Copies the snapshot files for the merge publication from the snapshot folder to a destination folder.
Public method Create Creates the publication. (Inherited from Publication.)
Public method CreateSnapshotAgent Creates the SQL Server Agent job that is used to generate the initial snapshot for the publication, if this job does not already exist. (Inherited from Publication.)
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method DisableSynchronizationPartner Disables the specified synchronization partner for this merge publication.
Public method EnableSynchronizationPartner Enables a specified synchronization partner for this merge publication.
Public method EnumAllMergeJoinFilters Returns all the merge join filters defined on the merge publication.
Public method EnumArticles Returns the articles in the publication. (Inherited from Publication.)
Public method EnumMergeDynamicSnapshotJobs Returns a list of merge dynamic snapshot jobs.
Public method EnumMergePartitions Returns the Subscriber partitions defined for this merge publication.
Public method EnumPublicationAccesses Returns logins that have access to the Publisher. (Inherited from Publication.)
Public method EnumSubscriptions Returns the subscriptions that subscribe to the publication. (Inherited from Publication.)
Public method EnumSynchronizationPartners Returns the alternate synchronization partners for this merge publication.
Public method Equals (Inherited from Object.)
Public method GenerateFilters Infrastructure. Creates filters of the merge publication.
Public method GetHashCode (Inherited from Object.)
Public method GetMergeDynamicSnapshotJobScheduleWithJobId Returns the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber based on the job ID.
Public method GetMergeDynamicSnapshotJobScheduleWithJobName Returns the schedule for the Snapshot Agent job that generates the filtered data partition for a Subscriber based on the job name.
Public method GetType (Inherited from Object.)
Public method GrantPublicationAccess Adds the specified login to the publication access list (PAL). (Inherited from Publication.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method MakePullSubscriptionWellKnown Registers a merge pull subscription at the Publisher.
Public method ReadLastValidationDateTimes Returns information about the most recent subscription validation for a Subscriber.
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method ReinitializeAllSubscriptions Marks all the subscriptions for reinitialization.
Public method Remove() Removes an existing publication. (Inherited from Publication.)
Public method Remove(Boolean) Removes an existing publication even if the Distributor cannot be accessed. (Inherited from Publication.)
Public method RemoveMergeDynamicSnapshotJob Removes the specified dynamic snapshot job from the merge publication.
Public method RemoveMergePartition Removes an existing Subscriber partition defined on the merge publication.
Public method RemovePullSubscription Removes the registration of a Subscriber with a pull subscription to the merge publication.
Public method ReplicateUserDefinedScript Replicates the execution of a user-defined script to the Subscribers of a specified publication. (Inherited from Publication.)
Public method ResynchronizeSubscription Resynchronizes a merge subscription to a known validation state that you specify.
Public method RevokePublicationAccess Removes the specified login from the publication access list (PAL). (Inherited from Publication.)
Public method Script Generates a Transact-SQL script that can be used to re-create the publication as specified by the script options. (Inherited from Publication.)
Public method ScriptMergeDynamicSnapshotJob Generates a Transact-SQL script that can be used to re-create the Snapshot Agent job that generates a Subscriber's partitioned data snapshot for publications with a parameterized row filter.
Public method ScriptMergePartition Generates a Transact-SQL script that can be used to re-create a Subscriber partition for publications with a parameterized row filter.
Public method ScriptPublicationActivation Generates a Transact-SQL script that, when run, sets the status of a merge publication to active.
Public method StartSnapshotGenerationAgentJob Starts the job that generates the initial snapshot for the publication. (Inherited from Publication.)
Public method StopSnapshotGenerationAgentJob Attempts to stop a running Snapshot Agent job. (Inherited from Publication.)
Public method ToString (Inherited from Object.)
Public method ValidatePublication Marks all subscriptions for validation during the next synchronization.
Public method ValidateSubscription Marks the specified subscription for validation during the next synchronization.

Top

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.

Examples

This example creates a merge publication.

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

            ReplicationDatabase publicationDb;
            MergePublication publication;

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

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

                // Enable the database for merge publication.               
                publicationDb = new ReplicationDatabase(publicationDbName, conn);
                if (publicationDb.LoadProperties())
                {
                    if (!publicationDb.EnabledMergePublishing)
                    {
                        publicationDb.EnabledMergePublishing = true;
                    }
                }
                else
                {
                    // Do something here if the database does not exist. 
                    throw new ApplicationException(String.Format(
                        "The {0} database does not exist on {1}.",
                        publicationDb, publisherName));
                }

                // Set the required properties for the merge publication.
                publication = new MergePublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Enable precomputed partitions.
                publication.PartitionGroupsOption = PartitionGroupsOption.True;

                // Specify the Windows account under which the Snapshot Agent job runs.
                // This account will be used for the local connection to the 
                // Distributor and all agent connections that use Windows Authentication.
                publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin;
                publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword;

                // Explicitly set the security mode for the Publisher connection
                // Windows Authentication (the default).
                publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = true;

                // Enable Subscribers to request snapshot generation and filtering.
                publication.Attributes |= PublicationAttributes.AllowSubscriberInitiatedSnapshot;
                publication.Attributes |= PublicationAttributes.DynamicFilters;

                // Enable pull and push subscriptions.
                publication.Attributes |= PublicationAttributes.AllowPull;
                publication.Attributes |= PublicationAttributes.AllowPush;

                if (!publication.IsExistingObject)
                {
                    // Create the merge publication.
                    publication.Create();
                    
                    // Create a Snapshot Agent job for the publication.
                    publication.CreateSnapshotAgent();
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} publication already exists.", publicationName));
                }
            }

            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be created.", publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }
' Set the Publisher, publication database, and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2012"

Dim publicationDb As ReplicationDatabase
Dim publication As MergePublication

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

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Enable the database for merge publication.                
    publicationDb = New ReplicationDatabase(publicationDbName, conn)
    If publicationDb.LoadProperties() Then
        If Not publicationDb.EnabledMergePublishing Then
            publicationDb.EnabledMergePublishing = True
        End If
    Else
        ' Do something here if the database does not exist. 
        Throw New ApplicationException(String.Format( _
         "The {0} database does not exist on {1}.", _
         publicationDb, publisherName))
    End If

    ' Set the required properties for the merge publication.
    publication = New MergePublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Enable precomputed partitions.
    publication.PartitionGroupsOption = PartitionGroupsOption.True

    ' Specify the Windows account under which the Snapshot Agent job runs.
    ' This account will be used for the local connection to the 
    ' Distributor and all agent connections that use Windows Authentication.
    publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin
    publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword

    ' Explicitly set the security mode for the Publisher connection
    ' Windows Authentication (the default).
    publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = True

    ' Enable Subscribers to request snapshot generation and filtering.
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowSubscriberInitiatedSnapshot
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.DynamicFilters

    ' Enable pull and push subscriptions
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowPull
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowPush

    If Not publication.IsExistingObject Then
        ' Create the merge publication.
        publication.Create()

        ' Create a Snapshot Agent job for the publication.
        publication.CreateSnapshotAgent()
    Else
        Throw New ApplicationException(String.Format( _
            "The {0} publication already exists.", publicationName))
    End If
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
        "The publication {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try

This example changes the properties of a merge publication.

         // Define the server, database, and publication names
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks2012";

            MergePublication publication;

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

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

                // Set the required properties for the publication.
                publication = new MergePublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;


                // If we can't get the properties for this merge publication, then throw an application exception.
                if (publication.LoadProperties())
                {
                    // If DDL replication is currently enabled, disable it.
                    if (publication.ReplicateDdl == DdlReplicationOptions.All)
                    {
                        publication.ReplicateDdl = DdlReplicationOptions.None;
                    }
                    else
                    {
                        publication.ReplicateDdl = DdlReplicationOptions.All;
                    }
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "Settings could not be retrieved for the publication. " +
                        "Ensure that the publication {0} exists on {1}.",
                        publicationName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Do error handling here.
                throw new ApplicationException(
                    "The publication property could not be changed.", ex);
            }
            finally
            {
                conn.Disconnect();
            }
' Define the server, database, and publication names
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2012"

Dim publication As MergePublication

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

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Set the required properties for the publication.
    publication = New MergePublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' If we can't get the properties for this merge publication, then throw an application exception.
    If publication.LoadProperties() Then
        ' If DDL replication is currently enabled, disable it.
        If publication.ReplicateDdl = DdlReplicationOptions.All Then
            publication.ReplicateDdl = DdlReplicationOptions.None
        Else
            publication.ReplicateDdl = DdlReplicationOptions.All
        End If
    Else
        Throw New ApplicationException(String.Format( _
         "Settings could not be retrieved for the publication. " + _
         "Ensure that the publication {0} exists on {1}.", _
         publicationName, publisherName))
    End If
Catch ex As Exception
    ' Do error handling here.
    Throw New ApplicationException( _
        "The publication property could not be changed.", ex)
Finally
    conn.Disconnect()
End Try

This example deletes a merge publication.

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

            MergePublication publication;
            ReplicationDatabase publicationDb;

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

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

                // Set the required properties for the merge publication.
                publication = new MergePublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Delete the publication, if it exists and has no subscriptions.
                if (publication.LoadProperties() && !publication.HasSubscription)
                {
                    publication.Remove();
                }
                else
                {
                    // Do something here if the publication does not exist
                    // or has subscriptions.
                    throw new ApplicationException(String.Format(
                        "The publication {0} could not be deleted. " +
                        "Ensure that the publication exists and that all " +
                        "subscriptions have been deleted.",
                        publicationName, publisherName));
                }

                // If no other merge publications exists,
                // disable publishing on the database.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);
                if (publicationDb.LoadProperties())
                {
                    if (publicationDb.MergePublications.Count == 0 && publicationDb.EnabledMergePublishing)
                    {
                        publicationDb.EnabledMergePublishing = false;
                    }
                }
                else
                {
                    // Do something here if the database does not exist.
                    throw new ApplicationException(String.Format(
                        "The database {0} does not exist on {1}.",
                        publicationDbName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Implement application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be deleted.",
                    publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }
' Define the Publisher, publication database, 
' and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2012"

Dim publication As MergePublication
Dim publicationDb As ReplicationDatabase

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

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Set the required properties for the merge publication.
    publication = New MergePublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Delete the publication, if it exists and has no subscriptions.
    If (publication.LoadProperties() And Not publication.HasSubscription) Then
        publication.Remove()
    Else
        ' Do something here if the publication does not exist
        ' or has subscriptions.
        Throw New ApplicationException(String.Format( _
         "The publication {0} could not be deleted. " + _
         "Ensure that the publication exists and that all " + _
         "subscriptions have been deleted.", _
         publicationName, publisherName))
    End If

    ' If no other merge publications exists,
    ' disable publishing on the database.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)
    If publicationDb.LoadProperties() Then
        If publicationDb.MergePublications.Count = 0 _
        And publicationDb.EnabledMergePublishing Then
            publicationDb.EnabledMergePublishing = False
        End If
    Else
        ' Do something here if the database does not exist.
        Throw New ApplicationException(String.Format( _
         "The database {0} does not exist on {1}.", _
         publicationDbName, publisherName))
    End If
Catch ex As Exception
    ' Implement application error handling here.
    Throw New ApplicationException(String.Format( _
     "The publication {0} could not be deleted.", _
     publicationName), ex)
Finally
    conn.Disconnect()
End Try

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Create a Publication (RMO Programming)

NIB View and Modify Publication Properties (RMO Programming)