MeilisearchBuilderExtensions Methods

Docs / Reference / Search C# APIs / CommunityToolkit.Aspire.Hosting.Meilisearch / MeilisearchBuilderExtensions / Methods

Methods

Docs Reference Search C# APIs CommunityToolkit.Aspire.Hosting.Meilisearch MeilisearchBuilderExtensions Methods

Class Methods 3 members

Provides extension methods for adding Meilisearch resources to the application model.

AddMeilisearch(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?) extension IResourceBuilder<MeilisearchResource>

Adds an Meilisearch container resource to the application model. The default image is and the tag is .

public static class MeilisearchBuilderExtensions
{
    public static IResourceBuilder<MeilisearchResource> AddMeilisearch(
        this IDistributedApplicationBuilder builder,
        string name,
        IResourceBuilder<ParameterResource>? masterKey = null,
        int? port = null)
    {
        // ...
    }
}

MeilisearchBuilderExtensions.cs#L48-L82

Parameters

builder IDistributedApplicationBuilder The Hosting.IDistributedApplicationBuilder.

name string The name of the resource. This name will be used as the connection string name when referenced in a dependency.

masterKey IResourceBuilder<ParameterResource> optional The parameter used to provide the master key for the Meilisearch. If null a random master key will be generated.

port int? optional The host port to bind the underlying container to.

Returns

IResourceBuilder<MeilisearchResource> A reference to the ApplicationModel.IResourceBuilder`1.

Remarks

Add an Meilisearch container to the application model and reference it in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var meilisearch = builder.AddMeilisearch("meilisearch");
var api = builder.AddProject<Projects.Api>("api")
  .WithReference(meilisearch);

builder.Build().Run();

WithDataBindMount(IResourceBuilder<MeilisearchResource>, string) extension IResourceBuilder<MeilisearchResource>

Adds a bind mount for the data folder to a Meilisearch container resource.

public static class MeilisearchBuilderExtensions
{
    public static IResourceBuilder<MeilisearchResource> WithDataBindMount(
        this IResourceBuilder<MeilisearchResource> builder,
        string source)
    {
        // ...
    }
}

MeilisearchBuilderExtensions.cs#L138-L141

Parameters

builder IResourceBuilder<MeilisearchResource> The resource builder.

source string The source directory on the host to mount into the container.

Returns

IResourceBuilder<MeilisearchResource> The ApplicationModel.IResourceBuilder`1.

Remarks

Add an Meilisearch container to the application model and reference it in a .NET project. Additionally, in this example a bind mount is added to the container to allow data to be persisted across container restarts.

var builder = DistributedApplication.CreateBuilder(args);

var meilisearch = builder.AddMeilisearch("meilisearch")
.WithDataBindMount("./data/meilisearch/data");
var api = builder.AddProject<Projects.Api>("api")
  .WithReference(meilisearch);

builder.Build().Run();

WithDataVolume(IResourceBuilder<MeilisearchResource>, string?) extension IResourceBuilder<MeilisearchResource>

Adds a named volume for the data folder to a Meilisearch container resource.

public static class MeilisearchBuilderExtensions
{
    public static IResourceBuilder<MeilisearchResource> WithDataVolume(
        this IResourceBuilder<MeilisearchResource> builder,
        string? name = null)
    {
        // ...
    }
}

MeilisearchBuilderExtensions.cs#L109-L111

Parameters

builder IResourceBuilder<MeilisearchResource> The resource builder.

name string? optional The name of the volume. Defaults to an auto-generated name based on the application and resource names.

Returns

IResourceBuilder<MeilisearchResource> The ApplicationModel.IResourceBuilder`1.

Remarks

Add an Meilisearch container to the application model and reference it in a .NET project. Additionally, in this example a data volume is added to the container to allow data to be persisted across container restarts.

var builder = DistributedApplication.CreateBuilder(args);

var meilisearch = builder.AddMeilisearch("meilisearch")
.WithDataVolume();
var api = builder.AddProject<Projects.Api>("api")
  .WithReference(meilisearch);

builder.Build().Run();