TestcontainerEx.ClickHouseContainer (testcontainer_ex v0.9.0)

Copy Markdown View Source

Provides functionality for creating and managing ClickHouse container configurations.

Exposes both the HTTP interface (port 8123) and the native TCP interface (port 9000). The HTTP interface is used by the default wait strategy and is the most common entry point for Elixir drivers such as Clickhousex.

Summary

Types

t()

Functions

connection_parameters(container)
connection_url(container, opts \\ [])
default_http_port()
default_native_port()
http_port(container)
native_port(container)
new()

Callback implementation for TestcontainerEx.DatabaseBehaviour.new/0.

port(container)
with_check_image(config, check_image)

Sets the check image regex (or string) used to validate the container image name before starting.

with_database(c, db)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_database/2.

with_http_port(c, port)
with_image(c, image)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_image/2.

with_native_port(c, port)
with_password(c, pw)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_password/2.

with_persistent_volume(c, vol)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_persistent_volume/2.

with_port(c, arg)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_port/2.

with_reuse(config, reuse)

Enables or disables container reuse.

with_user(c, user)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_user/2.

with_wait_timeout(c, t)

Types

t()

@type t() :: %TestcontainerEx.ClickHouseContainer{
  check_image: term(),
  database: term(),
  http_port: term(),
  image: term(),
  name: term(),
  native_port: term(),
  password: term(),
  persistent_volume: term(),
  reuse: term(),
  user: term(),
  wait_timeout: term()
}

Functions

connection_parameters(container)

connection_url(container, opts \\ [])

default_http_port()

default_native_port()

http_port(container)

native_port(container)

new()

Callback implementation for TestcontainerEx.DatabaseBehaviour.new/0.

port(container)

with_check_image(config, check_image)

@spec with_check_image(t(), String.t() | Regex.t()) :: t()

Sets the check image regex (or string) used to validate the container image name before starting.

with_database(c, db)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_database/2.

with_http_port(c, port)

with_image(c, image)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_image/2.

with_native_port(c, port)

with_password(c, pw)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_password/2.

with_persistent_volume(c, vol)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_persistent_volume/2.

with_port(c, arg)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_port/2.

with_reuse(config, reuse)

@spec with_reuse(t(), boolean()) :: t()

Enables or disables container reuse.

with_user(c, user)

Callback implementation for TestcontainerEx.DatabaseBehaviour.with_user/2.

with_wait_timeout(c, t)