Compartir a través de


Clase SnapshotGenerationAgent

Provides the functionality of the Replication Snapshot Agent.

Jerarquía de herencia

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

Espacio de nombres:  Microsoft.SqlServer.Replication
Ensamblado:  Microsoft.SqlServer.Replication (en Microsoft.SqlServer.Replication.dll)

Sintaxis

'Declaración
<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

El tipo SnapshotGenerationAgent expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público SnapshotGenerationAgent Creates an instance of the SnapshotGenerationAgent class.

Arriba

Propiedades

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

Arriba

Métodos

  Nombre Descripción
Método público Abort (Se hereda de AgentCore.)
Método público CreateObjRef (Se hereda de MarshalByRefObject.)
Método público Equals (Se hereda de Object.)
Método protegido Finalize (Se hereda de Object.)
Método público GenerateSnapshot Starts the Snapshot Agent to generate the snapshot.
Método público GetHashCode (Se hereda de Object.)
Método público GetLifetimeService (Se hereda de MarshalByRefObject.)
Método público GetType (Se hereda de Object.)
Método público InitializeLifetimeService (Se hereda de MarshalByRefObject.)
Método protegido MemberwiseClone() () () () (Se hereda de Object.)
Método protegido MemberwiseClone(Boolean) (Se hereda de MarshalByRefObject.)
Método público ResetParametersToDefault (Se hereda de AgentCore.)
Método público ToString (Se hereda de Object.)

Arriba

Eventos

  Nombre Descripción
Evento público ComStatus (Se hereda de AgentCore.)
Evento público Status Occurs when a running agent returns status information. (Se hereda de AgentCore.)

Arriba

Implementaciones de interfaces explícitas

  Nombre Descripción
Implementación de interfaces explícitasMétodo privado ISnapshotGenerationAgent. . :: . .ResetParametersToDefault

Arriba

Comentarios

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.

Ejemplos

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

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.