MeiliSearch .NET

MeiliSearch | Website | Blog | Twitter | Documentation | FAQ

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in C#

MeiliSearchDotnet is a client for MeiliSearch written in .NET standard 2.0. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.

Table of Contents

• 🔧 Installation
• 🚀 Getting started
• ⚙️ Development workflow
• 🤖 Compatibility with MeiliSearch

🔧 Installation

It's available as NuGet package :

dotnet add package MeilisearchDotnet --version 0.0.8

https://www.nuget.org/packages/MeilisearchDotnet

🏃‍♀️ Run MeiliSearch

There are many easy ways to download and run a MeiliSearch instance.

For example, if you use Docker:

docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🎬 Getting started

Here is a quickstart how to add / update documents

using System.Collections.Generic;
using System.Threading.Tasks;

using MeilisearchDotnet;

namespace console
{
    public class Doc
    {
        public int Key1 { get; set; }
        public string Value { get; set; }
    }
    class Program
    {
        static async Task Main(string[] args)
        {
            Meilisearch ms = new Meilisearch("http://localhost:7700", "masterKey");
            Index index = await ms.GetOrCreateIndex(new IndexRequest
            {
                Uid = "kero",
                PrimaryKey = "Key1"
            });

            EnqueuedUpdate ret = await index.AddDocuments<Doc>(new List<Doc>() {
                new Doc { Key1 = 222, Value = "aaa" },
                new Doc { Key1 = 333, Value = "bbb" }
            });

            await index.WaitForPendingUpdate(ret.UpdateId);

            Doc doc = await index.GetDocument<Doc>("222");

            // doc => { Key1 = 222, Value = "aaa" }

            ret = await index.AddDocuments<Doc>(new List<Doc>() {
                new Doc { Key1 = 444, Value = "aaa" },
                new Doc { Key1 = 555, Value = "bbb" }
            }, new AddDocumentParams
            {
                PrimaryKey = "Key1"
            });

            await index.WaitForPendingUpdate(ret.UpdateId);

            ret = await index.UpdateDocuments(new List<Doc>() {
                new Doc { Key1 = 222, Value = "tpayet" },
                new Doc { Key1 = 444, Value = "tutu" }
            });

            await index.WaitForPendingUpdate(ret.UpdateId);

            doc = await index.GetDocument<Doc>("222");

            // doc => { Key1 = 222, Value = "tpayet" }
        }
    }
}

Search in index

// MeiliSearch is typo-tolerant:
SearchResponse<Doc> result = await index.Search<Doc>("tpyaet");
// result => {
//   "Hits": [{"Key1": 222,"Value": "tpayet"}],
//   "Offset": 0,
//   "Limit": 20,
//   "ProcessingTimeMs": 1,
//   "Query": "tpyaet"
// }

⚙️ Development Workflow

If you want to contribute, this sections describes the steps to follow.

Tests

# Tests
docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics
dotnet restore
dotnet test

Release

MeiliSearch tools follow the Semantic Versioning Convention.

You must do a PR modifying the file meilisearch-dotnet.csproj with the right version.

<Version>x.x.x</Version>

🤖 Compatibility with MeiliSearch

This package works for MeiliSearch >=0.10.x