ObjectSearch.Net 1.2.0

dotnet add package ObjectSearch.Net --version 1.2.0
                    
NuGet\Install-Package ObjectSearch.Net -Version 1.2.0
                    
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="ObjectSearch.Net" Version="1.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="ObjectSearch.Net" Version="1.2.0" />
                    
Directory.Packages.props
<PackageReference Include="ObjectSearch.Net" />
                    
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 ObjectSearch.Net --version 1.2.0
                    
#r "nuget: ObjectSearch.Net, 1.2.0"
                    
#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 ObjectSearch.Net@1.2.0
                    
#: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=ObjectSearch.Net&version=1.2.0
                    
Install as a Cake Addin
#tool nuget:?package=ObjectSearch.Net&version=1.2.0
                    
Install as a Cake Tool

ObjectSearch.NET

ObjectSearch is a lightweight in memory search engine using Lucene.

It allows you to use Lucene search engine query semantics over a collection of in-memory objects.

Console.WriteLine("Objects match: +big cat");
foreach(var result in items.Search("+big cat"))
{
    Console.WriteLine($"{result.Score} {JsonConvert.SerializeObject(result.Value)}");
}

ObjectSearchEngine

ObjectSearchEngine represents a search engine over a collection of objects. You can call multiple times without penalty as the lifetime of the search index is managed by ObjectSearchEngine.

Example

// search over items collection.
var searchEngine = new ObjectSearchEngine()
    .AddObjects(items);

var results1 = searchEngine.Search("foo bar");
var results2 = searchEngine.Search("big cat");

Linq style .Search() operator

The Linq style .Search() operator will build an index on the fly over the collection of objects and then do a full text search over the collection.

You can do further Linq operations on it like .Select(), .Where(), etc.

// find adults named joe 
foreach(var item in items.Where(item => item.Age >= 18)
                        .Search("joe")
                        .Select(searchResult => searchResult.Value)
                        .Take(5))
{
    ...
}

Issuing multiple queries with Linq

All SearchResults<T> and SearchResult<T> have a reference to the ObjectSearchEngine used to create the results allowing you to issue multiple queries and it will all be backed by the same search index built over the original collection of items.

var bigDogs = items.Search("big dogs"); // creates a new index over items
var littleDogs = results.SearchEngine.Search("little dogs"); // uses the same engine (GOOD)

var bigCats = items.Search("big cats"); // creates a new index over items
var littleCats = items.Search("little cats"); // creates a duplicate index over items (BAD)

Controlling indexing

Default content

By default the object is serialized as JSON object stored as default field of "content".

You can override this by simply providing a object=>content selector function to AddObjects() or Search linq operator.

// defining using AddObjects()
var engine = new ObjectSearchEngine()
    .AddObjects(items, (item) => item.Title); // <-- this will build index on title content only.

// You can also do this for Linq .Search operator
foreach(var item in items.Search("christmas", (item) => item.Title))
    ...

Additional Custom fields

You can add additional fields by implementing a doc selector action.

// index "title" as additional field
foreach(var item in items.Search("title:christmas", (record, doc) => doc.AddTextField("title", record.Title, Field.Store.NO))
{
    ...
}

If you add a "content" field you will override the normal behavior of searching over the JSON respresentation of the object.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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.2.0 100 5/9/2025
1.1.0 153 10/18/2024
1.0.0 138 10/18/2024