Artikel
03/30/2012

SnapshotGenerationAgent-Klasse

Stellt die Funktionalität des Replikationsmomentaufnahme-Agents bereit.

Vererbungshierarchie

System. . :: . .Object
  System. . :: . .MarshalByRefObject
    Microsoft.SqlServer.Replication. . :: . .AgentCore
      Microsoft.SqlServer.Replication..::..SnapshotGenerationAgent

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)

Syntax

'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<GuidAttribute("141945FD-18BD-4222-B6D9-F937704C7FFE")> _
<ComVisibleAttribute(True)> _
Public NotInheritable Class SnapshotGenerationAgent _
    Inherits AgentCore _
    Implements ISnapshotGenerationAgent
'Usage
Dim instance As SnapshotGenerationAgent

[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[GuidAttribute("141945FD-18BD-4222-B6D9-F937704C7FFE")]
[ComVisibleAttribute(true)]
public sealed class SnapshotGenerationAgent : AgentCore, 
    ISnapshotGenerationAgent

[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[GuidAttribute(L"141945FD-18BD-4222-B6D9-F937704C7FFE")]
[ComVisibleAttribute(true)]
public ref class SnapshotGenerationAgent sealed : public AgentCore, 
    ISnapshotGenerationAgent

[<SealedAttribute>]
[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<GuidAttribute("141945FD-18BD-4222-B6D9-F937704C7FFE")>]
[<ComVisibleAttribute(true)>]
type SnapshotGenerationAgent =  
    class
        inherit AgentCore
        interface ISnapshotGenerationAgent
    end

public final class SnapshotGenerationAgent extends AgentCore implements ISnapshotGenerationAgent

Der SnapshotGenerationAgent-Typ macht folgende Elemente verfügbar.

Konstruktoren

	Name	Beschreibung
	SnapshotGenerationAgent	Erstellt eine Instanz der SnapshotGenerationAgent-Klasse.

Zum Anfang

Eigenschaften

	Name	Beschreibung
	AbortPolicy	Ruft ab oder legt fest, wie aktive Threads von Replikations-Agents beendet werden, wenn ein unerwartetes Herunterfahren auftritt. (Geerbt von AgentCore.)
	BcpBatchSize	Ruft die Anzahl der Zeilen ab, die in einem Massenkopiervorgang an den Verteiler gesendet werden sollen, oder legt diese fest.
	ComErrorCollection	Gibt Informationen zu Fehlern zurück, die während der Agentausführung auftreten. (Geerbt von AgentCore.)
	Distributor	Ruft den Namen der SQL Server-Instanz ab, die als Verteiler für die Veröffentlichung fungiert, oder legt diesen fest.
	DistributorDeadlockPriority	Ruft die Priorität der Verbindung des Momentaufnahme-Agents mit dem Verteiler ab, wenn ein Deadlock auftritt, oder legt diese fest.
	DistributorEncryptedPassword	Infrastruktur
	DistributorEncryptionLevel	Ruft die Ebene der SSL-Verschlüsselung (Secure Sockets Layer) ab, die vom Momentaufnahme-Agent beim Herstellen einer Verbindung mit dem Verteiler verwendet wird, oder legt diese fest.
	DistributorLogin	Ruft den Anmeldenamen ab, der beim Herstellen einer lokalen Verbindung mit dem Verteiler mithilfe der SQL Server-Authentifizierung verwendet wird, oder legt diesen fest.
	DistributorNetworkLibrary	Infrastruktur
	DistributorPassword	Legt das Kennwort fest, das verwendet wird, um mithilfe der SQL Server-Authentifizierung eine lokale Verbindung mit dem Verteiler herzustellen.
	DistributorSecurityMode	Ruft den Sicherheitsmodus ab, der beim Herstellen einer lokalen Verbindung mit dem Verteiler verwendet wird, oder legt diesen fest.
	DynamicFilterHostName	Ruft den Wert ab, der der in einem parametrisierten Zeilenfilter verwendeten HOST_NAME-Funktion bereitgestellt wird, oder legt diesen fest.
	DynamicFilterLogin	Ruft den Wert ab, der der in einem parametrisierten Zeilenfilter verwendeten SUSER_SNAME-Funktion bereitgestellt wird, oder legt diesen fest.
	DynamicSnapshotLocation	Ruft den Speicherort der partitionierten Momentaufnahme für das Abonnement einer Mergeveröffentlichung ab, die auf Grundlage eines parametrisierten Zeilenfilters definiert wird, oder legt diesen fest.
	FieldDelimiter	Ruft das Zeichen oder die Zeichenfolge ab, mit dem bzw. der das Ende eines Felds in der SQL Server-Datendatei für das Massenkopieren markiert wird, oder legt dieses Zeichen bzw. diese Zeichenfolge fest.
	FlatExceptionCollection	Infrastruktur (Geerbt von AgentCore.)
	HistoryVerboseLevel	Ruft ab oder legt fest, wie viele Informationen bei der Agentausführung protokolliert werden. (Geerbt von AgentCore.)
	HRBcpBlocks	Infrastruktur
	HRBcpBlockSize	Infrastruktur
	HRBcpDynamicBlocks	Infrastruktur
	LoginTimeout	Ruft die Anzahl von Sekunden ab, die bei der Anmeldung auf Verbindungen durch den Agent gewartet wird, oder legt diese fest. (Geerbt von AgentCore.)
	MaxBcpThreads	Ruft die Anzahl von Massenkopiervorgängen ab, die parallel ausgeführt werden können, oder legt diese fest.
	MaxNetworkOptimization	Ruft ab oder legt fest, ob Löschvorgänge außerhalb von Partitionen an den Abonnenten gesendet werden.
	OnetimeDynamicSnapshot	Infrastruktur
	Output	Ruft den Namen und den Pfad der Agentausgabedatei ab oder legt diese Angaben fest. (Geerbt von AgentCore.)
	OutputVerboseLevel	Ruft ab oder legt fest, mit welcher Detailgenauigkeit Informationen in die Agentausgabedatei geschrieben werden sollen. (Geerbt von AgentCore.)
	PacketSize	Infrastruktur (Geerbt von AgentCore.)
	ProfileName	Ruft ab oder legt fest, welches Agentprofil für die Ausführung des Agents verwendet werden soll. (Geerbt von AgentCore.)
	Publication	Ruft den Namen der Veröffentlichung ab oder legt diesen fest.
	Publisher	Ruft den Namen der SQL Server-Instanz ab, die der Verleger ist, oder legt diesen fest.
	PublisherDatabase	Ruft den Namen der Veröffentlichungsdatenbank ab oder legt ihn fest.
	PublisherDeadlockPriority	Ruft die Priorität der Verbindung des Momentaufnahme-Agents mit dem Verleger ab, wenn ein Deadlock auftritt, oder legt diese fest.
	PublisherEncryptedPassword	Infrastruktur
	PublisherEncryptionLevel	Ruft die Ebene der SSL-Verschlüsselung (Secure Sockets Layer) ab, die vom Momentaufnahme-Agent beim Herstellen einer Verbindung mit dem Verteiler verwendet wird, oder legt diese fest.
	PublisherFailoverPartner	Ruft die Failoverpartnerinstanz von SQL Server ab, die an einer Datenbank-Spiegelungssitzung mit der Veröffentlichungsdatenbank teilnimmt, oder legt diese fest. (Geerbt von AgentCore.)
	PublisherLogin	Ruft den Anmeldenamen ab, der beim Herstellen einer Verbindung mit dem Verleger mithilfe der SQL Server-Authentifizierung verwendet wird, oder legt diesen fest.
	PublisherNetworkLibrary	Infrastruktur
	PublisherPassword	Legt das Kennwort fest, das verwendet wird, um mithilfe der SQL Server-Authentifizierung eine Verbindung mit dem Verleger herzustellen.
	PublisherSecurityMode	Ruft den Sicherheitsmodus ab, der beim Herstellen einer Verbindung mit dem Verleger verwendet wird, oder legt diesen fest.
	QueryTimeout	Ruft ab oder legt fest, wie viele Sekunden auf die Durchführung einer Abfrage gewartet werden soll. (Geerbt von AgentCore.)
	ReplicationType	Ruft den Typ der Veröffentlichung ab oder legt diesen fest.
	RowDelimiter	Ruft das Zeichen oder die Zeichenfolge ab, mit dem bzw. der das Ende einer Zeile in der SQL Server-Datendatei für das Massenkopieren markiert wird, oder legt dieses Zeichen bzw. diese Zeichenfolge fest.
	SecureDistributorEncryptedPassword	Infrastruktur
	SecureDistributorPassword	Legt das Kennwort (als SecureString-Objekt) fest, das beim Herstellen einer lokalen Verbindung mit dem Verteiler mithilfe der SQL Server-Authentifizierung verwendet wird.
	SecurePublisherEncryptedPassword	Infrastruktur
	SecurePublisherPassword	Legt das Kennwort (als SecureString-Objekt) fest, das beim Herstellen einer Verbindung mit dem Verleger mithilfe der SQL Server-Authentifizierung verwendet wird.
	StartQueueTimeout	Ruft die Zeit ab, die der Momentaufnahme-Agent abwartet, wenn bereits die maximale Anzahl von gleichzeitigen partitionierten Momentaufnahmevorgängen für eine Mergeveröffentlichung ausgeführt wird, oder legt diese fest.
	Supports70Subscribers	Ruft ab oder legt fest, ob die generierte Momentaufnahme SQL Server 7.0-Abonnenten unterstützt.

Zum Anfang

Methoden

	Name	Beschreibung
	Abort	(Geerbt von AgentCore.)
	CreateObjRef	(Geerbt von MarshalByRefObject.)
	Equals	(Geerbt von Object.)
	Finalize	(Geerbt von Object.)
	GenerateSnapshot	Startet den Momentaufnahme-Agent, um die Momentaufnahme zu generieren.
	GetHashCode	(Geerbt von Object.)
	GetLifetimeService	(Geerbt von MarshalByRefObject.)
	GetType	(Geerbt von Object.)
	InitializeLifetimeService	(Geerbt von MarshalByRefObject.)
	MemberwiseClone() () () ()	(Geerbt von Object.)
	MemberwiseClone(Boolean)	(Geerbt von MarshalByRefObject.)
	ResetParametersToDefault	(Geerbt von AgentCore.)
	ToString	(Geerbt von Object.)

Zum Anfang

Ereignisse

	Name	Beschreibung
	ComStatus	(Geerbt von AgentCore.)
	Status	Tritt auf, wenn ein aktiver Agent Statusinformationen zurückgibt. (Geerbt von AgentCore.)

Zum Anfang

Explizite Schnittstellenimplementierungen

	Name	Beschreibung
	ISnapshotGenerationAgent. . :: . .ResetParametersToDefault

Zum Anfang

Hinweise

The SnapshotGenerationAgent class provides direct, programmatic access to the Snapshot Agent.

The SnapshotGenerationAgent class supports the ability to do the following replication tasks:

Generate the initial snapshot
Generate a partitioned snapshot for a subscription defined based-on a parameterized filter.

Beispiele

This example generates a standard snapshot for a transactional publication.

          // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2008R2";
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;

            SnapshotGenerationAgent agent;

            try
            {
                // Set the required properties for Snapshot Agent.
                agent = new SnapshotGenerationAgent();
                agent.Distributor = distributorName;
                agent.DistributorSecurityMode = SecurityMode.Integrated;
                agent.Publisher = publisherName;
                agent.PublisherSecurityMode = SecurityMode.Integrated;
                agent.Publication = publicationName;
                agent.PublisherDatabase = publicationDbName;
                agent.ReplicationType = ReplicationType.Transactional;

                // Start the agent synchronously.
                agent.GenerateSnapshot();

            }
            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "A snapshot could not be generated for the {0} publication."
                    , publicationName), ex);
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Transactional

    ' Start the agent synchronously.
    agent.GenerateSnapshot()

Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try

This example generates a standard snapshot for a merge publication.

// Set the Publisher, publication database, and publication names.
string publicationName = "AdvWorksSalesOrdersMerge";
string publicationDbName = "AdventureWorks2008R2";
string publisherName = publisherInstance;
string distributorName = publisherInstance;

SnapshotGenerationAgent agent;

try
{
    // Set the required properties for Snapshot Agent.
    agent = new SnapshotGenerationAgent();
    agent.Distributor = distributorName;
    agent.DistributorSecurityMode = SecurityMode.Integrated;
    agent.Publisher = publisherName;
    agent.PublisherSecurityMode = SecurityMode.Integrated;
    agent.Publication = publicationName;
    agent.PublisherDatabase = publicationDbName;
    agent.ReplicationType = ReplicationType.Merge;

    // Start the agent synchronously.
    agent.GenerateSnapshot();

}
catch (Exception ex)
{
    // Implement custom application error handling here.
    throw new ApplicationException(String.Format(
        "A snapshot could not be generated for the {0} publication."
        , publicationName), ex);
}

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Merge

    ' Start the agent synchronously.
    agent.GenerateSnapshot()

Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try

This example overloads the HOST_NAME function to generate a filtered data snapshot for a subscription to a merge publication that has a parameterized filter.

           // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks2008R2";
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;

            SnapshotGenerationAgent agent;

            try
            {
                // Set the required properties for Snapshot Agent.
                agent = new SnapshotGenerationAgent();
                agent.Distributor = distributorName;
                agent.DistributorSecurityMode = SecurityMode.Integrated;
                agent.Publisher = publisherName;
                agent.PublisherSecurityMode = SecurityMode.Integrated;
                agent.Publication = publicationName;
                agent.PublisherDatabase = publicationDbName;
                agent.ReplicationType = ReplicationType.Merge;

                // Specify the partition information to generate a 
                // filtered snapshot based on Hostname.
                agent.DynamicFilterHostName = hostname;

                // Start the agent synchronously.
                agent.GenerateSnapshot();
            }
            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "A snapshot could not be generated for the {0} publication."
                    , publicationName), ex);
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Merge

    ' Specify the partition information to generate a 
    ' filtered snapshot based on Hostname.
    agent.DynamicFilterHostName = hostname

    ' Start the agent synchronously.
    agent.GenerateSnapshot()
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.