https://github.com/joymoe/pgroonga.entityframeworkcore

PGroonga extension for Npgsql.EntityFrameworkCore.PostgreSQL (PostgreSQL / Npgsql Entity Framework Core provider). It enable the ability to do full text search, especially Chinese, Japanese, and so on, with EntityFramework Core, PostgreSQL and Groonga.
https://github.com/joymoe/pgroonga.entityframeworkcore

dotnet entity-framework-core full-text-search groonga npgsql pgroonga postgres postgresql

Last synced: 3 days ago
JSON representation

PGroonga extension for Npgsql.EntityFrameworkCore.PostgreSQL (PostgreSQL / Npgsql Entity Framework Core provider). It enable the ability to do full text search, especially Chinese, Japanese, and so on, with EntityFramework Core, PostgreSQL and Groonga.

• Host: GitHub
• URL: https://github.com/joymoe/pgroonga.entityframeworkcore
• Owner: JoyMoe
• License: mit
• Created: 2018-12-25T15:57:30.000Z (about 6 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-04T05:58:17.000Z (about 2 years ago)
• Last Synced: 2025-01-02T23:38:19.895Z (22 days ago)
• Topics: dotnet, entity-framework-core, full-text-search, groonga, npgsql, pgroonga, postgres, postgresql
• Language: PowerShell
• Homepage:
• Size: 291 KB
• Stars: 4
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PGroonga.EntityFrameworkCore

[PGroonga](https://pgroonga.github.io) extension for [Npgsql.EntityFrameworkCore.PostgreSQL](https://github.com/npgsql/Npgsql.EntityFrameworkCore.PostgreSQL) (PostgreSQL / Npgsql Entity Framework Core provider). It enable the ability to do full text search, especially Chinese, Japanese, and so on, with EntityFramework Core, PostgreSQL and Groonga.

![postgresql](postgresql.png)![pgroonga](pgroonga.png)

[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/JoyMoe/PGroonga.EntityFrameworkCore/build)](https://github.com/JoyMoe/PGroonga.EntityFrameworkCore/actions?query=workflow%3Abuild)

[![Codecov](https://img.shields.io/codecov/c/gh/JoyMoe/PGroonga.EntityFrameworkCore)](https://codecov.io/gh/JoyMoe/PGroonga.EntityFrameworkCore)

[![License](https://img.shields.io/github/license/JoyMoe/Base62.Net.svg)](https://github.com/JoyMoe/Base62.Net/blob/master/LICENSE)

[![NuGet](https://img.shields.io/nuget/v/PGroonga.EntityFrameworkCore.svg)](https://www.nuget.org/packages/PGroonga.EntityFrameworkCore)

[![NuGet](https://img.shields.io/nuget/vpre/PGroonga.EntityFrameworkCore.svg)](https://www.nuget.org/packages/PGroonga.EntityFrameworkCore/absoluteLatest)

![netstandard2.0](https://img.shields.io/badge/.Net-netstandard2.0-brightgreen.svg)

## Attention

`EF.Functions.Pgroonga*` only works with `Npgsql.EntityFrameworkCore.PostgreSQL` >= 2.2.6 and >= 3.0.1 due to [aspnet/EntityFrameworkCore#13454](https://github.com/aspnet/EntityFrameworkCore/issues/13454).

## Usage

```csharp

public class ApplicationDbContext : DbContext

{

    // ...

    protected override void OnModelCreating(ModelBuilder modelBuilder)

    {

        base.OnModelCreating(modelBuilder);

        // ...

        modelBuilder.Entity()

            .HasIndex(g => g.Content)

            .HasMethod("pgroonga")

            .HasOperators("pgroonga_varchar_full_text_search_ops_v2");

    }

}

public class Startup

{

    // ...

    public void ConfigureServices(IServiceCollection services)

    {

        services.AddDbContextPool(options =>

            options.UseNpgsql(Configuration.GetConnectionString("DefaultConnection"),

            builder => builder.UsePGroonga()));

        // ...

    }

}

var posts = await _dbContext.Posts.Where(g => g.Content.SimilarSearch(q))

    .OrderByDescending(g => EF.Functions.PgroongaScore())

    .ToArrayAsync();

```

For more information, see `PGroongaLinqExtensions` and `PGroongaDbFunctionsExtensions`.

## Features

* [x] Operators

  * [x] ~`LIKE`~ same as PostgreSQL standard `LIKE`

  * [x] ~`ILIKE`~ same as PostgreSQL standard `ILIKE`

  * [x] ==== pgroonga_xxx_full_text_search_ops[_v2] ====

  * [x] `&@` Match

  * [x] `&@~` Query

  * [x] `&@*` SimilarSearch

  * [x] `` &` `` ScriptQuery

  * [x] `&@|` MatchIn

  * [x] `&@~|` QueryIn

  * [x] ==== pgroonga_xxx_term_search_ops[_v2] ====

  * [x] `&^` PrefixSearch

  * [x] `&^~` PrefixRkSearch

  * [x] `&^|` PrefixSearchIn

  * [x] `&^~|` PrefixRkSearchIn

  * [x] ==== pgroonga_xxx_regexp_ops[_v2] ====

  * [x] `&~` RegexpMatch

* [x] Functions

  * [x] `pgroonga_command`

  * [x] `pgroonga_command_escape_value`

  * [x] `pgroonga_escape`

  * [x] `pgroonga_flush`

  * [x] `pgroonga_highlight_html`

  * [x] `pgroonga_is_writable`

  * [x] `pgroonga_match_positions_byte`

  * [x] `pgroonga_match_positions_character`

  * [x] `pgroonga_normalize`

  * [x] `pgroonga_query_escape`

  * [x] `pgroonga_query_expand`

  * [x] `pgroonga_query_extract_keywords`

  * [x] `pgroonga_set_writable`

  * [x] `pgroonga_score`

  * [x] `pgroonga_snippet_html`

  * [x] `pgroonga_table_name`

  * [x] `pgroonga_wal_apply`

  * [x] `pgroonga_wal_truncate`

## License

The MIT License

More info see [LICENSE](LICENSE)