sp_setreplfailovermode (Transact-SQL)

Allows you to set the failover operation mode for subscriptions enabled for immediate updating with queued updating as failover. This stored procedure is executed at the Subscriber on the subscription database. For more information about failover modes, see Updatable Subscriptions for Transactional Replication.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_setreplfailovermode [ @publisher= ] 'publisher'
    [ , [ @publisher_db = ] 'publisher_db' ]
    [ , [ @publication= ] 'publication' ]
    [ , [ @failover_mode= ] 'failover_mode' ]
    [ , [ @override = ] override ]

Arguments

  • [ **@publisher=**\] 'publisher'
    Is the name of the publication. publication is sysname, with no default. The publication must already exist.

  • [ @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. publicationis sysname, with no default.

  • [**@failover\_mode=**\] 'failover_mode'
    Is the failover mode for the subscription. failover_mode is nvarchar(10) and can be one of these values.

    Value

    Description

    immediate or sync

    Data modifications made at the Subscriber are bulk-copied to the Publisher as they occur.

    queued

    Data modifications are stored in a Microsoft SQL Server queue.

    Note

    Microsoft Message Queuing has been deprecated and is no longer supported.

  • [ **@override**= ] override
    Internal use only.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_setreplfailovermode is used in snapshot replication or transactional replication for which subscriptions are enabled, either for queued updating with failover to immediate updating, or for immediate updating with failover to queued updating.

Permissions

Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_setreplfailovermode.