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

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	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