DatabaseReplicaState DatabaseReplicaState DatabaseReplicaState Class

Definition

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.

public ref class DatabaseReplicaState sealed : Microsoft::SqlServer::Management::Smo::SqlSmoObject
[Microsoft.SqlServer.Management.Facets.EvaluationMode(Microsoft.SqlServer.Management.Dmf.AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElement(Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementFlags.Standalone)]
[Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacet(Microsoft.SqlServer.Management.Sdk.Sfc.PhysicalFacetOptions.ReadOnly)]
public sealed class DatabaseReplicaState : Microsoft.SqlServer.Management.Smo.SqlSmoObject
Public NotInheritable Class DatabaseReplicaState
Inherits SqlSmoObject
Inheritance
DatabaseReplicaStateDatabaseReplicaStateDatabaseReplicaState
Attributes
Microsoft.SqlServer.Management.Facets.EvaluationModeAttribute Microsoft.SqlServer.Management.Sdk.Sfc.Metadata.SfcElementAttribute PhysicalFacetAttribute

Properties

AvailabilityDatabaseName AvailabilityDatabaseName AvailabilityDatabaseName

Gets the name of the availability database.

AvailabilityDateabaseId AvailabilityDateabaseId AvailabilityDateabaseId

Gets the identifier of the database within the availability group.

AvailabilityGroupId AvailabilityGroupId AvailabilityGroupId

Gets the identifier of the availability group to which the database belongs.

AvailabilityGroupName AvailabilityGroupName AvailabilityGroupName

Gets the name of the availability group.

AvailabilityReplicaId AvailabilityReplicaId AvailabilityReplicaId

Gets the identifier of the availability replica within the availability group.

AvailabilityReplicaServerName AvailabilityReplicaServerName AvailabilityReplicaServerName

Gets the server name of the availability replica.

DatabaseId DatabaseId DatabaseId

Gets the identifier of the database, unique within an instance of SQL Server.

EndOfLogLSN EndOfLogLSN EndOfLogLSN

Gets the LSN of the most recent log record flushed to disk.

EstimatedDataLoss EstimatedDataLoss EstimatedDataLoss

Gets the estimated data loss.

EstimatedRecoveryTime EstimatedRecoveryTime EstimatedRecoveryTime

Gets the estimated recovery time.

ExecuteForScalar ExecuteForScalar ExecuteForScalar

Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option.

(Inherited from SqlSmoObject)
ExecutionManager ExecutionManager ExecutionManager

Gets the object to execute to the manager.

(Inherited from SqlSmoObject)
FileStreamSendRate FileStreamSendRate FileStreamSendRate

Gets the rate at which the files are sent to the secondary replica.

IsFailoverReady IsFailoverReady IsFailoverReady

Gets or sets a value that indicates whether the database is marked synchronized in the cluster.

IsJoined IsJoined IsJoined

Gets or sets a value that indicates whether the availability database has a physical replica on the server instance.

IsLocal IsLocal IsLocal

Gets or sets a value that indicates whether the database is local to the instance.

IsSuspended IsSuspended IsSuspended

Gets a value that indicates whether the state of the database replica is suspended.

IsTouched IsTouched IsTouched

Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server.

(Inherited from SqlSmoObject)
LastCommitLSN LastCommitLSN LastCommitLSN

Gets the LSN of the last commit record.

LastCommitTime LastCommitTime LastCommitTime

Gets the time corresponding to the last commit record.

LastHardenedLSN LastHardenedLSN LastHardenedLSN

Gets the start of the log block that contained the latest log records that were written to disk.

LastHardenedTime LastHardenedTime LastHardenedTime

Gets the time when the log-block identifier for the last hardened LSN.

LastReceivedLSN LastReceivedLSN LastReceivedLSN

Gets the last log block that was received on this secondary replica for this database.

LastReceivedTime LastReceivedTime LastReceivedTime

Gets the time when the log block identifier was last received on the secondary.

LastRedoneLSN LastRedoneLSN LastRedoneLSN

Gets the last log record that was redone on the secondary database.

LastRedoneTime LastRedoneTime LastRedoneTime

Gets the time when the last log record was redone on the secondary database.

LastSentLSN LastSentLSN LastSentLSN

Gets the last block of transaction log records that was sent to this secondary replica for this database.

LastSentTime LastSentTime LastSentTime

Gets the time when the last log block was sent.

LogSendQueueSize LogSendQueueSize 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 LogSendRate LogSendRate

Gets the rate at which log records are being sent to the secondary replica.

ObjectInSpace ObjectInSpace ObjectInSpace

Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
Parent Parent Parent

Gets the AvailabilityGroup object that is the parent of the DatabaseReplicaState object.

Properties Properties Properties

Gets a collection of Property objects that represent the object properties.

(Inherited from SqlSmoObject)
RecoveryLSN RecoveryLSN RecoveryLSN

Gets the end of the transaction log before the replica writes any new log records after recovery failover.

RedoQueueSize RedoQueueSize RedoQueueSize

Gets the amount of log records in the log files of the secondary replica that has not yet been redone.

RedoRate RedoRate RedoRate

Gets the rate at which the log records are being redone.

ReplicaAvailabilityMode ReplicaAvailabilityMode ReplicaAvailabilityMode

Gets the availability mode of the availability replica.

ReplicaRole ReplicaRole ReplicaRole

Gets the role of the availability replica.

ScalarResult ScalarResult ScalarResult

Gets the scalar result for the referenced object.

(Inherited from SqlSmoObject)
State State State

Gets the state of the referenced object.

(Inherited from SmoObjectBase)
SuspendReason SuspendReason SuspendReason

Gets the reason for a database replica to be in suspended state.

SynchronizationPerformance SynchronizationPerformance SynchronizationPerformance

Gets the performance of the synchronization for the database.

SynchronizationState SynchronizationState SynchronizationState

Gets the state of the availability database synchronization.

TruncationLSN TruncationLSN TruncationLSN

Gets the log truncation value, which may be higher than the local truncation LSN if local log truncation is blocked.

Urn Urn Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.

(Inherited from SqlSmoObject)
UserData UserData UserData

Gets or sets user-defined data associated with the referenced object.

(Inherited from SmoObjectBase)

Methods

AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection) AddDatabaseContext(StringCollection)

Add the database context to the collection of queries identified by the queries parameter.

(Inherited from SqlSmoObject)
AlterImpl() AlterImpl() AlterImpl()

Activates the object altered event.

(Inherited from SqlSmoObject)
AlterImplWorker() AlterImplWorker() AlterImplWorker()

Calls the Alter methods.

(Inherited from SqlSmoObject)
BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean) BindDefaultImpl(String, String, Boolean)

Binds the default items identified by the parameters.

(Inherited from SqlSmoObject)
BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean) BindRuleImpl(String, String, Boolean)

Binds the rule schema to the rule and columns identified by the parameters.

(Inherited from SqlSmoObject)
CheckObjectState() CheckObjectState() CheckObjectState()

Validates the state of the referenced object.

(Inherited from SqlSmoObject)
CheckObjectState(Boolean) CheckObjectState(Boolean) CheckObjectState(Boolean)

Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created.

(Inherited from SqlSmoObject)
CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean) CheckObjectStateImpl(Boolean)

Checks the state of a SqlSmoObject.

(Inherited from SqlSmoObject)
CleanObject() CleanObject() CleanObject()

Sets the object to its unmodified state.

(Inherited from SqlSmoObject)
CreateImpl() CreateImpl() CreateImpl()

Creates an object with scripting options.

(Inherited from SqlSmoObject)
Discover() Discover() Discover()

Discovers a list of type Object.

(Inherited from SqlSmoObject)
DropImpl(Boolean) DropImpl(Boolean) DropImpl(Boolean)

Drops a SqlSmoObject.

(Inherited from SqlSmoObject)
DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean) DropImplWorker(Urn, Boolean)

Drops the IMPL worker.

(Inherited from SqlSmoObject)
ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean) ExecuteNonQuery(StringCollection, Boolean)

Executes a batch of statements that does not return a result set.

(Inherited from SqlSmoObject)
FormatSqlVariant(Object) FormatSqlVariant(Object) FormatSqlVariant(Object)

Formats an object as Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.

(Inherited from SqlSmoObject)
GenerateAlterEvent() GenerateAlterEvent() GenerateAlterEvent()

Generates the alter event with the specified value.

(Inherited from SqlSmoObject)
GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object) GenerateAlterEvent(Urn, Object)

Generates alter event with the specified URN and inner object value.

(Inherited from SqlSmoObject)
GetContextDB() GetContextDB() GetContextDB()

Gets the context database that is associated with this object.

(Inherited from SqlSmoObject)
GetDBName() GetDBName() GetDBName()

Gets the database name that is associated with the object.

(Inherited from SqlSmoObject)
GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption) GetFragOptionString(FragmentationOption)

Gets a FragmentationOption object as a string value.

(Inherited from SqlSmoObject)
GetPropValue(String) GetPropValue(String) GetPropValue(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptional(String) GetPropValueOptional(String) GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String) GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetRealValue(Property, Object) GetRealValue(Property, Object) GetRealValue(Property, Object)

Gets a property value of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetServerName() GetServerName() GetServerName()

Gets the name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetServerObject() GetServerObject() GetServerObject()

Gets the server of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetSqlServerVersionName() GetSqlServerVersionName() GetSqlServerVersionName()

Gets the version name of the instance of SQL Server with which the object is associated.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder) GetUrnRecursive(StringBuilder)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption) GetUrnRecursive(StringBuilder, UrnIdOption)

Assigns an Urn object of the SqlSmoObject object.

(Inherited from SqlSmoObject)
ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[]) ImplInitialize(String[], OrderBy[])

Initializes the fields of the SqlSmoObject object.

(Inherited from SqlSmoObject)
Initialize() Initialize() Initialize()

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
Initialize(Boolean) Initialize(Boolean) Initialize(Boolean)

Initializes the object and forces the properties be loaded.

(Inherited from SqlSmoObject)
IsObjectDirty() IsObjectDirty() IsObjectDirty()

Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server.

(Inherited from SqlSmoObject)
IsObjectInitialized() IsObjectInitialized() IsObjectInitialized()

Verifies whether the object has been initialized.

(Inherited from SqlSmoObject)
IsObjectInSpace() IsObjectInSpace() IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.

(Inherited from SqlSmoObject)
IsSupportedProperty(String) IsSupportedProperty(String) IsSupportedProperty(String)

Determines whether the specified property is supported in the target .NET Framework.

(Inherited from SqlSmoObject)
IsVersion80SP3() IsVersion80SP3() IsVersion80SP3()

Determines whether the version of SQL Server is SQL Server 2000 with SP3.

(Inherited from SqlSmoObject)
IsVersion90AndAbove() IsVersion90AndAbove() IsVersion90AndAbove()

Determines whether the version of SQL Server is SQL Server 2005 or later.

(Inherited from SqlSmoObject)
MarkDropped() MarkDropped() MarkDropped()

Sets the SqlSmoState to dropped.

(Inherited from SqlSmoObject)
MarkForDropImpl(Boolean) MarkForDropImpl(Boolean) MarkForDropImpl(Boolean)

Sets the SqlSmoState for drop operation.

(Inherited from SqlSmoObject)
PostAlter() PostAlter() PostAlter()

The method that is activated after the SqlSmoObject is altered.

(Inherited from SqlSmoObject)
PostCreate() PostCreate() PostCreate()

The method that is activated after the SqlSmoObject is created.

(Inherited from SqlSmoObject)
PostDrop() PostDrop() PostDrop()

The method that is activated after the SqlSmoObject is dropped.

(Inherited from SqlSmoObject)
Refresh() Refresh() Refresh()

Refreshes the object and retrieves properties when the object is next accessed.

(Inherited from SqlSmoObject)
ScriptImpl() ScriptImpl() ScriptImpl()

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions) ScriptImpl(ScriptingOptions)

Gets a collection of scripts of the SqlSmoObject.

(Inherited from SqlSmoObject)
SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject) SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String) ThrowIfAboveVersion100(String)

Throws the object if above version 100.

(Inherited from SqlSmoObject)
ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String) ThrowIfAboveVersion80(String)

Throws SqlSmoObject if version is above 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String) ThrowIfBelowVersion100(String)

Throws exception if the version is below 100.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String) ThrowIfBelowVersion110(String)

Throws the object if the version belows 110.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String) ThrowIfBelowVersion110Prop(String)

Throws the SqlSmoObject if version is below 110Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String) ThrowIfBelowVersion120(String)

Throws the object if the version is below 120.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String) ThrowIfBelowVersion120Prop(String)

Throws the object if the version belows 120 property.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String) ThrowIfBelowVersion130(String)

Throws the object if the version is below 130.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String) ThrowIfBelowVersion130Prop(String)

Throws an object if BelowVersion130Prop.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String) ThrowIfBelowVersion80(String)

Throws the object if the version is below 80.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3() ThrowIfBelowVersion80SP3()

Throws an exception if the version is below 80SP3.

(Inherited from SqlSmoObject)
ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String) ThrowIfBelowVersion90(String)

Throws the object if the version is below 90.

(Inherited from SqlSmoObject)
ToString() ToString() ToString()

Returns a String that represents the referenced object.

(Inherited from SqlSmoObject)
TouchImpl() TouchImpl() TouchImpl()

Implements a touch object.

(Inherited from SqlSmoObject)
UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean) UnbindDefaultImpl(Boolean)

Unbinds the default columns of the SqlSmoObject.

(Inherited from SqlSmoObject)
UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean) UnbindRuleImpl(Boolean)

Unbinds rules of the SqlSmoObject.

(Inherited from SqlSmoObject)
Validate(String, Object[]) Validate(String, Object[]) Validate(String, Object[])

Validates the state of an object.

(Inherited from SmoObjectBase)

Fields

m_ExtendedProperties m_ExtendedProperties m_ExtendedProperties

Represents a property that is defined to extend the properties provided by a SqlSmoObject.

(Inherited from SqlSmoObject)
singletonParent singletonParent singletonParent

Represents the singleton parent.

(Inherited from SqlSmoObject)

Explicit Interface Implementations

IAlienObject.Discover() IAlienObject.Discover() 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() IAlienObject.GetDomainRoot() IAlienObject.GetDomainRoot()

Returns the root of the domain.

(Inherited from SqlSmoObject)
IAlienObject.GetParent() IAlienObject.GetParent() 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(String) IAlienObject.GetPropertyType(String) IAlienObject.GetPropertyType(String)

Gets the type of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type) IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.

(Inherited from SqlSmoObject)
IAlienObject.GetUrn() IAlienObject.GetUrn() 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(String) IAlienObject.Resolve(String) IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.

(Inherited from SqlSmoObject)
IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState) IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.

(Inherited from SqlSmoObject)
IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object) IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.

(Inherited from SqlSmoObject)
ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet() ISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.

(Inherited from SqlSmoObject)

Events

PropertyChanged PropertyChanged PropertyChanged

Represents the event that occurs when a property is changed.

(Inherited from SqlSmoObject)
PropertyMetadataChanged PropertyMetadataChanged PropertyMetadataChanged

Represents the event that occurs when property metadata changes.

(Inherited from SqlSmoObject)

Applies to