org.testcontainers.clickhouse

Class ClickHouseContainer

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

org.testcontainers.clickhouse.ClickHouseContainer

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<ClickHouseContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public class ClickHouseContainer
extends org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

Testcontainers implementation for ClickHouse.

Supported image: clickhouse/clickhouse-server

Exposed ports:

• Database: 8123
• Console: 9000

Nested Class Summary

Nested classes/interfaces inherited from class org.testcontainers.containers.JdbcDatabaseContainer

org.testcontainers.containers.JdbcDatabaseContainer.NoDriverFoundException

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields inherited from class org.testcontainers.containers.JdbcDatabaseContainer

parameters, urlParameters

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
ClickHouseContainer(org.testcontainers.utility.DockerImageName dockerImageName)
ClickHouseContainer(java.lang.String dockerImageName)

Method Summary

Modifier and Type	Method and Description
protected void	configure()
java.lang.String	getDriverClassName()
java.lang.String	getJdbcUrl()
java.util.Set<java.lang.Integer>	getLivenessCheckPortNumbers()
java.lang.String	getPassword()
java.lang.String	getTestQueryString()
java.lang.String	getUsername()
ClickHouseContainer	withDatabaseName(java.lang.String databaseName)
ClickHouseContainer	withPassword(java.lang.String password)
ClickHouseContainer	withUsername(java.lang.String username)

Methods inherited from class org.testcontainers.containers.JdbcDatabaseContainer

addParameter, constructUrlForConnection, constructUrlParameters, constructUrlParameters, containerIsStarted, createConnection, createConnection, getConnectTimeoutSeconds, getDatabaseDelegate, getDatabaseName, getJdbcDriverInstance, getStartupTimeoutSeconds, optionallyMapResourceParameterAsVolume, optionallyMapResourceParameterAsVolume, runInitScriptIfRequired, setParameters, waitUntilContainerStarted, withConnectTimeoutSeconds, withInitScript, withStartupTimeoutSeconds, withUrlParam

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.traits.LinkableContainer

getContainerName

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Constructor Detail

ClickHouseContainer

public ClickHouseContainer(java.lang.String dockerImageName)

ClickHouseContainer

public ClickHouseContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

configure

protected void configure()

Overrides:

configure in class org.testcontainers.containers.GenericContainer<ClickHouseContainer>

getLivenessCheckPortNumbers

public java.util.Set<java.lang.Integer> getLivenessCheckPortNumbers()

Specified by:

getLivenessCheckPortNumbers in interface org.testcontainers.containers.wait.strategy.WaitStrategyTarget

Overrides:

getLivenessCheckPortNumbers in class org.testcontainers.containers.GenericContainer<ClickHouseContainer>

getDriverClassName

public java.lang.String getDriverClassName()

Specified by:

getDriverClassName in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

getJdbcUrl

public java.lang.String getJdbcUrl()

Specified by:

getJdbcUrl in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

getUsername

public java.lang.String getUsername()

Specified by:

getUsername in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

getPassword

public java.lang.String getPassword()

Specified by:

getPassword in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

getTestQueryString

public java.lang.String getTestQueryString()

Specified by:

getTestQueryString in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

withUsername

public ClickHouseContainer withUsername(java.lang.String username)

Overrides:

withUsername in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

withPassword

public ClickHouseContainer withPassword(java.lang.String password)

Overrides:

withPassword in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>

withDatabaseName

public ClickHouseContainer withDatabaseName(java.lang.String databaseName)

Overrides:

withDatabaseName in class org.testcontainers.containers.JdbcDatabaseContainer<ClickHouseContainer>