Struct Postgres

pub struct Postgres { /* private fields */ }

Available on crate feature postgres only.

Module to work with Postgres inside of tests.

Starts an instance of Postgres. This module is based on the official Postgres docker image.

Default db name, user and password is postgres.

Example

use testcontainers_modules::{postgres, testcontainers::runners::SyncRunner};

let postgres_instance = postgres::Postgres::default().start().unwrap();

let connection_string = format!(
    "postgres://postgres:postgres@{}:{}/postgres",
    postgres_instance.get_host().unwrap(),
    postgres_instance.get_host_port_ipv4(5432).unwrap()
);

Implementations

impl Postgres

pub fn with_host_auth(self) -> Self

Enables the Postgres instance to be used without authentication on host. For more information see the description of POSTGRES_HOST_AUTH_METHOD in official docker image

pub fn with_db_name(self, db_name: &str) -> Self

Sets the db name for the Postgres instance.

pub fn with_user(self, user: &str) -> Self

Sets the user for the Postgres instance.

pub fn with_password(self, password: &str) -> Self

Sets the password for the Postgres instance.

pub fn with_init_sql(self, init_sql: impl Into<CopyDataSource>) -> Self

Registers sql to be executed automatically when the container starts. Can be called multiple times to add (not override) scripts.

Example

let postgres_image = Postgres::default().with_init_sql(
    "CREATE EXTENSION IF NOT EXISTS hstore;"
        .to_string()
        .into_bytes(),
);

let postgres_image = Postgres::default()
                               .with_init_sql(include_str!("path_to_init.sql").to_string().into_bytes());

pub fn with_fsync_enabled(self) -> Self

Enables the fsync-setting for the Postgres instance.

Trait Implementations

impl Clone for Postgres

fn clone(&self) -> Postgres

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Postgres

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Postgres

fn default() -> Self

Returns the “default value” for a type.

impl Image for Postgres

fn name(&self) -> &str

The name of the docker image to pull from the Docker Hub registry.

fn tag(&self) -> &str

Implementations are encouraged to include a tag that will not change (i.e. NOT latest) in order to prevent test code from randomly breaking because the underlying docker suddenly changed.

fn ready_conditions(&self) -> Vec<WaitFor>

Returns a list of conditions that need to be met before a started container is considered ready.

fn env_vars( &self, ) -> impl IntoIterator<Item = (impl Into<Cow<'_, str>>, impl Into<Cow<'_, str>>)>

Returns the environment variables that needs to be set when a container is created.

fn copy_to_sources(&self) -> impl IntoIterator<Item = &CopyToContainer>

Returns the files to be copied into the container at startup.

fn cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD this image needs to be created with.

fn mounts(&self) -> impl IntoIterator<Item = &Mount>

Returns the mounts that needs to be created when a container is created.

fn entrypoint(&self) -> Option<&str>

Returns the entrypoint this image needs to be created with.

fn expose_ports(&self) -> &[ContainerPort]

Returns the ports that needs to be exposed when a container is created.

fn exec_after_start( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns the commands that needs to be executed after a container is started i.e. commands to be run in a running container.

fn exec_before_ready( &self, cs: ContainerState, ) -> Result<Vec<ExecCommand>, TestcontainersError>

Returns commands that will be executed after the container has started, but before the Image::ready_conditions are awaited for.