Partilhar via


Classe TransSubscription

Represents a push subscription to a transactional or snapshot publication.

Hierarquia de herança

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Subscription
      Microsoft.SqlServer.Replication.TransSubscription

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

Sintaxe

'Declaração
Public NotInheritable Class TransSubscription _
    Inherits Subscription
'Uso
Dim instance As TransSubscription
public sealed class TransSubscription : Subscription
public ref class TransSubscription sealed : public Subscription
[<SealedAttribute>]
type TransSubscription =  
    class 
        inherit Subscription 
    end
public final class TransSubscription extends Subscription

O tipo TransSubscription expõe os membros a seguir.

Construtores

  Nome Descrição
Método público TransSubscription() Creates a new instance of the TransSubscription class.
Método público TransSubscription(String, String, String, String, ServerConnection) Creates a new instance of the TransSubscription class with the specified publication, database, Subscriber, and subscriber database, and with the specified connection to the instance of Microsoft SQL Server.

Início

Propriedades

  Nome Descrição
Propriedade pública AgentJobId Gets the ID of the agent job used to synchronize the subscription. (Herdado de Subscription.)
Propriedade pública AgentOffload Gets or sets whether 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 Subscription.)
Propriedade pública AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (Herdado de Subscription.)
Propriedade pública AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (Herdado de Subscription.)
Propriedade pública BackupInformation Gets or sets information needed to initialize a subscription from a backup.
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 the agent job used to synchronize the subscription is created by default. (Herdado de Subscription.)
Propriedade pública DatabaseName Gets or sets the name of the publication database. (Herdado de Subscription.)
Propriedade pública DtsPackageLocation Gets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Propriedade pública DtsPackageName Gets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.
Propriedade pública DtsPackagePassword Sets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Propriedade pública EnabledForSynchronizationManager Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (Herdado de Subscription.)
Propriedade pública FullSubscription Infraestrutura. Gets a value that indicates whether the subscription is full.
Propriedade pública IsExistingObject Gets whether the object exists on the server or not. (Herdado de ReplicationObject.)
Propriedade pública LoopBackDetection Gets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.
Propriedade pública Name Gets the name assigned to an existing subscription. (Herdado de Subscription.)
Propriedade pública PublicationName Gets or sets the name of the publication to which the subscription subscribes. (Herdado de Subscription.)
Propriedade pública PublisherName Gets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.
Propriedade pública SecureDtsPackagePassword Sets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
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 Status Gets the status of the subscription. (Herdado de Subscription.)
Propriedade pública SubscriberCatalog Gets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.
Propriedade pública SubscriberDatasource Name of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.
Propriedade pública SubscriberDatasourceType Identifies the type of data source that is a non-SQL Server Subscriber.
Propriedade pública SubscriberLocation Location of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.
Propriedade pública SubscriberName Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (Herdado de Subscription.)
Propriedade pública SubscriberProvider Unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered
Propriedade pública SubscriberProviderString OLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.
Propriedade pública SubscriberSecurity Gets the security context used to connect to the Subscriber. (Herdado de Subscription.)
Propriedade pública SubscriberType Gets or sets the updating behavior for data changes at the Subscriber.
Propriedade pública SubscriptionDBName Gets or sets the name of the database on the Subscriber that receives the replicated data. (Herdado de Subscription.)
Propriedade pública SubscriptionLSN Gets or sets the log sequence number of the subscription.
Propriedade pública SubscriptionType Gets whether the subscription registration is for a push or pull subscription. (Herdado de Subscription.)
Propriedade pública SynchronizationAgent Gets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.
Propriedade pública SynchronizationAgentName Gets or sets the name of the agent job created to synchronize the subscription. (Herdado de 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 Subscription.)
Propriedade pública SyncType Gets or sets the manner in which the subscription is initialized. (Herdado de Subscription.)
Propriedade pública UserData Gets or sets an object property that allows users to attach their own data to the object. (Herdado de ReplicationObject.)

Início

Métodos

  Nome Descrição
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 subscription registration at the Publisher. (Herdado de Subscription.)
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 público GetHashCode (Herdado de Object.)
Método público GetType (Herdado de Object.)
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 público Refresh Reloads the properties of the object. (Herdado de ReplicationObject.)
Método público Reinitialize() Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.
Método público Reinitialize(Boolean) Reinitializes the subscription.
Método público Remove Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (Herdado de Subscription.)
Método público Script Returns a Transact-SQL script that can be used to create or delete the subscription. (Herdado de Subscription.)
Método público StopSynchronizationJob Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.
Método público SynchronizeWithJob Starts the agent job to synchronize the subscription.
Método público ToString (Herdado de Object.)

Início

Comentários

When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including SynchronizationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the Create method. For more information, see Criptografando conexões com o SQL Server.

When the subscription belongs to a non-SQL Server Publisher, the ConnectionContext property is set to the Distributor instead of Publisher, the DatabaseName property is set to the distribution database instead of the publication database, and the PublisherName property is set to the name of the non-SQL Server Publisher.

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 = "AdventureWorks2012Replica";
            string publicationDbName = "AdventureWorks2012";

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

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

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

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

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

                    // Define the push subscription.
                    subscription = new TransSubscription();
                    subscription.ConnectionContext = conn;
                    subscription.SubscriberName = subscriberName;
                    subscription.PublicationName = publicationName;
                    subscription.DatabaseName = publicationDbName;
                    subscription.SubscriptionDBName = subscriptionDbName;

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

                    // 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 push subscription.
                    subscription.Create();
                }
                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
            {
                conn.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 a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(subscriberName)

' Create the objects that we need.
Dim publication As TransPublication
Dim subscription As TransSubscription

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

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

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

        ' Define the push subscription.
        subscription = New TransSubscription()
        subscription.ConnectionContext = conn
        subscription.SubscriberName = subscriberName
        subscription.PublicationName = publicationName
        subscription.DatabaseName = publicationDbName
        subscription.SubscriptionDBName = subscriptionDbName

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

        ' 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 push subscription.
        subscription.Create()
    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
    conn.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.

Consulte também

Referência

Namespace Microsoft.SqlServer.Replication

Outros recursos

Como criar uma assinatura push (programação RMO)