Replication Snapshot Agent Utility
The Replication Snapshot Agent utility configures and begins the Snapshot Agent, which prepares snapshot files containing schema and data of published tables and database objects, stores the files in the snapshot folder, and records synchronization jobs in the distribution database.
Note Parameters can be specified in any order.
Prints all available parameters.
Is the name of the Publisher. Specify server_name for the default instance of Microsoft® SQL Server™ 2000 on that server. Specify server_name\instance_name for a named instance of SQL Server 2000 on that server.
Is the name of the Publisher database.
Is the name of the publication. This parameter is only valid if the publication is set to always have a snapshot available for new or reinitialized subscriptions.
Must be used if any Subscribers are running SQL Server version 7.0.
Is the number of rows to send in a bulk copy operation. When performing a bcp in operation, the batch size is the number of rows to send to the server as one transaction, and also the number of rows that must be sent before the Distribution Agent logs a bcp progress message. When performing a bcp out operation, a fixed batch size of 1000 is used. A value of 0 indicates no message logging.
Is the path of the agent definition file. An agent definition file contains command prompt arguments for the agent. The content of the file is parsed as an executable file. Use double quotation marks (") to specify argument values containing arbitrary characters.
Is the Distributor name.
Is the Distributor login name. Specify server_name for the default instance of SQL Server 2000 on that server. Specify server_name\instance_name for a named instance of SQL Server 2000 on that server.
Is the Distributor password.
Specifies the security mode of the Distributor. A value of 0 indicates SQL Server Authentication Mode (default), and a value of 1 indicates Windows Authentication Mode.
Is used to set a value for HOST_NAME() in filtering when a dynamic snapshot is created. For example, if the subset filter clause "rep_id = HOST_NAME()" is specified for an article, and you set the DynamicFilterHostName property to "FBJones" before calling the Merge Agent, only rows having "FBJones" in the rep_id column will be replicated.
Is used to set a value for SUSER_SNAME() in filtering when a dynamic snapshot is created. For example, if the subset filter clause "user_id = SUSER_SNAME()" is specified for an article, and you set the DynamicFilterLogin property to "rsmith" before calling the Run method of the SQLSnapshot object, only rows having "rsmith" in the user_id column will be included in the snapshot.
Is the location where the dynamic snapshot should be generated.
Is the character or character sequence that marks the end of a field in the SQL Server bulk-copy data file. The default is \n<x$3>\n.
Specifies the amount of history logged during a snapshot operation. You can minimize the effect of history logging on performance by selecting 1.
|HistoryVerboseLevel value|| |
|1||Default. Always update a previous history message of the same status (startup, progress, success, and so on). If no previous record with the same status exists, insert a new record.|
|2||Insert new history records unless the record is for such things as idle messages or long-running job messages, in which case update the previous records.|
|3||Always insert new records, unless it is for idle messages.|
Is the number of seconds before the login times out. The default is 15 seconds.
Specifies the number of bulk copy operations that can be performed in parallel. The maximum number of threads and ODBC connections that exist simultaneously is the lesser of MaxBcpThreads or the number of bulk copy requests that appear in the synchronization transaction in the distribution database. MaxBcpThreads must have a value greater than 0 and has no hard-coded upper limit. The default is 1.
Is the path of the agent output file. If the file name is not provided, the output is sent to the console. If the specified file name exists, the output is appended to the file.
Specifies whether the output should be verbose. If the verbose level is 0, only error messages are printed. If the verbose level is 1, all the progress report messages are printed. If the verbose level is 2 (default), all error messages and progress report messages are printed, which is useful for debugging.
Specifies an agent profile to use for agent parameters. If ProfileName is NULL, the agent profile is disabled. If ProfileName is not specified, the default profile for the agent type is used.
Is the Publisher login name.
Is the Publisher password.
Specifies the security mode of the Publisher. A value of 0 indicates SQL Server Authentication (default), and a value of 1 indicates Windows Authentication Mode.
Is the number of seconds before the query times out. The default is 300 seconds.
Specifies the type of replication. A value of 1 indicates transactional replication, and a value of 2 indicates merge replication.
Is the character or character sequence that marks the end of a row in the SQL Server bulk-copy data file. The default is \n<,@g>\n.
Is the maximum number of seconds that the Snapshot Agent waits when the number of concurrent dynamic snapshot processes running is at the limit set by the @max_concurrent_dynamic_snapshots property of sp_addmergepublication. If the maximum number of seconds is reached and the Snapshot Agent is still waiting, it will exit. A value of 0 means that the agent waits indefinitely, although it can be cancelled.