Share via


SqlConnectionStringBuilder.FailoverPartner Property

Definition

Gets or sets the name or address of the partner server to connect to if the primary server is down.

public:
 property System::String ^ FailoverPartner { System::String ^ get(); void set(System::String ^ value); };
[System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlDataSourceConverter))]
public string FailoverPartner { get; set; }
public string FailoverPartner { get; set; }
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlDataSourceConverter))>]
member this.FailoverPartner : string with get, set
member this.FailoverPartner : string with get, set
Public Property FailoverPartner As String

Property Value

The value of the FailoverPartner property, or String.Empty if none has been supplied.

Attributes

Exceptions

To set the value to null, use Value.

Remarks

If the value of this key is "", then Initial Catalog must be present, and its value must not be "".

The server name can be 128 characters or less.

If you specify a failover partner but the failover partner server is not configured for database mirroring and the primary server (specified with the Server keyword) is not available, then the connection will fail.

If you specify a failover partner and the primary server is not configured for database mirroring, the connection to the primary server (specified with the Server keyword) will succeed if the primary server is available.

Applies to