HInfoBackup (Function) In french: HInfoSauvegarde
 Available only with this kind of connection
Returns information about one or more backups performed on an HFSQL Client/Server server. The backups have been performed by HBackup (or via the HFSQL Control Center) and they can be restored by HRestoreBackup (or via the HFSQL Control Center).
Remark: From version 19, HFSQL is the new name of HyperFileSQL.  Versions 22 and later New in version 22
// Displays information about the backups in a Table control
sReport is string = HInfoBackup(gctConnection)
sLine is string
FOR EACH STRING sLine OF sReport SEPARATED BY EOT
IF sLine ~="" THEN CONTINUE
TableAdd(TABLE_Backups)
nSub is int = TableCount(TABLE_Backups)
TABLE_Backups.COL_BackupID[nSub] = ExtractString(sLine, 1)
TABLE_Backups.COL_DateTime[nSub] = ExtractString(sLine, 2)
TABLE_Backups.COL_Filter[nSub] = ExtractString(sLine, 3)
TABLE_Backups.COL_Name[nSub] = ExtractString(sLine, 4)
TABLE_Backups.COL_Description[nSub] = ExtractString(sLine, 5)
TABLE_Backups.COL_Status[nSub] = ...
SWITCH(Val(ExtractString(sLine, 6)) + 1, ...
"In progress", "Performed", "Canceled", "Error")
TABLE_Backups.COL_PerThousand[nSub] = ExtractString(sLine, 7)
END
Syntax
Information about the backups performed on the server Hide the details
<Result> = HInfoBackup(<Connection>)
<Result>: Character string Description of backups performed on the specified server. This description has the following format:
<Identifier of Backup 1> + TAB + <Date of Backup 1> + TAB + <Files Saved> + TAB + <Destination Path of Backup 1> + TAB + <Description> + TAB + <Status> + TAB + <Per Thousand> + TAB + <Error Message> + TAB + <Type> + TAB + <Identifier of Full Backup> + TAB + <With Index> + TAB + <Compression> + EOT
where:- <Files Saved> is the list of data saved separated by semicolons (";").
<Status> corresponds to an integer (or to an Integer constant) used to find out the backup status:
| | | | hBackupInProgress | 0 | Backup in progress | | hBackupCompleted | 1 | Backup completed | | hBackupCanceled | 2 | Backup canceled | | hBackupError | 3 | Error during backup |
- <Per Thousand> corresponds to the rate of backup completion if the backup is in progress (expressed in per thousand).
Versions 15 and later<Error Message> is the error message if the backup failed. New in version 15<Error Message> is the error message if the backup failed. <Error Message> is the error message if the backup failed.Versions 15 and later<Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup: | | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
New in version 15<Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup: | | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
<Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup:
| | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
Versions 15 and later<Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup. New in version 15<Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup. <Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup.Versions 22 and later<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
New in version 22<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
Versions 22 and later<Compression>: Constant corresponding to the backup compression: - zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
New in version 22<Compression>: Constant corresponding to the backup compression: - zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
<Compression>: Constant corresponding to the backup compression:- zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
Remark: the separator used between the different descriptions is "EOT" (instead of "CR") because the different description parameters can contain Carriage Return characters (CR). <Connection>: Character string (with or without quotes) or Connection variable Connection to the server whose backups will be listed. This connection corresponds to:
Information about a specific backup Hide the details
<Result> = HInfoBackup(<Connection> , <Backup identifier>)
<Result>: Character string Description of specified backup on the specified server. This description has the following format:
<Identifier of Backup 1> + TAB + <Date of Backup 1> + TAB + <Files Saved> + TAB + <Destination Path of Backup 1> + TAB + <Description> + TAB + <Status> + TAB + <Per Thousand> + TAB + <Error Message> + TAB + <Type> + TAB + <Identifier of Full Backup> + TAB + <With Index> + TAB + <Compression> + EOT
where:- <Files Saved> is the list of data saved separated by semicolons (";").
<Status> corresponds to an integer (or to an Integer constant) used to find out the backup status:
| | | | hBackupInProgress | 0 | Backup in progress | | hBackupCompleted | 1 | Backup completed | | hBackupCanceled | 2 | Backup canceled | | hBackupError | 3 | Error during backup |
- <Per Thousand> corresponds to the rate of backup completion if the backup is in progress (expressed in per thousand).
Versions 15 and later<Error Message> is the error message if the backup failed. <Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup: | | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
New in version 15<Error Message> is the error message if the backup failed. <Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup: | | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
<Error Message> is the error message if the backup failed.
<Type> corresponds to an integer (or to an Integer constant) used to find out the type of backup:
| | | | hBackupFull | 0 | Full backup | | hBackupDifferential | 1 | Differential backup |
Versions 15 and later<Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup. New in version 15<Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup. <Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup.Versions 22 and later<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
New in version 22<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
<With Index>: Used to find out whether the backup contains the indexes: - 0 if the backup of indexes was not performed,
- 1 if the backup of indexes was performed.
Versions 22 and later<Compression>: Constant corresponding to the backup compression: - zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
New in version 22<Compression>: Constant corresponding to the backup compression: - zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
<Compression>: Constant corresponding to the backup compression: - zipFormatNone: the backup is not compressed.
- zipFormatZip: the backup is compressed.
Remark: the separator used between the different descriptions is "EOT" (instead of "CR") because the different description parameters can contain Carriage Return characters (CR). <Connection>: Character string (with or without quotes) or Connection variable Connection to the server that performed the backup. This connection corresponds to: <Backup identifier>: Integer Identifier of backup whose characteristics are requested. This identifier is returned by HBackup. Remarks Various - HInfoBackup is used to list the tasks performed or the current tasks. The scheduled tasks that have not been performed are not listed.
- The backups performed by the HFSQL Control Center and the ones performed by programming are listed.
- The dates and times are expressed in universal time (UTC).
Versions 23 and laterNecessary rights To get in formation about a backup, the user or the group must have: - for each database affected by the backup, the rights to perform backups (hRightsBackup constant) or the rights to connect (hRightsConnection or hRightsEncryptedConnection constant).
- for a full server backup, the rights to perform backups (hRightsBackup constant) on the server.
New in version 23Necessary rights To get in formation about a backup, the user or the group must have: - for each database affected by the backup, the rights to perform backups (hRightsBackup constant) or the rights to connect (hRightsConnection or hRightsEncryptedConnection constant).
- for a full server backup, the rights to perform backups (hRightsBackup constant) on the server.
Necessary rights To get in formation about a backup, the user or the group must have: - for each database affected by the backup, the rights to perform backups (hRightsBackup constant) or the rights to connect (hRightsConnection or hRightsEncryptedConnection constant).
- for a full server backup, the rights to perform backups (hRightsBackup constant) on the server.
Related Examples:
|
Training (WINDEV): WD Duplication
[ + ] This educational example explains how to duplicate a database on a server. The duplication is performed by programming and it allows you to give a new name to the database. The example is based on the functions for saving and restoring a HFSQL backup.
|
This page is also available for…
|
|
|