4D Doc Center : BACKUP

Home

4D v14.3

BACKUP


	BACKUP

	Does not require any parameters

Description

The BACKUP command starts the backup of the database using the current backup settings. No confirmation dialog is displayed; however, a progress bar appears on screen.

Backup settings are set in the Database Settings ("Preferences" in 4D v11 SQL). They are also stored in the Backup.XML file located in the subfolder Preferences/Backup of the database.

The BACKUP command calls the On Backup Startup Database Method at the beginning of its execution and the On Backup Shutdown Database Method at the end of its execution.
Because of this mechanism, the command should not be called from one of these database methods.

4D Server: When called from a client machine, BACKUP is considered as a stored procedure; it is still executed on the server.

System variables and sets

If the backup is performed correctly, the system variable OK is set to 1; otherwise, it is set to 0.

Error management

If an incident occurs during backup, information about the incident is written in the backup log and the top-level error is sent only to the On Backup Shutdown database method. It is therefore particularly important to use this database method in order to be able to manage back-up related errors using programming.