- Use conditions
- Automatic reindexing
- "Zero-downtime" reindexing
- Calculating statistics
- Directory of temporary files
- Managing non-Latin character sets
- Access rights to the data file
- Special case: Files corrupted after a computer reboot or a fatal error
- Previous versions
In french: HRéindexe
Available only with these kinds of connection
Rebuilds the file index (".NDX" file). You also have the ability to reindex full-text indexes (".FTX" extension). A data file can be reindexed even when it is accessed by applications. For more details, see remarks
: The reindex operation reorganizes the indexes. After the reindex operation, the access to indexes is optimized. Reindexing a data file can become necessary further to the loss or modification of the index file. HCheckIndex
is used to regularly check the status of the index file.
IF HIndex(AFile, hNdxNormal) = True THEN
<Result> = HIndex([<Data file> [, <Mode> [, <Progress Bar> [, <Density rate>]]]])
- True if the reindex operation was successfully performed,
- False otherwise. HError returns more details about the problem.
<Data file>: Optional character string
Name of the data file used.
If this name is not specified, HIndex will use the last data file used by the last HFSQL function (function starting with "H").
<Mode>: Optional Integer constant (or combination of constants)
Configure the reindex operation:
|hChangeCharset||Reindexing with change of character set.|
The new character set defined by ChangeCharset will be taken into account during the reindexing. Sorts, searches, ... on string keys (strings, characters, date and time) will be performed according to this character set.
|hFTX||Reindexing full-text indexes.|
|hMmoCompact||Compression and defragmentation of "Mmo" files.|
Caution: This constant cannot be combined with the hNdxCompact, hCheckMemo, hFTX, hNdxNormal or hNdxDelete constants.
|hNdxCompact||Reindexing with compression (keeps the active records only. All the other records are permanently deleted).|
|hNdxMinimal||Reindexing while taking the corrupted keys into account only. This parameter is ignored if the hNdxDelete or hNdxCompact constant is enabled.|
|hNdxSilent||Reindexing without display|
|Standard reindexing (with statistics and without compression).|
The statistics are used to optimize the queries and the filters (see the Notes). Only active records are taken into account for calculating statistics.
|hNdxNoStat||Reindex without calculating statistics. This constant increases the available space by reducing the size of index files.|
Caution: The statistics are very important to get correct execution times when using queries, filters with condition and views with condition.
|hNdxDelete||Reindex and delete damaged records|
Reindexing performed in background task. The applications are not locked during the reindex operation.
This feature is available in Client/Server mode only.
|hCheckMemo||Standard reindexing with memo check and correction if necessary (used to retrieve the damaged memos). |
Remark: Before reindexing memos, you have the ability to check the status of memos via HCheckMemo
<Progress Bar>: Optional control or window name, or optional integer
- Name of the window in which the progress bar will be displayed,
- Name of the Progress Bar control that displays the reindexing progress,
- Handle of the window that displays the progress bar.
<Density rate>: Integer included between 1 and 100
Density rate of indices. This rate is set to 60 by default.
The higher this rate is, the denser and smaller the index is. In this case, iterations, searches, filters and queries will be faster. The additions of records and the modifications of records may be slower.
The smallest this rate is, the less dense and the bigger the index will be. In this case, iterations, searches, filters and queries will be slower. The additions of records and the modifications of records will be faster.
Caution: this parameter can only be used on the data files in HFSQL format.
This parameter cannot be used.
- HIndex reindexes an xBase file.
- HIndex reindexes the files of a cluster. In this case:
- The reindex operation is performed on the node to which the user is connected.
- Only a zero-downtime reindexing is available (hBackgroundTask constant).
Reindexing a data file can become necessary further to the loss or alteration of index file. An automatic reindex operation can be implemented for the data files.
To implement an automatic reindex operation, you must:
- configure the value of the H.AutoIndexingLimit variable.
Indeed, if the data file contains less than H.AutoIndexingLimit records, the reindex operation is automatically performed if an index error occurs.
The H.AutoIndexingLimit variable is set to 10000 by default. The automatic reindex operation is disabled if this variable is set to 0.
- configure the value of the H.VisibleAutoIndexing variable.
If this value is set to True (default value), a window is automatically displayed as long as the automatic reindex operation is not completed. This window contains a progress bar used to follow the progress of the current reindexing. This window can be customized. For more details, see Assisted HFSQL error handling.
During the reindex operation, the different applications that use the file data (read or write records) will be temporarily stopped and/or locked until the end of the reindex operation.
If the hBackgroundTask constant is used, the reindex operation is performed in background task and the applications that use the data file are not stopped.
If an error occurs during the automatic reindex operation (lock error on the data file or on the record for example), the automatic reindex operation is stopped and a fatal error (corrupted index) is displayed. This operating mode is similar to the one without automatic reindexing.
- During the automatic reindexing, the reindex operation is performed in normal mode (hNdxNormal constant).
- No automatic reindexing is available for data files in Hyper File 5.5 format.
- If an automatic reindexing is performed, the applications that use the data files currently reindexed are temporarily locked. A message is displayed, indicating that the file is currently maintained.
- At the end of the reindex operation, the current HyperFileSQL context is automatically restored (except if a reindex operation with memo check was performed).
A data file can be reindexed even when it is accessed by applications.
During the reindex operation, the different applications that use the file data (reading or writing records) will be temporarily stopped/locked until the end of the reindex operation.
A window is displayed, indicating that the data file is currently reindexed (also called reorganization). This window is displayed during the entire reindex operation and it cannot be closed. A progress bar indicates the status of reindex operation.
This window can be customized and/or hidden. For more details, see Assisted HFSQL error handling
To avoid flashing effects, the indexing window is displayed only if the indexing operation may exceed 2 seconds. In this case, this window is displayed after 0.7 seconds.
: no "live" reindexing can be performed if records are locked in read/write mode in the data file to reindex. If the records are locked in write mode only, the zero-downtime reindexing can still be performed.
If the hBackgroundTask
constant is used, the reindex operation is performed in background task and the applications that use the data file are not stopped.
Statistics are used to optimize the queries and filters on the data file. Only active records are taken into account for these statistics. HStatCalculate
also returns the results of this calculation.
Remark: To efficiently calculate statistics, all data files must be included. This is the case of a multi-file query, for example.
Directory of temporary files
Temporary files can be created during the reindex operation. By default, these files are created in the Windows temporary directory or in the current directory if there is not enough space.
variable allows you to configure the directory used to save these temporary files. This variable is recommended when reindexing large data files.
The directory used to store the temporary files on the server can be defined:
Access rights to the data file
The reindex operation provokes the re-creation of the data file on disk. In an allocation system managing the rights at file level (NTFS...), the data file after the reindex operation will have the rights of the directory to which it belongs.
Before the reindex operation, if the data file had specific rights different from the rights of the folder, they must be redefined in Windows after the reindex operation.
Special case: Files corrupted after a computer reboot or a fatal error
The data files may be corrupted when the computer is unexpectedly rebooted. In this case, the data files contain invalid data (unreadable characters for example). To fix this problem:
- Perform a reindexing with deletion.
- Free the records in transaction with HTransactionFree.
- Delete the incorrect records with WDMAP.
This function replaces HIndex_55, which is kept for compatibility with WINDEV 5.5.
This page is also available for…