company logo

ODABAClient :: RestoreDB - Restore database

The function restores the database from a previously made backup. The function can be called on the local machine or on a server client. When calling the function locally, the database must be available exclusively. When calling RestoreDB from a server client, the request is passed to the server. Before restoring the database, the server waits the number of seconds passed to the function until remaining active clients are killed.

When running RestoreDB on a server, the path names for source (cpath) and backup target (source) must be valid file locations on the server side or symbolic file names defined in the server's file catalog (When running BackupDB on a server, the path names for source (FILE-CATALOG section in the server settings). Symbolic file names must be enclosed in %...% (e.g. %DBPath%).

Return value:  Return value ( logical  )

The function returns YES when the question was answered positively. Otherwise it returns NO.

Implementation details

logical ODABAClient  :: RestoreDB ( NPath &cpath, NPath &source, int32 wait_sec=300 )
  • cpath - Complete file or directory path
  • source - Source file path
  • wait_sec - Number of seconds to wait

    The system waits the given number of seconds before executing the request.

    Default: 300