View Source
Class UmbracoExamineIndex
An abstract provider containing the basic functionality to be able to query against Umbraco data.
Inheritance
System.Object
Assembly: Umbraco.Examine.Lucene.dll
Syntax
public abstract class UmbracoExamineIndex : LuceneIndex, IUmbracoIndex, IIndexDiagnostics
Constructors
View Source
UmbracoExamineIndex(ILoggerFactory, String, IOptionsMonitor<LuceneDirectoryIndexOptions>, IHostingEnvironment, IRuntimeState)
Declaration
protected UmbracoExamineIndex(ILoggerFactory loggerFactory, string name, IOptionsMonitor<LuceneDirectoryIndexOptions> indexOptions, IHostingEnvironment hostingEnvironment, IRuntimeState runtimeState)
Parameters
Type |
Name |
Description |
ILoggerFactory |
loggerFactory |
|
System.String |
name |
|
IOptionsMonitor<LuceneDirectoryIndexOptions> |
indexOptions |
|
IHostingEnvironment |
hostingEnvironment |
|
IRuntimeState |
runtimeState |
|
Properties
View Source
Performs special __Path and __Icon value transformations to all deriving indexes when set to true.
Declaration
protected virtual bool ApplySpecialValueTransformations { get; }
Property Value
Type |
Description |
System.Boolean |
|
View Source
EnableDefaultEventHandler
When set to true Umbraco will keep the index in sync with Umbraco data automatically
Declaration
public bool EnableDefaultEventHandler { get; set; }
Property Value
Type |
Description |
System.Boolean |
|
View Source
Declaration
public virtual IReadOnlyDictionary<string, object> Metadata { get; }
Property Value
Type |
Description |
IReadOnlyDictionary<System.String, System.Object> |
|
View Source
PublishedValuesOnly
Declaration
public bool PublishedValuesOnly { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
|
View Source
SupportProtectedContent
Declaration
public bool SupportProtectedContent { get; protected set; }
Property Value
Type |
Description |
System.Boolean |
|
Methods
View Source
CanInitialize()
Returns true if the Umbraco application is in a state that we can initialize the examine indexes
Declaration
protected bool CanInitialize()
Returns
Type |
Description |
System.Boolean |
|
View Source
IsHealthy()
Declaration
public Attempt<string> IsHealthy()
Returns
Type |
Description |
Attempt<System.String> |
|
View Source
OnDocumentWriting(DocumentWritingEventArgs)
This ensures that the special _Raw fields are indexed correctly
Declaration
protected override void OnDocumentWriting(DocumentWritingEventArgs docArgs)
Parameters
Type |
Name |
Description |
DocumentWritingEventArgs |
docArgs |
|
View Source
Declaration
protected override void OnTransformingIndexValues(IndexingItemEventArgs e)
Parameters
Type |
Name |
Description |
IndexingItemEventArgs |
e |
|
View Source
override to check if we can actually initialize.
Declaration
protected override void PerformDeleteFromIndex(IEnumerable<string> itemIds, Action<IndexOperationEventArgs>? onComplete)
Parameters
Type |
Name |
Description |
IEnumerable<System.String> |
itemIds |
|
System.Nullable<Action<IndexOperationEventArgs>> |
onComplete |
|
View Source
Declaration
protected override void PerformIndexItems(IEnumerable<ValueSet> values, Action<IndexOperationEventArgs> onComplete)
Parameters
Type |
Name |
Description |
IEnumerable<ValueSet> |
values |
|
Action<IndexOperationEventArgs> |
onComplete |
|