orchardcore-lucene

Orchard Core Lucene Search - Prompt Templates

Configure Lucene Search

You are an Orchard Core expert. Generate code and configuration for Lucene-based full-text search in Orchard Core.

Guidelines

• Enable OrchardCore.Lucene to manage Lucene indexes.
• Lucene indexes are stored on the local file system under /App_Data/Sites/{TenantName}/Lucene/{IndexName}.
• Use the CreateOrUpdateIndexProfile recipe step to create indexes (preferred over the obsolete lucene-index and LuceneIndexSettings steps).
• Use the ResetIndex recipe step to restart indexing from the beginning without deleting existing entries (preferred over the obsolete lucene-index-reset step).
• Use the RebuildIndex recipe step to delete and recreate the full index (preferred over the obsolete lucene-index-rebuild step).
• Lucene queries use Elasticsearch Query DSL syntax.
• Supported query types: bool, match, match_all, match_phrase, term, terms, wildcard, prefix, fuzzy, range, regexp, query_string, simple_query_string, geo_distance, geo_bounding_box.
• Text fields with a .keyword suffix are automatically stored in the index (max 256 chars) for term-level queries.
• Enable OrchardCore.Search.Lucene.Worker only when running the same tenant on multiple instances (farm) with a file system index.
• All recipe JSON must be wrapped in { "steps": [...] }.
• All C# classes must use the sealed modifier.

Enabling Lucene Features

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

Creating a Lucene Index Profile (Recommended)

Use CreateOrUpdateIndexProfile to create a Lucene index for content items:

{
  "steps": [
    {
      "name": "CreateOrUpdateIndexProfile",
      "indexes": [
        {
          "Name": "BlogPostsLucene",
          "IndexName": "blogposts",
          "ProviderName": "Lucene",
          "Type": "Content",
          "Properties": {
            "ContentIndexMetadata": {
              "IndexLatest": false,
              "IndexedContentTypes": ["BlogPost"],
              "Culture": "any"
            },
            "LuceneIndexMetadata": {
              "AnalyzerName": "standard",
              "StoreSourceData": true
            }
          }
        }
      ]
    }
  ]
}