Google Cloud Spanner v1 API - Class SessionPool.DatabaseStatistics (5.0.0-beta02)

[Obsolete("Use Google.Cloud.Spanner.V1.SessionPool.SessionPoolSegmentStatistics instead. The behavior of both classes is the same, but the new class name better reflects the fact that sessions are now pooled by aspects other than database name.")]
public sealed class SessionPool.DatabaseStatistics

Reference documentation and code samples for the Google Cloud Spanner v1 API class SessionPool.DatabaseStatistics.

A snapshot of statistics for a SessionPool.SessionPoolSegmentKey within a SessionPool.

Inheritance

object > SessionPool.DatabaseStatistics

Inherited Members

object.GetHashCode()

object.GetType()

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Properties

ActiveSessionCount

public int ActiveSessionCount { get; }

The number of active or requested sessions. This is the difference between the number of successful or pending session acquisition requests and the number of released sessions. If this exceeds MaximumActiveSessions it indicates that some acquisition calls are currently pending; the limit is obeyed separately, in terms of how many session creation requests the pool has made to the server.

Property Value
Type	Description
`int`

DatabaseName

public DatabaseName DatabaseName { get; }

The database this set of statistics corresponds to.

Property Value
Type	Description
`Google.Cloud.Spanner.Common.V1.DatabaseName`

DatabaseRole

public string DatabaseRole { get; }

The database role of the sessions in the session pool this set of statistics corresponds to. May be null in which case the default (public) database role is used if fine grained access control is enabled; otherwise the database role is ignored.

Property Value
Type	Description
`string`

Healthy

public bool Healthy { get; }

Whether the pool is healthy or not.

Property Value
Type	Description
`bool`

InFlightCreationCount

public int InFlightCreationCount { get; }

The number of session creation (or refresh, or transaction creation) requests in flight.

Property Value
Type	Description
`int`

PendingAcquisitionCount

public int PendingAcquisitionCount { get; }

The number of client calls awaiting sessions.

Property Value
Type	Description
`int`

PoolCount

public int PoolCount { get; }

The number of sessions in the pool.

Property Value
Type	Description
`int`

Shutdown

public bool Shutdown { get; }

Whether the pool has been shut down or not. (This indicates the start of shutdown, not necessarily the end.)

Property Value
Type	Description
`bool`

Methods

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()