Classe SnapshotGenerationAgent

Provides the functionality of the Replication Snapshot Agent.

Hierarquia de herança

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

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

Sintaxe

'Declaração
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<GuidAttribute("141945FD-18BD-4222-B6D9-F937704C7FFE")> _
<ComVisibleAttribute(True)> _
Public NotInheritable Class SnapshotGenerationAgent _
    Inherits AgentCore _
    Implements ISnapshotGenerationAgent
'Uso
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

O tipo SnapshotGenerationAgent expõe os membros a seguir.

Construtores

	Nome	Descrição
	SnapshotGenerationAgent	Creates an instance of the SnapshotGenerationAgent class.

Início

Propriedades

	Nome	Descrição
	AbortPolicy	Gets or sets how running replication agent threads are terminated when an unanticipated shutdown occurs. (Herdado de AgentCore.)
	BcpBatchSize	Gets or set the number of rows to send to the Distributor in a bulk copy operation.
	ComErrorCollection	Returns information on errors that occur during agent execution. (Herdado de AgentCore.)
	Distributor	Gets or sets the name of the instance of SQL Server acting as the Distributor for the publication.
	DistributorDeadlockPriority	Gets or sets the priority of the Snapshot Agent connection to the Distributor when a deadlock occurs.
	DistributorEncryptedPassword	Infraestrutura.
	DistributorEncryptionLevel	Gets of sets the level of Secure Sockets Layer (SSL) encryption used by the Snapshot Agent when connecting to the Distributor.
	DistributorLogin	Gets or sets the login name used when connecting locally to the Distributor using SQL Server Authentication.
	DistributorNetworkLibrary	Infraestrutura.
	DistributorPassword	Sets the password used when connecting locally to the Distributor using SQL Server Authentication.
	DistributorSecurityMode	Gets or sets the security mode used when connecting locally to the Distributor.
	DynamicFilterHostName	Gets or sets the value supplied to the HOST_NAME function used in a parameterized row filter.
	DynamicFilterLogin	Gets or sets the value supplied to the SUSER_SNAME function used in a parameterized row filter.
	DynamicSnapshotLocation	Gets or sets the location of the partitioned snapshot for a subscription to a merge publication that is defined based-on a parameterized row filter.
	FieldDelimiter	Gets or sets the character or character sequence that marks the end of a field in the SQL Server bulk-copy data file.
	FlatExceptionCollection	Infraestrutura. (Herdado de AgentCore.)
	HistoryVerboseLevel	Gets or sets the amount of history logged during agent execution. (Herdado de AgentCore.)
	HRBcpBlocks	Infraestrutura.
	HRBcpBlockSize	Infraestrutura.
	HRBcpDynamicBlocks	Infraestrutura.
	LoginTimeout	Get or sets the number of seconds before the login times out for connections made by the agent. (Herdado de AgentCore.)
	MaxBcpThreads	Gets or sets the number of bulk copy operations that can be performed in parallel.
	MaxNetworkOptimization	Gets or sets whether out-of-partition deletes are sent to the Subscriber.
	OnetimeDynamicSnapshot	Infraestrutura.
	Output	Get or sets the name and path of the agent output file. (Herdado de AgentCore.)
	OutputVerboseLevel	Gets or sets the level of detail of information written to the agent output file. (Herdado de AgentCore.)
	PacketSize	Infraestrutura. (Herdado de AgentCore.)
	ProfileName	Gets or sets an agent profile to use when running the agent. (Herdado de AgentCore.)
	Publication	Gets or sets the name of the publication.
	Publisher	Gets or sets the name of the instance of SQL Server that is the Publisher.
	PublisherDatabase	Gets or sets the name of the publication database.
	PublisherDeadlockPriority	Gets or sets the priority of the Snapshot Agent connection to the Publisher when a deadlock occurs.
	PublisherEncryptedPassword	Infraestrutura.
	PublisherEncryptionLevel	Gets of sets the level of Secure Sockets Layer (SSL) encryption used by the Snapshot Agent when connecting to the Distributor.
	PublisherFailoverPartner	Gets or sets the failover partner instance of SQL Server participating in a database mirroring session with the publication database. (Herdado de AgentCore.)
	PublisherLogin	Gets or sets the login name used when connecting to the Publisher using SQL Server Authentication.
	PublisherNetworkLibrary	Infraestrutura.
	PublisherPassword	Sets the password used when connecting to the Publisher using SQL Server Authentication.
	PublisherSecurityMode	Gets or sets the security mode used when connecting to the Publisher.
	QueryTimeout	Get or sets the number of seconds before a query times out. (Herdado de AgentCore.)
	ReplicationType	Gets or sets the type of publication.
	RowDelimiter	Gets or sets the character or character sequence that marks the end of a row in the SQL Server bulk-copy data file.
	SecureDistributorEncryptedPassword	Infraestrutura.
	SecureDistributorPassword	Sets the password (as a SecureString object) used when connecting locally to the Distributor using SQL Server Authentication.
	SecurePublisherEncryptedPassword	Infraestrutura.
	SecurePublisherPassword	Sets the password (as a SecureString object) used when connecting to the Publisher using SQL Server Authentication.
	StartQueueTimeout	Gets or sets the time that the Snapshot Agent waits when the maximum number of concurrent partitioned snapshot processes for a merge publication are already running.
	Supports70Subscribers	Gets or sets whether the generated snapshot supports SQL Server 7.0 Subscribers.

Início

Métodos

	Nome	Descrição
	Abort	(Herdado de AgentCore.)
	CreateObjRef	(Herdado de MarshalByRefObject.)
	Equals	(Herdado de Object.)
	Finalize	(Herdado de Object.)
	GenerateSnapshot	Starts the Snapshot Agent to generate the snapshot.
	GetHashCode	(Herdado de Object.)
	GetLifetimeService	(Herdado de MarshalByRefObject.)
	GetType	(Herdado de Object.)
	InitializeLifetimeService	(Herdado de MarshalByRefObject.)
	MemberwiseClone() () () ()	(Herdado de Object.)
	MemberwiseClone(Boolean)	(Herdado de MarshalByRefObject.)
	ResetParametersToDefault	(Herdado de AgentCore.)
	ToString	(Herdado de Object.)

Início

Eventos

	Nome	Descrição
	ComStatus	(Herdado de AgentCore.)
	Status	Occurs when a running agent returns status information. (Herdado de AgentCore.)

Início

Implementações de interfaces explícitas

	Nome	Descrição
	ISnapshotGenerationAgent. . :: . .ResetParametersToDefault

Início

Comentários

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.

Exemplos

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

Segurança de thread

Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.

Consulte também

Referência

Namespace Microsoft.SqlServer.Replication

Outros recursos

Como criar o instantâneo inicial (Programação RMO)

Como criar um instantâneo para uma publicação de mesclagem com filtros com parâmetros (Programação RMO)

Replication Snapshot Agent