# clickhouse

## Options

### services.clickhouse.enable

Whether to enable clickhouse-server.

*Type:* boolean

*Default:*

```nix
false
```

*Example:*

```nix
true
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.package

Which package of clickhouse to use

*Type:* package

*Default:*

```nix
pkgs.clickhouse
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.config

ClickHouse configuration in YAML.

*Type:* strings concatenated with “\n”

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.httpPort

Which http port to run clickhouse on.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
8123
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.keeper.enable

Whether to enable keeper\_server in ClickHouse.

*Type:* boolean

*Default:*

```nix
false
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.keeper.port

Which port to run clickhouse keeper service on.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
9181
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.keeper.raft.port

Which http port to use clickhouse keeper for raft consensus.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
9234
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.macros.enable

Whether to enable macros in ClickHouse.

*Type:* boolean

*Default:*

```nix
false
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.port

Which port to run clickhouse on.

*Type:* 16 bit unsigned integer; between 0 and 65535 (both inclusive)

*Default:*

```nix
9000
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.remoteServers.enable

Whether to enable remote\_servers in ClickHouse.

*Type:* boolean

*Default:*

```nix
false
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.timezone

Which timezone to use for ClickHouse.

*Type:* null or string

*Default:*

```nix
null
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>

### services.clickhouse.usersConfig

Your `users.yaml` as a Nix attribute set. Check the [documentation](https://clickhouse.com/docs/operations/configuration-files#user-settings) for possible options.

*Type:* YAML 1.1 value

*Default:*

```nix
{ }
```

*Example:*

```nix
{
  profiles = {};


  users = {
    default = {
      profile = "default";
      password_sha256_hex = "36dd292533174299fb0c34665df468bb881756ca9eaf9757d0cfde38f9ededa1";  # `echo -n verysecret | sha256sum`
    };
  };
}
```

*Declared by:*

* <https://github.com/cachix/devenv/blob/main/src/modules/services/clickhouse.nix>