6.7.42SHOW FLUSH
Syntax
SHOW FLUSH [BY NAME]
[post_processing_option]
[output_redirecting_option]
Description
Show (i.e. get) the status of the automatic flushing.
Parameter(s)
post_processing_option – optional option that transforms the result set according to the programmer’s needs, such as ordering or truncating (please refer to the section PROCESSING for additional information).
output_redirecting_option – optional option that specifies the cursor in use, an HDF5 object (i.e. dataset or attribute), a (text, binary, or Excel) file, or memory (i.e. user-defined variable) to write the result set into (please refer to the subsection INTO for additional information). If not specified, the cursor in use is populated with the result set instead (please refer to the chapter CURSOR for additional information).
Return
If the keyword BY NAME is not specified, it returns the status of the automatic flushing as an HDFQL_INT, which can be HDFQL_GLOBAL, HDFQL_LOCAL, or HDFQL_DISABLED depending on whether the automatic flushing is enabled for the entire virtual HDF5 file (global) currently in use, is enabled only for the HDF5 file (local) currently in use, or is disabled, respectively. Otherwise, if the keyword BY NAME is specified, it returns the status of the automatic flushing as an HDFQL_VARCHAR, which can be “GLOBAL”, “LOCAL”, or “DISABLED”.
Example(s)
# enable automatic flushing of the entire virtual HDF5 file (global) currently in use
SET FLUSH ENABLE
# show (i.e. get) status of the automatic flushing (should return 1 (i.e. HDFQL_GLOBAL))
SHOW FLUSH
# enable automatic flushing of only the HDF5 file (local) currently in use
SET FLUSH LOCAL ENABLE
# show (i.e. get) status of the automatic flushing (should return 2 (i.e. HDFQL_LOCAL))
SHOW FLUSH
# disable automatic flushing of the entire virtual HDF5 file (global) or only the HDF5 file (local) currently in use
SET FLUSH DISABLE
# show (i.e. get) status of the automatic flushing (should return -1 (i.e. HDFQL_DISABLED))
SHOW FLUSH