Skip to content

Clickhouse

Options

services.clickhouse.enable

Whether to enable clickhouse-server.

Type: boolean

Default:

false

Example:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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 for possible options.

Type: YAML 1.1 value

Default:

{ }

Example:

{
  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