Share via


DatabaseReplicaState Class

Represents the runtime state of a database that’s participating in an availability group. This database may be located on any of the replicas that compose the availability group.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.DatabaseReplicaState

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class DatabaseReplicaState _
    Inherits SqlSmoObject
'Usage
Dim instance As DatabaseReplicaState
[PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class DatabaseReplicaState : SqlSmoObject
[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class DatabaseReplicaState sealed : public SqlSmoObject
[<SealedAttribute>]
[<PhysicalFacetAttribute(PhysicalFacetOptions.ReadOnly)>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type DatabaseReplicaState =  
    class 
        inherit SqlSmoObject 
    end
public final class DatabaseReplicaState extends SqlSmoObject

The DatabaseReplicaState type exposes the following members.

Properties

  Name Description
Public property AvailabilityDatabaseName Gets the name of the availability database.
Public property AvailabilityDateabaseId Gets the identifier of the database within the availability group.
Public property AvailabilityGroupId Gets the identifier of the availability group to which the database belongs.
Public property AvailabilityGroupName Gets the name of the availability group.
Public property AvailabilityReplicaId Gets the identifier of the availability replica within the availability group.
Public property AvailabilityReplicaServerName Gets the server name of the availability replica.
Public property DatabaseId Gets the identifier of the database, unique within an instance of SQL Server.
Public property EndOfLogLSN Gets the LSN of the most recent log record flushed to disk.
Public property EstimatedDataLoss Gets the estimated data loss.
Public property EstimatedRecoveryTime Gets the estimated recovery time.
Public property FileStreamSendRate Gets the rate at which the files are sent to the secondary replica.
Public property IsFailoverReady Gets or sets a value that indicates whether the database is marked synchronized in the cluster.
Public property IsJoined Gets or sets a value that indicates whether the availability database has a physical replica on the server instance.
Public property IsLocal Gets or sets a value that indicates whether the database is local to the instance.
Public property IsSuspended Gets a value that indicates whether the state of the database replica is suspended.
Public property LastCommitLSN Gets the LSN of the last commit record.
Public property LastCommitTime Gets the time corresponding to the last commit record.
Public property LastHardenedLSN Gets the start of the log block that contained the latest log records that were written to disk.
Public property LastHardenedTime Gets the time when the log-block identifier for the last hardened LSN.
Public property LastReceivedLSN Gets the last log block that was received on this secondary replica for this database.
Public property LastReceivedTime Gets the time when the log block identifier was last received on the secondary.
Public property LastRedoneLSN Gets the last log record that was redone on the secondary database.
Public property LastRedoneTime Gets the time when the last log record was redone on the secondary database.
Public property LastSentLSN Gets the last block of transaction log records that was sent to this secondary replica for this database.
Public property LastSentTime Gets the time when the last log block was sent.
Public property LogSendQueueSize Gets the amount of log records in the log files of the primary database that has not been sent to the secondary replica.
Public property LogSendRate Gets the rate at which log records are being sent to the secondary replica.
Public property Parent Gets the AvailabilityGroup object that is the parent of the DatabaseReplicaState object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property RecoveryLSN Gets the end of the transaction log before the replica writes any new log records after recovery failover.
Public property RedoQueueSize Gets the amount of log records in the log files of the secondary replica that has not yet been redone.
Public property RedoRate Gets the rate at which the log records are being redone.
Public property ReplicaAvailabilityMode Gets the availability mode of the availability replica.
Public property ReplicaRole Gets the role of the availability replica.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property SuspendReason Gets the reason for a database replica to be in suspended state.
Public property SynchronizationPerformance Gets the performance of the synchronization for the database.
Public property SynchronizationState Gets the state of the availability database synchronization.
Public property TruncationLSN Gets the log truncation value, which may be higher than the local truncation LSN if local log truncation is blocked.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace