PostgresTestContainer from postgres - @valkyr/testcontainers

class PostgresTestContainer

Provides a simplified utility layer for starting, operating, and shutting down a postgres docker container.

Will automatically pull the requested docker image before starting the container.

Constructors

new



PostgresTestContainer(container: Container,
connection: PostgresConnectionInfo,
)

readonly



exec: this.container.exec

Execute a command in the Postgres container.

readonly



host: string

PostgreSQL container host.

readonly



password: string

PostgreSQL password applied to the container.

readonly



port: number

PostgreSQL container port.

readonly



username: string

PostgreSQL username applied to the container.



client(name: string,
options?: PostgresConnectionOptions,
): Sql

Get postgres client instance for the current container.



create(name: string): Promise<void>

Create a new database with the given name.



stop(): Promise<void>

Stop and remove the Postgres container.



url(name: string,
options?: PostgresConnectionOptions,
): PostgresConnectionUrl

Return the connection URL for the Postgres container in the format: postgres://${user}:${pass}@${host}:${port}/${database}.

Make sure to start the container before accessing this method or it will throw an error.



start(image: string,
config?: Partial<PostgresConnectionInfo>,
): Promise<PostgresTestContainer>

Start a new Postgres container.