Package org.testcontainers.postgresql

Class PostgreSQLContainer

java.lang.Object
org.testcontainers.containers.GenericContainer<SELF>
org.testcontainers.containers.JdbcDatabaseContainer<PostgreSQLContainer>
org.testcontainers.postgresql.PostgreSQLContainer
All Implemented Interfaces:
AutoCloseable, org.testcontainers.containers.Container<PostgreSQLContainer>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable
public class PostgreSQLContainer extends org.testcontainers.containers.JdbcDatabaseContainer<PostgreSQLContainer>
Testcontainers implementation for PostgreSQL.

Supported images: postgres, pgvector/pgvector

Exposed ports: 5432

  • 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
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_TAG
     
    static final String
    IMAGE
     
    static final String
    NAME
     
    static final Integer
    POSTGRESQL_PORT
     

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

  • Method Summary

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

    Methods inherited from class org.testcontainers.containers.JdbcDatabaseContainer

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

    Methods inherited from class org.testcontainers.containers.GenericContainer

    addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, canBeReused, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, 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, stop, 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

  • Field Details

  • Constructor Details

    • PostgreSQLContainer

      public PostgreSQLContainer(String dockerImageName)

    • PostgreSQLContainer

      public PostgreSQLContainer(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<PostgreSQLContainer>
      Returns:
      the ports on which to check if the container is ready

    • configure

      protected void configure()
      Overrides:
      configure in class org.testcontainers.containers.GenericContainer<PostgreSQLContainer>

    • getDriverClassName

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

    • getJdbcUrl

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

    • getDatabaseName

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

    • getUsername

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

    • getPassword

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

    • getTestQueryString

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

    • withDatabaseName

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

    • withUsername

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

    • withPassword

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

    • waitUntilContainerStarted

      protected void waitUntilContainerStarted()
      Overrides:
      waitUntilContainerStarted in class org.testcontainers.containers.JdbcDatabaseContainer<PostgreSQLContainer>