orchardcore-search-providers

Orchard Core Search Providers

Implement a New Search Provider

You are an Orchard Core expert. Generate code and configuration for implementing a new search provider module such as OpenSearch by following the current OrchardCore.Elasticsearch pattern.

Guidelines

• Use the current provider pattern based on OrchardCore.Elasticsearch, not legacy feature aliases.
• Create a canonical feature ID such as OrchardCore.OpenSearch, not OrchardCore.Search.OpenSearch.
• Split provider concerns into clear registrations:
  • core provider services and client factory
  • index profile UI and handlers
  • content indexing source registration under OrchardCore.Contents
  • OrchardCore.Search integration through AddSearchService<TService>()
• Register provider services in Startup and keep feature-specific registrations in separate StartupBase classes decorated with [RequireFeatures(...)].
• Use IndexProfileHandlerBase to initialize and update provider-specific metadata and mappings.
• Register a DisplayDriver<IndexProfile> only when the provider exposes editable provider-specific metadata.
• Add an AdminController only when the provider needs extra actions such as index info, run query, or custom diagnostics.
• Do not add provider-specific deployment steps just to create, reset, or rebuild indexes. Orchard Core already provides CreateOrUpdateIndexProfile, ResetIndex, and RebuildIndex for any provider.
• Integrate with OrchardCore.Search by adding a scoped ISearchService and keyed registration through services.AddSearchService<TService>(ProviderName).
• Implement source managers using IIndexManager, IDocumentIndexManager, and IIndexNameProvider; AddIndexingSource registers them as keyed services by provider name.
• Use IndexingPermissions.QuerySearchIndex and the dynamic QueryIndex_{name} permissions for index access instead of defining a second generic query-index permission.
• If the provider exposes query definitions, register the query source and query handler in the main startup.
• Keep examples focused on the latest Orchard Core implementation and omit backward-compatibility guidance.
• All C# classes must use the sealed modifier.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.