sp_helpmergepartition (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Returns partition information for the specified merge publication. This stored procedure is executed at the Publisher on any database.

Transact-SQL syntax conventions

Syntax

  
sp_helpmergepartition [ @publication= ] 'publication'   
    [ , [ @suser_sname = ] 'suser_sname' ]  
    [ , [ @host_name = ] 'host_name' ]

Arguments

[ @publication = ] 'publication' Is the name of the publication. publication is sysname, with no default.

[ @suser_sname = ] 'suser_sname' Is the SUSER_SNAME value used to define a partition. suser_sname is sysname, with a default value of NULL. Supply this parameter to limit the result set to only partitions where SUSER_SNAME resolves to the supplied value.

Note

When suser_sname is supplied, host_name must be NULL

[ @host_name = ] 'host_name' Is the HOST_NAME value used to define a partition. host_name is sysname, with a default value of NULL. Supply this parameter to limit the result set to only partitions where HOST_NAME resolves to the supplied value.

Note

When suser_sname is supplied, host_name must be NULL

Result Sets

Column name	Data type	Description
partition	int	Identifies the Subscriber partition.
host_name	sysname	Value used when creating the partition for a subscription that is filtered by the value of the HOST_NAME function at the Subscriber.
suser_sname	sysname	Value used when creating the partition for a subscription that is filtered by the value of the SUSER_SNAME function at the Subscriber.
dynamic_snapshot_location	nvarchar(255)	Location of the filtered data snapshot for the Subscriber's partition.
date_refreshed	datetime	Last date that the snapshot job was run to generate the filtered data snapshot for the partition.
dynamic_snapshot_jobid	uniqueidentifier	Identifies the job that creates the filtered data snapshot for a partition.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_helpmergepartition is used in merge replication.

Permissions

Only members of the sysadmin fixed server role and the db_owner fixed database role can execute sp_helpmergepartition.