ESS_DBSTATS_T

This database statistics structure gets run-time statistical information about a specific database. Fields in this structure cannot be modified using the API. See also the ESS_DBSTATE_T structure, which contains additional database state parameters that can be modified, and the ESS_DBINFO_T structure. The fields are:

typedef struct ESS_DBSTATS_T
{
   ESS_USHORT_T      IndexType;                 
   ESS_ULONG_T       nDims;                     
   ESS_ULONG_T       DeclaredBlockSize;         
   ESS_ULONG_T       ActualBlockSize;           
   ESS_DOUBLE_T      DeclaredMaxBlocks;         
   ESS_DOUBLE_T      ActualMaxBlocks;           
   ESS_DOUBLE_T      NonMissingLeafBlocks;      
   ESS_DOUBLE_T      NonMissingNonLeafBlocks;   
   ESS_DOUBLE_T      NonMissingBlocks;          
   ESS_DOUBLE_T      PagedOutBlocks;            
   ESS_DOUBLE_T      PagedInBlocks;             
   ESS_DOUBLE_T      InMemCompBlocks;           
   ESS_DOUBLE_T      TotalBlocks;               
   ESS_DOUBLE_T      AverageFragmentationQuotient; 
   ESS_DOUBLE_T      BytesOfRecoverableFreeSpace;    
   ESS_DOUBLE_T      TotMemPagedInBlocks;       
   ESS_DOUBLE_T      TotMemBlocks;              
   ESS_DOUBLE_T      TotMemIndex;               
   ESS_DOUBLE_T      TotMemInMemCompBlocks;     
   ESS_DOUBLE_T      BlockDensity;              
   ESS_DOUBLE_T      SparseDensity;             
   ESS_DOUBLE_T      CompressionRatio;          
   ESS_DOUBLE_T      ClusterRatio;            
   ESS_DIMSTATS_T    DimStatsAry[1];
} ESS_DBSTATS_T, *ESS_PDBSTATS_T, **ESS_PPDBSTATS_T;
Data TypeFieldDescription
ESS_USHORT_TIndexTypeThe database index type (array or tree). This field can contain the following values:

  • ESS_INDEXTYPE_ARRAY

  • ESS_INDEXTYPE_AVL

ESS_ULONG_TnDimsThe number of dimensions in database.
ESS_ULONG_TDeclaredBlockSizeThe declared data block size.
ESS_ULONG_TActualBlockSizeThe actual data block size
ESS_DOUBLE_TDeclaredMaxBlocksThe declared maximum number of blocks in the database.
ESS_DOUBLE_TActualMaxBlocksThe actual maximum number of blocks in the database.
ESS_DOUBLE_TNonMissingLeafBlocksThe number of non-missing leaf (lowest level) blocks in the database.
ESS_DOUBLE_TNonMissingNonLeafBlocksThe number of non-missing, non-leaf (upper level) blocks in the database.
ESS_DOUBLE_TNonMissingBlocksObsolete. Returns zero.
ESS_DOUBLE_TPagedOutBlocksThe number of database blocks currently paged out to disk.
ESS_DOUBLE_TPagedInBlocksThe total number of database blocks currently paged into memory.
ESS_DOUBLE_TInMemCompBlocksThe number of database blocks currently paged into compressed memory.
ESS_DOUBLE_TTotalBlocksTotal number of existing data blocks (not the maximum).
ESS_DOUBLE_TAverageFragmentationQuotientPercentage of space within the data file that is free space or not used by Essbase.
ESS_DOUBLE_TBytesOfRecoverableFreeSpace

  • Estimated bytes of recoverable free space

  • -1 if free space recovery is not necessary

ESS_DOUBLE_TTotMemPagedIn-BlocksThe total memory used for all paged-in (uncompressed) database blocks.
ESS_DOUBLE_TTotMemBlocksThe total memory used for all database blocks.
ESS_DOUBLE_TTotMemIndexThe total memory used for the database index.
ESS_DOUBLE_TTotMemInMemCompBlocksThe total memory used for database blocks currently paged into compressed memory.
ESS_DOUBLE_TBlockDensityThe average database block density (calculated using all currently loaded blocks).
ESS_DOUBLE_TSparseDensityAverage density of the sparse dimensions in the database.
ESS_DOUBLE_TCompressionRatioAverage data block compression ratio on the disk.
ESS_DOUBLE_TClusterRatioA measure of the fragmentation of the page file. A value close to 1 indicates the degree of fragmentation is low. A value close to zero indicates a high degree of fragmentation that could affect calculation and query performance.
ESS_DIMSTATS_TDimStatsAry [1]Dynamic array (with nDim elements) of Dimension Statistical Structures, of type ESS_DIMSTATS_T. See the structure definition.