• Article

Restore.ReplaceDatabase Property

Gets or sets a Boolean value that specifies whether a restore operation creates a new image of the restored database.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public Property ReplaceDatabase As Boolean
    Get
    Set
'Usage
Dim instance As Restore
Dim value As Boolean

value = instance.ReplaceDatabase

instance.ReplaceDatabase = value

public bool ReplaceDatabase { get; set; }

public:
property bool ReplaceDatabase {
    bool get ();
    void set (bool value);
}

member ReplaceDatabase : bool with get, set

function get ReplaceDatabase () : boolean
function set ReplaceDatabase (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether a new image of the restored database will be created.
If True, a new image of the database is created. The image is created regardless of the presence of an existing database with the same name.
If False (default), a new image of the database is not created by the restore operation. The database that is targeted by the restore operation must exist on an instance of SQL Server.

Examples

The following code example sets the restore operation to create a new image of the restored database.

VB

Dim rs As Restore
rs = New Restore
rs.ReplaceDatabase = true

PowerShell

$rs = new-object Microsoft.SqlServer.Management.Smo.Restore
$rs.ReplaceDatabast = $TRUE