ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions
  • Overview
  • List of functions
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Overview
Several HFSQL functions are used to manage the HFSQL Client/Server data.
These functions are mainly used to:
  • Manage the users and the groups of users (creation, rights, ...)
  • Manage the data files found on the server
  • Manage the referential integrity (functions for managing the links)
  • Manage the server.
List of functions
The following functions are used to manage the HFSQL Client/Server engine in prefix syntax:
<Connection variable>.ActivateServerTriggerRe-enables a server trigger that was disabled by <Connection variable>.DeactivateServerTrigger.
<Connection variable>.AddGroupAdds a group of users.
<Connection variable>.AddLinkAdds an integrity rule between two files on the server.
<Connection variable>.AddScheduledBackupAdds a scheduling for full backup (with or without differential backup) on the server defined by the connection.
<Connection variable>.AddScheduledOptimizationAdds an optimization task of HFSQL Client/Server data files.
<Connection variable>.AddSchedulingAdds a new scheduled item to an HFSQL server: scheduled task (stored procedure), backup, optimization or refresh of a materialized view.
<Connection variable>.AddTaskAdds a scheduled task on the server defined by the connection.
<Connection variable>.AddUserAdds a user to a database.
<Connection variable>.BackupBacks up the contents of an HFSQL server: all server databases, one or more databases, one or more data files.
<Connection variable>.CancelBackupCancels a current backup.
<Connection variable>.CheckServerUpdateChecks for the latest version of the HFSQL server that can be automatically updated.
<Connection variable>.ConnectionQualityReturns the quality level of the connection: the higher the level is, the faster the connection is.
<Connection variable>.CopyFileCopies an HFSQL data file (.fic, .ndx, .ftx, .sdx and .mmo files, if any):
  • from the HFSQL server to the server (to perform a backup for example).
  • from the HFSQL server to the client (to perform a local backup for example).
  • from the client to the HFSQL server (to update the data files for example).
  • from an HFSQL server to antoher HFSQL server.
<Connection variable>.DeactivateServerTriggerDisables an HFSQL Client/Server server trigger on a server.
<Connection variable>.DeleteBackupDeletes a backup previously created with <Connection variable>.Backup.
<Connection variable>.DeleteDatabaseDeletes a database located on an HFSQL server.
<Connection variable>.DeleteDirectoryDeletes a directory from an HFSQL Client/Server database.
<Connection variable>.DeleteFileDeletes HFSQL data files (.fic, .ndx, .ftx, .sdx and .mmo files, if any) from the server.
<Connection variable>.DeleteGroupDeletes (from the server) a group of users associated with a connection.
<Connection variable>.DeleteLinkDeletes an integrity rule between two data files on the server.
<Connection variable>.DeleteParameterDeletes a parameter previously saved by <Connection variable>.SaveParameter.
<Connection variable>.DeleteQueryDeletes a query (used by stored procedures) from an HFSQL server.
<Connection variable>.DeleteScheduledBackupDeletes a scheduled backup from an HFSQL Client/Server server.
<Connection variable>.DeleteScheduledOptimizationDeletes a scheduled optimization task from HFSQL Client/Server data files.
<Connection variable>.DeleteSchedulingDelete a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
Deletes the executions of a scheduled operation on an HFSQL server. This operation can be a scheduled task (stored procedure), backup, optimization or a materialized view refresh.
<Connection variable>.DeleteServerTriggerDeletes a server trigger.
<Connection variable>.DeleteSetDeletes a set of stored procedures from an HFSQL server.
<Connection variable>.DeleteTaskDeletes a scheduled task from an HFSQL Client/Server server.
<Connection variable>.DeleteUserDeletes a user associated with a connection to the HFSQL server.
<Connection variable>.DescribeServerTriggerAdds or modifies a server trigger.
<Connection variable>.DisconnectClientDisplays a message on the Client computer(s) and disconnects the application.
<Connection variable>.DropViewDeletes a materialized view from the HFSQL server.
<Connection variable>.DuplicateDatabaseDuplicates the database associated with a connection on an HFSQL server.
<Connection variable>.EndNoDatabaseAccessRe-allows the access (which means the connection) to one or more databases accessible via a connection.
<Connection variable>.ExecuteAsynchronousProcedureExecutes a stored procedure in asynchronous mode.
This new function is available from WINDEV Suite SaaS 2025 Update 2.
<Connection variable>.ExecuteProcedureRuns a stored procedure.
<Connection variable>.ExecuteScheduledBackupForces the execution of a scheduled backup.
<Connection variable>.ExecuteSchedulingImmediately executes a scheduled item regardless of its scheduling: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
<Connection variable>.InfoBackupReturns information about one or more backups performed on an HFSQL Client/Server server.
<Connection variable>.InfoDatabasePropertyUsed to find out the properties of a database on an HFSQL server.
<Connection variable>.InfoDatabaseRightsGets the rights granted to a user or group on a database.
<Connection variable>.InfoFilePropertyAllows you to find out the properties of a data file located in an HFSQL server.
<Connection variable>.InfoFileRightsGets the rights granted to a user or group on an HFSQL Client/Server data file.
<Connection variable>.InfoGroupReturns information about the specified group of users.
<Connection variable>.InfoItemRightsGets the rights granted to a user or group on an item.
<Connection variable>.InfoLockReturns information about the lock set on a data file, on one or all the records in a data file.
<Connection variable>.InfoServerReturns the specified information about the server.
<Connection variable>.InfoServerPropertyAllows you to find out the properties of an HFSQL server.
<Connection variable>.InfoServerRightsGets the rights granted to a user or group of users on a server.
<Connection variable>.InfoTaskReturns the characteristics of a scheduled task in a hScheduledTask variable].
<Connection variable>.InfoUserUpdates the variables for user management with the information regarding the specified user.
<Connection variable>.InfoViewReturns information about a materialized view.
<Connection variable>.InfoViewRightsGets the rights granted to a user or group on an SQL view or on a materialized view.
<Connection variable>.ListDatabaseLists the Client/Server databases associated with a connection.
<Connection variable>.ListGroupReturns the list of groups of users defined for a connection.
<Connection variable>.ListParameterReturns the list of parameters saved from the stored procedures on the server.
<Connection variable>.ListScheduledBackupLists the full and differential backups that have been scheduled on HFSQL Client/Server.
<Connection variable>.ListScheduledOptimizationLists the scheduled optimization tasks of HFSQL Client/Server data files for a connection.
<Connection variable>.ListSchedulingLists scheduled elements defined on an HFSQL server: scheduled tasks (stored procedure), backup, optimization, refresh of a materialized view.
Lists the executions of a scheduled operation on an HFSQL server. This operation can be a scheduled task (stored procedure), backup, optimization or a materialized view refresh.
<Connection variable>.ListStoredElementReturns the list of elements stored on an HFSQL server (sets of procedures, stored procedures or queries).
<Connection variable>.ListTaskLists the scheduled tasks of an HFSQL Client/Server server for a given connection.
<Connection variable>.ListUserReturns the list of users defined for a connection.
<Connection variable>.ListWatchedFilesReturns the list of data files watched by <Source>.Watch.
<Connection variable>.LoadParameterReads a parameter that was saved from a stored procedure by <Connection variable>.SaveParameter.
<Connection variable>.ManageServerUpdateUsed to manage the automatic update of HFSQL Client/Server servers by specifying the check frequency regarding the availability of updates.
<Connection variable>.ManageTaskEnables or disables a scheduled task on an HFSQL Client/Server server.
<Connection variable>.ModifyDatabasePropertyModifies the properties of a database located on an HFSQL server.
<Connection variable>.ModifyDatabaseRightsSets the rights granted to a user or group for an HFSQL Client/Server database.
<Connection variable>.ModifyFilePropertyModifies the properties of an HFSQL data file located on a server.
<Connection variable>.ModifyFileRightsSets the rights granted to a user or group on an HFSQL Client/Server data file.
<Connection variable>.ModifyGroupModifies the group information according to the elements found in the corresponding variables for group management.
<Connection variable>.ModifyItemRightsModifies the rights granted to a user or group on an item of an HFSQL Client/Server data file.
<Connection variable>.ModifyScheduledBackupModifies a backup scheduling.
<Connection variable>.ModifyScheduledOptimizationModifies a scheduled optimization task on the HFSQL server defined by the connection.
<Connection variable>.ModifySchedulingModify a scheduled item on an HFSQL server: scheduled task (stored procedure), backup, optimization, refresh of a materialized view.
<Connection variable>.ModifyServerPropertyModifies the properties of an HFSQL server.
<Connection variable>.ModifyServerRightsSets the rights granted to a user or group on an HFSQL server.
<Connection variable>.ModifyTaskModifies a scheduled task on the HFSQL server defined by the connection.
<Connection variable>.ModifyUserModifies the information about a user according to the elements found in the corresponding variables for user management.
<Connection variable>.ModifyViewRightsSets the rights granted to a user or group on an SQL view or on a materialized view.
<Connection variable>.NoDatabaseAccessDenies all new connections to a database or to all databases.
<Connection variable>.NotifAddCCRecipientAdds recipients for the notifications sent via the Control Centers (WDBal messaging tool).
<Connection variable>.NotifAddEmailRecipientAdds recipients for the notifications sent by email.
<Connection variable>.NotifConfigureSpecifies and configures the server used to send notifications by the HFSQL server.
<Connection variable>.NotifDeleteCCRecipientDeletes the recipients of a notification sent via the Control Centers (WDBal messaging tool).
<Connection variable>.NotifDeleteEmailRecipientDeletes the recipients of an email notification.
<Connection variable>.NotifListCCRecipientReturns the list of recipients of a notification sent via the Control Centers (WDBal messaging tool).
<Connection variable>.NotifListEmailRecipientReturns the list of recipients for a notification by email.
<Connection variable>.OperationInProgressReturns the list of automatic operations in progress on an HFSQL server.
<Connection variable>.PriorityFinds out and modifies the priority of the calling application.
<Connection variable>.PriorityClientModifies the priority of a client application.
<Connection variable>.RestoreBackupUsed to restore:
<Connection variable>.RetrieveBackupRetrieves locally the content of a compressed backup (in ZIP format) performed on an HFSQL server.
<Connection variable>.RetrieveLogCreates a text file containing the server logs between two given dates.
<Connection variable>.SaveParameterSaves a persistent value on the HFSQL server.
<Connection variable>.SendMessageToClientDisplays a message on the client computers.
<Connection variable>.ServerMaintenanceChecks and optimizes the system tables of an HFSQL server.
<Connection variable>.SetServerUsed to find out and modify some settings of HFSQL Client/Server server.
<Connection variable>.SimulateNetworkSimulates the operating mode of HFSQL Client/Server on an ADSL or 3G network.
<Connection variable>.StartServerUpdateUsed to immediately start the automatic server update.
<Connection variable>.StopServerStops an HFSQL server.
<Connection variable>.TransactionIsolationConfigures the isolation level of transactions for a connection to an HFSQL server.
<Connection variable>.TransactionListReturns the list of current or interrupted transactions on the server for the specified connection.
<Connection variable>.TransactionRollbackToSavepointRolls the transaction back to the savepoint.
<Connection variable>.TransactionSavepointDeclares a transaction savepoint.
<Connection variable>.UpdateQueryCreates or updates a query on an HFSQL server.
<Connection variable>.UpdateSetCreates or updates a set of procedures on an HFSQL server.
<Connection variable>.UpdateViewCreates or updates the description of an SQL view or materialized view from the analysis to an HFSQL server.
<HFSQL connection>.CheckIndexAsynchronousChecks that the data contained in the index file (.NDX file) correctly references the data contained in the HFSQL Client/Server data file (.FIC file).
This new function is available from WINDEV Suite SaaS 2025 - Update 2.
<HFSQL connection>.CheckMemoAsynchronousChecks the structural integrity of memos in an HFSQL Client/Server data file.
This new function is available from WINDEV Suite SaaS 2025 - Update 2.
<HFSQL connection>.ListReindexingHistoryLists the operations performed on current data files, over the last 24 hours, or on the last 1000 files. These operations include reindexing, recalculation of statistics, memo verification, index verification, etc.
This new function is available from WINDEV Suite SaaS 2025 - Update 2.
<HFSQL connection>.ReindexAsynchronousRebuilds the index of an HFSQL Client/Server data file (".NDX" file). This operation is asynchronous, i.e., it is performed on the server and does not block the client side.
This new function is available from WINDEV Suite SaaS 2025 - Update 2.
<HFSQL connection>.StatCalculateAsynchronousGets various statistics on the keys of an HFSQL Client/Server data file.
This new function is available from WINDEV Suite SaaS 2025 - Update 2.
<Source>.ChangePasswordChanges the password of an HFSQL Classic or HFSQL Client/Server data file.
<Source>.InfoLockReturns information about the lock set on a data file, on one or all the records in a data file.
<Source>.UpdateLinkUpdates on the server all the links of an HFSQL Client/Server data file.
AndroidAndroid Widget Note: This function is only available from WINDEV Suite SaaS 2025 - Update 2. For more details, see Using new features exclusive to WINDEV Suite SaaS 2025.
<Source>.WatchTrigger monitoring of write actions (add, modify or delete) performed on a data file present on an HFSQL server. In case of modification, a specific procedure can be triggered.
<Source>.WatchStopStops watching a data file on an HFSQL server.
<Variable Connexion>AccountUnlockSecurityPolicyUnblocks a user account blocked by too many unsuccessful login attempts.
This new function is available from WINDEV Suite SaaS 2025 - Update 3.
<Variable Connexion>PolicySecurityVerifyVerifies that the password security policy associated with the HFSQL server is respected for each user account.
This new function is available from WINDEV Suite SaaS 2025 - Update 3.
<Variable Connexion>SafetyPolicyRecoverRetrieves the security policy of an HFSQL server.
This new feature is available from version 2025 Update 3.
Android This feature is available for Android apps starting from WINDEV Suite SaaS 2025 Update 3.
<Variable Connexion>SecurityPolicyModifyModifies the password security policy of an HFSQL server.
This new function is available from WINDEV Suite SaaS 2025 - Update 3.
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 06/19/2025

Send a report | Local help