get_client_report: commenting DatabaseState::getClientStatus

This commit is contained in:
Vaidas Gasiunas 2023-01-16 16:50:17 +01:00
parent d064487550
commit 46178f4c74

View File

@ -2376,6 +2376,31 @@ const char* initializationStateToString(MultiVersionDatabase::InitializationStat
} // namespace
//
// Generates the client-side status report for the Multi-Version Database
//
// The parameter dbContextStatus contains the status report generated by
// the wrapped Native Database (from external or local client), which is then
// embedded within the status report of the Multi-Version Database
//
// The overall report schema is as follows:
// { "Healthy": <overall health status, true or false>,
// "InitializationState": <initialization state of the Multi-Version Database>,
// "InitializationError": <initialization error code, present if initialization failed>,
// "ProtocolVersion" : <determined protocol version of the cluster, present if determined>,
// "ConnectionRecord" : <connection file name or connection string>,
// "DatabaseStatus" : <Native Database status report, present if successfully retrieved>,
// "ErrorRetrievingDatabaseStatus" : <error code of retrieving status of the Native Database, present if failed>,
// "AvailableClients" : [
// { "ProtocolVersion" : <protocol version of the client>,
// "ReleaseVersion" : <release version of the client>,
// "ThreadIndex" : <the index of the client thread serving this database>
// },
// ...
// ]
// }
//
//
Standalone<StringRef> MultiVersionDatabase::DatabaseState::getClientStatus(
ErrorOr<Standalone<StringRef>> dbContextStatus) {
json_spirit::mObject statusObj;