Struct Mysql

pub struct Mysql { /* private fields */ }

Available on crate feature mysql only.

Module to work with MySQL inside of tests.

Starts an instance of MySQL with no password set for the root user and a default database named test created.

This module is based on the officlal MySQL docker image.

Example

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

let mysql_instance = mysql::Mysql::default().start().unwrap();
let mysql_url = format!(
    "mysql://{}:{}/test",
    mysql_instance.get_host().unwrap(),
    mysql_instance.get_host_port_ipv4(3306).unwrap()
);

Implementations

impl Mysql

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 mysql_image = Mysql::default().with_init_sql(
    "CREATE TABLE foo (bar varchar(255));"
        .to_string()
        .into_bytes(),
);

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

Trait Implementations

impl Clone for Mysql

fn clone(&self) -> Mysql

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mysql

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

Formats the value using the given formatter.

impl Default for Mysql

fn default() -> Mysql

Returns the “default value” for a type.

impl Image for Mysql

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 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 cmd(&self) -> impl IntoIterator<Item = impl Into<Cow<'_, str>>>

Returns the CMD 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.