Package org.testcontainers.tidb

Class TiDBContainer

java.lang.Object
org.testcontainers.containers.FailureDetectingExternalResource
org.testcontainers.containers.GenericContainer<SELF>
org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>
org.testcontainers.tidb.TiDBContainer
All Implemented Interfaces:
AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<TiDBContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable
public class TiDBContainer extends org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>
Testcontainers implementation for TiDB.

Supported image: pingcap/tidb

Exposed ports:

  • Database: 4000
  • HTTP: 10080

  • 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
    Description
    TiDBContainer(String dockerImageName)
     
    TiDBContainer(org.testcontainers.utility.DockerImageName dockerImageName)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    constructUrlForConnection(String queryString)
     
    String
    getDatabaseName()
     
    String
    getDriverClassName()
     
    String
    getJdbcUrl()
     
    protected @NotNull Set<Integer>
    getLivenessCheckPorts()
    Deprecated.
    use GenericContainer.getLivenessCheckPortNumbers() instead
    String
    getPassword()
     
    String
    getTestQueryString()
     
    String
    getUsername()
     
    TiDBContainer
    withDatabaseName(String databaseName)
     
    TiDBContainer
    withPassword(String password)
     
    TiDBContainer
    withUsername(String username)
     

    Methods inherited from class org.testcontainers.containers.JdbcDatabaseContainer

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

    Methods inherited from class org.testcontainers.containers.GenericContainer

    addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, 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, getLivenessCheckPortNumbers, 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.Container

    addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

    Methods inherited from interface org.testcontainers.containers.ContainerState

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

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

    getContainerName

    Methods inherited from interface org.testcontainers.lifecycle.Startable

    close

  • Constructor Details

    • TiDBContainer

      public TiDBContainer(String dockerImageName)

    • TiDBContainer

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

  • Method Details

    • getLivenessCheckPorts

      @NotNull @Deprecated protected @NotNull Set<Integer> getLivenessCheckPorts()
      Deprecated.
      use GenericContainer.getLivenessCheckPortNumbers() instead
      Overrides:
      getLivenessCheckPorts in class org.testcontainers.containers.GenericContainer<TiDBContainer>
      Returns:
      the ports on which to check if the container is ready

    • getDriverClassName

      public String getDriverClassName()
      Specified by:
      getDriverClassName in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • getJdbcUrl

      public String getJdbcUrl()
      Specified by:
      getJdbcUrl in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • constructUrlForConnection

      protected String constructUrlForConnection(String queryString)
      Overrides:
      constructUrlForConnection in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • getDatabaseName

      public String getDatabaseName()
      Overrides:
      getDatabaseName in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • getUsername

      public String getUsername()
      Specified by:
      getUsername in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • getPassword

      public String getPassword()
      Specified by:
      getPassword in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • getTestQueryString

      public String getTestQueryString()
      Specified by:
      getTestQueryString in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • withDatabaseName

      public TiDBContainer withDatabaseName(String databaseName)
      Overrides:
      withDatabaseName in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • withUsername

      public TiDBContainer withUsername(String username)
      Overrides:
      withUsername in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>

    • withPassword

      public TiDBContainer withPassword(String password)
      Overrides:
      withPassword in class org.testcontainers.containers.JdbcDatabaseContainer<TiDBContainer>