Share via


Server.Restore Method (String, String, Boolean, array<RestoreLocation , RestoreSecurity, String)

Restores an Analysis Services database from a backup file to the specified database, given a password, an overwrite flag, multiple remote servers, and specifying security settings.

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
Public Sub Restore ( _
    file As String, _
    databaseName As String, _
    allowOverwrite As Boolean, _
    locations As RestoreLocation(), _
    security As RestoreSecurity, _
    password As String _
)
'Usage
Dim instance As Server 
Dim file As String 
Dim databaseName As String 
Dim allowOverwrite As Boolean 
Dim locations As RestoreLocation()
Dim security As RestoreSecurity 
Dim password As String

instance.Restore(file, databaseName, allowOverwrite, _
    locations, security, password)
public void Restore(
    string file,
    string databaseName,
    bool allowOverwrite,
    RestoreLocation[] locations,
    RestoreSecurity security,
    string password
)
public:
void Restore(
    String^ file, 
    String^ databaseName, 
    bool allowOverwrite, 
    array<RestoreLocation^>^ locations, 
    RestoreSecurity security, 
    String^ password
)
member Restore : 
        file:string * 
        databaseName:string * 
        allowOverwrite:bool * 
        locations:RestoreLocation[] * 
        security:RestoreSecurity * 
        password:string -> unit
public function Restore(
    file : String, 
    databaseName : String, 
    allowOverwrite : boolean, 
    locations : RestoreLocation[], 
    security : RestoreSecurity, 
    password : String
)

Parameters

  • file
    Type: System.String
    The name and location of the file to restore.
  • allowOverwrite
    Type: System.Boolean
    true to indicate that the database will be overwritten, if it exists; otherwise, false.
  • password
    Type: System.String
    The password to use to decrypt the restoration file.

Remarks

Security noteSecurity Note

For each backup file, the user who runs the backup command must have permission to read from the backup location specified for each file. To restore an Analysis Services database that is not installed on the server, the user must also be a member of the server role for that Analysis Services instance. To overwrite an Analysis Services database, the user must have one of the following roles: a member of the server role for the Analysis Services instance or a member of a database role with Full Control (Administrator) permissions on the database to be restored.

Note

After restoring an existing database, the user who restored the database might lose access to the restored database. This loss of access can occur if, at the time that the backup was performed, the user was not a member of the server role or was not a member of the database role with Full Control (Administrator) permissions.

See Also

Reference

Server Class

Restore Overload

Microsoft.AnalysisServices Namespace