# MeilisearchBuilderExtensions Methods

- Package: [CommunityToolkit.Aspire.Hosting.Meilisearch](/reference/api/csharp/communitytoolkit.aspire.hosting.meilisearch.md)
- Type: [MeilisearchBuilderExtensions](/reference/api/csharp/communitytoolkit.aspire.hosting.meilisearch/meilisearchbuilderextensions.md)
- Kind: `Methods`
- Members: `3`

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

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

- Name: `AddMeilisearch(IDistributedApplicationBuilder, string, IResourceBuilder<ParameterResource>, int?)`
- Modifiers: `extension`
- Returns: `IResourceBuilder<MeilisearchResource>`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/67afcca30f02c18687f9c5219313710af9706630/src/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchBuilderExtensions.cs#L48-L82)

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

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

## 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.

```csharp
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)

- Name: `WithDataBindMount(IResourceBuilder<MeilisearchResource>, string)`
- Modifiers: `extension`
- Returns: `IResourceBuilder<MeilisearchResource>`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/67afcca30f02c18687f9c5219313710af9706630/src/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchBuilderExtensions.cs#L138-L141)

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

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

## 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.

```csharp
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?)

- Name: `WithDataVolume(IResourceBuilder<MeilisearchResource>, string?)`
- Modifiers: `extension`
- Returns: `IResourceBuilder<MeilisearchResource>`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/67afcca30f02c18687f9c5219313710af9706630/src/CommunityToolkit.Aspire.Hosting.Meilisearch/MeilisearchBuilderExtensions.cs#L109-L111)

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

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

## 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.

```csharp
var builder = DistributedApplication.CreateBuilder(args);

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

builder.Build().Run();
```