CommunityToolkit.Aspire.Meilisearch
9.0.1-beta.104
Prefix Reserved
See the version list below for details.
dotnet add package CommunityToolkit.Aspire.Meilisearch --version 9.0.1-beta.104
NuGet\Install-Package CommunityToolkit.Aspire.Meilisearch -Version 9.0.1-beta.104
<PackageReference Include="CommunityToolkit.Aspire.Meilisearch" Version="9.0.1-beta.104" />
paket add CommunityToolkit.Aspire.Meilisearch --version 9.0.1-beta.104
#r "nuget: CommunityToolkit.Aspire.Meilisearch, 9.0.1-beta.104"
// Install CommunityToolkit.Aspire.Meilisearch as a Cake Addin #addin nuget:?package=CommunityToolkit.Aspire.Meilisearch&version=9.0.1-beta.104&prerelease // Install CommunityToolkit.Aspire.Meilisearch as a Cake Tool #tool nuget:?package=CommunityToolkit.Aspire.Meilisearch&version=9.0.1-beta.104&prerelease
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
- https://github.com/meilisearch/meilisearch-dotnet
- https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-meilisearch
Feedback & contributing
Product | Versions 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. |
-
net8.0
- Aspire.Hosting (>= 9.0.0)
- MeiliSearch (>= 0.15.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.0)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
-
net9.0
- Aspire.Hosting (>= 9.0.0)
- MeiliSearch (>= 0.15.5)
- Microsoft.Extensions.Configuration.Binder (>= 9.0.0)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 9.0.0)
- Microsoft.Extensions.Hosting.Abstractions (>= 9.0.0)
- OpenTelemetry.Extensions.Hosting (>= 1.9.0)
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.1.0 | 109 | 12/12/2024 |
9.1.0-beta.112 | 34 | 12/18/2024 |
9.1.0-beta.110 | 37 | 12/16/2024 |
9.1.0-beta.109 | 37 | 12/12/2024 |
9.0.1-beta.108 | 39 | 12/12/2024 |
9.0.1-beta.107 | 33 | 12/11/2024 |
9.0.1-beta.106 | 36 | 12/12/2024 |
9.0.1-beta.104 | 35 | 12/11/2024 |
9.0.1-beta.102 | 44 | 12/6/2024 |
9.0.1-beta.99 | 38 | 12/6/2024 |
9.0.1-beta.98 | 38 | 12/6/2024 |
9.0.1-beta.95 | 47 | 12/5/2024 |
9.0.1-beta.94 | 40 | 12/5/2024 |
9.0.1-beta.93 | 30 | 12/2/2024 |
9.0.1-beta.92 | 38 | 11/30/2024 |
9.0.1-beta.91 | 38 | 11/30/2024 |
9.0.1-beta.90 | 38 | 11/29/2024 |
9.0.1-beta.89 | 37 | 11/29/2024 |
9.0.1-beta.88 | 33 | 11/27/2024 |
9.0.1-beta.87 | 39 | 11/27/2024 |
9.0.1-beta.86 | 42 | 11/27/2024 |
9.0.1-beta.84 | 43 | 11/24/2024 |
9.0.1-beta.83 | 41 | 11/22/2024 |
9.0.1-beta.82 | 40 | 11/21/2024 |
9.0.1-beta.81 | 33 | 11/19/2024 |
9.0.1-beta.80 | 32 | 11/19/2024 |
9.0.1-beta.79 | 36 | 11/19/2024 |
9.0.1-beta.77 | 37 | 11/15/2024 |
9.0.0 | 230 | 11/15/2024 |
9.0.0-beta.76 | 37 | 11/14/2024 |
9.0.0-beta.75 | 39 | 11/14/2024 |
9.0.0-beta.74 | 38 | 11/14/2024 |
9.0.0-beta.73 | 38 | 11/14/2024 |
9.0.0-beta.72 | 41 | 11/14/2024 |
9.0.0-beta.71 | 40 | 11/13/2024 |
9.0.0-beta.70 | 41 | 11/13/2024 |
9.0.0-beta.69 | 39 | 11/13/2024 |
9.0.0-beta.68 | 38 | 11/13/2024 |
9.0.0-beta.67 | 43 | 11/13/2024 |
9.0.0-beta.66 | 41 | 11/13/2024 |
9.0.0-beta.63 | 41 | 11/12/2024 |
9.0.0-beta.54 | 40 | 10/31/2024 |
9.0.0-beta.53 | 37 | 10/29/2024 |
8.3.0 | 180 | 10/29/2024 |
8.3.0-beta.51 | 37 | 10/29/2024 |
8.3.0-beta.50 | 40 | 10/28/2024 |
8.3.0-beta.49 | 40 | 10/28/2024 |
8.3.0-beta.48 | 41 | 10/28/2024 |
8.3.0-beta.47 | 41 | 10/28/2024 |
8.3.0-beta.46 | 40 | 10/27/2024 |
8.3.0-beta.45 | 45 | 10/25/2024 |
8.3.0-beta.44 | 43 | 10/25/2024 |
8.3.0-beta.43 | 37 | 10/25/2024 |
8.3.0-beta.42 | 42 | 10/24/2024 |
8.2.1 | 87 | 10/23/2024 |
8.2.1-beta.40 | 37 | 10/23/2024 |
8.2.1-beta.39 | 42 | 10/23/2024 |
8.2.1-beta.38 | 43 | 10/23/2024 |
8.2.1-beta.37 | 42 | 10/23/2024 |
8.2.1-beta.36 | 43 | 10/23/2024 |
8.2.1-beta.35 | 42 | 10/23/2024 |
8.2.0-beta.34 | 42 | 10/23/2024 |
8.2.0-beta.33 | 44 | 10/23/2024 |
8.2.0-beta.32 | 43 | 10/22/2024 |
1.0.0-beta.60 | 48 | 11/11/2024 |
1.0.0-beta.58 | 38 | 11/4/2024 |
1.0.0-beta.57 | 43 | 11/1/2024 |
1.0.0-beta.56 | 37 | 11/1/2024 |
1.0.0-beta.55 | 37 | 11/1/2024 |