FluentCMS.Plugins.Search 1.0.0-preview.1

This is a prerelease version of FluentCMS.Plugins.Search.
dotnet add package FluentCMS.Plugins.Search --version 1.0.0-preview.1
                    
NuGet\Install-Package FluentCMS.Plugins.Search -Version 1.0.0-preview.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FluentCMS.Plugins.Search" Version="1.0.0-preview.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluentCMS.Plugins.Search" Version="1.0.0-preview.1" />
                    
Directory.Packages.props
<PackageReference Include="FluentCMS.Plugins.Search" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FluentCMS.Plugins.Search --version 1.0.0-preview.1
                    
#r "nuget: FluentCMS.Plugins.Search, 1.0.0-preview.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package FluentCMS.Plugins.Search@1.0.0-preview.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=FluentCMS.Plugins.Search&version=1.0.0-preview.1&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=FluentCMS.Plugins.Search&version=1.0.0-preview.1&prerelease
                    
Install as a Cake Tool

FluentCMS.Plugins.Search

Full-text search for q= on the Delivery and Management lists. The plugin fills the ISearchIndex provider slot with an index of the fields marked [Searchable], keeps it current from the entry events and rebuilds it on request. Section 5.7 of the backend technical specification has the full design.

The plugin is named search. It has no options.

builder.Services.AddFluentCms(cms =>
{
    cms.UsePostgreSql(builder.Configuration.GetConnectionString("cms"));
    cms.AddPlugin<SearchPlugin>();
});

What a search finds

  • The text of the fields of a content type marked [Searchable] ("searchable": true in a schema file), at the top level of the type and not [Hidden]: text, the texts of a list such as a multiple select, and rich text as plain text. Numbers, dates, relations, media, components and blocks have no text to search.
  • Every word of the search must match, and the last one matches as the start of a word, so a search box finds while the editor types: release no finds "Release notes". Case and accents do not count: cafe finds "Café". On SQL Server every word matches as a part of the text, so otnet finds "dotnet" there and nowhere else.
  • The index finds ids, and the list keeps its filter, row rule, site, locale, status, sort and page, so a search never shows an entry the caller could not list. A draft is found with status=draft and on Delivery only once it is published.
  • The index gives at most FluentCms:Query:MaxSearchResults ids (1,000): those of the type, locale, state and site of the query that match, the most recently indexed first. The filter and the row rule of the query apply after that cap. So when more entries match than the cap, a reader can miss entries it may read, because entries it may not read, or that the filter leaves out, took their places among the 1,000. A longer search narrows the matches. There is no ranking by relevance and no stemming or stop words for a language.
  • A type without such a field refuses q= with FCMS1700 (400), and a site where the plugin is disabled with FCMS2211 (400), as a host without an index does.
  • Any caller who may list the type can learn whether an entry holds a word of a searchable field, even a caller who may not read that field. Mark only fields whose text every reader of the type may know.

The text is folded the same way for every database: lower case, the accents taken off, and words of letters and digits, so punctuation separates words. One entry keeps at most 100,000 characters of it.

Database Index
SQLite an FTS5 table, cms_search_entry_fts, over the text of cms_search_entry, which triggers keep in step
PostgreSQL a GIN index over to_tsvector('simple', text)
SQL Server none: LIKE '%word%' over the text, which reads every row of the type, locale and state. A full-text catalogue is not used, so the plugin runs on every edition and on Azure SQL; with a large index, search on PostgreSQL or SQLite is faster

The tables are the stream cms_search__migrations, one migration, the baseline Initial, in a set per provider. The FTS5 table and the GIN index are written by hand into the SQLite and PostgreSQL migrations.

Keeping the index current

The outbox handlers of the entry events (a draft saved, published, unpublished, a draft discarded, a version restored, trashed, restored and purged) read the entry again through the content service and write its rows, one for each locale and state. So a change is found once its events are delivered, a moment after the write, and a delivery that fails is tried again by the outbox. An import and a seed raise the same events. A delete or a purge removes every row of the entry, in every locale, whatever the site allows, so q= on the trash list finds nothing. A restore writes the rows again in the locales the restoring site allows; the other locales of a global entry come back when a site that allows them rebuilds, or when the entry changes there. The rows of a site go with the site.

A delete or a purge made while the plugin is disabled in the site reaches no handler of the plugin, so the entry's rows stay until the plugin is enabled there again, whose rebuild removes them, or the site is deleted. They are never served: the site refuses q= meanwhile, and in another site the list keeps out an entry that is deleted or gone. The plugin hears nothing when it is disabled in a site, since core gives none of the site's events to a plugin disabled there, so it cannot remove the rows at that moment.

Core evicts the Delivery copies of the type through the outbox too, and the plugin's handlers start first. When a Delivery search runs between that eviction and the plugin's delivery, as after a delivery of the plugin that failed and runs later, the output cache can serve the older answer until the type changes again or OutputCacheDuration (60 seconds) ends.

Rebuild

POST /api/management/v1/search/rebuild
Content-Type: application/json

{ "type": "article" }

needs search.manage in the site of the request, answers 202 with { "jobId" } and queues the job search.rebuild for that site, which fluentcms jobs list shows. Without a body, or without type, it rebuilds every type with a searchable field. The job reads the entries of the site and of the global types, the drafts and the published versions, a page at a time, writes what differs and removes the rows of entries that no longer exist. A second run writes nothing, and an attempt that fails starts again. A type that is unknown is FCMS1701 (422), and one without a searchable field FCMS1700.

Run it once:

  • when you add the plugin to a host that already has content;
  • after a schema change that marks a field [Searchable], or no longer, since the rows change only as entries change.

A list reads one locale, so the job lists a localized type in each locale the site allows among the site's default, the locales that the entries in it hold, and the locales the index holds. An entry that exists only in a locale that none of those has is not found by the rebuild, and is indexed at its next change. The rows of the site in a locale it no longer allows are removed. The rows of a global type in a locale the site does not allow are left alone, since another site may allow it, so a rebuild of one site never removes what another site reads.

Per site

Where the plugin is disabled in a site, q= is refused there, and its handlers hear nothing of the site (4.13). Enabling it again queues a rebuild of the site (event 9382). The rows of a global type are shared by every site, so a change to a global entry made in a site where the plugin is disabled reaches them only with a rebuild. A change to a global entry made in a site rewrites its rows in the locales that site allows, and leaves those in other locales to the sites that allow them; a delete or a purge removes them all.

Codes and log events

Code Status Meaning
FCMS1700 400 the type has no field marked [Searchable]
FCMS1701 422 a rebuild that names no content type

FCMS1702 to FCMS1719 are free. Log event ids: 9380 a rebuild with what it wrote and removed, 9381 the rows of a deleted site, 9382 a rebuild queued when the plugin is enabled in a site and 9383 an entry that could not be read for the index, of 9380 to 9399. No line holds the text of an entry.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-preview.1 52 11/16/2026