View Source

Class GenericIndexDiagnostics

Used to return diagnostic data for any index

Inheritance
object
Namespace: Umbraco.Cms.Infrastructure.Examine
Assembly: Umbraco.Infrastructure.dll
Syntax
public class GenericIndexDiagnostics : IIndexDiagnostics

Constructors

View Source

GenericIndexDiagnostics(IIndex)

Declaration
public GenericIndexDiagnostics(IIndex index)
Parameters
Type Name Description
IIndex index

Properties

View Source

DocumentCount

Declaration
public int DocumentCount { get; }
Property Value
Type Description
int
View Source

FieldCount

Declaration
public int FieldCount { get; }
Property Value
Type Description
int
View Source

Metadata

A key/value collection of diagnostic properties for the index

Declaration
public IReadOnlyDictionary<string, object?> Metadata { get; }
Property Value
Type Description
IReadOnlyDictionary<string, object>
Remarks

Used to display in the UI

Methods

View Source

GetDocumentCount()

Declaration
public long GetDocumentCount()
Returns
Type Description
long
View Source

GetFieldNames()

Declaration
public IEnumerable<string> GetFieldNames()
Returns
Type Description
IEnumerable<string>
View Source

IsHealthy()

If the index can be open/read

Declaration
public Attempt<string?> IsHealthy()
Returns
Type Description
Attempt<string>

A successful attempt if it is healthy, else a failed attempt with a message if unhealthy