Partager via

  • Article

Classe TransSubscription

Represents a push subscription to a transactional or snapshot publication.

Hiérarchie d'héritage

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

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

Syntaxe

'Déclaration
Public NotInheritable Class TransSubscription _
    Inherits Subscription
'Utilisation
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

Le type TransSubscription expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique TransSubscription() () () () Creates a new instance of the TransSubscription class.
Méthode publique 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.

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 Subscription.)
Propriété publique 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. (hérité de Subscription.)
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 Subscription.)
Propriété publique AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (hérité de Subscription.)
Propriété publique BackupInformation Gets or sets information needed to initialize a subscription from a backup.
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 the agent job used to synchronize the subscription is created by default. (hérité de Subscription.)
Propriété publique DatabaseName Gets or sets the name of the publication database. (hérité de Subscription.)
Propriété publique DtsPackageLocation Gets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Propriété publique DtsPackageName Gets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.
Propriété publique DtsPackagePassword Sets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Propriété publique EnabledForSynchronizationManager Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (hérité de Subscription.)
Propriété publique FullSubscription Infrastructure.
Propriété publique IsExistingObject Gets whether the object exists on the server or not. (hérité de ReplicationObject.)
Propriété publique LoopBackDetection Gets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.
Propriété publique Name Gets the name assigned to an existing subscription. (hérité de Subscription.)
Propriété publique PublicationName Gets or sets the name of the publication to which the subscription subscribes. (hérité de Subscription.)
Propriété publique PublisherName Gets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.
Propriété publique SecureDtsPackagePassword Sets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
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 Status Gets the status of the subscription. (hérité de Subscription.)
Propriété publique SubscriberCatalog Gets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.
Propriété publique SubscriberDatasource Name of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.
Propriété publique SubscriberDatasourceType Identifies the type of data source that is a non-SQL Server Subscriber.
Propriété publique SubscriberLocation Location of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.
Propriété publique SubscriberName Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (hérité de Subscription.)
Propriété publique SubscriberProvider Unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered
Propriété publique SubscriberProviderString OLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.
Propriété publique SubscriberSecurity Gets the security context used to connect to the Subscriber. (hérité de Subscription.)
Propriété publique SubscriberType Gets or sets the updating behavior for data changes at the Subscriber.
Propriété publique SubscriptionDBName Gets or sets the name of the database on the Subscriber that receives the replicated data. (hérité de Subscription.)
Propriété publique SubscriptionLSN
Propriété publique SubscriptionType Gets whether the subscription registration is for a push or pull subscription. (hérité de Subscription.)
Propriété publique SynchronizationAgent Gets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.
Propriété publique SynchronizationAgentName Gets or sets the name of the agent job created to synchronize the subscription. (hérité de 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 Subscription.)
Propriété publique SyncType Gets or sets the manner in which the subscription is initialized. (hérité de Subscription.)
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.)

Haut de la page

Méthodes

  Nom Description
Méthode protégée CheckValidCreation Infrastructure. (hérité de ReplicationObject.)
Méthode protégée CheckValidDefinition Infrastructure. (hérité de Subscription.)
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 subscription registration at the Publisher. (hérité de Subscription.)
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 protégée Finalize (hérité de Object.)
Méthode protégée GetChangeCommand Infrastructure. (hérité de ReplicationObject.)
Méthode protégée GetCreateCommand Infrastructure. (hérité de ReplicationObject.)
Méthode protégée GetDropCommand Infrastructure. (hérité de ReplicationObject.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetType (hérité de Object.)
Méthode protégée InternalRefresh Infrastructure. (hérité de ReplicationObject.)
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 protégée MemberwiseClone (hérité de Object.)
Méthode publique Refresh Reloads the properties of the object. (hérité de ReplicationObject.)
Méthode publique Reinitialize() () () () Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.
Méthode publique Reinitialize(Boolean)
Méthode publique Remove Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (hérité de Subscription.)
Méthode publique Script Returns a Transact-SQL script that can be used to create or delete the subscription. (hérité de Subscription.)
Méthode publique StopSynchronizationJob Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.
Méthode publique SynchronizeWithJob Starts the agent job to synchronize the subscription.
Méthode publique ToString (hérité de Object.)

Haut de la page

Notes

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 Chiffrement des connexions à 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.

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.

Exemples

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

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

'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

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.