- Overview
- How to?
- Make an immediate backup
- Creating a scheduled backup
- Operations on the backups
- Remarks
- Characteristics of the backup
- Management of a procedure before and/or after
- Managing a webhook
HFSQL Control Center: HFSQL Client/Server backups
Available only with this kind of connection
The HFSQL Control Center is used to manage the backups of HFSQL Client/Server data files. The backups can be: - complete In this case, all selected items (complete server, databases or files) are saved in their entirety. This backup is more secured because it is sufficient to restore the elements. It is longer to perform because everything is saved.
- differential in this case, only the differences from a full backup are saved. This backup is faster to perform and less bulky. It must be stored with the full backup that corresponds to it.
Make an immediate backup  Attention An immediate backup is necessarily complete. To perform an immediate backup: - If necessary, connect to an HFSQL server and display the description of the server or one of its databases (double-click on the server or database name in the tree structure).
- Click the "Backups" tab.
- In the ribbon, in the "Backups" group, expand "New backup" and select "New hot backup". The wizard for creating a backup starts.
- Specify the content of the backup:
- The entire content of the server.
- A specific database.
- A selection of databases and/or data files.
Proceed to the next step of the wizard. - Specify backup options:
- whether the result of the backup must be compressed in a zip file.
- whether the backup is to contain index files (NDX index files, FTX full-text index files, etc.). If the index files are not saved, the size of the backup will be reduced but the restore time will be longer.
Note If index files are not saved, it will be necessary to provide the file passwords at the time of restoration, to enable them to be re-indexed.
- Proceed to the next step of the wizard.
- Specify the backup location by specifying the backup directory.
If this name corresponds to a relative path, the backup will be performed in the "Backup" subdirectory of the HFSQL server. The wizard is used to define a "backup" subdirectory ("Backups" by default). You can add the date and time (in the form "Year\Month\Day\Hour-Minute") to the directory name to easily identify the backup. Note Backups are made in a numbered subdirectory (e.g. "backup\Backups\1"). Therefore, if several backups are performed, the corresponding files will not be overwritten by a new backup. - Proceed to the next step of the wizard.
- Specify the actions associated with the backup:
- Procedure stored before or after backup: In this case, the next step in the wizard allows you to specify:
- the name of the database containing the stored procedure to run,
- the name of the set of procedures containing the stored procedure to run,
- the name of the procedure to run.
- Webhook executed after backup: In this case, the next step in the wizard allows you to specify the URL of the webhook (REST service) to which the backup result should be sent..
- Give a description to your backup and validate.
- The backup is automatically started. The progress of the backup can be monitored in the HFSQL Control Center.
Creating a scheduled backup To perform a scheduled backup:
# If necessary, connect to an HFSQL server and display the description of the server or one of its databases (double-click on the server or database name in the tree structure). - Click the "Backups" tab.
- In the ribbon, in the "Backups" group, expand "New backup" and select "New scheduled backup". The wizard for creating a backup starts.
- Specify the content of the backup:
- The entire content of the server.
- A specific database.
- A selection of databases and/or data files.
- Specify backup options:
- whether the result of the backup must be compressed in zip format.
- whether the backup is to contain index files (NDX index files, FTX full-text index files, etc.). If the index files are not saved, the size of the backup will be reduced but the restore time will be longer.
Note If index files are not saved, it will be necessary to provide the file passwords at the time of restoration, to enable them to be re-indexed.
- Proceed to the next step of the wizard.
- Choose a scheduling scenario among the preset scenarios.
- Complete monthly backups with the option of weekly or daily differential Backups.
- Full weekly backup with daily differential backup option.
- Full daily backup.
You can also choose a custom scheduling. In this case, the next steps of the wizard will guide you through the definition of the schedule. - Proceed to the next step of the wizard.
- Specify the backup location by specifying the backup directory.
If this name corresponds to a relative path, the backup will be performed in the "Backup" subdirectory of the HFSQL server. The wizard is used to define a "backup" subdirectory ("Backups" by default). You can add the date and time (in the form "Year\Month\Day\Hour-Minute") to the directory name to easily identify the backup. Note Backups are made in a numbered subdirectory (e.g. "backup\Backups\1"). Therefore, if several backups are performed, the corresponding files will not be overwritten by a new backup.. - Specify the actions associated with the backup:
- Procedure stored before or after backup: In this case, the next step in the wizard allows you to specify:
- the name of the database containing the stored procedure to run,
- the name of the set of procedures containing the stored procedure to run,
- the name of the procedure to run.
New in version 2025Upload the backup to an FTP server: In this case, the next step in the wizard allows you to define the connection options to the FTP server and the location where the backup will be copied. - Webhook executed after backup: In this case, the next step in the wizard allows you to specify the URL of the webhook (REST service) to which the backup result should be sent..
- Specify whether you want to limit the number of backups stored on the server.
- Give a description to your backup and validate.
- The backup definition appears in the "Scheduled items" tab.
The backup will be automatically started according to the specified scheduling. The progress of the backup can be monitored in the HFSQL Control Center. Note It is possible to modify the characteristics of the backup ("Edit" option in the context menu or double-click). In particular, you can modify the scheduling options (month, day and time of execution). Operations on the backups The HFSQL Control Center lets you manipulate backups via 2 tabs: the "Scheduled items" tab and the "Backups" tab. The "Scheduled items" tab lets you manipulate backup definitions. For the selected backup, you can: - Edit backup description.
- Run the backup directly.
The "Backups" tab lists all executed backups. It is possible to: - Restore a backup in a zip file or in a specific directory.
- Delete a backup. To delete a backup, you must be a "Superuser".
- Restart a backup.
- Recovering a backup on the client workstation.
These actions can be performed via the save context menu or via the ribbon. To edit a backup description: - If necessary, connect to an HFSQL server and display the appropriate server or database tab.
- Click the "Scheduled elements" tab.
- Select the scheduled backup you wish to modify.
- In the ribbon, in the "Scheduled elements" group, click "Edit".
You also have the ability to use the context menu of the scheduled element ("Edit" option). - The planned item description window appears. All features are grouped together on several tabs:
- Tab "General": Defines if the backup is active.
- Tab "Scheduling": Defines the execution options for the scheduled backup (month, day, hour, number of executions, execution at startup).
- Tab "Backups": Defines the backup options (backup content, location, etc.)
New in version 2025Tab "Execution History": This tab appears when the backup has been executed automatically. This tab lists the various automatic executions of the scheduled backup, indicating: - the backup start date,
- backup status: completed, in progress, error,
- running time,
- the user who launched the backup,
- if launched manually (via HExecuteScheduling).
- Validate.
Characteristics of the backup The backup performed will correspond to the status of the database at the beginning of backup. During the backup, you are not allowed to: - delete the data files and the databases,
- update the stored procedures.
Management of a procedure before and/or after It is possible to call a stored procedure before or after the backup. These procedures can take parameters. Management of a procedure before: The stored procedure called BEFORE the backup can take parameters. This procedure has the following format: PROCEDURE <Procedure name>(<Data to back up>, ... <Backup destination>, <Description>) These parameters are optional. They will allow you to handle the following indications in the code of the stored procedure: - <Data to be saved>: String corresponding to the information to be saved. Corresponds to the Source property. The possible values are as follows:
| | * | Makes a backup copy of all the databases of the server, the logs, the system databases (users, groups, rights). | Database name/* | Backup the entire database: files, bindings, stored procedures, triggers. | Database name/Name of File1 | Makes a back up copy of <Name of File1> found in <Database name> | Name of database 1/Name of File1 + TAB + Name of database 2/ Name of File2 + ... | List of elements to back up. The separator can be the tabulation (TAB) or the semicolon (";"). | System | Makes a backup copy of the system databases (users, groups, rights). |
- <Backup Destination>: Name and destination of the backup. Corresponds to the Destination property. The backup will be preformed on the server, in a location defined by this name. If this name corresponds to a relative path, the backup will be placed in the "Backup" subdirectory of the HFSQL server. To specify:
- the directory of the Manta service, use the "%%EXE%%" character string.
- the year, use the "%%YEAR%%" character string (2008 for example).
- the month on 2 digits, use the "%%MONTH%%" character string (03 for example).
- the day, use the "%%DAY%%" character string.
- the hour, use the "%%HOUR%%" character string.
- the minutes, use the "%%MINUTE%%" character string.
- <Description>: Backup description. Corresponds to the Description property.
Management of a procedure after: The stored procedure called AFTER the backup can take parameters. This procedure has the following format: PROCEDURE <Procedure name>(<Data to back up>, <Backup destination>, ... <Description>, <Status>, <Error message>) These parameters are optional. They will allow you to handle the following indications in the code of the stored procedure: - <Data to be saved>: String corresponding to the information to be saved. Corresponds to the Source property. The possible values are as follows:
| | * | Makes a backup copy of all the databases of the server, the logs, the system databases (users, groups, rights). | Database name/* | Backup the entire database: files, bindings, stored procedures, triggers. | Database name/Name of File1 | Makes a back up copy of <Name of File1> found in <Database name> | Name of database 1/Name of File1 + TAB + Name of database 2/ Name of File2 + ... | List of elements to back up. The separator can be the tabulation (TAB) or the semicolon (";"). | System | Makes a backup copy of the system databases (users, groups, rights). |
- <Backup Destination>: Name and destination of the backup. Corresponds to the Destination property. The backup will be preformed on the server, in a location defined by this name. If this name corresponds to a relative path, the backup will be placed in the "Backup" subdirectory of the HFSQL server. To specify:
- the directory of the Manta service, use the "%%EXE%%" character string.
- the year, use the "%%YEAR%%" character string (2008 for example).
- the month on 2 digits, use the "%%MONTH%%" character string (03 for example).
- the day, use the "%%DAY%%" character string.
- the hour, use the "%%HOUR%%" character string.
- the minutes, use the "%%MINUTE%%" character string.
- <Description>: Backup description. Corresponds to the Description property.
- <State>: integer (or integer-type constant) used to determine the status of the backup:
| | | hBackupCanceled | 2 | Backup canceled | hBackupCompleted | 1 | Backup completed | hBackupError | 3 | Error during backup | hBackupInProgress | 0 | Backup in progress |
- <Error Message>: Error message if it exists in the form of a string.
Managing a webhook A webhook allows you to trigger a process automatically via a REST service. Simply enter the URL of the REST service. A POST request will be performed on the provided URL. The URL receives an "application/json" content corresponding to the information on the backup. For example: { "identify": "283", "destination": "c:\backup\283\monbackup.zip", "state": "completed" } where: - "identifier" corresponds to the backup identifier.
- "destination" corresponds to the backup destination.
- "state" corresponds to the state of the backup. Different states are possible: 'completed', 'cancelled' or 'error'.
|
|
|