SQL Admin Provider::RestoreDBFromDisk
The RestoreDBFromDisk method allows you to restore a backup from disk.
Arguments
| Input argument | Required | Description |
|---|---|---|
ServerName |
Yes |
A string representing the name of the server. This can be a NetBIOS name, a FQDN, or an IP address. It is vital that the server upon which MPS is running be able to resolve server names using whichever naming convention you employ. |
Name |
Yes |
The name of the database to restore. |
FilePath |
Yes |
The path to the backup file. |
[Position] |
No |
The instance (if necessary) of the backup within the backup file. This is necessary if a particular file contains multiple backups. |
[SqlUserName] |
No |
The user name for connecting to the SQL server via SQL Authentication. If this node is present the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist. |
[SqlUserPass] |
No |
The password for connecting to the SQL server via SQL Authentication using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored. |
Remarks
Rollback Calls
The RestoreDBFromDisk method has no transaction rollback support.
Sample Code
Example XML Request
The following is an example of an XML request for the RestoreDBFromDisk method:
<?xml version="1.0" encoding="iso-8859-1" ?>
<request>
<data>
<serverName>SQL01</serverName>
<name>SampleSQL01</name>
<filePath>D:\Backups\SampleSQL01.bak</filePath>
<position>1</position>
<sqlUserName>sampleUser</sqlUserName>
<sqlUserPass>Pass1Word</sqlUserPass>
</data>
<procedure>
<execute namespace="SQL Admin Provider"
procedure="RestoreDBFromDisk">
<before source="data" destination="executeData" mode="merge"/>
<after source="executeData" destination="data" mode="insert"/>
</execute>
</procedure>
</request>
Example XML Response
The following is an example of the structure of an XML response for the RestoreDBFromDisk method. The actual returned data will be filled in within the <data> nodes:
<?xml version="1.0" encoding="iso-8859-1" ?>
<response>
<data></data>
</response>
Applies To
for:
Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0
Windows-based Hosting version 4.5
Windows-based Hosting version 4.0
Windows-based Hosting version 3.5
Windows-based Hosting for Applications version 1.0