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
            }
          }
        }
      ]
    }
  ]
}

Legacy Index Creation (Obsolete)

The lucene-index step is obsolete but still supported:

{
  "steps": [
    {
      "name": "lucene-index",
      "Indices": [
        {
          "Search": {
            "AnalyzerName": "standard",
            "IndexLatest": false,
            "IndexedContentTypes": [
              "Article",
              "BlogPost"
            ]
          }
        }
      ]
    }
  ]
}

Reset Lucene Index

Restarts indexing from the beginning without deleting existing entries:

{
  "steps": [
    {
      "name": "ResetIndex",
      "indexNames": [
        "BlogPostsLucene"
      ]
    }
  ]
}

To reset all indices:

{
  "steps": [
    {
      "name": "ResetIndex",
      "IncludeAll": true
    }
  ]
}

Rebuild Lucene Index

Deletes and recreates the full index content:

{
  "steps": [
    {
      "name": "RebuildIndex",
      "indexNames": [
        "BlogPostsLucene"
      ]
    }
  ]
}

To rebuild all indices:

{
  "steps": [
    {
      "name": "RebuildIndex",
      "IncludeAll": true
    }
  ]
}

Creating a Lucene Query via Recipe

{
  "steps": [
    {
      "name": "Queries",
      "Source": "Lucene",
      "Name": "RecentBlogPosts",
      "Index": "Search",
      "Template": "{ \"query\": { \"match_all\": {} }, \"size\": 10 }",
      "ReturnContentItems": true
    }
  ]
}

Lucene Query Filters

Query filters retrieve records without considering boost values, similar to SQL filtering.

Bool filter with term and wildcard:

{
  "query": {
    "bool": {
      "filter": [
        {
          "term": {
            "Content.ContentItem.Published": "true"
          }
        },
        {
          "wildcard": {
            "Content.ContentItem.DisplayText": "Main*"
          }
        }
      ]
    }
  }
}

Bool with must and filter (filtering by content type):

{
  "query": {
    "bool": {
      "must": {
        "term": {
          "Content.ContentItem.ContentType.keyword": "Menu"
        }
      },
      "filter": [
        {
          "term": {
            "Content.ContentItem.Published": "true"
          }
        },
        {
          "wildcard": {
            "Content.ContentItem.DisplayText": "Main*"
          }
        }
      ]
    }
  }
}

Full-text search with query_string:

{
  "query": {
    "query_string": {
      "query": "Content.ContentItem.FullText:\"exploration\""
    }
  }
}

Full-text search with simple_query_string and default field:

{
  "query": {
    "simple_query_string": {
      "query": "\"exploration\"",
      "fields": [
        "Content.ContentItem.FullText"
      ]
    }
  }
}

Web APIs

api/lucene/content — Executes a query and returns content items.

Verbs: POST and GET

api/lucene/documents — Executes a query and returns Lucene documents (stored fields only).

Same parameters as api/lucene/content.

Lucene Worker

Enable OrchardCore.Search.Lucene.Worker to synchronize the local file system index across multiple instances. This creates a background task that keeps indexes in sync in a farm scenario.

Do not enable the Worker if:

• You are running a single instance.
• You are running on Azure App Services.
• You are using Elasticsearch instead of Lucene.

Indexing Custom Data

Register a custom indexing source in Startup.cs:

using OrchardCore.Modules;

namespace MyModule;

[Feature("MyModule.CustomLuceneIndex")]
public sealed class Startup : StartupBase
{
    private readonly IStringLocalizer<Startup> _localizer;

    public Startup(IStringLocalizer<Startup> localizer)
    {
        _localizer = localizer;
    }

    public override void ConfigureServices(IServiceCollection services)
    {
        services.AddLuceneIndexingSource("CustomSource", o =>
        {
            o.DisplayName = _localizer["Custom Source"];
            o.Description = _localizer["Create a Lucene index based on a custom data source."];
        });
    }
}

Automatic Field Mapping

Lucene automatically maps text fields with a .keyword suffix as stored values in the index, unless the document is already explicitly stored. Values longer than 256 characters are ignored. This enables any TextField to be searched using term queries by appending .keyword to the field name.

For example, to query by the exact DisplayText value, use Content.ContentItem.DisplayText.keyword in a term query.