sp_helpsubscription (Transact-SQL)

适用于SQL Server Azure SQL 托管实例

列出与特定的发布、项目、订阅服务器或订阅集关联的订阅信息。 此存储过程在发布服务器上对发布数据库执行。

Transact-SQL 语法约定

语法

sp_helpsubscription
    [ [ @publication = ] N'publication' ]
    [ , [ @article = ] N'article' ]
    [ , [ @subscriber = ] N'subscriber' ]
    [ , [ @destination_db = ] N'destination_db' ]
    [ , [ @found = ] found OUTPUT ]
    [ , [ @publisher = ] N'publisher' ]
[ ; ]

参数

[ @publication = ] N'publication'

关联的发布的名称。 @publication为 sysname,默认值%为 ,返回此服务器的所有订阅信息。

[ @article = ] N'article'

项目的名称。 @article是 sysname,默认值%为 ,它将返回所选发布和订阅服务器的所有订阅信息。 如果 all为发布上的完整订阅只返回一个条目。

[ @subscriber = ] N'subscriber'

要在其上获取订阅信息的订阅服务器的名称。 @subscribersysname,默认值 %为 ,返回所选发布和项目的所有订阅信息。

[ @destination_db = ] N'destination_db'

目标数据库的名称。 @destination_db为 sysname,默认值为 %.

[ @found = ] 找到 OUTPUT

指示返回行的标志。 @found是 int 类型的 OUTPUT 参数。

  • 1 指示找到发布。
  • 0 指示找不到发布。

[ @publisher = ] N'publisher'

发布服务器的名称。 @publishersysname,默认为当前服务器的名称。

除非是 Oracle 发布服务器,否则不应指定@publisher。

结果集

列名称 数据类型 描述
subscriber sysname 订阅服务器的名称。
publication sysname 发布的名称。
article sysname 项目的名称。
destination database sysname 用于存放复制数据的目标数据库的名称。
subscription status tinyint 订阅状态:

0 = 非活动
1 = 已订阅
2 = 活动
synchronization type tinyint 订阅同步类型:

1 = 自动
2 = 无
subscription type int 订阅的类型:

0 = 推送
1 = 拉取
2 = 匿名
full subscription bit 指示是否订阅发布中的所有项目:

0 = 否
1 = 是
subscription name nvarchar(255) 订阅的名称。
update mode int 0 = 只读
1 = 立即更新订阅
distribution job id binary(16) 分发代理的作业 ID。
loopback_detection bit 环回检测将确定分发代理是否将在订阅服务器上发起的事务发送回订阅服务器:

0 = 发送回。
1 = 不发送回。

与双向事务复制一起使用。 有关详细信息,请参阅 Bidirectional Transactional Replication
offload_enabled bit 指定是否将复制代理的卸载执行设置为在订阅服务器上运行。

如果 0,代理在发布服务器上运行。
如果 1,代理在订阅服务器上运行。
offload_server sysname 启用了远程代理激活的服务器的名称。 如果 NULL,则使用MSdistribution_agents表中列出的 当前offload_server
dts_package_name sysname 指定 Data Transformation Services (DTS) 包的名称。
dts_package_location int 为订阅分配了一个 DTS 包时,此包的位置。 如果有包,则 0 指定包位置的值 distributor1一个指定subscriber值 。
subscriber_security_mode smallint 订阅服务器上的安全模式,这意味着 1 Windows 身份验证,以及 0 SQL Server 身份验证。
subscriber_login sysname 订阅服务器上的登录名。
subscriber_password 永远不会返回实际的订阅服务器密码。 结果由 ****** 字符串屏蔽。
job_login sysname 分发代理运行时所用的 Windows 帐户的名称。
job_password 从不返回实际的作业密码。 结果由 ****** 字符串屏蔽。
distrib_agent_name nvarchar(100) 同步订阅的代理作业的名称。
subscriber_type tinyint 订阅服务器类型,可以是以下值之一:

0 = SQL Server 订阅服务器
1 = ODBC 数据源服务器
2 = Microsoft JET 数据库(已弃用)
3 = OLE DB 访问接口
subscriber_provider sysname 非 SQL Server 数据源的 OLE DB 访问接口用于注册的唯一编程标识符 (PROGID)。
subscriber_datasource nvarchar(4000) OLE DB 访问接口识别的数据源的名称。
subscriber_providerstring nvarchar(4000) OLE DB 访问接口特定的连接字符串,用于标识数据源。
subscriber_location nvarchar(4000) OLE DB 访问接口所了解的数据库的位置
subscriber_catalog sysname 在与 OLE DB 访问接口建立连接时要使用的目录。

返回代码值

0(成功)或 1(失败)。

注解

sp_helpsubscription 用于快照复制和事务复制。

权限

执行权限默认为 公共 角色。 只为用户返回他们创建的订阅的信息。 有关所有订阅的信息将返回到发布服务器上的 sysadmin 固定服务器角色的成员或发布数据库中db_owner固定数据库角色的成员