# addClickHouse

- Module: [Aspire.Hosting.ClickHouse](/reference/api/typescript/aspire.hosting.clickhouse.md)
- Version: `13.5.3`
- Kind: `method`
- Source: [GitHub](https://github.com/ClickHouse/ClickHouse.Aspire/tree/cabd9edc0899714407e6ad81dc4954eb01302af0)

Adds a ClickHouse resource to the application model.

## Definition

```typescript
interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addClickHouse(
    name: string,
    port?: number,
    userName?: ParameterResource,
    password?: ParameterResource): ClickHouseServerResource
}
```

## Parameters

- `name` (`string`)
- `port` (`number`) `optional`
- `userName` (`ParameterResource`) `optional`
- `password` (`ParameterResource`) `optional`

## Returns

[ClickHouseServerResource](/reference/api/typescript/aspire.hosting.clickhouse/clickhouseserverresource.md) `builder`

## Applies to

- [IDistributedApplicationBuilder](/reference/api/typescript/aspire.hosting.clickhouse/idistributedapplicationbuilder.md)