• 發行項

TransSynchronizationAgent 類別

Provides the functionality of the Replication Distribution Agent.

繼承階層

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    Microsoft.SqlServer.Replication..::..TransSynchronizationAgent

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

語法

'宣告
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<ComVisibleAttribute(True)> _
<GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public Class TransSynchronizationAgent _
    Inherits MarshalByRefObject _
    Implements IDisposable, ITransSynchronizationAgent
'用途
Dim instance As TransSynchronizationAgent

[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[ComVisibleAttribute(true)]
[GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public class TransSynchronizationAgent : MarshalByRefObject, 
    IDisposable, ITransSynchronizationAgent

[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
[GuidAttribute(L"adeda98a-bdfc-4029-b6fb-991d6b468395")]
[PermissionSetAttribute(SecurityAction::Demand, Name = L"FullTrust")]
public ref class TransSynchronizationAgent : public MarshalByRefObject, 
    IDisposable, ITransSynchronizationAgent

[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<ComVisibleAttribute(true)>]
[<GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")>]
[<PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")>]
type TransSynchronizationAgent =  
    class
        inherit MarshalByRefObject
        interface IDisposable
        interface ITransSynchronizationAgent
    end

public class TransSynchronizationAgent extends MarshalByRefObject implements IDisposable, ITransSynchronizationAgent

TransSynchronizationAgent 型別公開下列成員。

建構函式

  名稱 說明
公用方法 TransSynchronizationAgent Creates an instance of the TransSynchronizationAgent class.

上層

屬性

  名稱 說明
公用屬性 AltSnapshotFolder Gets or sets the alternate snapshot folder for the subscription.
公用屬性 ComErrorCollection Gets a collection of errors that are generated by the replication agent.
公用屬性 Distributor Gets or sets the name of the instance of Microsoft SQL Server that is acting as the Distributor for the subscription.
公用屬性 DistributorAddress Gets or sets the network address that is used to connect to the Distributor when the DistributorNetwork property is specified.
公用屬性 DistributorEncryptedPassword 基礎結構。
公用屬性 DistributorLogin Gets or sets the login name that is used when connecting to the Distributor by using SQL Server Authentication.
公用屬性 DistributorNetwork Gets or sets the client Net-Library that is used when connecting to the Distributor.
公用屬性 DistributorPassword Sets the password that is used when connecting to the Distributor by using SQL Server Authentication.
公用屬性 DistributorSecurityMode Gets or sets the security mode that is used when connecting to the Distributor.
公用屬性 DtsPackageFileName Gets or sets the name and path of a Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is used to transform command rowsets before they are applied to a Subscriber.
公用屬性 DtsPackagePassword Gets or sets the owner password that used to access the Microsoft SQL Server 2000 Data Transformation Services (DTS) package specified by the DtsPackageFileName property.
公用屬性 FileTransferType Gets or sets how the initial snapshot files are transferred to the Subscriber.
公用屬性 HostName 基礎結構。
公用屬性 LastUpdatedTime Gets the timestamp of the last time that replication agent synchronized the subscription.
公用屬性 LoginTimeout Gets or sets the maximum number of seconds to wait for connections to be established.
公用屬性 MaxDeliveredTransactions Gets or sets the maximum number of transactions that are applied to the Subscriber during a single agent execution.
公用屬性 Output Gets or sets the file name and path of the agent output file.
公用屬性 OutputVerboseLevel Gets or sets the amount of information that is logged by the Distribution Agent in the agent output file.
公用屬性 ProfileName Gets or sets the name of the profile that is used by the agent.
公用屬性 Publication Gets or sets the name of the publication.
公用屬性 Publisher Gets or sets the name of the instance of Microsoft SQL Server that is the Publisher for the subscription.
公用屬性 PublisherDatabase Gets or sets the name of the publication database.
公用屬性 QueryTimeout Gets or sets the number of seconds that are allowed for internal queries to complete.
公用屬性 SecureDistributorEncryptedPassword 基礎結構。
公用屬性 SecureSubscriberEncryptedPassword 基礎結構。
公用屬性 SkipErrors Gets or sets a colon-separated list of the error numbers that are to be skipped by this agent.
公用屬性 Subscriber Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.
公用屬性 SubscriberDatabase Gets or sets the name of the subscription database.
公用屬性 SubscriberDatabasePath 基礎結構。
公用屬性 SubscriberDataSourceType Gets or sets the type of data source that is used as the Subscriber.
公用屬性 SubscriberEncryptedPassword 基礎結構。
公用屬性 SubscriberLogin Gets or sets the login name that is used when connecting to the Subscriber by using SQL Server Authentication.
公用屬性 SubscriberPassword Sets the password that is used when connecting to the Subscriber by using SQL Server Authentication.
公用屬性 SubscriberSecurityMode Gets or sets the security mode that is used when connecting to the Publisher.
公用屬性 SubscriptionType Gets or sets whether the subscription is a push or pull subscription.
公用屬性 UndeliveredCommands 基礎結構。
公用屬性 UndeliveredTransactions 基礎結構。
公用屬性 UseInProcLoader Gets or sets whether to use the BULK INSERT command when applying snapshot files at the Subscriber.
公用屬性 WorkingDirectory Gets or sets the working directory from which snapshot files are accessed when File Transfer Protocol (FTP) is used.

上層

方法

  名稱 說明
公用方法 Abort 基礎結構。
公用方法 CreateObjRef (繼承自 MarshalByRefObject。)
公用方法 Dispose() () () () 基礎結構。
受保護的方法 Dispose(Boolean)
公用方法 Equals (繼承自 Object。)
受保護的方法 Finalize 基礎結構。 (覆寫 Object. . :: . .Finalize() () () ()。)
公用方法 GetHashCode (繼承自 Object。)
公用方法 GetLifetimeService (繼承自 MarshalByRefObject。)
公用方法 GetType (繼承自 Object。)
公用方法 InitializeLifetimeService (繼承自 MarshalByRefObject。)
公用方法 IsSnapshotRequired Connects to the Distributor and the Subscriber to determine whether a new snapshot will be applied during the next agent synchronization.
受保護的方法 MemberwiseClone() () () () (繼承自 Object。)
受保護的方法 MemberwiseClone(Boolean) (繼承自 MarshalByRefObject。)
公用方法 Synchronize Starts the Distribution Agent to synchronize the subscription.
公用方法 ToString (繼承自 Object。)

上層

事件

  名稱 說明
公用事件 ComStatus 基礎結構。
公用事件 Status Occurs when the Distribution Agent returns synchronization status information.

上層

備註

The TransSynchronizationAgent class supports the ability to programmatically synchronize subscriptions to transactional or snapshot publications.

範例

In the following example, the Synchronize method is called on the instance of the TransSynchronizationAgent class that is accessed from the SynchronizationAgent property to synchronize the push subscription.

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

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

            TransSubscription subscription;

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

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

                // If the push subscription exists, start the synchronization.
                if (subscription.LoadProperties())
                {
                    // Check that we have enough metadata to start the agent.
                    if (subscription.SubscriberSecurity != null)
                    {
                        // Synchronously start the Distribution Agent for the subscription.
                        subscription.SynchronizationAgent.Synchronize();
                    }
                    else
                    {
                        throw new ApplicationException("There is insufficent metadata to " +
                            "synchronize the subscription. Recreate the subscription with " +
                            "the agent job or supply the required agent properties at run time.");
                    }
                }
                else
                {
                    // Do something here if the push subscription does not exist.
                    throw new ApplicationException(String.Format(
                        "The subscription to '{0}' does not exist on {1}",
                        publicationName, subscriberName));
                }
            }
            catch (Exception ex)
            {
                // Implement appropriate error handling here.
                throw new ApplicationException("The subscription could not be synchronized.", ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Define the server, publication, and database names.
Dim subscriberName As String = subscriberInstance
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksProductTran"
Dim subscriptionDbName As String = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"

' Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)

Dim subscription As TransSubscription

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

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

    ' If the push subscription exists, start the synchronization.
    If subscription.LoadProperties() Then
        ' Check that we have enough metadata to start the agent.
        If Not subscription.SubscriberSecurity Is Nothing Then

            ' Synchronously start the Distribution Agent for the subscription.
            subscription.SynchronizationAgent.Synchronize()
        Else
            Throw New ApplicationException("There is insufficent metadata to " + _
             "synchronize the subscription. Recreate the subscription with " + _
             "the agent job or supply the required agent properties at run time.")
        End If
    Else
        ' Do something here if the push subscription does not exist.
        Throw New ApplicationException(String.Format( _
         "The subscription to '{0}' does not exist on {1}", _
         publicationName, subscriberName))
    End If
Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("The subscription could not be synchronized.", ex)
Finally
    conn.Disconnect()
End Try

執行緒安全性

The TransSynchronizationAgent class does not support multithreaded apartments. You can specify a single-threaded apartment by declaring the [STAThread] attribute on the method that is the main entry point for the application. This is the default for Microsoft Windows-based applications that are created by using Microsoft Visual Studio.