SnapshotGenerationAgent クラス

Provides the functionality of the Replication Snapshot Agent.

継承階層

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

名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Replication (Microsoft.SqlServer.Replication.dll)

構文

'宣言
<ComVisibleAttribute(True)> _
<GuidAttribute("80016755-0016-4129-A778-1461AD058C86")> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
Public NotInheritable Class SnapshotGenerationAgent _
    Inherits AgentCore _
    Implements ISnapshotGenerationAgent
'使用
Dim instance As SnapshotGenerationAgent

[ComVisibleAttribute(true)]
[GuidAttribute("80016755-0016-4129-A778-1461AD058C86")]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
public sealed class SnapshotGenerationAgent : AgentCore, 
    ISnapshotGenerationAgent

[ComVisibleAttribute(true)]
[GuidAttribute(L"80016755-0016-4129-A778-1461AD058C86")]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
public ref class SnapshotGenerationAgent sealed : public AgentCore, 
    ISnapshotGenerationAgent

[<SealedAttribute>]
[<ComVisibleAttribute(true)>]
[<GuidAttribute("80016755-0016-4129-A778-1461AD058C86")>]
[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
type SnapshotGenerationAgent =  
    class 
        inherit AgentCore 
        interface ISnapshotGenerationAgent 
    end

public final class SnapshotGenerationAgent extends AgentCore implements ISnapshotGenerationAgent

SnapshotGenerationAgent 型は、以下のメンバーを公開しています。

コンストラクター

	名前	説明
	SnapshotGenerationAgent	Creates an instance of the SnapshotGenerationAgent class.

先頭に戻る

プロパティ

	名前	説明
	AbortPolicy	Gets or sets how running replication agent threads are terminated when an unanticipated shutdown occurs. (AgentCore から継承されています。)
	BcpBatchSize	Gets or set the number of rows to send to the Distributor in a bulk copy operation.
	ComErrorCollection	Gets information on errors that occur during agent execution. (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	インフラストラクチャです。Gets or sets the encrypted password for the distributor.
	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	インフラストラクチャです。Gets or sets the Network library used when connecting locally to the Distributor using SQL Server Authentication.
	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	インフラストラクチャです。Gets the collection of exception objects accessed using the IEnumerable interface. (AgentCore から継承されています。)
	HistoryVerboseLevel	Gets or sets the amount of history logged during agent execution. (AgentCore から継承されています。)
	HRBcpBlocks	インフラストラクチャです。Gets or sets the HR bulk copy program blocks.
	HRBcpBlockSize	インフラストラクチャです。Gets or sets the HR bulk copy program block size.
	HRBcpDynamicBlocks	インフラストラクチャです。Gets or sets the HR bulk copy program dynamic blocks.
	LoginTimeout	Get or sets the number of seconds before the login times out for connections made by the agent. (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	インフラストラクチャです。Gets or sets the one time dynamic snapshot.
	Output	Gets or sets the name and path of the agent output file. (AgentCore から継承されています。)
	OutputVerboseLevel	Gets or sets the level of detail of information written to the agent output file. (AgentCore から継承されています。)
	PacketSize	インフラストラクチャです。Gets or sets the packet size associated with the agent. (AgentCore から継承されています。)
	ProfileName	Gets or sets an agent profile to use when running the agent. (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	インフラストラクチャです。Gets or sets the encrypted password for the publisher.
	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. (AgentCore から継承されています。)
	PublisherLogin	Gets or sets the login name used when connecting to the Publisher using SQL Server Authentication.
	PublisherNetworkLibrary	インフラストラクチャです。Gets or sets the Network library used when connecting locally to the Publisher using SQL Server Authentication.
	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	Gets or sets the number of seconds before a query times out. (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	インフラストラクチャです。Sets the encrypted password used when connecting locally to the Distributor using SQL Server Authentication.
	SecureDistributorPassword	Sets the password (as a SecureString object) used when connecting locally to the Distributor using SQL Server Authentication.
	SecurePublisherEncryptedPassword	インフラストラクチャです。Sets the encrypted password used when connecting to the Publisher using SQL Server Authentication.
	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.

先頭に戻る

メソッド

	名前	説明
	Abort	Aborts the process of the current instance. (AgentCore から継承されています。)
	CreateObjRef	セキュリティクリティカル。 (MarshalByRefObject から継承されています。)
	Equals	(Object から継承されています。)
	GenerateSnapshot	Starts the Snapshot Agent to generate the snapshot.
	GetHashCode	(Object から継承されています。)
	GetLifetimeService	セキュリティクリティカル。 (MarshalByRefObject から継承されています。)
	GetType	(Object から継承されています。)
	InitializeLifetimeService	セキュリティクリティカル。 (MarshalByRefObject から継承されています。)
	ResetParametersToDefault	Resets the value of the parameters to default. (AgentCore から継承されています。)
	ToString	(Object から継承されています。)

先頭に戻る

イベント

	名前	説明
	ComStatus	インフラストラクチャです。Occurs when a running agent returns synchronization Com status information. (AgentCore から継承されています。)
	Status	Occurs when a running agent returns status information. (AgentCore から継承されています。)

先頭に戻る

明示的なインターフェイスの実装

	名前	説明
	ISnapshotGenerationAgent.ResetParametersToDefault	Resets the parameters to its default value.

先頭に戻る

説明

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.

使用例

This example generates a standard snapshot for a transactional publication.

         // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2012";
            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 = "AdventureWorks2012"
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 = "AdventureWorks2012";
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 = "AdventureWorks2012"
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 = "AdventureWorks2012";
            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 = "AdventureWorks2012"
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

スレッドセーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

次の方法で共有

SnapshotGenerationAgent クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

イベント

明示的なインターフェイスの実装

説明

使用例

スレッド セーフ

関連項目

参照

その他の技術情報

その他のリソース

スレッドセーフ