Restore Object (SQL-DMO)

The Restore object defines the behavior of a RESTORE statement for a Microsoft® SQL Server™ database or log.

Remarks

With the Restore object you can:

SQL Server can write a backup to one of four media types: disk, tape, named pipe, or a proprietary media called a backup device. SQL Server supports backup striping. A striped backup is one directed to more than a single device. Striping is supported to a single media type only. That is, a backup can be written to two tape devices. A backup cannot be written half to a tape device and the other half to a disk.

At a minimum, you must supply values for a restore source when using the Restore object. SQL-DMO implements supported media types in the Restore object properties Files, Devices, Pipes, and Tapes. Use one media type property to specify the restore operation source.

Setting other properties in the Restore object may be required by the restore operation desired. For example, before using the SQLRestore method, the Database property of the Restore object must be set.

To perform a complete database restore

  1. Create a Restore object.
  2. Set a media property, naming the source device(s)
  3. Set the Database property to indicate the target database.
  4. If necessary, set the ReplaceDatabase property to force database creation.
  5. Call the SQLRestore method.

To restore a single unit of a database log

  1. Create a Restore object.
  2. Set the Action property to SQLDMORestore_Log.
  3. Set a media property, naming the source device(s).
  4. Set the Database property to indicate the target database.
  5. Call the SQLRestore method.

To restore a database log chain

  1. Create a Restore object.
  2. Set the Action property to SQLDMORestore_Log.
  3. Set the Database property to indicate the target database.
  4. Set the LastRestore property to False.
  5. Set a media property, naming the source device(s).
  6. Call the SQLRestore method.
  7. Repeat steps 5 and 6 for all but the last unit in the database log chain.
  8. Set the LastRestore property to True.
  9. Call the SQLRestore method to restore the last unit.

To verify the integrity of backup media

  1. Create a Restore object.
  2. Set a media property, naming the source device(s)
  3. Call the SQLVerify method.
Methods
Abort Method ReadMediaHeader Method (Restore)
GenerateSQL Method (Backup, Restore) SQLRestore Method
ReadBackupHeader Method (Restore) SQLVerify Method
ReadFileList Method  

Events
Complete Event PercentComplete Event
NextMedia Event  

Properties
Action Property (Restore) MediaName Property
BackupSetName Property PercentCompleteNotification Property
Database Property Pipes Property
DatabaseFileGroups Property RelocateFiles Property
DatabaseFiles Property ReplaceDatabase Property
Devices Property Restart Property
FileNumber Property StandbyFiles Property
Files Property Tapes Property
LastRestore Property ToPointInTime Property
LoadHistory Property UnloadTapeAfter Property

  


(c) 1988-98 Microsoft Corporation. All Rights Reserved.