• Artigo

Classe TransPullSubscription

Represents a pull subscription to a transactional publication.

Hierarquia de herança

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

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

Sintaxe

'Declaração
Public NotInheritable Class TransPullSubscription _
    Inherits PullSubscription
'Uso
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

O tipo TransPullSubscription expõe os membros a seguir.

Construtores

  Nome Descrição
Método público TransPullSubscription() () () () Creates a new instance of the TransPullSubscription class.
Método público TransPullSubscription(String, String, String, String, ServerConnection) Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription.
Método público 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.

Início

Propriedades

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

Início

Métodos

  Nome Descrição
Método protegido CheckValidCreation Infraestrutura. (Herdado de ReplicationObject.)
Método protegido CheckValidDefinition Infraestrutura. (Herdado de PullSubscription.)
Método público CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Herdado de ReplicationObject.)
Método público Create Creates the pull subscription on the Subscriber. (Herdado de PullSubscription.)
Método protegido CustomEnabledForSyncMgr Infraestrutura. (Herdado de PullSubscription.)
Método público Decouple Decouples the referenced replication object from the server. (Herdado de ReplicationObject.)
Método público Equals (Herdado de Object.)
Método protegido Finalize (Herdado de Object.)
Método protegido GetChangeCommand Infraestrutura. (Herdado de ReplicationObject.)
Método protegido GetCreateCommand Infraestrutura. (Herdado de ReplicationObject.)
Método protegido GetDropCommand Infraestrutura. (Herdado de ReplicationObject.)
Método público GetHashCode (Herdado de Object.)
Método público GetType (Herdado de Object.)
Método protegido InitMemberVariables Infraestrutura. (Herdado de PullSubscription.)
Método protegido InternalRefresh Infraestrutura. (Herdado de ReplicationObject.)
Método público LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run. (Herdado de PullSubscription.)
Método público Load Loads the properties of an existing object from the server. (Herdado de ReplicationObject.)
Método público LoadProperties Loads the properties of an existing object from the server. (Herdado de ReplicationObject.)
Método protegido MemberwiseClone (Herdado de Object.)
Método público Refresh Reloads the properties of the object. (Herdado de ReplicationObject.)
Método público Reinitialize Marks the pull subscription for reinitialization.
Método público Remove Removes the pull subscription. (Herdado de PullSubscription.)
Método público Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (Herdado de PullSubscription.)
Método público StopSynchronizationJob Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription. (Substitui PullSubscription. . :: . .StopSynchronizationJob() () () ().)
Método público SynchronizeWithJob Starts the agent job to synchronize the subscription. (Substitui PullSubscription. . :: . .SynchronizeWithJob() () () ().)
Método público ToString (Herdado de Object.)

Início

Comentários

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

This namespace, class, or member is supported only in version 2.0 of the .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.

Exemplos

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

            //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 = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"

'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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.