# AspireSurrealDbExtensions Methods

- Package: [CommunityToolkit.Aspire.SurrealDb](/reference/api/csharp/communitytoolkit.aspire.surrealdb.md)
- Type: [AspireSurrealDbExtensions](/reference/api/csharp/communitytoolkit.aspire.surrealdb/aspiresurrealdbextensions.md)
- Kind: `Methods`
- Members: `2`

Provides extension methods for registering SurrealDB-related services in an `Hosting.IHostApplicationBuilder`.

## AddKeyedSurrealClient(IHostApplicationBuilder, string, Action<SurrealDbClientSettings>)

- Name: `AddKeyedSurrealClient(IHostApplicationBuilder, string, Action<SurrealDbClientSettings>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.SurrealDb/AspireSurrealDbExtensions.cs#L54-L57)

Registers `Net.SurrealDbClient` as a keyed service for the given `name` in the services provided by the `builder`.

```csharp
public static class AspireSurrealDbExtensions
{
    public static void AddKeyedSurrealClient(
        this IHostApplicationBuilder builder,
        string name,
        Action<SurrealDbClientSettings>? configureSettings = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `name` (`string`)
  The connection name to use to find a connection string.
- `configureSettings` (`Action<SurrealDbClientSettings>`) `optional`
  An optional method that can be used for customizing the [SurrealDbClientSettings](/reference/api/csharp/communitytoolkit.aspire.surrealdb/surrealdbclientsettings.md). It's invoked after the settings are read from the configuration.

## Exceptions

- `InvalidOperationException` -- If required ConnectionString is not provided in configuration section

## Remarks

Reads the configuration from "Aspire:Surreal:Client" section.

## AddSurrealClient(IHostApplicationBuilder, string, Action<SurrealDbClientSettings>)

- Name: `AddSurrealClient(IHostApplicationBuilder, string, Action<SurrealDbClientSettings>)`
- Modifiers: `extension`
- Source: [GitHub](https://github.com/CommunityToolkit/Aspire/blob/d9dc6fc02412d7398c5722840513d99965a6e98f/src/CommunityToolkit.Aspire.SurrealDb/AspireSurrealDbExtensions.cs#L35-L38)

Registers `Net.SurrealDbClient` in the services provided by the `builder`.

```csharp
public static class AspireSurrealDbExtensions
{
    public static void AddSurrealClient(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<SurrealDbClientSettings>? configureSettings = null)
    {
        // ...
    }
}
```

## Parameters

- `builder` (`IHostApplicationBuilder`)
  The `Hosting.IHostApplicationBuilder` to read config from and add services to.
- `connectionName` (`string`)
  The connection name to use to find a connection string.
- `configureSettings` (`Action<SurrealDbClientSettings>`) `optional`
  An optional method that can be used for customizing the [SurrealDbClientSettings](/reference/api/csharp/communitytoolkit.aspire.surrealdb/surrealdbclientsettings.md). It's invoked after the settings are read from the configuration.

## Exceptions

- `InvalidOperationException` -- If required ConnectionString is not provided in configuration section

## Remarks

Reads the configuration from "Aspire:Surreal:Client" section.