Classe TransPullSubscription

  • Article

Represents a pull subscription to a transactional publication.

Hiérarchie d'héritage

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.PullSubscription
      Microsoft.SqlServer.Replication.TransPullSubscription

Espace de noms :  Microsoft.SqlServer.Replication
Assembly :  Microsoft.SqlServer.Rmo (en Microsoft.SqlServer.Rmo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class TransPullSubscription _
    Inherits PullSubscription
'Utilisation
Dim instance As TransPullSubscription

public sealed class TransPullSubscription : PullSubscription

public ref class TransPullSubscription sealed : public PullSubscription

[<SealedAttribute>]
type TransPullSubscription =  
    class 
        inherit PullSubscription 
    end

public final class TransPullSubscription extends PullSubscription

Le type TransPullSubscription expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique TransPullSubscription() Creates a new instance of the TransPullSubscription class.
Méthode publique TransPullSubscription(String, String, String, String, ServerConnection) Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription.
Méthode publique TransPullSubscription(String, String, String, String, ServerConnection, Boolean) Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription, and whether or not to create the agent job for the subscription.

Haut de la page

Propriétés

  Nom Description
Propriété publique AgentJobId Gets the ID of the agent job used to synchronize the subscription. (hérité de PullSubscription.)
Propriété publique 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. (hérité de PullSubscription.)
Propriété publique AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (hérité de PullSubscription.)
Propriété publique AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (hérité de PullSubscription.)
Propriété publique AltSnapshotFolder Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. (hérité de PullSubscription.)
Propriété publique Attributes Gets or sets the attributes of a transactional publication that are supported by the subscription.
Propriété publique CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (hérité de ReplicationObject.)
Propriété publique ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (hérité de ReplicationObject.)
Propriété publique 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. (hérité de PullSubscription.)
Propriété publique DatabaseName Gets or sets the name of the subscription database. (hérité de PullSubscription.)
Propriété publique Description Gets or sets a textual description of the pull subscription. (hérité de PullSubscription.)
Propriété publique DistributorName Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. (hérité de PullSubscription.)
Propriété publique DistributorSecurity Gets the security context used to connect to the Distributor. (hérité de PullSubscription.)
Propriété publique DtsPackageLocation Gets or sets the location of the Data Transformation Services (DTS) package used with a transformable subscription.
Propriété publique DtsPackageName Gets or sets the Data Transformation Services (DTS) package name used in a transformable subscription.
Propriété publique DtsPackagePassword Sets the password that is used with a transformable subscription.
Propriété publique EnabledForSynchronizationManager Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager. (hérité de PullSubscription.)
Propriété publique FtpAddress Infrastructure. Gets or sets the IP address of the FTP server. (hérité de PullSubscription.)
Propriété publique FtpLogin Infrastructure. Gets or sets the FTP login. (hérité de PullSubscription.)
Propriété publique FtpPassword Infrastructure. Gets or sets the FTP password. (hérité de PullSubscription.)
Propriété publique FtpPort Infrastructure. Gets or sets the port number for the FTP server. (hérité de PullSubscription.)
Propriété publique IsExistingObject Gets whether the object exists on the server or not. (hérité de ReplicationObject.)
Propriété publique LastAgentDateTime Gets the date and time when the subscription was last synchronized. (hérité de PullSubscription.)
Propriété publique LastAgentStatus Gets the status of the most recent synchronization of the subscription. (hérité de PullSubscription.)
Propriété publique LastAgentSummary Gets a summary of the result of the most recent synchronization of the subscription. (hérité de PullSubscription.)
Propriété publique LastSummaryDateTime Gets the date and time that the last synchronization was completed.
Propriété publique Name Gets the name generated for the pull subscription. (hérité de PullSubscription.)
Propriété publique PublicationDBName Gets or sets the name of the publication database. (hérité de PullSubscription.)
Propriété publique PublicationName Gets or sets the name of the publication to which the subscription subscribes. (hérité de PullSubscription.)
Propriété publique PublisherName Gets or sets the name of the Publisher. (hérité de PullSubscription.)
Propriété publique PublisherSecurity Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (hérité de PullSubscription.)
Propriété publique SecureFtpPassword Infrastructure. Gets or sets the secured password for the login used to connect to the FTP server. (hérité de PullSubscription.)
Propriété publique SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (hérité de ReplicationObject.)
Propriété publique SubscriberSecurity Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. (hérité de PullSubscription.)
Propriété publique SubscriberType Gets or sets the updating behavior of the subscription.
Propriété publique SubscriptionId Gets the subscription ID value. (hérité de PullSubscription.)
Propriété publique SubscriptionType Gets whether the subscription registration is for a push, pull, or anonymous subscription. (hérité de PullSubscription.)
Propriété publique SynchronizationAgent Gets an object that represents an instance of the Distribution Agent that can be used to synchronize the subscription.
Propriété publique 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. (hérité de PullSubscription.)
Propriété publique Type Infrastructure. Gets or sets the publication type. (hérité de PullSubscription.)
Propriété publique 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). (hérité de PullSubscription.)
Propriété publique UserData Gets or sets an object property that allows users to attach their own data to the object. (hérité de ReplicationObject.)
Propriété publique WorkingDirectory Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files. (hérité de PullSubscription.)

Haut de la page

Méthodes

  Nom Description
Méthode publique CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (hérité de ReplicationObject.)
Méthode publique Create Creates the pull subscription on the Subscriber. (hérité de PullSubscription.)
Méthode publique Decouple Decouples the referenced replication object from the server. (hérité de ReplicationObject.)
Méthode publique Equals (hérité de Object.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetType (hérité de Object.)
Méthode publique LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run. (hérité de PullSubscription.)
Méthode publique Load Loads the properties of an existing object from the server. (hérité de ReplicationObject.)
Méthode publique LoadProperties Loads the properties of an existing object from the server. (hérité de ReplicationObject.)
Méthode publique Refresh Reloads the properties of the object. (hérité de ReplicationObject.)
Méthode publique Reinitialize Marks the pull subscription for reinitialization.
Méthode publique Remove Removes the pull subscription. (hérité de PullSubscription.)
Méthode publique Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (hérité de PullSubscription.)
Méthode publique StopSynchronizationJob Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription. (remplace PullSubscription.StopSynchronizationJob().)
Méthode publique SynchronizeWithJob Starts the agent job to synchronize the subscription. (remplace PullSubscription.SynchronizeWithJob().)
Méthode publique ToString (hérité de Object.)

Haut de la page

Notes

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

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.

Exemples

            // Define the Publisher, publication, and databases.
            string publicationName = "AdvWorksProductTran";
            string publisherName = publisherInstance;
            string subscriberName = subscriberInstance;
            string subscriptionDbName = "AdventureWorks2012Replica";
            string publicationDbName = "AdventureWorks2012";

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

            // Create the objects that we need.
            TransPublication publication;
            TransPullSubscription subscription;

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

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

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

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

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

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

                    // By default, subscriptions to transactional publications are synchronized 
                    // continuously, but in this case we only want to synchronize on demand.
                    subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand;

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

                    Boolean registered = false;

                    // Verify that the subscription is not already registered.
                    foreach (TransSubscription existing
                        in publication.EnumSubscriptions())
                    {
                        if (existing.SubscriberName == subscriberName
                            && existing.SubscriptionDBName == subscriptionDbName)
                        {
                            registered = true;
                        }
                    }
                    if (!registered)
                    {
                        // Register the subscription with the Publisher.
                        publication.MakePullSubscriptionWellKnown(
                            subscriberName, subscriptionDbName,
                            SubscriptionSyncType.Automatic,
                            TransSubscriberType.ReadOnly);
                    }
                }
                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 = "AdvWorksProductTran"
Dim publisherName As String = publisherInstance
Dim subscriberName As String = subscriberInstance
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"

'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 TransPublication
Dim subscription As TransPullSubscription

Try
    ' Connect to the Publisher and Subscriber.
    subscriberConn.Connect()
    publisherConn.Connect()

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

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

        ' Define the pull subscription.
        subscription = New TransPullSubscription()
        subscription.ConnectionContext = subscriberConn
        subscription.PublisherName = publisherName
        subscription.PublicationName = publicationName
        subscription.PublicationDBName = publicationDbName
        subscription.DatabaseName = subscriptionDbName
        subscription.Description = "Pull subscription to " + publicationDbName _
        + " on " + subscriberName + "."

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

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

        ' By default, subscriptions to transactional publications are synchronized 
        ' continuously, but in this case we only want to synchronize on demand.
        subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand

        ' 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 TransSubscription In publication.EnumSubscriptions()
            If existing.SubscriberName = subscriberName And _
                existing.SubscriptionDBName = subscriptionDbName Then
                registered = True
            End If
        Next existing
        If Not registered Then
            ' Register the subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown( _
             subscriberName, subscriptionDbName, _
             SubscriptionSyncType.Automatic, _
             TransSubscriberType.ReadOnly)
        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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Replication

Autres ressources

Procédure : créer un abonnement par extraction (programmation RMO)