The mi_tab_update_stat_mode() accessor function

The mi_tab_update_stat_mode() function indicates whether an UPDATE STATISTICS function includes a LOW, MEDIUM, or HIGH mode keyword.

Syntax

MI_UPDATE_STAT_MODE 
mi_tab_update_stat_mode(MI_AM_TABLE_DESC *tableDesc)
tableDesc
Points to the table descriptor.

Usage

To extract the distribution-level keyword that an UPDATE STATISTICS statement specifies, the am_stats purpose function calls the mi_tab_update_stat_mode() function. Three keywords describe distribution level, HIGH, MEDIUM, and the default LOW.

If a purpose function other than am_stats calls mi_tab_update_stat_mode(), the return value indicates that UPDATE STATISTICS is not running.

Return values

MI_US_LOW
Indicates that the update statistics statement specifies the low keyword or that low is in effect by default.
MI_US_MED or
Indicates that the UPDATE STATISTICS specifies the medium keyword.
MI_US_HIGH
Indicates that the UPDATE STATISTICS specifies the HIGH keyword.
MI_US_NOT_RUNNING
Indicates that no UPDATE STATISTICS statement is executing.
MI_US_ERROR
Indicates an error.