CommunityToolkit.Aspire.Meilisearch 8.3.0

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

// Install CommunityToolkit.Aspire.Meilisearch as a Cake Tool
#tool nuget:?package=CommunityToolkit.Aspire.Meilisearch&version=8.3.0                

CommunityToolkit.Aspire.Meilisearch

Registers a MeilisearchClient in the DI container for connecting to a Meilisearch.

Getting started

Prerequisites

  • Meilisearch cluster.

Install the package

Install the .NET Aspire Meilisearch Client library with NuGet:

dotnet add package CommunityToolkit.Aspire.Meilisearch

Usage example

In the Program.cs file of your project, call the AddMeilisearchClient extension method to register a MeilisearchClient for use via the dependency injection container. The method takes a connection name parameter.

builder.AddMeilisearchClient("meilisearch");

Configuration

The .NET Aspire Meilisearch Client integration provides multiple options to configure the server connection based on the requirements and conventions of your project.

Use a connection string

When using a connection string from the ConnectionStrings configuration section, you can provide the name of the connection string when calling builder.AddMeilisearchClient():

builder.AddMeilisearchClient("meilisearch");

And then the connection string will be retrieved from the ConnectionStrings configuration section:

{
    "ConnectionStrings": {
        "meilisearch": "Endpoint=http://localhost:19530/;MasterKey=123456!@#$%"
    }
}

Use configuration providers

The .NET Aspire Meilisearch Client integration supports Microsoft.Extensions.Configuration. It loads the MeilisearchClientSettings from configuration by using the Aspire:Meilisearch:Client key. Example appsettings.json that configures some of the options:

{
  "Aspire": {
    "Meilisearch": {
      "Client": {
        "Endpoint": "http://localhost:19530/",
        "MasterKey": "123456!@#$%"
      }
    }
  }
}

Use inline delegates

Also you can pass the Action<MeilisearchClientSettings> configureSettings delegate to set up some or all the options inline, for example to set the API key from code:

builder.AddMeilisearchClient("meilisearch", settings => settings.MasterKey = "123456!@#$%");

AppHost extensions

In your AppHost project, install the CommunityToolkit.Aspire.Hosting.Meilisearch library with NuGet:

dotnet add package CommunityToolkit.Aspire.Hosting.Meilisearch

Then, in the Program.cs file of AppHost, register a Meilisearch cluster and consume the connection using the following methods:

var meilisearch = builder.AddMeilisearch("meilisearch");

var myService = builder.AddProject<Projects.MyService>()
                       .WithReference(meilisearch);

The WithReference method configures a connection in the MyService project named meilisearch. In the Program.cs file of MyService, the Meilisearch connection can be consumed using:

builder.AddMeilisearchClient("meilisearch");

Then, in your service, inject MeilisearchClient and use it to interact with the Meilisearch API:

public class MyService(MeilisearchClient meilisearchClient)
{
    // ...
}

Additional documentation

Feedback & contributing

https://github.com/CommunityToolkit/Aspire

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. 
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
9.0.0-beta.54 33 10/31/2024
9.0.0-beta.53 30 10/29/2024
8.3.0 99 10/29/2024
8.3.0-beta.51 30 10/29/2024
8.3.0-beta.50 33 10/28/2024
8.3.0-beta.49 31 10/28/2024
8.3.0-beta.48 34 10/28/2024
8.3.0-beta.47 32 10/28/2024
8.3.0-beta.46 32 10/27/2024
8.3.0-beta.45 35 10/25/2024
8.3.0-beta.44 32 10/25/2024
8.3.0-beta.43 29 10/25/2024
8.3.0-beta.42 34 10/24/2024
8.2.1 71 10/23/2024
8.2.1-beta.40 25 10/23/2024
8.2.1-beta.39 30 10/23/2024
8.2.1-beta.38 33 10/23/2024
8.2.1-beta.37 32 10/23/2024
8.2.1-beta.36 31 10/23/2024
8.2.1-beta.35 31 10/23/2024
8.2.0-beta.34 34 10/23/2024
8.2.0-beta.33 34 10/23/2024
8.2.0-beta.32 33 10/22/2024
1.0.0-beta.58 28 11/4/2024
1.0.0-beta.57 27 11/1/2024
1.0.0-beta.56 27 11/1/2024
1.0.0-beta.55 30 11/1/2024