EFCore.ParadeDB.PgSearch 0.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package EFCore.ParadeDB.PgSearch --version 0.1.0
                    


                    

                
NuGet\Install-Package EFCore.ParadeDB.PgSearch -Version 0.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="EFCore.ParadeDB.PgSearch" Version="0.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="EFCore.ParadeDB.PgSearch" Version="0.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="EFCore.ParadeDB.PgSearch" />
                    


                            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 EFCore.ParadeDB.PgSearch --version 0.1.0
                    


                    

                
#r "nuget: EFCore.ParadeDB.PgSearch, 0.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. 
#:package EFCore.ParadeDB.PgSearch@0.1.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=EFCore.ParadeDB.PgSearch&version=0.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=EFCore.ParadeDB.PgSearch&version=0.1.0
                    


                            Install as a Cake Tool

EFCore.ParadeDB.PgSearch

Build License

EFCore.ParadeDB.PgSearch adds ParadeDB's pg_search extension support to Npgsql.EntityFrameworkCore.PostgreSQL. It exposes ParadeDB search functions through EF.Functions API for LINQ-based full-text search queries. BM25 index creation must be done via raw SQL. See the EF Core documentation for more details on adding raw SQL to migrations.

Configuration

Install the Npgsql.EntityFrameworkCore.PostgreSQL NuGet package and configure your DbContext by calling UsePgSearch() on the NpgsqlDbContextOptionsBuilder to enable pg_search function mappings.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddDbContextPool<AppDbContext>(opt =>
{
    opt.UseNpgsql(
        builder.Configuration.GetConnectionString("AppDatabase"),
        o => o.UsePgSearch()
    );
});

Register the pg_search extension in the DbContext.

public class AppDbContext : DbContext
{
    public AppDbContext(DbContextOptions<AppDbContext> options)
        : base(options) { }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        base.OnModelCreating(modelBuilder);

        modelBuilder.HasPostgresExtension("pg_search");
    }
}

A complete example is also available in the samples directory demonstrating PgSearch configuration and BM25 index creation.

Function Mappings

The following ParadeDB operations are available through the EF.Functions API:

ParadeDB Operation LINQ Methods
Match MatchDisjunction(), MatchConjunction()
Phrase Phrase()
Term Term()
BM25 scoring Score()
Highlighting Snippet()
Proximity Proximity(), ProximityRegex()

Usage Example

var products = await dbContext
    .Products.Where(p =>
        EF.Functions.MatchDisjunction(
            p.Description,
            "with shoes and",
            Fuzzy.With(1),
            Boost.With(2.3f)
        )
    )
    .Select(p => new
    {
        p.Id,
        p.Description,
        Score = EF.Functions.Score(p.Id),
    })
    .ToListAsync();

Translates to:

SELECT p.id AS "Id", p.description AS "Description", COALESCE(paradedb.score(p.id), 0) AS "Score"
FROM products AS p
WHERE p.description ||| 'with shoes and'::fuzzy(1)::boost(2.3)
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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 is compatible.  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. 
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
0.1.0 232 9/26/2025