MergePullSubscription-Klasse

Represents a pull subscription to a merge publication.

Vererbungshierarchie

System. . :: . .Object
  Microsoft.SqlServer.Replication. . :: . .ReplicationObject
    Microsoft.SqlServer.Replication. . :: . .PullSubscription
      Microsoft.SqlServer.Replication..::..MergePullSubscription

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

Syntax

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

Der MergePullSubscription-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode MergePullSubscription() () () () Creates a new instance of the MergePullSubscription class.
Öffentliche Methode MergePullSubscription(String, String, String, String, ServerConnection) Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, and Subscriber connection.
Öffentliche Methode MergePullSubscription(String, String, String, String, ServerConnection, Boolean) Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, Subscriber connection, and whether the agent job is created.

Zum Anfang

Eigenschaften

  Name Beschreibung
Öffentliche Eigenschaft AgentJobId Gets the ID of the agent job used to synchronize the subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft AgentOffload Gets or sets whether or not the Synchronization Agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft AltSnapshotFolder Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Geerbt von ReplicationObject.)
Öffentliche Eigenschaft ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Geerbt von ReplicationObject.)
Öffentliche Eigenschaft CreateSyncAgentByDefault Gets or sets whether or not the agent job used to start the Replication Agent to synchronize the subscription is created when the subscription is created. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft DatabaseName Gets or sets the name of the subscription database. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft Description Gets or sets a textual description of the pull subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft DistributorName Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft DistributorSecurity Gets the security context used to connect to the Distributor. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft DynamicSnapshotLocation Gets or sets the file location for the subscription-specific snapshot files when the publication uses a parameterized row filter.
Öffentliche Eigenschaft EnabledForSynchronizationManager Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft FtpAddress Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft FtpLogin Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft FtpPassword Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft FtpPort Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft HostName Gets or sets the value supplied to the HOST_NAME function when this function is used in the parameterized row filter that defines the Subscriber's data partition.
Öffentliche Eigenschaft InternetLogin Gets or sets the login used with HTTP Basic Authentication when connecting to the Web server during Web synchronization.
Öffentliche Eigenschaft InternetPassword Gets or sets the password for the supplied InternetLogin value when connecting to the Web server during Web synchronization.
Öffentliche Eigenschaft InternetSecurityMode Gets or sets the HTTP authentication method used when connecting to the Web server during Web synchronization.
Öffentliche Eigenschaft InternetTimeout Gets or sets the HTTP timeout, in seconds, when connecting to the Web server during Web synchronization.
Öffentliche Eigenschaft InternetUrl Gets or sets the URL to use when synchronizing the subscription using Web synchronization.
Öffentliche Eigenschaft IsExistingObject Gets whether the object exists on the server or not. (Geerbt von ReplicationObject.)
Öffentliche Eigenschaft LastAgentDateTime Gets the date and time when the subscription was last synchronized. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft LastAgentStatus Gets the status of the most recent synchronization of the subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft LastAgentSummary Gets a summary of the result of the most recent synchronization of the subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft Name Gets the name generated for the pull subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft Priority Gets or sets the weighting of this server subscription relative to other server subscriptions when resolving conflicts between subscriptions.
Öffentliche Eigenschaft PublicationDBName Gets or sets the name of the publication database. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft PublicationName Gets or sets the name of the publication to which the subscription subscribes. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft PublisherName Gets or sets the name of the Publisher. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft PublisherSecurity Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SecureFtpPassword Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SecureInternetPassword Sets the password (as a SecureString object) used when connecting to the Web server using HTTP Basic Authentication.
Öffentliche Eigenschaft SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Geerbt von ReplicationObject.)
Öffentliche Eigenschaft SubscriberSecurity Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SubscriberType Gets or sets whether the subscription is a server or client subscription.
Öffentliche Eigenschaft SubscriptionId Gets the subscription ID value. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SubscriptionType Gets whether the subscription registration is for a push, pull, or anonymous subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SynchronizationAgent Gets an object that represents an instance of the Merge Agent that can be used to synchronize the subscription.
Öffentliche Eigenschaft SynchronizationAgentProcessSecurity Gets the security context that is used to specify the Microsoft Windows account under which the Synchronization Agent job runs to synchronize the subscription. (Geerbt von PullSubscription.)
Öffentliche Eigenschaft SyncType Gets or sets the manner in which data is initialized at the Subscriber.
Öffentliche Eigenschaft Type Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Eigenschaft UseFtp Gets or sets whether or not the snapshot files needed to initialize the pull subscription are accessed by the Synchronization Agent using File Transfer Protocol (FTP). (Geerbt von PullSubscription.)
Öffentliche Eigenschaft UseInteractiveResolver Gets or sets whether the Interactive Resolver is used during the synchronization process.
Öffentliche Eigenschaft UserData Gets or sets an object property that allows users to attach their own data to the object. (Geerbt von ReplicationObject.)
Öffentliche Eigenschaft UseWebSynchronization Gets or sets whether the subscription is synchronized using Web synchronization.
Öffentliche Eigenschaft WorkingDirectory Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files. (Geerbt von PullSubscription.)

Zum Anfang

Methoden

  Name Beschreibung
Geschützte Methode CheckValidCreation Infrastruktur (Geerbt von ReplicationObject.)
Geschützte Methode CheckValidDefinition Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Methode CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Geerbt von ReplicationObject.)
Öffentliche Methode Create Creates the pull subscription on the Subscriber. (Geerbt von PullSubscription.)
Geschützte Methode CustomEnabledForSyncMgr Infrastruktur (Geerbt von PullSubscription.)
Öffentliche Methode Decouple Decouples the referenced replication object from the server. (Geerbt von ReplicationObject.)
Öffentliche Methode EnumSynchronizationPartners Returns the Alternate Synchronization Partners
Öffentliche Methode Equals (Geerbt von Object.)
Geschützte Methode Finalize (Geerbt von Object.)
Geschützte Methode GetChangeCommand Infrastruktur (Geerbt von ReplicationObject.)
Geschützte Methode GetCreateCommand Infrastruktur (Geerbt von ReplicationObject.)
Geschützte Methode GetDropCommand Infrastruktur (Geerbt von ReplicationObject.)
Öffentliche Methode GetHashCode (Geerbt von Object.)
Öffentliche Methode GetType (Geerbt von Object.)
Geschützte Methode InitMemberVariables Infrastruktur (Geerbt von PullSubscription.)
Geschützte Methode InternalRefresh Infrastruktur (Geerbt von ReplicationObject.)
Öffentliche Methode LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run. (Geerbt von PullSubscription.)
Öffentliche Methode Load Loads the properties of an existing object from the server. (Geerbt von ReplicationObject.)
Öffentliche Methode LoadProperties Loads the properties of an existing object from the server. (Geerbt von ReplicationObject.)
Geschützte Methode MemberwiseClone (Geerbt von Object.)
Öffentliche Methode Refresh Reloads the properties of the object. (Geerbt von ReplicationObject.)
Öffentliche Methode Reinitialize Marks the merge pull subscription for reinitialization.
Öffentliche Methode Remove Removes the pull subscription. (Geerbt von PullSubscription.)
Öffentliche Methode Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (Geerbt von PullSubscription.)
Öffentliche Methode StopSynchronizationJob Attempts to stop a running Merge Agent job that is currently synchronizing the subscription. (Überschreibt PullSubscription. . :: . .StopSynchronizationJob() () () ().)
Öffentliche Methode SynchronizeWithJob Starts the agent job asynchronously to synchronize the pull subscription. (Überschreibt PullSubscription. . :: . .SynchronizeWithJob() () () ().)
Öffentliche Methode ToString (Geerbt von Object.)

Zum Anfang

Hinweise

For a pull subscription, the Merge Agent runs at the Subscriber.

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

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.

Beispiele

           // Define the Publisher, publication, and databases.
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publisherName = publisherInstance;
            string subscriberName = subscriberInstance;
            string subscriptionDbName = "AdventureWorks2008R2Replica";
            string publicationDbName = "AdventureWorks2008R2";
            string hostname = @"adventure-works\garrett1";

            //Create connections to the Publisher and Subscriber.
            ServerConnection subscriberConn = new ServerConnection(subscriberName);
            ServerConnection publisherConn = new ServerConnection(publisherName);

            // Create the objects that we need.
            MergePublication publication;
            MergePullSubscription subscription;

            try
            {
                // Connect to the Subscriber.
                subscriberConn.Connect();

                // Ensure that the publication exists and that 
                // it supports pull subscriptions.
                publication = new MergePublication();
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;
                publication.ConnectionContext = publisherConn;

                if (publication.LoadProperties())
                {
                    if ((publication.Attributes & PublicationAttributes.AllowPull) == 0)
                    {
                        publication.Attributes |= PublicationAttributes.AllowPull;
                    }

                    // Define the pull subscription.
                    subscription = new MergePullSubscription();
                    subscription.ConnectionContext = subscriberConn;
                    subscription.PublisherName = publisherName;
                    subscription.PublicationName = publicationName;
                    subscription.PublicationDBName = publicationDbName;
                    subscription.DatabaseName = subscriptionDbName;
                    subscription.HostName = hostname;

                    // Specify the Windows login credentials for the Merge Agent job.
                    subscription.SynchronizationAgentProcessSecurity.Login = winLogin;
                    subscription.SynchronizationAgentProcessSecurity.Password = winPassword;

                    // Make sure that the agent job for the subscription is created.
                    subscription.CreateSyncAgentByDefault = true;

                    // Create the pull subscription at the Subscriber.
                    subscription.Create();

                    Boolean registered = false;

                    // Verify that the subscription is not already registered.
                    foreach (MergeSubscription existing
                        in publication.EnumSubscriptions())
                    {
                        if (existing.SubscriberName == subscriberName
                            && existing.SubscriptionDBName == subscriptionDbName
                            && existing.SubscriptionType == SubscriptionOption.Pull)
                        {
                            registered = true;
                        }
                    }
                    if (!registered)
                    {
                        // Register the local subscription with the Publisher.
                        publication.MakePullSubscriptionWellKnown(
                            subscriberName, subscriptionDbName,
                            SubscriptionSyncType.Automatic,
                            MergeSubscriberType.Local, 0);
                    }
                }
                else
                {
                    // Do something here if the publication does not exist.
                    throw new ApplicationException(String.Format(
                        "The publication '{0}' does not exist on {1}.",
                        publicationName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Implement the appropriate error handling here.
                throw new ApplicationException(String.Format(
                    "The subscription to {0} could not be created.", publicationName), ex);
            }
            finally
            {
                subscriberConn.Disconnect();
                publisherConn.Disconnect();
            }
' Define the Publisher, publication, and databases.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publisherName As String = publisherInstance
Dim subscriberName As String = subscriberInstance
Dim subscriptionDbName As String = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim hostname As String = "adventure-works\garrett1"

'Create connections to the Publisher and Subscriber.
Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName)
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)

' Create the objects that we need.
Dim publication As MergePublication
Dim subscription As MergePullSubscription

Try
    ' Connect to the Subscriber.
    subscriberConn.Connect()

    ' Ensure that the publication exists and that 
    ' it supports pull subscriptions.
    publication = New MergePublication()
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName
    publication.ConnectionContext = publisherConn

    If publication.LoadProperties() Then
        If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPull
        End If

        ' Define the pull subscription.
        subscription = New MergePullSubscription()
        subscription.ConnectionContext = subscriberConn
        subscription.PublisherName = publisherName
        subscription.PublicationName = publicationName
        subscription.PublicationDBName = publicationDbName
        subscription.DatabaseName = subscriptionDbName
        subscription.HostName = hostname

        ' Specify the Windows login credentials for the Merge Agent job.
        subscription.SynchronizationAgentProcessSecurity.Login = winLogin
        subscription.SynchronizationAgentProcessSecurity.Password = winPassword

        ' Make sure that the agent job for the subscription is created.
        subscription.CreateSyncAgentByDefault = True

        ' Create the pull subscription at the Subscriber.
        subscription.Create()

        Dim registered As Boolean = False

        ' Verify that the subscription is not already registered.
        For Each existing As MergeSubscription In _
        publication.EnumSubscriptions()
            If existing.SubscriberName = subscriberName Then
                registered = True
            End If
        Next
        If Not registered Then
            ' Register the local subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown( _
             subscriberName, subscriptionDbName, _
             SubscriptionSyncType.Automatic, _
             MergeSubscriberType.Local, 0)
        End If
    Else
        ' Do something here if the publication does not exist.
        Throw New ApplicationException(String.Format( _
         "The publication '{0}' does not exist on {1}.", _
         publicationName, publisherName))
    End If
Catch ex As Exception
    ' Implement the appropriate error handling here.
    Throw New ApplicationException(String.Format( _
        "The subscription to {0} could not be created.", publicationName), ex)
Finally
    subscriberConn.Disconnect()
    publisherConn.Disconnect()
End Try

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.