TransSubscription 類別

Represents a push subscription to a transactional or snapshot publication.

繼承階層

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

命名空間：  Microsoft.SqlServer.Replication
組件：  Microsoft.SqlServer.Rmo (在 Microsoft.SqlServer.Rmo.dll 中)

語法

'宣告
Public NotInheritable Class TransSubscription _
    Inherits Subscription
'用途
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

TransSubscription 型別公開下列成員。

建構函式

	名稱	說明
	TransSubscription() () () ()	Creates a new instance of the TransSubscription class.
	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.

上層

屬性

	名稱	說明
	AgentJobId	Gets the ID of the agent job used to synchronize the subscription. (繼承自 Subscription。)
	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. (繼承自 Subscription。)
	AgentOffloadServer	Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (繼承自 Subscription。)
	AgentSchedule	Gets the schedule for the agent job used to synchronize the subscription. (繼承自 Subscription。)
	BackupInformation	Gets or sets information needed to initialize a subscription from a backup.
	CachePropertyChanges	Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (繼承自 ReplicationObject。)
	ConnectionContext	Gets or sets the connection to an instance of Microsoft SQL Server. (繼承自 ReplicationObject。)
	CreateSyncAgentByDefault	Gets or sets whether the agent job used to synchronize the subscription is created by default. (繼承自 Subscription。)
	DatabaseName	Gets or sets the name of the publication database. (繼承自 Subscription。)
	DtsPackageLocation	Gets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
	DtsPackageName	Gets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.
	DtsPackagePassword	Sets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
	EnabledForSynchronizationManager	Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (繼承自 Subscription。)
	FullSubscription	基礎結構。
	IsExistingObject	Gets whether the object exists on the server or not. (繼承自 ReplicationObject。)
	LoopBackDetection	Gets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.
	Name	Gets the name assigned to an existing subscription. (繼承自 Subscription。)
	PublicationName	Gets or sets the name of the publication to which the subscription subscribes. (繼承自 Subscription。)
	PublisherName	Gets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.
	SecureDtsPackagePassword	Sets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
	SqlServerName	Gets the name of the Microsoft SQL Server instance to which this object is connected. (繼承自 ReplicationObject。)
	Status	Gets the status of the subscription. (繼承自 Subscription。)
	SubscriberCatalog	Gets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.
	SubscriberDatasource	Name of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.
	SubscriberDatasourceType	Identifies the type of data source that is a non-SQL Server Subscriber.
	SubscriberLocation	Location of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.
	SubscriberName	Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (繼承自 Subscription。)
	SubscriberProvider	Unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered
	SubscriberProviderString	OLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.
	SubscriberSecurity	Gets the security context used to connect to the Subscriber. (繼承自 Subscription。)
	SubscriberType	Gets or sets the updating behavior for data changes at the Subscriber.
	SubscriptionDBName	Gets or sets the name of the database on the Subscriber that receives the replicated data. (繼承自 Subscription。)
	SubscriptionLSN
	SubscriptionType	Gets whether the subscription registration is for a push or pull subscription. (繼承自 Subscription。)
	SynchronizationAgent	Gets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.
	SynchronizationAgentName	Gets or sets the name of the agent job created to synchronize the subscription. (繼承自 Subscription。)
	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. (繼承自 Subscription。)
	SyncType	Gets or sets the manner in which the subscription is initialized. (繼承自 Subscription。)
	UserData	Gets or sets an object property that allows users to attach their own data to the object. (繼承自 ReplicationObject。)

上層

方法

	名稱	說明
	CheckValidCreation	基礎結構。 (繼承自 ReplicationObject。)
	CheckValidDefinition	基礎結構。 (繼承自 Subscription。)
	CommitPropertyChanges	Sends all the cached property change statements to the instance of Microsoft SQL Server. (繼承自 ReplicationObject。)
	Create	Creates the subscription registration at the Publisher. (繼承自 Subscription。)
	Decouple	Decouples the referenced replication object from the server. (繼承自 ReplicationObject。)
	Equals	(繼承自 Object。)
	Finalize	(繼承自 Object。)
	GetChangeCommand	基礎結構。 (繼承自 ReplicationObject。)
	GetCreateCommand	基礎結構。 (繼承自 ReplicationObject。)
	GetDropCommand	基礎結構。 (繼承自 ReplicationObject。)
	GetHashCode	(繼承自 Object。)
	GetType	(繼承自 Object。)
	InternalRefresh	基礎結構。 (繼承自 ReplicationObject。)
	Load	Loads the properties of an existing object from the server. (繼承自 ReplicationObject。)
	LoadProperties	Loads the properties of an existing object from the server. (繼承自 ReplicationObject。)
	MemberwiseClone	(繼承自 Object。)
	Refresh	Reloads the properties of the object. (繼承自 ReplicationObject。)
	Reinitialize() () () ()	Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.
	Reinitialize(Boolean)
	Remove	Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (繼承自 Subscription。)
	Script	Returns a Transact-SQL script that can be used to create or delete the subscription. (繼承自 Subscription。)
	StopSynchronizationJob	Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.
	SynchronizeWithJob	Starts the agent job to synchronize the subscription.
	ToString	(繼承自 Object。)

上層

備註

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 加密 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.

範例

            // 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

執行緒安全性

這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

請參閱

參考

Microsoft.SqlServer.Replication 命名空間

其他資源

如何：建立發送訂閱 (RMO 程式設計)