Database.Backup Method (String, Boolean, Boolean, array<BackupLocation , Boolean, String)

Provides programmatic access to Backup operations for a Database with six parameters.

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

Syntax

'Declaration
Public Sub Backup ( _
    file As String, _
    allowOverwrite As Boolean, _
    backupRemotePartitions As Boolean, _
    locations As BackupLocation(), _
    applyCompression As Boolean, _
    password As String _
)
'Usage
Dim instance As Database 
Dim file As String 
Dim allowOverwrite As Boolean 
Dim backupRemotePartitions As Boolean 
Dim locations As BackupLocation()
Dim applyCompression As Boolean 
Dim password As String

instance.Backup(file, allowOverwrite, _
    backupRemotePartitions, locations, _
    applyCompression, password)

public void Backup(
    string file,
    bool allowOverwrite,
    bool backupRemotePartitions,
    BackupLocation[] locations,
    bool applyCompression,
    string password
)

public:
void Backup(
    String^ file, 
    bool allowOverwrite, 
    bool backupRemotePartitions, 
    array<BackupLocation^>^ locations, 
    bool applyCompression, 
    String^ password
)

member Backup : 
        file:string * 
        allowOverwrite:bool * 
        backupRemotePartitions:bool * 
        locations:BackupLocation[] * 
        applyCompression:bool * 
        password:string -> unit

public function Backup(
    file : String, 
    allowOverwrite : boolean, 
    backupRemotePartitions : boolean, 
    locations : BackupLocation[], 
    applyCompression : boolean, 
    password : String
)

Parameters

• file
  Type: System.String
  Name of the file.

• allowOverwrite
  Type: System.Boolean
  true if overwrite of the target is enabled; otherwise, false.

• backupRemotePartitions
  Type: System.Boolean
  true if remote partitions are subject to backup; otherwise, false.

• locations
  Type: array<Microsoft.AnalysisServices.BackupLocation[]
  If locations is specified, then remote partitions are backed up on their servers using the same file name as defined in this parameter.

• applyCompression
  Type: System.Boolean
  true if compression is to be used; otherwise, false.

• password
  Type: System.String
  The password text to apply to the backup.

Remarks

Security Note
For each backup file, the user who runs the backup command must have permission to write to the backup location specified for each file. Also, the user must have one of the following roles: a member of a server role for the Analysis Services instance or a member of a database role with Full Control (Administrator) permissions on the database to be backed up.

See Also

Reference

Database Class

Backup Overload

Microsoft.AnalysisServices Namespace