sp_helpreplfailovermode
Displays the current failover mode of a subscription for immediate updating with queued updating as a standby in case of a failure. This stored procedure is executed at the Subscriber on any database.
Syntax
sp_helpreplfailovermode [ @publisher = ] 'publisher'
[ , [ @publisher_db = ] 'publisher_db' ]
[ , [ @publication = ] 'publication' ]
[ , [ @failover_mode_id = ] 'failover_mode_id'OUTPUT]
[ , [ @failover_mode = ] 'failover_mode'OUTPUT]
Arguments
[@publisher =] 'publisher'
Is the name of the Publisher that is participating in the update of this Subscriber. publisher is sysname, with no default. The Publisher must already be configured for publishing.
[@publisher_db =] 'publisher_db'
Is the name of the publication database. publisher_db is sysname, with no default.
[@publication =] 'publication'
Is the name of the publication that is participating in the update of this Subscriber. publication is sysname, with no default.
[@failover_mode_id =] 'failover_mode_id' OUTPUT
Returns the integer value of the failover mode and is an OUTPUT parameter. failover_mode_id is a tinyint with a default of 0. It returns 0 for immediate updating and 1 for queued updating.
[@failover_mode =] 'failover_mode' OUTPUT
Returns the mode in which data modifications are made at the Subscriber. failover_mode is a nvarchar(10) with a default of NULL. Is an OUTPUT parameter.
| Value | Description |
|---|---|
| immediate | Immediate updating: updates made at the Subscriber are immediately propagated to the Publisher using two-phase commit protocol (2PC). |
| queued | Queued updating: updates made at the Subscriber are stored in a queue. |
Return Code Values
0 (success) or 1 (failure)
Remarks
sp_helpreplfailovermode is used in snapshot replication or transactional replication for which subscriptions are enabled for immediate updating with queued updating as failover in case of failure.
Permissions
Members of the public role can execute sp_helpreplfailovermode.