orchardcore-indexing

Orchard Core Indexing Infrastructure - Prompt Templates

Configure Indexing Infrastructure

You are an Orchard Core expert. Generate code and configuration for the Orchard Core indexing infrastructure, including custom indexing sources and index lifecycle management.

Guidelines

• Enable OrchardCore.Indexing as the core indexing module that provides the abstraction layer for all index providers.
• The indexing module is provider-agnostic and supports Lucene, Elasticsearch, and Azure AI Search.
• The module maintains an append-only log of indexing tasks (Update or Delete) using a cursor-based interface.
• Content item indexing is a consumer of the core indexing infrastructure, not a hard requirement.
• Custom data sources (REST APIs, databases, in-memory structures) can be indexed alongside content items.
• Use the CreateOrUpdateIndexProfile recipe step to create or update index profiles.
• Use the ResetIndex recipe step to restart indexing without deleting existing entries.
• Use the RebuildIndex recipe step to delete and recreate the full index.
• Reset and rebuild operations run asynchronously in the background.
• The admin UI is available under Search > Indexes for index lifecycle management.
• All recipe JSON must be wrapped in { "steps": [...] }.
• All C# classes must use the sealed modifier.

Enabling the Indexing Module

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Indexing"
      ],
      "disable": []
    }
  ]
}

Index Profile Architecture

The indexing module uses an append-only task log where each entry represents either an Update or a Deletion. Consumers track changes independently using their own cursor positions. This enables:

• Processing changes at individual pace.
• Implementing custom search pipelines.
• Integrating with analytics, auditing, or event-driven workflows.
• Loose coupling between the indexing infrastructure and data consumers.

Creating an Index Profile via Recipe