Replication Distribution Agent

  • 项目

适用于：SQL ServerAzure SQL 数据库

复制分发代理是一个可执行文件，它可用于将快照（用于快照复制和事务复制）和分发数据库表中保存的事务（用于事务复制）移动到订阅服务器上的目标表。

注意

可以按任意顺序指定参数。 如果未指定可选参数，将使用本地计算机上预定义的注册表设置中的值。

语法

  
distrib [-?]  
-Publisher server_name[\instance_name]  
-PublisherDB publisher_database  
-Subscriber server_name[\instance_name]  
-SubscriberDB subscriber_database   
[-AltSnapshotFolder alt_snapshot_folder_path]   
[-BcpBatchSize bcp_batch_size]  
[-CommitBatchSize commit_batch_size]  
[-CommitBatchThreshold commit_batch_threshold]  
[-Continuous]  
[-DefinitionFile def_path_and_file_name]  
[-Distributor distributor]  
[-DistributorLogin distributor_login]  
[-DistributorPassword distributor_password]  
[-DistributorSecurityMode [0|1]]  
[-EncryptionLevel [0|1|2]]  
[-ErrorFile error_path_and_file_name]  
[-ExtendedEventConfigFile configuration_path_and_file_name]  
[-FileTransferType [0|1]]  
[-FtpAddress ftp_address]  
[-FtpPassword ftp_password]   
[-FtpPort ftp_port]  
[-FtpUserName ftp_user_name]  
[-HistoryVerboseLevel [0|1|2|3]]  
[-Hostname host_name]  
[-KeepAliveMessageInterval keep_alive_message_interval_seconds]  
[-LoginTimeOut login_time_out_seconds]  
[-MaxBcpThreads]  
[-MaxDeliveredTransactions number_of_transactions]  
[-MessageInterval message_interval]  
[-MultiSubnetFailover [0|1]]
[-OledbStreamThreshold oledb_stream_threshold]  
[-Output output_path_and_file_name]  
[-OutputVerboseLevel [0|1|2]]  
[-PacketSize packet_size]  
[-PollingInterval polling_interval]  
[-ProfileName profile_name]  
[-Publication publication]  
[-QueryTimeOut query_time_out_seconds]  
[-QuotedIdentifier quoted_identifier]  
[-SkipErrors native_error_id [:...n]]  
[-SubscriberDatabasePath subscriber_path]  
[-SubscriberLogin subscriber_login]  
[-SubscriberPassword subscriber_password]  
[-SubscriberSecurityMode [0|1]]  
[-SubscriberType [0|1|3]]  
[-SubscriptionStreams [1|2|...64]]  
[-SubscriptionTableName subscription_table]  
[-SubscriptionType [0|1|2]]  
[-TransactionsPerHistory [0|1|...10000]]  
[-UseDTS]  
[-UseInprocLoader]  
[-UseOledbStreaming]

参数

%>
输出所有可用的参数。

-Publisherserver_name[\instance_name]
发布服务器的名称。 指定该服务器上 Microsoft SQL Server 默认实例的 server_name。 指定该服务器上 SQL Server 命名实例的 server_name\instance_name。 如果发布服务器数据库位于 Always On 可用性组中，由于 sp_redirect_publisher，这仍将反映原始主发布服务器的服务器名称。 它将不会反映 AG 侦听器名称。

-PublisherDBpublisher_database
发布服务器数据库的名称。

-Subscriberserver_name[\instance_name]
订阅服务器的名称。 指定该服务器上 SQL Server 默认实例的 server_name。 指定该服务器上 SQL Server 命名实例的 server_name\instance_name。 如果订阅服务器数据库位于 Always On 可用性组中，这应反映 AG 侦听器名称。

-SubscriberDBsubscriber_database
订阅服务器数据库的名称。

-AltSnapshotFolderalt_snapshot_folder_path
包含订阅的初始快照的文件夹路径。

-BcpBatchSizebcp_batch_size
在一次大容量复制操作中发送的行数。 执行 bcp in 操作时，批的大小为要作为一个事务发送到服务器的行数，并且也是分发代理记录 bcp 进度消息之前必须发送的行数。 当执行 bcp out 操作时，将使用固定批大小 1000 。

-CommitBatchSizecommit_batch_size
发出 COMMIT 语句前要发给订阅服务器的事务数。 默认值为 100，最大值为 10000。 当分发代理在订阅服务器上应用快照时，忽略该参数。

-CommitBatchThresholdcommit_batch_threshold
发出 COMMIT 语句前要发给订阅服务器的复制命令数。 默认值为 1000，最大值为 10000。 当分发代理在订阅服务器上应用快照时，忽略该参数。

-Continuous
指定代理是否尝试连续轮询已复制的事务。 如果指定了该参数，即使没有事务挂起，代理也将在轮询间隔期间轮询来自源的已复制事务。

-DefinitionFiledef_path_and_file_name
代理定义文件的路径。 代理定义文件中包含代理的命令提示符参数。 文件的内容被当作可执行文件进行分析。 使用双引号 (") 指定包含任意字符的参数值。

-Distributordistributor
分发服务器名称。 对于分发服务器（推送）分发，该名称默认为本地分发服务器的名称。 如果分发服务器数据库位于 Always On 可用性组中，这应反映 AG 侦听器名称。

-DistributorLogindistributor_login
分发服务器登录名。

-DistributorPassworddistributor_password
分发服务器密码。

-DistributorSecurityMode [ 0| 1]
指定分发服务器的安全模式。 值为 0 表示 SQL Server 身份验证模式，值为 1 表示 Windows 身份验证模式（默认值）。

-EncryptionLevel [ 0 | 1 | 2 ]
是分发代理在建立连接时使用的传输层安全性 (TLS)（旧称为“安全套接字层 (SSL)”）加密的级别。

EncryptionLevel 值 说明
0 指定不使用 TLS。
1 指定使用 TLS，但代理不验证 TLS/SSL 服务器证书是否由受信任的颁发者进行签名。
2 指定使用 TLS，并验证证书。

注意

有效的 TLS/SSL 证书是使用 SQL Server 的完全限定的域名进行定义。 为了在将 -EncryptionLevel 设置为 2 时成功连接代理，请在本地 SQL Server 上创建别名。 “Alias Name”参数应为服务器名称，”Server”参数应设置为 SQL Server 的完全限定名称。

有关详细信息，请参阅查看和修改复制安全设置。

-ErrorFileerror_path_and_file_name
分发代理生成的错误文件的路径和文件名。 在订阅服务器上应用复制事务时，在故障发生位置生成此文件；在发布服务器或分发服务器上出现的错误不记录在此文件中。 此文件包含失败的复制事务和相关的错误消息。 如果没有指定，则在分发代理的当前目录中生成此错误文件。 错误文件名为分发代理的名称，扩展名为 .err。 如果指定的文件名已存在，会将错误消息追加到该文件中。 此参数最多可包含 256 个 Unicode 字符。

-ExtendedEventConfigFileconfiguration_path_and_file_name
为扩展事件 XML 配置文件指定路径和文件名。 通过该扩展事件 XML 配置文件，您可以配置会话并且启用事件跟踪。

-FileTransferType [ 0| 1]
指定文件传输类型。 值为 0 ，表示 UNC（通用命名约定），值为 1，表示 FTP（文件传输协议）。

-FtpAddressftp_address
分发服务器的 FTP 服务网络地址。 未指定该参数时，使用 DistributorAddress。 如果未指定 DistributorAddress ，将使用 Distributor。

-FtpPasswordftp_password
用于连接到 FTP 服务的用户密码。

-FtpPortftp_port
分发服务器 FTP 服务的端口号。 如果不指定，则使用 FTP 服务的默认端口号 (21)。

-FtpUserNameftp_user_name
用于连接到 FTP 服务的用户名。 如果不指定，则使用 anonymous。

-HistoryVerboseLevel [ 0 | 1 | 2 | 3]
指定分发操作期间记录的历史信息量。 选择 1 可将历史日志记录对性能的影响减小到最低限度。

HistoryVerboseLevel 值 说明
0 进度消息将写入控制台或输出文件。 不在分发数据库中记录历史记录。
1 默认。 总是更新具有相同状态（启动、进行中、成功等）的上一历史记录消息。 如果不存在状态相同的上一记录，将插入新记录。
2 除非记录为空闲消息或长时间运行的作业消息等信息（此时将更新上一记录），否则插入新的历史记录。
3 始终插入新记录，除非它与空闲消息有关。

-Hostnamehost_name
连接到发布服务器时使用的主机名。 此参数最多可包含 128 个 Unicode 字符。

-KeepAliveMessageIntervalkeep_alive_message_interval_seconds
在历史记录线程检查目前是否有连接在等待服务器响应之前等待的秒数。 在执行长时间运行的批处理时，减小该值可避免检查代理将分发代理标记为可疑。 默认值为 300 秒。

-LoginTimeOutlogin_time_out_seconds
登录超时前等待的秒数。默认为 15 秒。

-MaxBcpThreadsnumber_of_threads
指定可以并行执行的大容量复制操作的数量。 同时存在的线程和 ODBC 连接的最大数量为 MaxBcpThreads 或显示在分发数据库中同步事务中的大容量复制请求数中较小的那一个。 MaxBcpThreads 的值必须大于 0 ，并且不存在任何硬编码的上限。 默认值是处理器数目的 2倍，最大值为 8。 应用于使用并发快照选项在发布服务器上生成的快照时，不管为 MaxBcpThreads指定了什么数值，都将使用一个线程。

-MaxDeliveredTransactionsnumber_of_transactions
一次同步期间应用于订阅服务器的推送事务或请求事务的最大数量。 值为 0，表示最大值为无穷多个事务。 订阅服务器可使用其他值缩短从发布服务器请求的同步的持续时间。

注意

如果同时指定了 -MaxDeliveredTransactions 和 -Continuous，分发代理将传送指定数目的事务，然后停止（即使指定了 -Continuous）。 在作业完成后，您必须重新启动分发代理。

-MessageIntervalmessage_interval
用于历史日志记录的时间间隔。 当达到以下参数值之一时，将记录一个历史记录事件：

  • 记录上一历史记录事件后，达到 TransactionsPerHistory 值。

  • 记录上一历史记录事件后，达到 MessageInterval 值。

如果源上没有可用的已复制事务，代理将向分发服务器报告无事务消息。 此选项可指定代理在报告另一条无事务消息前将等待多长时间。 在上次处理已复制事务后，如果代理在源上没有检测到任何可用的事务，则总是会报告一条无事务消息。 默认值为 60 秒。

-MultiSubnetFailover 指定是否启用 MultiSubnetFailover 属性。 如果应用程序要连接到不同子网上的 Always On 可用性组 (AG)，则设置 MultiSubnetFailover=true 会加快检测（当前）活动服务器以及与服务器的连接。
适用对象：SQL Server（从 SQL Server 2019 (15.x) 开始）。

-OledbStreamThresholdoledb_stream_threshold
指定二进制大型对象数据的最小大小（按字节计），如果超过此大小，数据将作为流进行绑定。 必须将 -UseOledbStreaming 指定为使用此参数。 值可以介于 400 个字节到 1048576 个字节之间，默认值为 16384 个字节。

-Outputoutput_path_and_file_name
代理输出文件的路径。 如果未提供文件名，则向控制台发送该输出。 如果指定的文件名已存在，会将输出追加到该文件。

-OutputVerboseLevel [ 0| 1| 2]
指定输出是否应提供详细内容。 如果详细级别为 0，则只输出错误消息。 如果详细级别为 1，则输出所有进度报告消息。 如果详细级别为 2（默认），则输出所有错误消息和进度消息，这对调试很有帮助。

-PacketSizepacket_size
数据包大小（按字节计）。 默认值为 4096（字节）。

-PollingInterval polling_interval_
对分发数据库进行已复制事务查询的频率（以秒计）。 默认值为 5 秒。

-ProfileNameprofile_name
指定用于代理参数的代理配置文件。 如果 ProfileName 为 NULL，则将禁用代理配置文件。 如果未指定 ProfileName ，则使用该代理类型的默认配置文件。 有关信息，请参阅复制代理配置文件。

-Publicationpublication
发布的名称。 只有将发布设置为总是使快照可用于新订阅或重新初始化的订阅时，此参数才有效。

-QueryTimeOutquery_time_out_seconds
查询超时之前等待的秒数。默认为 1800 秒。

-QuotedIdentifierquoted_identifier
指定要使用的带引号的标识符字符。 该值的第一个字符表示分发代理使用的值。 如果使用不带有任何值的 QuotedIdentifier ，则分发代理使用一个空格。 如果未使用 QuotedIdentifier ，则分发代理使用订阅服务器支持的任意带引号的标识符。

-SkipErrorsnative_error_id [:...n]
以冒号分隔的列表，指定此代理要跳过的错误号。 当分发代理在订阅服务器上应用快照时，忽略该参数。

-SubscriberDatabasePathsubscriber_database_path
如果 SubscriberType 为 2 （允许建立到 Jet 数据库的连接，而无需 ODBC 数据源名称 (DSN)），则为 Jet 数据库（.mdb 文件）的路径。

-SubscriberLoginsubscriber_login
订阅服务器登录名。 如果 SubscriberSecurityMode 为 0（对于 SQL Server 身份验证），则必须指定此参数。

-SubscriberPasswordsubscriber_password
订阅服务器密码。 如果 SubscriberSecurityMode 为 0（对于 SQL Server 身份验证），则必须指定此参数。

-SubscriberSecurityMode [ 0| 1]
指定订阅服务器的安全模式。 值为 0 表示 SQL Server 身份验证，值为 1 表示 Windows 身份验证模式（默认值）。

-SubscriberType [ 0| 1| 3]
指定分发代理使用的订阅服务器连接类型。

SubscriberType 值 说明
0 SQL Server
1 ODBC 数据源
3 OLE DB 数据源

-SubscriptionStreams [0|1|2|...64]
每个分发代理允许的连接数，用于将成批更改并行应用于订阅服务器，同时保留在使用单线程时具有的多种事务特征。 对于 SQL Server 发布服务器，支持介于 1 到 64 之间的值。 只有当发布服务器和分发服务器均在 SQL Server 2005 (9.x) 或更高版本上运行时，才支持此参数。 对于非 SQL Server 订阅服务器或对等订阅，不支持此参数或者参数必须为 0。 当分发代理在订阅服务器上应用快照时，忽略该参数。

注意

如果有一个连接无法执行或提交，则所有连接将中止当前批处理，而且代理将用单独的流重试失败的批处理。 在重试阶段完成之前，订阅服务器上会存在临时事务不一致。 失败的批处理成功提交后，订阅服务器将恢复到事务一致状态。

重要

将 -SubscriptionStreams的值指定为 2 或更大的数字时，订阅服务器接收事务的顺序可能与发布服务器提交事务的顺序不同。 如果此行为在同步期间导致约束冲突，则应使用 NOT FOR REPLICATION 选项禁止在同步期间强制执行约束。 有关详细信息，请参阅控制同步期间触发器和约束的行为（复制 Transact-SQL 编程）。

注意

订阅流不适用于配置为传递 Transact-SQL 的项目。 若要使用订阅流，请改将项目配置为传递存储过程调用。

-SubscriptionTableNamesubscription_table
在给定订阅服务器上生成或使用的订阅表的名称。 如果未指定，将使用 MSreplication_subscriptions (Transact-SQL) 表。 可将此选项用于不支持长文件名的数据库管理系统 (DBMS)。

-SubscriptionType [ 0| 1| 2]
指定分发的订阅类型。 值为 0 ，表示推送订阅，值为 1 ，表示请求订阅，值为 2，表示匿名订阅。

-TransactionsPerHistory [ 0| 1|... 10000]
指定历史日志记录的事务间隔。 如果自历史日志记录上一实例之后的已提交事务数大于此选项，将记录历史记录消息。 默认值为 100。 值 0 表示无限 TransactionsPerHistory。 See the preceding –MessageIntervalparameter.

-UseDTS
必须指定为允许数据转换的发布的参数。

-UseInprocLoader
通过让分发代理在将快照文件应用于订阅服务器时使用 BULK INSERT 命令，提高初始快照的性能。 不推荐使用此参数，因为它与 XML 数据类型不兼容。 如果不复制 XML 数据，则可以使用此参数。 此参数不可用于字符模式快照或非 SQL Server 订阅服务器。 如果使用此参数，订阅服务器上的 SQL Server 服务帐户必须具有快照 .bcp 数据文件所在目录的读取权限。 如果不使用此参数，则代理（对于非 SQL Server 订阅服务器）或代理加载的 ODBC 驱动程序（对于 SQL Server 订阅服务器）将从文件中读取数据，从而不使用 SQL Server 服务帐户的安全性上下文。

-UseOledbStreaming
指定此参数时，可以将二进制大型对象数据作为流进行绑定。 使用 -OledbStreamThreshold 指定大小（按字节计），超过此大小时将使用流。 UseOledbStreaming 默认为启用状态。

注意

从 SQL 2017 CU22 及更高版本（包括 SQL 2019 RTM）开始，UseOledbStreaming 写入 c:\Users\<DistributionAgentAccount>\AppData\Temp 文件夹。

在 SQL 2017 CU22 之前，UseOledbStreaming 写入到 C:\Program Files\Microsoft SQL Server\<版本>\COM 文件夹。

注解

重要

如果安装的 SQL Server 代理是通过本地系统帐户而非域用户帐户（默认值）运行，则该服务只能访问本地计算机。 如果将以 SQL Server 代理身份运行的分发代理配置为在登录到 SQL Server 实例时使用 Windows 身份验证模式，则分发代理将失败。 默认设置为 SQL Server 身份验证。 View and Modify Replication Security Settings有关更改安全帐户的详细信息，请参阅。

若要启动分发代理，请从命令提示符下执行 distrib.exe 。 有关信息，请参阅复制代理可执行文件概念。

更改历史记录

更新的内容
添加了 -ExtendedEventConfigFile 参数。
添加了 -MultiSubnetFailover 参数。

另请参阅

复制代理管理