DatabaseStatus class

Status

Implemented types

Constructors

DatabaseStatus({required String health, required bool ready, required String engine, required String version, required int uptime, required DatabaseStatusConnections connections, required String syncMode, String? effectiveSyncMode, required bool syncDegraded, required int syncAcknowledgements, required int syncStandbyCount, bool? syncStateConfirmed, required List<DatabaseStatusReplica> replicas, required List<DatabaseStatusVolume> volumes})
DatabaseStatus.fromMap(Map<String, dynamic> map)
factory

Properties

connections DatabaseStatusConnections
Connection statistics.
final
effectiveSyncMode String?
Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.
final
engine String
Database engine: postgresql, mysql, or mongodb.
final
hashCode int
The hash code for this object.
no setterinherited
health String
Overall health status: healthy, degraded, unhealthy, or unknown when nothing could be measured.
final
ready bool
Whether the database is ready to accept connections.
final
replicas List<DatabaseStatusReplica>
List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
syncAcknowledgements int
Number of standby acknowledgements the primary waits for before a write is committed.
final
syncDegraded bool
Whether the enforced replication is weaker than the requested syncMode.
final
syncMode String
Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
final
syncStandbyCount int
Number of standbys registered with the primary for synchronous replication.
final
syncStateConfirmed bool?
Whether the other sync fields are an engine reading rather than a recorded estimate. True when the primary answered what it is enforcing, including when that answer contradicted the record, in which case the contradicted values are replaced by the ones the engine reports. False when the reading could not be taken: the probe did not answer, there was no engine to ask, or the values describe a configuration change just applied rather than anything measured. Absent when no engine was asked at all, so an unprobed database is distinguishable from an unconfirmed one. False never means a standby was found lagging, because it is the absence of a reading rather than a negative one, so draw no conclusion about replication health from it or from a response that omits it.
final
uptime int
Database uptime in seconds.
final
version String
Database engine version.
final
volumes List<DatabaseStatusVolume>
Storage volume information.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() Map<String, dynamic>
override
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited