Client :: databaseInformation - Display database information
In contrast to databaseStatistics(), the function provides a short overview about versions, database type, used and unused resources etc. Database information are printed to document, console or application output area.
The function throws an exception, when the client handle is not valid or when the database passed in sDatabasePath refers to an invalid database file.
Since each dictionary is a database, databaseInformation() can also be called in order to get database information for a dictionary.
Implementation overview
- Display database information on output area or console
Client :: databaseInformation ( sDatabasePath ) - Write information statistics to target file
Client :: databaseInformation ( sDatabasePath, sOutputPath )
Implementation details
-
Display database information on output area or console
Client :: databaseInformation ( odaba::String &sDatabasePath )
Database information is displayed on application output area (GUI application supporting an output area) or on console (console applications).
- sDatabasePath
- File path to database location
The database path refers to the location of the main database file (root base).
In order to pass no database path, an empty string ( String() ) has to be passed.
to list
- sDatabasePath
- File path to database location
-
Write information statistics to target file
Client :: databaseInformation ( odaba::String &sDatabasePath, odaba::String &sOutputPath )
Database information are written to the file passed in sOutputPath.
- sDatabasePath
- File path to database location
The database path refers to the location of the main database file (root base).
In order to pass no database path, an empty string ( String() ) has to be passed.
- sOutputPath
- Output file path
The string contains the output file path for the protocol to be written from the function. In order to write protocol to console, "con" can be passed as file path.
to list
- sDatabasePath
- File path to database location