SET MIRROR OPTION statement

SET MIRROR OPTION option-name={ option-value | NULL }

option-name :
authentication_string
auto_add_fan_out
auto_add_server
auto_failover
child_creation
page_timeout
max_disconnected_time
max_retry_connect_time
synchronization_mode

option-name	Applies to	Values	Default	Description
authentication_string	database mirroring	string	null	Specifies the authentication string used by all the servers in the database mirroring system. The authentication string is required for database mirroring.
auto_add_fan_out	read-only scale-out	integer	10	Specifies the maximum number of children for each branch. The minimum value that can be specified is 2.
auto_add_server	read-only scale-out	string	null	Specifies the name of the database server that acts as the parent of the automatic assignment tree.
auto_failover	database mirroring	on, off	null	Specifies whether the mirror server automatically takes over as the primary server when the current primary server goes down. This option does not apply to synchronous mode. This option accepts Boolean values (automatic failover is turned on with YES, ON, TRUE, or 1, and is turned off with any of NO, OFF, FALSE, and 0). The parameters are case insensitive. If you are using asynchronous or asyncfullpage mode, it is recommended that you set the auto_failover option to on. Then, if the primary server goes down, the mirror server automatically takes over as the primary server.
child_creation	read-only scale-out	automatic, off, manual	automatic	Controls whether copy nodes are created automatically.
page_timeout	database mirroring	integer, in seconds	5	Specifies how often, in seconds, transaction log pages are sent to the mirror server, whether or not they are full. This option applies only when using asyncfullpage mode.
max_disconnected_time	read-only scale-out	integer, in seconds	no time limit	Specifies the length of time that the copy server attempts to connect to the root database server after a parent connection is lost. If the copy server fails to connect within the specified time, the database is shut down.
max_retry_connect_time	read-only scale-out	integer, in seconds	120	Specifies the length of time that a copy node attempts to reconnect to its parent once the parent becomes unavailable.
synchronization_mode	database mirroring	synchronous, asynchronous, asyncfullpage	synchronous	Specifies the synchronization mode used for database mirroring: synchronous (sync), asynchronous (async), or asyncfullpage (page). The synchronization mode controls when and how transactions are recorded on the mirror server.

Cloud note: This statement is not supported on tenant databases in the cloud.

Once you create a database server for a database mirroring system or a read-only scale-out system using the CREATE MIRROR SERVER statement, you can use the SET MIRROR OPTION statement to configure the settings for the system.

Must have DBA authority.

Automatic commit.

SQL/2008 Vendor extension.

The following statement sets the authentication string for a database mirroring system to abc:

SET MIRROR OPTION authentication_string = 'abc';

SET MIRROR OPTION statement

Note

Syntax

Parameters

Remarks

Permissions

Side effects

See also

Standards and compatibility

Example