PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

  • Miscellaneous
  • Necessary rights
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Returns information about one or more backups performed on an HFSQL Client/Server server.
The backups have been performed by <Connection variable>.Backup (or via the HFSQL Control Center) and they can be restored by <Connection variable>.RestoreBackup (or via the HFSQL Control Center).
Example
// Describe the connection
gctConnection is Connection
 
// Displays information about the backups in a Table control
sReport is string = gctConnection.InfoBackup()
sLine is string
FOR EACH STRING sLine OF sReport SEPARATED BY EOT
IF sLine ~="" THEN CONTINUE
TABLE_Backups.Add()
nSub is int = TABLE_Backups.Count()
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> = <Connection>.InfoBackup()
<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:
    hBackupCanceled2Backup canceled
    hBackupCompleted1Backup completed
    hBackupError3Error during backup
    hBackupInProgress0Backup in progress
  • <Per Thousand> corresponds to the rate of backup completion if the backup is in progress (expressed in per thousand).
  • <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:
    hBackupDifferential1Differential backup
    hBackupFull0Full backup
  • <Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup.
  • <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.
  • <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>: Connection variable
Name of the Connection variable that describes the connection to the server whose backups will be listed.

Information about a specific backup Hide the details

<Result> = <Connection>.InfoBackup(<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:
    hBackupCanceled2Backup canceled
    hBackupCompleted1Backup completed
    hBackupError3Error during backup
    hBackupInProgress0Backup in progress
  • <Per Thousand> corresponds to the rate of backup completion if the backup is in progress (expressed in per thousand).
  • <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:
    hBackupDifferential1Differential backup
    hBackupFull0Full backup
  • <Identifier of Full Backup> corresponds to the identifier of the corresponding full backup in case of differential backup.
  • <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.
  • <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>: Connection variable
Name of the Connection variable that describes the connection to the server that performed the backup.
<Backup identifier>: Integer
Identifier of backup whose characteristics are requested. This identifier is returned by <Connection variable>.Backup.
Remarks

Miscellaneous

  • <Connection variable>.InfoBackup 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).

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.
To find out whether these rights are granted to a user or to a group, use <Connection variable>.InfoServerRights or <Connection variable>.InfoDatabaseRights.
To modify the rights granted to a user or to a group of users, use <Connection variable>.ModifyServerRights or <Connection variable>.ModifyDatabaseRights.
Component: wd270hf.dll
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment