Classe TransSynchronizationAgent
Provides the functionality of the Replication Distribution Agent.
Hiérarchie d'héritage
System.Object
System.MarshalByRefObject
Microsoft.SqlServer.Replication.TransSynchronizationAgent
Espace de noms : Microsoft.SqlServer.Replication
Assembly : Microsoft.SqlServer.Replication (en Microsoft.SqlServer.Replication.dll)
Syntaxe
'Déclaration
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")> _
<ComVisibleAttribute(True)> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public Class TransSynchronizationAgent _
Inherits MarshalByRefObject _
Implements IDisposable, ITransSynchronizationAgent
'Utilisation
Dim instance As TransSynchronizationAgent
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")]
[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public class TransSynchronizationAgent : MarshalByRefObject,
IDisposable, ITransSynchronizationAgent
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[GuidAttribute(L"adeda98a-bdfc-4029-b6fb-991d6b468395")]
[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction::Demand, Name = L"FullTrust")]
public ref class TransSynchronizationAgent : public MarshalByRefObject,
IDisposable, ITransSynchronizationAgent
[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<GuidAttribute("adeda98a-bdfc-4029-b6fb-991d6b468395")>]
[<ComVisibleAttribute(true)>]
[<PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")>]
type TransSynchronizationAgent =
class
inherit MarshalByRefObject
interface IDisposable
interface ITransSynchronizationAgent
end
public class TransSynchronizationAgent extends MarshalByRefObject implements IDisposable, ITransSynchronizationAgent
Le type TransSynchronizationAgent expose les membres suivants.
Constructeurs
Nom | Description | |
---|---|---|
TransSynchronizationAgent | Creates an instance of the TransSynchronizationAgent class. |
Haut de la page
Propriétés
Nom | Description | |
---|---|---|
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 | Infrastructure. Gets or sets the encrypted password that is used when connecting to the distributor by using SQL Server Authentication. | |
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 | Gets or 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 | Infrastructure. Gets or sets the host name used. | |
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 | Infrastructure. Gets or sets the secure encrypted password for the distributor. | |
SecureSubscriberEncryptedPassword | Infrastructure. Gets or sets the secure encrypted password for the subscriber. | |
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 | Infrastructure. Get or sets the database path for the subscriber. | |
SubscriberDataSourceType | Gets or sets the type of data source that is used as the subscriber. | |
SubscriberEncryptedPassword | Infrastructure. Gets or sets the encrypted password for the subscriber. | |
SubscriberLogin | Gets or sets the login name that is used when connecting to the subscriber by using SQL Server Authentication. | |
SubscriberPassword | Gets or 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 | Infrastructure. Gets the number of undelivered commands. | |
UndeliveredTransactions | Infrastructure. Gets the number of undelivered transactions. | |
UseInProcLoader | Gets or sets a value that indicates 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. |
Haut de la page
Méthodes
Nom | Description | |
---|---|---|
Abort | Infrastructure. Aborts the TransSynchronizationAgent operation. | |
CreateObjRef | Informations critiques de sécurité. (hérité de MarshalByRefObject.) | |
Dispose() | Infrastructure. Releases all resources used by the current instance of the TransSynchronizationAgent class. | |
Dispose(Boolean) | Releases all resources used by the TransSynchronizationAgent class. | |
Equals | (hérité de Object.) | |
Finalize | Infrastructure. Finalizes the TransSynchronizationAgent. (remplace Object.Finalize().) | |
GetHashCode | (hérité de Object.) | |
GetLifetimeService | Informations critiques de sécurité. (hérité de MarshalByRefObject.) | |
GetType | (hérité de Object.) | |
InitializeLifetimeService | Informations critiques de sécurité. (hérité de MarshalByRefObject.) | |
IsSnapshotRequired | Connects to the Distributor and the Subscriber to determine whether a new snapshot will be applied during the next agent synchronization. | |
MemberwiseClone() | (hérité de Object.) | |
MemberwiseClone(Boolean) | (hérité de MarshalByRefObject.) | |
Synchronize | Starts the Distribution Agent to synchronize the subscription. | |
ToString | (hérité de Object.) |
Haut de la page
Événements
Nom | Description | |
---|---|---|
ComStatus | Infrastructure. Occurs when the Distribution Agent returns synchronization Com status information. | |
Status | Occurs when the Distribution Agent returns synchronization status information. |
Haut de la page
Notes
The TransSynchronizationAgent class supports the ability to programmatically synchronize subscriptions to transactional or snapshot publications.
Exemples
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 = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";
// 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 = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
' 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
Sécurité des threads
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.
Voir aussi
Référence
Espace de noms Microsoft.SqlServer.Replication
Autres ressources
Procédure : synchroniser un abonnement par extraction (programmation RMO)
Procédure : synchroniser un abonnement par émission de données (programmation RMO)