LinqToSolr 3.1.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package LinqToSolr --version 3.1.0
NuGet\Install-Package LinqToSolr -Version 3.1.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="LinqToSolr" Version="3.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add LinqToSolr --version 3.1.0
#r "nuget: LinqToSolr, 3.1.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.
// Install LinqToSolr as a Cake Addin
#addin nuget:?package=LinqToSolr&version=3.1.0

// Install LinqToSolr as a Cake Tool
#tool nuget:?package=LinqToSolr&version=3.1.0


alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image alternate text is missing from this package README image

LinqToSolr is an intuitive and lightweight C# library designed to enhance Solr queries with the power of Linq. It seamlessly integrates Solr search capabilities into .NET applications, facilitating cleaner and more maintainable code. LinqToSolr is suitable for developing complex search solutions or simplifying query logic.

nuget package: alternate text is missing from this package README image

To install:

dotnet add package LinqToSolr

Supported Methods

The library supports a variety of Linq methods, including but not limited to:

  • Where
  • First
  • FirstOrDefault
  • Select
  • Contains
  • Array.Contains(solrField)
  • StartsWith
  • EndsWith
  • GroupBy
  • Take
  • Skip
  • OrderBy
  • ThenBy
  • OrderByDescending
  • ThenByDescending
  • ToListAsync
  • AddOrUpdateAsync
  • DeleteAsync

Usage Instructions

Defining a Model

First, define a model class to represent your Solr document:

public class MyProduct{
  public int Id{get;set;}

  public string Name{get;set}
  public string Group{get;set}

  public bool IsDeleted{get;set}
  public string[] Tags{get;set;}

  public string CustomField{}


Initialize a configuration class for the service:

var solrConfig = new LinqToSolrConfiguration("http://localhost:8983/") // URL to Solr instance, if solr has different location (not under/solr) set it to  http://localhost:8983/somecustomlocation
                .MapCoreFor<MyProduct>("MyProductIndex"); // Mapping your model to Solr Index
Creating a Service

Instantiate the base service and provide the configuration:

var solrService = new LinqToSolrService(solrConfig);
Extending LinqToSolrService

You may create a custom service that inherits from LinqToSolrService:

public class MyProductService: LinqToSolrService{

  private  Task<IQueryable<>> IQueryable<MyProduct> IsNotDeleted()
       return  AsQueryable<MyProduct>().Where(x=> !x.IsDeleted);

  public async Task<ICollection<MyProduct>> GetProductsByIds(params int[] ids)
      return await IsNotDeleted().Where(x=> ids.Contains(x.Id)).ToListAsync();

Linq Query Examples

Where Clause
await solrService.AsQueryable<MyProduct>().Where(x => x.Group == "MyGroup1").ToListAsync();
var groupArray = new[] { "MyGroup1", "MyGroup2", "MyGroup3", "MyGroup4" };
var product = await solrService.AsQueryable<MyProduct>().FirstOrDefault(x => x.Id == 123);
OrderBy & OrderByDescending
var orderedProducts = await solrService.AsQueryable<MyProduct>()
                                        .Where(x => x.Group == "MyGroup1")
                                        .OrderBy(x => x.Id)
                                        .ThenByDescending(x => x.Name)
Contains Examples
solrService.AsQueriable<MyProduct>().Where(x=> x.Name.Contains("productName")).ToList();
var array = new[]{"str2", "str3", "str4"};
solrService.AsQueriable<MyProduct>().Where(x=> array.Contains(x.Name)).ToList();
solrService.AsQueriable<MyProduct>().Where(x=> x.Tags.Contains("tag1")).ToList();
OrderBy & OrderByDescending
await solrService.AsQueriable<MyProduct>().Where(x=> x.Group == "MyGroup1").OrderBy(x=>x.Id).ThenByDescending(x=>x.Name).ToListAsync();
Select Clause
solrService.AsQueriable<MyProduct>().Where(x=> x.Group == "MyGroup1").Select(x=x.Name).ToList();
solrService.AsQueriable<MyProduct>().Where(x=> x.Group == "MyGroup1").Select(x=x new {x.Name, x.Group}).ToList();

Solr Document Interaction

Adding or Updating Documents Add or update documents in a Solr core:

var products = new[] {
    new MyProduct { Id = 1, Name = "Product One" },
    new MyProduct { Id = 2, Name = "Product Two" },
    new MyProduct { Id = 3, Name = "Product Three" }

await solrService.AddOrUpdateAsync(products);

Deleting Documents Delete documents by specifying an array of ids:

await solrService.Where(x => x.Id == 123).DeleteAsync<MyProduct>();
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. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.1 is compatible.  netstandard1.2 is compatible.  netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 is compatible.  netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  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 tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 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
3.1.1 80 2/29/2024
3.1.0 76 2/28/2024 6,599 7/11/2017
2.1.1 1,030 7/6/2017 1,098 6/20/2017 1,096 6/12/2017 1,073 6/7/2017 1,067 6/6/2017 1,199 6/5/2017 1,108 5/8/2017 838 5/8/2017 1,161 4/27/2017 973 4/27/2017 1,015 4/21/2017 1,001 4/20/2017