MeiliSearch .NET

MeiliSearch | Website | Blog | Twitter | Documentation | FAQ

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

MeiliSearch .NET is a client for MeiliSearch written in C#. 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.

🔧 Installation
🚀 Getting started
🤖 Compatibility with MeiliSearch
🎬 Examples
⚙️ Development Workflow

🔧 Installation

// TODO

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

// TODO

🤖 Compatibility with MeiliSearch

This package is compatible with the following MeiliSearch versions:

v0.11.X

🎬 Examples

Indexes

Create an index

var index = client.CreateIndex("uid1");

Create an index and give the primary-key

client.CreateIndex("uid2", "movieId");

List all an index

var client = new MeilisearchClient(_httpClient);
var indexes = await client.GetAllIndexes();

Get an Index object

 var client = new MeilisearchClient(_httpClient);
 var indexes = await client.GetIndex("somerandomIndex");

Documents

Add Documents

 var updateStatus = await index.AddorUpdateDocuments(new[]{new  Movie {Id = "1", Name = "Batman"}});

Update Status has a reference UpdateId to get status of the action.

Get Documents

 var documents = await index.GetDocuments<Movie>(new DocumentQuery {Limit = 1});

Get Document by Id

var documents = await index.GetDocument<Movie>("10");

Delete documents

 var updateStatus = await index.DeleteOneDocument("11");

Delete in Batch

var updateStatus = await index.DeleteDocuments(new []{"12","13","14"});

Delete all documents

var updateStatus = await indextoDelete.DeleteAllDocuments();

Update Status

Get Update Status By Id

 UpdateStatus individualStatus = await index.GetUpdateStatus(1);

Get All Update Status

 var status = await index.GetAllUpdateStatus();

Search

Basic Search

var movies = await this.index.Search<Movie>("ironman");

Custom Search

var movies = await this.index.Search<Movie>("ironman", new SearchQuery {Limit = 100});

⚙️ Development Workflow

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

Tests

$ docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --no-analytics=true
$ dotnet restore
$ dotnet test

Release

MeiliSearch tools follow the Semantic Versioning Convention.

You must do a PR modifying the file src/Meilisearch/Meilisearch.csproj with the right version.

<Version>X.X.X</Version>

Once the changes are merged on master, you can publish the current draft release via the GitHub interface.

A GitHub Action will be triggered and push the new package to Nuget.

MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.

tpayet/meilisearch-dotnet