Client :: databaseStatistics - Display database statistics
The function displays database statistics for the database passed in sDatabasePath path. The path must refer to a database file. Database statistics 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, databaseStatistics() can also be called in order to get database statistics for a dictionary.
Implementation overview
- Display database statistics on output area or console
Client :: databaseStatistics ( sDatabasePath ) - Write database statistics to target file
Client :: databaseStatistics ( sDatabasePath, sOutputPath )
Implementation details
-
Display database statistics on output area or console
Client :: databaseStatistics ( odaba::String &sDatabasePath )
Database statistics are 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 database statistics to target file
Client :: databaseStatistics ( odaba::String &sDatabasePath, odaba::String &sOutputPath )
Database statistics 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