ODABAClient :: BackupDB - Database backup
The function starts the database backup service. This may run locally but also on a server. Running BackupDB() locally, only the database path ( cpath ) and backup target ( target ) are required and should contain the complete path to the file locations. Passing NULL for an empty path as target location causes the function to create a backup file at the same location as the source with the extension .ozi.
When running backup on a server, the server will pause all active clients as long as backup is running (which may take a few minutes). The maximum waiting time can be limited by passing a maximum number of seconds to wait for successful pausing. When pausing is not possible during that time interval, BackUp() terminates with error.
When running BackupDB() on a server, the path names for source ( cpath ) and backup target ( target ) must be valid file locations on the server side or symbolic file names defined in the server's file catalog. Symbolic file names must be enclosed in %% (e.g. % DBPath %).
The function returns YES when the question was answered positively. Otherwise it returns NO .
Implementation details
- cpath - Complete file or directory path
- target - Complete path to target
- wait_sec
- Number of seconds to wait
The system waits the given number of seconds before executing the request.
Default: 300