# ESS_DBINFO_T

This databaseInfo Structure gets 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_DBSTATS_T structure. The fields are:

    typedef struct  ESS_DBINFO_T
    {
       ESS_APPNAME_T      AppName;
       ESS_DBNAME_T       Name;
       ESS_USHORT_T       DbType;
       ESS_USHORT_T       Status;
       ESS_USHORT_T       nConnects;
       ESS_USHORT_T       nLocks;
       ESS_ULONG_T        nDims;
       ESS_USHORT_T       Data;
       ESS_MBRNAME_T      Country;
       ESS_MBRNAME_T      Time;
       ESS_MBRNAME_T      Category;
       ESS_MBRNAME_T      Type;
       ESS_MBRNAME_T      CrPartition;
       ESS_TIME_T         ElapsedDbTime;
       ESS_ULONG_T        DataFileCacheSetting;
       ESS_ULONG_T        DataFileCacheSize;
       ESS_ULONG_T        DataCacheSetting;
       ESS_ULONG_T        DataCacheSize;
       ESS_ULONG_T        IndexCacheSetting;
       ESS_ULONG_T        IndexCacheSize;
       ESS_ULONG_T        IndexPageSetting;
       ESS_ULONG_T        IndexPageSize;
       ESS_DBREQINFO_T    DbReqInfoAry[ESS_DBREQNUM];
       ESS_BOOL_T         bDbReadOnly;
       ESS_BOOL_T         bDataCompress;
       ESS_USHORT_T       usDataCompressType;
       ESS_ULONG_T        ulRetrievalBuffer;
       ESS_ULONG_T        ulRetrievalSortBuffer;
       ESS_BOOL_T         bCacheMemLocking;
       ESS_BOOL_T         bPreImage;
       ESS_USHORT_T       usIsolationLevel;
       ESS_LONG_T         lTimeOut;
       ESS_ULONG_T        ulCommitBlocks;
       ESS_ULONG_T        ulCommitRows;
       ESS_ULONG_T        ulDiskVolumeCount;
       ESS_DISKVOLUME_T   aDiskVolume[1];
    } ESS_DBINFO_T, *ESS_PDBINFO_T, **ESS_PPDBINFO_T;

Data Type | Field | Description
ESS_APPNAME_T | AppName | The associated application name
ESS_DBNAME_T | Name | The database name
ESS_USHORT_T | DbType | database type. Values : ESS_DBTYPE_NORMAL ESS_DBTYTPE_CURRENCY
ESS_USHORT_T | Status | databaseLoad status (loaded or not loaded . Values: ESS_STATUS_NOTLOADED ESS_STATUS_LOADING ESS_STATUS_LOADED ESS_STATUS_UNLOADING
ESS_USHORT_T | nConnects | Number of users currently connected to the database
ESS_USHORT_T | nLocks | Number of data blocks currently exclusively locked
ESS_ULONG_T | nDims | Number of dimensions in database
ESS_USHORT_T | Data | Flag indicating loading state of the data in the database. Values: ESS_DBDATA_NONE: no data loaded ESS_DBDATA_LOADNOCALC: data loaded but not calculated ESS_DBDATA_CLEAN: data loaded and calculated
ESS_MBRNAME_T | Country | The currency country dimension member, if any. If none, the first byte is NULL.
ESS_MBRNAME_T | Time | Currency time dimension member, if any. If none, the first byte is NULL.
ESS_MBRNAME_T | Category | The currency category dimension member, if any. If none, the first byte is NULL.
ESS_MBRNAME_T | Type | Currency type dimension member (currency databases only). If none exists, the first byte is NULL.
ESS_MBRNAME_T | CrPartition | The currency partition member (non-currency databases only)
ESS_TIME_T | ElapsedDbTime | Number of seconds the database has been loaded
ESS_ULONG_T | DataFileCacheSetting | The Data File Cache Size setting value currently in effect.
ESS_ULONG_T | DataFileCacheSize | The Run-time data file cache size (in Kbytes) currently in use by database. Note that once you have changed the data file cache size you must stop and restart the database in order for the new data file cache size to take effect.
ESS_ULONG_T | DataCacheSetting | The Data Cache Size setting value (in Kbytes) currently in effect.
ESS_ULONG_T | DataCacheSize | The run-time size (in Kbytes) of the Data Cache/
ESS_ULONG_T | IndexCacheSetting | The Index Cache Size (in Kbytes) setting value currently in effect.
ESS_ULONG_T | IndexCacheSize | Run-time size (in Kbytes) of the Index Cache.
ESS_ULONG_T | IndexPageSetting | The Index Page Size setting (in Kbytes) currently in effect.
ESS_ULONG_T | IndexPageSize | Run-time size (in Kbytes) of an Index Page.
ESS_DBREQINFO_T | DbReqInfo, Ary[ESS_DBREQNUM] | Array for request information, including last calc, dataLoad, and outline update
ESS_BOOL_T | bDbReadOnly | TRUE if the database is in read-only mode; FALSE otherwise.
ESS_BOOL_T | bDataCompress | Optional compression flag (the default is YES).
ESS_USHORT_T | usDataCompressType | The data compression type if the optional compression flag is set (the default is BitMap).
ESS_ULONG_T | ulRetrievalBuffer | Retrieval buffer size allocated per retrieval request (the default is 2048 bytes).
ESS_ULONG_T | ulRetrievalSortBuffer | Retrieval sort buffer size allocated per retrieval request (the default is 10240 bytes).
ESS_BOOL_T | bCacheMemLocking | TRUE if index and data cache memory pages are locked into physical memory.
ESS_BOOL_T | bPreImage | Flag to read previously committed.
ESS_USHORT_T | usIsolationLevel | Isolation level (the default is UNCOMMITTED).
ESS_LONG_T | lTimeOut | Time out set in seconds for COMMITTED access only.
ESS_ULONG_T | ulCommitBlocks | The number of data blocks updated before the explicit commit is performed (during calculation and spreadsheet updates).
ESS_ULONG_T | ulCommitRows | The number of rows of the input file processed before the explicit commit is performed during the dataload.
ESS_ULONG_T | ulDiskVolumeCount | The number of disk volume settings for this database.
ESS_DISKVOLUME_T | aDiskVolume[1] | an array of disk volume settings