company logo

DatabaseHandle :: RestoreDB - Restore database

The function closes the database handle, restores the database from a previously made backup and reopens the database handle again. The function can be called for databases opened locally, only. For calling RestoreDB() on the server, one may use ODABAClient::RestoreDB().

The database must be available exclusively.

Return value:  Success ( logical  )

Implementation details

logical DatabaseHandle  :: RestoreDB ( NPath &source, char sysenv=NO )
  • source - Source file path
  • sysenv - System application

    This option indicates that the application is running as system application. In this case context functions are disabled and will not be executed. This option should never be set in normal applications because this may lead to logical inconsistency of the database.

    When running a replication client, this option contains the value 2. Running a replication client in a system application, the option contains the value 3.

    For maintenance purposes, 4 might be passed in the variable. In this case, versions will not be upgraded automatically.

    Default: NO